Class ChatGoogleVertexAI

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

constructor

Properties

connection examples maxOutputTokens model streamedConnection temperature topK topP

Methods

createInstance formatParameters convertPrediction convertPredictionChunk

Constructors

constructor

  • Parameters

    Returns ChatGoogleVertexAI

Properties

connection

connection: GoogleVertexAILLMConnection<BaseLanguageModelCallOptions, GoogleVertexAIChatInstance, GoogleVertexAIChatPrediction, WebGoogleAuthOptions>

examples

examples: ChatExample[] = []

maxOutputTokens

maxOutputTokens: number = 1024

model

model: string = "chat-bison"

streamedConnection

streamedConnection: GoogleVertexAILLMConnection<BaseLanguageModelCallOptions, GoogleVertexAIChatInstance, GoogleVertexAIChatPrediction, WebGoogleAuthOptions>

temperature

temperature: number = 0.2

topK

topK: number = 40

topP

topP: number = 0.8

Methods

createInstance

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

formatParameters

  • Returns GoogleVertexAIModelParams

Static convertPrediction

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

    Parameters

    Returns ChatGeneration

    The converted chat generation.

Static convertPredictionChunk

  • Parameters

    • output: any

    Returns ChatGenerationChunk

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc