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

Constructors

Properties

indexId: string
kendraClient: KendraClient
topK: number
attributeFilter?: AttributeFilter
callbacks?: Callbacks
metadata?: Record<string, unknown>
tags?: string[]
verbose?: boolean

Methods

  • 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

  • Parameters

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

  • Parameters

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

  • 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.

  • 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.

  • 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.

  • 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.

  • 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
  • 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.

  • 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: BaseCallbackConfig | Callbacks

      Optional configuration object for the retrieval process.

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

    A promise that resolves to an array of Document objects.

  • 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.

  • 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.

  • 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.

  • Stream output in chunks.

    Parameters

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

    A readable stream that is also an iterable.

  • 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>

  • 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

    Returns AsyncGenerator<Document<Record<string, any>>[], any, unknown>

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

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

Generated using TypeDoc