Whether to print out response text.
Optional callbacksOptional memoryOptional metadataOptional tagsCall the chain on all inputs in the list
Optional config: (BaseCallbackConfig | Callbacks)[]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.
Run the core logic of this chain and add to output if desired.
Wraps _call and handles memory.
Optional config: BaseCallbackConfig | CallbacksOptional tags: string[]Invoke the chain with the provided input and returns the output.
Input values for the chain run.
Optional config: BaseCallbackConfigOptional configuration for the Runnable.
Promise that resolves with the output of the chain run.
Return 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.
Optional config: BaseCallbackConfig | CallbacksReturn a json-like object representing this chain.
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.
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.
The object containing the callback functions.
Optional onCalled after the runnable finishes running, with the Run object.
Optional config: BaseCallbackConfigOptional onCalled if the runnable throws an error, with the Run object.
Optional config: BaseCallbackConfigOptional onCalled before the runnable starts running, with the Run object.
Optional config: BaseCallbackConfigAdd retry logic to an existing runnable.
Optional fields: { Optional onOptional stopA new RunnableRetry that, when invoked, will retry according to the parameters.
Static deserializeLoad a chain from a json-like object describing it.
Static fromLLMStatic method to create a new ConversationalRetrievalQAChain from a BaseLanguageModel and a BaseRetriever.
BaseLanguageModel instance used to generate a new question.
BaseRetriever instance used to retrieve relevant documents.
A new instance of ConversationalRetrievalQAChain.
Static getStatic method to convert the chat history input into a formatted string.
Chat history input which can be a string, an array of BaseMessage instances, or an array of string arrays.
A formatted string representing the chat history.
Static isGenerated using TypeDoc
Class for conducting conversational question-answering tasks with a retrieval component. Extends the BaseChain class and implements the ConversationalRetrievalQAChainInput interface.
Example