Optional
input?: stringWhether to print out response text.
Optional
callbacksOptional
metadataOptional
tagsProtected
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 path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.
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.
Calls the tool with the provided argument and callbacks. It handles string inputs specifically.
The input argument for the tool, which can be a string, undefined, or an input of the tool's schema.
Optional
callbacks: CallbacksOptional callbacks for the tool.
A Promise that resolves with a string.
Invokes the tool with the provided input and configuration.
The input for the tool.
Optional
config: BaseCallbackConfigOptional configuration for the tool.
A Promise that resolves with a string.
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.
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
A class designed to interact with web pages, either to extract information from them or to summarize their content. It uses the axios library to send HTTP requests and the cheerio library to parse the returned HTML.