Enables calls to the Google Cloud's Vertex AI API to access Large Language Models in a chat-like fashion.

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".

Example

const model = new ChatGoogleVertexAI({
temperature: 0.7,
});
const result = await model.invoke(
"How do I implement a binary search algorithm in Python?",
);

Hierarchy

  • BaseChatGoogleVertexAI<WebGoogleAuthOptions>
    • ChatGoogleVertexAI

Constructors

  • Parameters

    Returns ChatGoogleVertexAI

Properties

ParsedCallOptions: Omit<BaseLanguageModelCallOptions, never>
caller: AsyncCaller

The async caller should be used by subclasses to make any async calls, which will thus benefit from the concurrency and retry logic.

connection: GoogleVertexAILLMConnection<BaseLanguageModelCallOptions, GoogleVertexAIChatInstance, GoogleVertexAIChatPrediction, WebGoogleAuthOptions>
examples: ChatExample[] = []
maxOutputTokens: number = 1024
model: string = "chat-bison"
streamedConnection: GoogleVertexAILLMConnection<BaseLanguageModelCallOptions, GoogleVertexAIChatInstance, GoogleVertexAIChatPrediction, WebGoogleAuthOptions>
temperature: number = 0.2
topK: number = 40
topP: number = 0.8
verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
metadata?: Record<string, unknown>
tags?: string[]

Accessors

  • get callKeys(): string[]
  • Keys that the language model accepts as call options.

    Returns string[]

Methods

  • Makes a single call to the chat model.

    Parameters

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

  • Makes a single call to the chat model with a prompt value.

    Parameters

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

  • Creates an instance of the Google Vertex AI chat model.

    Parameters

    • messages: BaseMessage[]

      The messages for the model instance.

    Returns GoogleVertexAIChatInstance

    A new instance of the Google Vertex AI chat model.

  • Returns GoogleVertexAIModelParams

  • Generates chat based on the input messages.

    Parameters

    Returns Promise<LLMResult>

    A Promise that resolves to an LLMResult.

  • Generates a prompt based on the input prompt values.

    Parameters

    Returns Promise<LLMResult>

    A Promise that resolves to an LLMResult.

  • Parameters

    Returns Promise<number>

  • Get the parameters used to invoke the model

    Parameters

    Returns any

  • Invokes the chat model with a single input.

    Parameters

    Returns Promise<BaseMessageChunk>

    A Promise that resolves to a BaseMessageChunk.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    Returns RunnableSequence<BaseLanguageModelInput, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Predicts the next message based on a text input.

    Parameters

    • text: string

      The text input.

    • Optional options: string[] | BaseLanguageModelCallOptions

      The call options or an array of stop sequences.

    • Optional callbacks: Callbacks

      The callbacks for the language model.

    Returns Promise<string>

    A Promise that resolves to a string.

  • Predicts the next message based on the input messages.

    Parameters

    Returns Promise<BaseMessage>

    A Promise that resolves to a BaseMessage.

  • Returns SerializedLLM

    Deprecated

    Return a json-like object representing this LLM.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<BaseMessageChunk>>

    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.

    Parameters

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Returns Serialized

  • 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.

    Parameters

    Returns AsyncGenerator<BaseMessageChunk, any, unknown>

  • Converts a prediction from the Google Vertex AI chat model to a chat generation.

    Parameters

    Returns ChatGeneration

    The converted chat generation.

  • Parameters

    • output: any

    Returns ChatGenerationChunk

  • Parameters

    • thing: any

    Returns thing is Runnable<any, any, BaseCallbackConfig>

Generated using TypeDoc