Class AmazonKendraRetriever

Class for interacting with Amazon Kendra, an intelligent search service provided by AWS. Extends the BaseRetriever class.

Example

const retriever = new AmazonKendraRetriever({
  topK: 10,
  indexId: "YOUR_INDEX_ID",
  region: "us-east-2",
  clientOptions: {
    credentials: {
      accessKeyId: "YOUR_ACCESS_KEY_ID",
      secretAccessKey: "YOUR_SECRET_ACCESS_KEY",
    },
  },
});

const docs = await retriever.getRelevantDocuments("How are clouds formed?");

Hierarchy

BaseRetriever
- AmazonKendraRetriever

Constructors

constructor

new AmazonKendraRetriever(__namedParameters): AmazonKendraRetriever
Parameters
- __namedParameters: AmazonKendraRetrieverArgs
Returns AmazonKendraRetriever
Overrides BaseRetriever.constructor
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:67

Properties

indexId

indexId: string

kendraClient

kendraClient: KendraClient

topK

topK: number

`Optional` attributeFilter

attributeFilter?: AttributeFilter

`Optional` callbacks

callbacks?: Callbacks

`Optional` metadata

metadata?: Record<string, unknown>

`Optional` tags

tags?: string[]

`Optional` verbose

verbose?: boolean

Methods

batch

batch(inputs, options?, batchOptions?): Promise<Document<Record<string, any>>[][]>
Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.
Parameters
- inputs: string[]
  
  Array of inputs to each batch call.
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
  
  Either a single call options object to apply to each batch call or an array for each call.
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions?: false;
  }
