A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.
Optional attributeOptional callbacksOptional metadataOptional tagsOptional verboseProtected lc_A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.
The final serialized identifier for the module.
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.
Internal method that handles batching and configuration for a runnable It takes a function, input values, and optional configuration, and returns a promise that resolves to the output values.
The function to be executed for each input value.
Optional options: Partial<BaseCallbackConfig>[]Optional runManagers: (undefined | CallbackManagerForChainRun)[]Optional batchOptions: RunnableBatchOptionsOptional options: Partial<BaseCallbackConfig & { Optional batchOptions: RunnableBatchOptionsA promise that resolves to the output values.
TODO: This should be an abstract method, but we'd like to avoid breaking changes to people currently using subclassed custom retrievers. Change it on next major release.
Default streaming implementation. Subclasses should override this method if they support streaming output.
Optional options: Partial<BaseCallbackConfig>Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.
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 & { An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]Optional batchOptions: RunnableBatchOptions & { Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]Optional batchOptions: RunnableBatchOptionsBind arguments to a Runnable, returning a new Runnable.
A new RunnableBinding that, when invoked, will apply the bound args.
Converts a QueryResultItem object into a Document object.
The QueryResultItem object to convert.
A Document object.
Converts a RetrieveResultItem object into a Document object.
The RetrieveResultItem object to convert.
A Document object.
Extracts the attribute value from a DocumentAttributeValue object.
The DocumentAttributeValue object to extract the value from.
The extracted attribute value.
Extracts the attribute key-value pairs from an array of DocumentAttribute objects.
Optional documentAttributes: DocumentAttribute[]The array of DocumentAttribute objects to extract the key-value pairs from.
An object containing the extracted attribute key-value pairs.
Extracts the top-k documents from a QueryCommandOutput object.
The QueryCommandOutput object to extract the documents from.
The number of documents to extract.
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.
The query string to retrieve relevant documents for.
Optional config: Callbacks | BaseCallbackConfigOptional configuration object for the retrieval process.
A promise that resolves to an array of Document objects.
Extracts the top-k documents from a RetrieveCommandOutput object.
The RetrieveCommandOutput object to extract the documents from.
The number of documents to extract.
An array of Document objects.
Optional options: BaseCallbackConfigReturn a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.
Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.
A runnable, function, or object whose values are functions or runnables.
A new runnable sequence.
Sends a retrieve or query request to Kendra and returns the top-k documents.
The query to send to Kendra.
The number of top documents to return.
Optional attributeFilter: AttributeFilterOptional filter to apply when retrieving documents.
A Promise that resolves to an array of Document objects.
Stream output in chunks.
Optional options: Partial<BaseCallbackConfig>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.
Optional options: Partial<BaseCallbackConfig>Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">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.
Bind config to a Runnable, returning a new Runnable.
New configuration parameters to attach to the new runnable.
A new RunnableBinding with a config matching what's passed.
Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
Other runnables to call if the runnable errors.
A new RunnableWithFallbacks.
Add retry logic to an existing runnable.
Optional fields: { Optional onOptional stopA new RunnableRetry that, when invoked, will retry according to the parameters.
Static isStatic lc_Protected _callOptional options: Partial<BaseCallbackConfig> & { Protected _getProtected _separateProtected _transformHelper method to transform an Iterator of Input values into an Iterator of
Output values, with callbacks.
Use this to implement stream() or transform() in Runnable subclasses.
Optional runManager: CallbackManagerForChainRunOptional options: Partial<BaseCallbackConfig>Optional options: BaseCallbackConfig & { Generated using TypeDoc
Class for interacting with Amazon Kendra, an intelligent search service provided by AWS. Extends the BaseRetriever class.