AmazonKnowledgeBaseRetriever

Defined in: community/src/retrievers/bedrock.ts:47

Class for interacting with Amazon Bedrock Knowledge Bases, a RAG workflow oriented service Extends the BaseRetriever class.

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

• BaseRetriever

Constructors

new AmazonKnowledgeBaseRetriever()

new AmazonKnowledgeBaseRetriever(__namedParameters): AmazonKnowledgeBaseRetriever

Defined in: community/src/retrievers/bedrock.ts:64

Parameters

__namedParameters

AmazonKnowledgeBaseRetrieverArgs

Returns

AmazonKnowledgeBaseRetriever

Overrides

BaseRetriever.constructor

Properties

lc_namespace

lc_namespace: string[]

Defined in: community/src/retrievers/bedrock.ts:52

knowledgeBaseId

knowledgeBaseId: string

Defined in: community/src/retrievers/bedrock.ts:54

topK

topK: number

Defined in: community/src/retrievers/bedrock.ts:56

bedrockAgentRuntimeClient

bedrockAgentRuntimeClient: BedrockAgentRuntimeClient

Defined in: community/src/retrievers/bedrock.ts:58

filter

filter: undefined | RetrievalFilter

Defined in: community/src/retrievers/bedrock.ts:60

overrideSearchType

overrideSearchType: undefined | SearchType

Defined in: community/src/retrievers/bedrock.ts:62

Methods

lc_name()

static lc_name(): string

Defined in: community/src/retrievers/bedrock.ts:48

Returns

string

cleanResult()

cleanResult(resText): string

Defined in: community/src/retrievers/bedrock.ts:90

Cleans the result text by replacing sequences of whitespace with a single space and removing ellipses.

Parameters

resText

string

The result text to clean.

Returns

string

The cleaned result text.

queryKnowledgeBase()

queryKnowledgeBase(query, topK, filter?, overrideSearchType?): Promise<NodeWithScore<Metadata>[]>

Defined in: community/src/retrievers/bedrock.ts:95

Parameters

query

QueryBundle

topK

number

filter?

RetrievalFilter

overrideSearchType?

SearchType

Returns

Promise<NodeWithScore<Metadata>[]>

_retrieve()

_retrieve(query): Promise<NodeWithScore<Metadata>[]>

Defined in: community/src/retrievers/bedrock.ts:157

Parameters

query

QueryBundle

Returns

Promise<NodeWithScore<Metadata>[]>

Overrides

BaseRetriever._retrieve