Returns Promise<Document<Record<string, any>>[][]>
An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Inherited from BaseRetriever.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:159
batch(inputs, options?, batchOptions?): Promise<(Error | Document<Record<string, any>>[])[]>
Parameters
- inputs: string[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(Error | Document<Record<string, any>>[])[]>
Inherited from BaseRetriever.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:165
batch(inputs, options?, batchOptions?): Promise<(Error | Document<Record<string, any>>[])[]>
Parameters
- inputs: string[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(Error | Document<Record<string, any>>[])[]>
Inherited from BaseRetriever.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:171

bind

bind(kwargs): Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<BaseCallbackConfig>
Returns Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from BaseRetriever.bind
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:67

cleanResult

cleanResult(resText): string
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.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:118

combineText

combineText(title?, excerpt?): string
Combines title and excerpt into a single string.
Parameters
- Optional title: string
  
  The title of the document.
- Optional excerpt: string
  
  An excerpt from the document.
Returns string
A single string combining the title and excerpt.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:100

convertQueryItem

convertQueryItem(item): Document<{
    document_attributes: {
        [key: string]: unknown;
    };
    excerpt: string;
    source: undefined | string;
    title: string;
}>
Converts a QueryResultItem object into a Document object.
Parameters
- item: QueryResultItem
  
  The QueryResultItem object to convert.
Returns Document<{
    document_attributes: {
        [key: string]: unknown;
    };
    excerpt: string;
    source: undefined | string;
    title: string;
}>
A Document object.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:243

convertRetrieverItem

convertRetrieverItem(item): Document<{
    document_attributes: {
        [key: string]: unknown;
    };
    excerpt: string;
    source: undefined | string;
    title: string;
}>
Converts a RetrieveResultItem object into a Document object.
Parameters
- item: RetrieveResultItem
  
  The RetrieveResultItem object to convert.
Returns Document<{
    document_attributes: {
        [key: string]: unknown;
    };
    excerpt: string;
    source: undefined | string;
    title: string;
}>
A Document object.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:172

getDocAttributeValue

getDocAttributeValue(value): string | number | string[] | Date
Extracts the attribute value from a DocumentAttributeValue object.
Parameters
- value: DocumentAttributeValue
  
  The DocumentAttributeValue object to extract the value from.
Returns string | number | string[] | Date
The extracted attribute value.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:129

getDocAttributes

getDocAttributes(documentAttributes?): {
[key: string]: unknown;
}
Extracts the attribute key-value pairs from an array of DocumentAttribute objects.
Parameters
- Optional documentAttributes: DocumentAttribute[]
  
  The array of DocumentAttribute objects to extract the key-value pairs from.
Returns {
[key: string]: unknown;
}
An object containing the extracted attribute key-value pairs.
- [key: string]: unknown
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:152

getQueryDocs

getQueryDocs(response, pageSize): Document<{
    document_attributes: {
        [key: string]: unknown;
    };
    excerpt: string;
    source: undefined | string;
    title: string;
}>[]
Extracts the top-k documents from a QueryCommandOutput object.
Parameters
- response: QueryCommandOutput
  
  The QueryCommandOutput object to extract the documents from.
- pageSize: number
  
  The number of documents to extract.
Returns Document<{
    document_attributes: {
        [key: string]: unknown;
    };
    excerpt: string;
    source: undefined | string;
    title: string;
}>[]
An array of Document objects.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:266

getQueryItemExcerpt

getQueryItemExcerpt(item): string
Extracts the excerpt text from a QueryResultItem object.
Parameters
- item: QueryResultItem
  
  The QueryResultItem object to extract the excerpt text from.
Returns string
The extracted excerpt text.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:214

getRelevantDocuments

getRelevantDocuments(query, config?): Promise<Document<Record<string, any>>[]>
Main method used to retrieve relevant documents. It takes a query string and an optional configuration object, and returns a promise that resolves to an array of Document objects. This method handles the retrieval process, including starting and ending callbacks, and error handling.
Parameters
- query: string
  
  The query string to retrieve relevant documents for.
- Optional config: Callbacks | BaseCallbackConfig
  
  Optional configuration object for the retrieval process.
Returns Promise<Document<Record<string, any>>[]>
A promise that resolves to an array of Document objects.
Inherited from BaseRetriever.getRelevantDocuments
- Defined in docs/api_refs/langchain/src/schema/retriever.ts:71

getRetrieverDocs

getRetrieverDocs(response, pageSize): Document<Record<string, any>>[]
Extracts the top-k documents from a RetrieveCommandOutput object.
Parameters
- response: RetrieveCommandOutput
  
  The RetrieveCommandOutput object to extract the documents from.
- pageSize: number
  
  The number of documents to extract.
Returns Document<Record<string, any>>[]
An array of Document objects.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:195

invoke

invoke(input, options?): Promise<Document<Record<string, any>>[]>
Parameters
- input: string
- Optional options: BaseCallbackConfig
Returns Promise<Document<Record<string, any>>[]>
Inherited from BaseRetriever.invoke
- Defined in docs/api_refs/langchain/src/schema/retriever.ts:57

map

map(): Runnable<string[], Document<Record<string, any>>[][], BaseCallbackConfig>
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

Returns Runnable<string[], Document<Record<string, any>>[][], BaseCallbackConfig>
Inherited from BaseRetriever.map
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:78

pipe

pipe<NewRunOutput>(coerceable): RunnableSequence<string, Exclude<NewRunOutput, Error>>
Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.
Type Parameters
- NewRunOutput
Parameters
- coerceable: RunnableLike<Document<Record<string, any>>[], NewRunOutput>
  
  A runnable, function, or object whose values are functions or runnables.
Returns RunnableSequence<string, Exclude<NewRunOutput, Error>>
A new runnable sequence.
Inherited from BaseRetriever.pipe
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:461

queryKendra

queryKendra(query, topK, attributeFilter?): Promise<Document<Record<string, any>>[] | Document<{
    document_attributes: {
        [key: string]: unknown;
    };
    excerpt: string;
    source: undefined | string;
    title: string;
}>[]>
Sends a retrieve or query request to Kendra and returns the top-k documents.
Parameters
- query: string
  
  The query to send to Kendra.
- topK: number
  
  The number of top documents to return.
- Optional attributeFilter: AttributeFilter
  
  Optional filter to apply when retrieving documents.
Returns Promise<Document<Record<string, any>>[] | Document<{
    document_attributes: {
        [key: string]: unknown;
    };
    excerpt: string;
    source: undefined | string;
    title: string;
}>[]>
A Promise that resolves to an array of Document objects.
- Defined in docs/api_refs/langchain/src/retrievers/amazon_kendra.ts:284

stream

stream(input, options?): Promise<IterableReadableStream<Document<Record<string, any>>[]>>
Stream output in chunks.
Parameters
- input: string
- Optional options: Partial<BaseCallbackConfig>
Returns Promise<IterableReadableStream<Document<Record<string, any>>[]>>
A readable stream that is also an iterable.
Inherited from BaseRetriever.stream
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:225

streamLog

streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>
Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.
Parameters
- input: string
- Optional options: Partial<BaseCallbackConfig>
- Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">
Returns AsyncGenerator<RunLogPatch, any, unknown>
Inherited from BaseRetriever.streamLog
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:507

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseRetriever.toJSON
- Defined in docs/api_refs/langchain/src/load/serializable.ts:148

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseRetriever.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

transform

transform(generator, options): AsyncGenerator<Document<Record<string, any>>[], any, unknown>
Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.
Parameters
- generator: AsyncGenerator<string, any, unknown>
- options: Partial<BaseCallbackConfig>
Returns AsyncGenerator<Document<Record<string, any>>[], any, unknown>
Inherited from BaseRetriever.transform
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:478

withConfig

withConfig(config): RunnableBinding<string, Document<Record<string, any>>[], BaseCallbackConfig>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: BaseCallbackConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<string, Document<Record<string, any>>[], BaseCallbackConfig>
A new RunnableBinding with a config matching what's passed.
Inherited from BaseRetriever.withConfig
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:107

withFallbacks

withFallbacks(fields): RunnableWithFallbacks<string, Document<Record<string, any>>[]>
Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
Parameters
- fields: {
  fallbacks: Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>[];
  }
  - fallbacks: Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<string, Document<Record<string, any>>[]>
A new RunnableWithFallbacks.
Inherited from BaseRetriever.withFallbacks
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:124

withRetry

withRetry(fields?): RunnableRetry<string, Document<Record<string, any>>[], BaseCallbackConfig>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<string, Document<Record<string, any>>[], BaseCallbackConfig>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from BaseRetriever.withRetry
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:88

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, BaseCallbackConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, BaseCallbackConfig>
Inherited from BaseRetriever.isRunnable
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:557

Class AmazonKendraRetriever

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: AmazonKendraRetrieverArgs

Returns AmazonKendraRetriever

Properties

indexId

kendraClient

topK

Optional attributeFilter

Optional callbacks

Optional metadata

Optional tags

Optional verbose

Methods

batch

Parameters

inputs: string[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions?: false; }

Returns Promise<Document<Record<string, any>>[][]>

Parameters

inputs: string[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(Error | Document<Record<string, any>>[])[]>

Parameters

inputs: string[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(Error | Document<Record<string, any>>[])[]>

bind

Parameters

kwargs: Partial<BaseCallbackConfig>

Returns Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>

cleanResult

Parameters

resText: string

Returns string

combineText

Parameters

Optional title: string

Optional excerpt: string

Returns string

convertQueryItem

Parameters

item: QueryResultItem

Returns Document<{ document_attributes: { [key: string]: unknown; }; excerpt: string; source: undefined | string; title: string; }>

convertRetrieverItem

Parameters

item: RetrieveResultItem

Returns Document<{ document_attributes: { [key: string]: unknown; }; excerpt: string; source: undefined | string; title: string; }>

getDocAttributeValue

Parameters

value: DocumentAttributeValue

Returns string | number | string[] | Date

getDocAttributes

Parameters

Optional documentAttributes: DocumentAttribute[]

Returns { [key: string]: unknown; }

[key: string]: unknown

getQueryDocs

Parameters

response: QueryCommandOutput

pageSize: number

Returns Document<{ document_attributes: { [key: string]: unknown; }; excerpt: string; source: undefined | string; title: string; }>[]

getQueryItemExcerpt

Parameters

item: QueryResultItem

Returns string

getRelevantDocuments

Parameters

query: string

`Optional` attributeFilter

`Optional` callbacks

`Optional` metadata

`Optional` tags

`Optional` verbose

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions?: false;
}

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions

`Optional` title: string

`Optional` excerpt: string

Returns Document<{
document_attributes: {
[key: string]: unknown;
};
excerpt: string;
source: undefined | string;
title: string;
}>

Returns Document<{
document_attributes: {
[key: string]: unknown;
};
excerpt: string;
source: undefined | string;
title: string;
}>

`Optional` documentAttributes: DocumentAttribute[]

Returns {
[key: string]: unknown;
}

Returns Document<{
document_attributes: {
[key: string]: unknown;
};
excerpt: string;
source: undefined | string;
title: string;
}>[]

`Optional` config: Callbacks | BaseCallbackConfig

`Optional` options: BaseCallbackConfig

`Optional` attributeFilter: AttributeFilter

Returns Promise<Document<Record<string, any>>[] | Document<{
document_attributes: {
[key: string]: unknown;
};
excerpt: string;
source: undefined | string;
title: string;
}>[]>

`Optional` options: Partial<BaseCallbackConfig>

`Optional` options: Partial<BaseCallbackConfig>

`Optional` streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

fields: {
fallbacks: Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>[];
}

`Optional` fields: {
onFailedAttempt?: RunnableRetryFailedAttemptHandler;
stopAfterAttempt?: number;
}

`Optional` onFailedAttempt?: RunnableRetryFailedAttemptHandler

`Optional` stopAfterAttempt?: number

`Static` isRunnable