Optional fields: GoogleVertexAITextInputThe 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 metadataOptional tagsProtected connectionProtected streamedKeys that the language model accepts as call options.
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<BaseLLMCallOptions> | Partial<BaseLLMCallOptions>[]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<BaseLLMCallOptions> | Partial<BaseLLMCallOptions>[]Optional batchOptions: RunnableBatchOptions & { Optional options: Partial<BaseLLMCallOptions> | Partial<BaseLLMCallOptions>[]Optional batchOptions: RunnableBatchOptionsBind arguments to a Runnable, returning a new Runnable.
A new RunnableBinding that, when invoked, will apply the bound args.
Convenience wrapper for generate that takes in a single string prompt and returns a single string output.
Optional options: string[] | BaseLLMCallOptionsOptional callbacks: CallbacksExtracts the prediction from the API response.
The API response from which to extract the prediction.
A TextPrediction object representing the extracted prediction.
Formats the input instance for the Google Vertex AI model based on the model type (text or code).
Prompt to be formatted as an instance.
A GoogleVertexAILLMInstance object representing the formatted instance.
Formats the input instance as a code instance for the Google Vertex AI model.
Prompt to be formatted as a code instance.
A GoogleVertexAILLMInstance object representing the formatted code instance.
Formats the input instance as a text instance for the Google Vertex AI model.
Prompt to be formatted as a text instance.
A GoogleVertexAILLMInstance object representing the formatted text instance.
Run the LLM on the given prompts and input, handling caching.
Optional options: string[] | BaseLLMCallOptionsOptional callbacks: CallbacksThis method takes prompt values, options, and callbacks, and generates a result based on the prompts.
Prompt values for the LLM.
Optional options: string[] | BaseLLMCallOptionsOptions for the LLM call.
Optional callbacks: CallbacksCallbacks for the LLM call.
An LLMResult based on the prompts.
Get the parameters used to invoke the model
Optional _options: Omit<BaseLLMCallOptions, never>This method takes an input and options, and returns a string. It converts the input to a prompt value and generates a result based on the prompt.
Input for the LLM.
Optional options: BaseLLMCallOptionsOptions for the LLM call.
A string result based on the prompt.
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.
This method is similar to call, but it's used for making predictions
based on the input text.
Input text for the prediction.
Optional options: string[] | BaseLLMCallOptionsOptions for the LLM call.
Optional callbacks: CallbacksCallbacks for the LLM call.
A prediction based on the input text.
This method takes a list of messages, options, and callbacks, and returns a predicted message.
A list of messages for the prediction.
Optional options: string[] | BaseLLMCallOptionsOptions for the LLM call.
Optional callbacks: CallbacksCallbacks for the LLM call.
A predicted message based on the list of messages.
Return a json-like object representing this LLM.
Stream output in chunks.
Optional options: Partial<BaseLLMCallOptions>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<BaseLLMCallOptions>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 an LLM from a json-like object describing it.
Static isGenerated using TypeDoc
Enables calls to the Google Cloud's Vertex AI API to access Large Language Models.
This entrypoint and class are intended to be used in web environments like Edge functions where you do not have access to the file system. It supports passing service account credentials directly as a "GOOGLE_VERTEX_AI_WEB_CREDENTIALS" environment variable or directly as "authOptions.credentials".