Optional fields: CloudflareWorkersAIInput & BaseLanguageModelParamsThe async caller should be used by subclasses to make any async calls, which will thus benefit from the concurrency and retry logic.
Whether to print out response text.
Optional cacheOptional callbacksOptional cloudflareOptional cloudflareOptional metadataOptional nameOptional tagsKeys that the language model accepts as call options.
Get the identifying parameters for this LLM.
Assigns new fields to the dict output of this runnable. Returns a new runnable.
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<BaseLanguageModelCallOptions> | Partial<BaseLanguageModelCallOptions>[]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<BaseLanguageModelCallOptions> | Partial<BaseLanguageModelCallOptions>[]Optional batchOptions: RunnableBatchOptions & { Optional options: Partial<BaseLanguageModelCallOptions> | Partial<BaseLanguageModelCallOptions>[]Optional batchOptions: RunnableBatchOptionsBind arguments to a Runnable, returning a new Runnable.
A new RunnableBinding that, when invoked, will apply the bound args.
An array of BaseMessage instances.
Optional options: BaseLanguageModelCallOptions | string[]The call options or an array of stop sequences.
Optional callbacks: CallbacksThe callbacks for the language model.
A Promise that resolves to a BaseMessage.
Use .invoke() instead. Will be removed in 0.2.0.
This feature is deprecated and will be removed in the future.
It is not recommended for use.
Makes a single call to the chat model.
The value of the prompt.
Optional options: BaseLanguageModelCallOptions | string[]The call options or an array of stop sequences.
Optional callbacks: CallbacksThe callbacks for the language model.
A Promise that resolves to a BaseMessage.
Use .invoke() instead. Will be removed in 0.2.0.
Makes a single call to the chat model with a prompt value.
Generates chat based on the input messages.
An array of arrays of BaseMessage instances.
Optional options: BaseLanguageModelCallOptions | string[]The call options or an array of stop sequences.
Optional callbacks: CallbacksThe callbacks for the language model.
A Promise that resolves to an LLMResult.
Generates a prompt based on the input prompt values.
An array of BasePromptValue instances.
Optional options: BaseLanguageModelCallOptions | string[]The call options or an array of stop sequences.
Optional callbacks: CallbacksThe callbacks for the language model.
A Promise that resolves to an LLMResult.
Get the parameters used to invoke the model
Optional _options: Omit<BaseLanguageModelCallOptions, never>Invokes the chat model with a single input.
The input for the language model.
Optional options: BaseLanguageModelCallOptionsThe call options.
A Promise that resolves to a BaseMessageChunk.
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.
Pick keys from the dict output of this runnable. Returns a new runnable.
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.
The text input.
Optional options: BaseLanguageModelCallOptions | string[]The call options or an array of stop sequences.
Optional callbacks: CallbacksThe callbacks for the language model.
A Promise that resolves to a string.
Use .invoke() instead. Will be removed in 0.2.0.
Predicts the next message based on a text input.
An array of BaseMessage instances.
Optional options: BaseLanguageModelCallOptions | string[]The call options or an array of stop sequences.
Optional callbacks: CallbacksThe callbacks for the language model.
A Promise that resolves to a BaseMessage.
Use .invoke() instead. Will be removed in 0.2.0.
Predicts the next message based on the input messages.
Return a json-like object representing this LLM.
Stream output in chunks.
Optional options: Partial<BaseLanguageModelCallOptions>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<BaseLanguageModelCallOptions>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: RunnableConfigOptional onCalled if the runnable throws an error, with the Run object.
Optional config: RunnableConfigOptional onCalled before the runnable starts running, with the Run object.
Optional config: RunnableConfigAdd retry logic to an existing runnable.
Optional fields: { Optional onOptional stopA new RunnableRetry that, when invoked, will retry according to the parameters.
Static deserializeLoad an LLM from a json-like object describing it.
Static isGenerated using TypeDoc
A class that enables calls to the Cloudflare Workers AI API to access large language models in a chat-like fashion. It extends the SimpleChatModel class and implements the CloudflareWorkersAIInput interface.
Example