AmazonKnowledgeBaseRetriever-1
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:47
Class for interacting with Amazon Bedrock Knowledge Bases, a RAG workflow oriented service Extends the BaseRetriever class.
Example
Section titled “Example”const retriever = new AmazonKnowledgeBaseRetriever(\{ topK: 10, knowledgeBaseId: "YOUR_KNOWLEDGE_BASE_ID", region: "us-east-2", clientOptions: { credentials: { accessKeyId: "YOUR_ACCESS_KEY_ID", secretAccessKey: "YOUR_SECRET_ACCESS_KEY", \}, },});
const docs = await retriever.retrieve(\{query: "How are clouds formed?"\});Extends
Section titled “Extends”BaseRetriever
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AmazonKnowledgeBaseRetriever(
__namedParameters):AmazonKnowledgeBaseRetriever
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:64
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”AmazonKnowledgeBaseRetrieverArgs
Returns
Section titled “Returns”AmazonKnowledgeBaseRetriever
Overrides
Section titled “Overrides”BaseRetriever.constructor
Properties
Section titled “Properties”lc_namespace
Section titled “lc_namespace”lc_namespace:
string[]
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:52
knowledgeBaseId
Section titled “knowledgeBaseId”knowledgeBaseId:
string
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:54
topK:
number
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:56
bedrockAgentRuntimeClient
Section titled “bedrockAgentRuntimeClient”bedrockAgentRuntimeClient:
BedrockAgentRuntimeClient
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:58
filter
Section titled “filter”filter:
undefined|RetrievalFilter
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:60
overrideSearchType
Section titled “overrideSearchType”overrideSearchType:
undefined|SearchType
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:62
Methods
Section titled “Methods”lc_name()
Section titled “lc_name()”
staticlc_name():string
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:48
Returns
Section titled “Returns”string
cleanResult()
Section titled “cleanResult()”cleanResult(
resText):string
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:90
Cleans the result text by replacing sequences of whitespace with a single space and removing ellipses.
Parameters
Section titled “Parameters”resText
Section titled “resText”string
The result text to clean.
Returns
Section titled “Returns”string
The cleaned result text.
queryKnowledgeBase()
Section titled “queryKnowledgeBase()”queryKnowledgeBase(
query,topK,filter?,overrideSearchType?):Promise<NodeWithScore<Metadata>[]>
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:95
Parameters
Section titled “Parameters”QueryBundle
number
filter?
Section titled “filter?”RetrievalFilter
overrideSearchType?
Section titled “overrideSearchType?”SearchType
Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
_retrieve()
Section titled “_retrieve()”_retrieve(
query):Promise<NodeWithScore<Metadata>[]>
Defined in: .build/typescript/packages/community/src/retrievers/bedrock.ts:157
Parameters
Section titled “Parameters”QueryBundle
Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
Overrides
Section titled “Overrides”BaseRetriever._retrieve