An BaseMessagePromptTemplate | BaseChatPromptTemplate used to format a single example.
String separator used to join the prefix, the examples, and suffix.
"\n\n"
A list of variable names the prompt template expects
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.
Partial variables
A prompt template string to put before the examples.
""
A prompt template string to put after the examples.
""
The format of the prompt template. Options are: 'f-string'
f-string
Whether or not to try validating the template on initialization.
true
Optional exampleAn BaseExampleSelector Examples to format into the prompt. Exactly one of this or examples must be provided.
Optional examplesExamples to format into the prompt. Exactly one of this or exampleSelector must be provided.
Optional outputHow to parse the output of calling an LLM on this formatted prompt
Protected 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.
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.
Formats the list of values and returns a list of formatted messages.
The values to format the prompt with.
A promise that resolves to a string representing the formatted prompt.
Invokes the prompt template with the given input and options.
The input to invoke the prompt template with.
Optional options: BaseCallbackConfigOptional configuration for the callback.
A Promise that resolves to the output of the prompt template.
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.
Merges partial variables and user variables.
The user variables to merge with the partial variables.
A Promise that resolves to an object containing the merged variables.
Partially formats the prompt with the given values.
The values to partially format the prompt with.
A promise that resolves to an instance of FewShotChatMessagePromptTemplate with the given values partially formatted.
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.
Return a json-like object representing this prompt template.
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 deserializeLoad a prompt template from a json-like object describing it.
Deserializing needs to be async because templates (e.g. FewShotPromptTemplate) can reference remote resources that we read asynchronously with a web request.
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
Chat prompt template that contains few-shot examples.