Class ChatGoogleVertexAI

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

To use, you will need to have one of the following authentication methods in place:

  • You are logged into an account permitted to the Google Cloud project using Vertex AI.
  • You are running this on a machine using a service account permitted to the Google Cloud project using Vertex AI.
  • The GOOGLE_APPLICATION_CREDENTIALS environment variable is set to the path of a credentials file for a service account permitted to the Google Cloud project using Vertex AI.

Example

const model = new ChatGoogleVertexAI({
  temperature: 0.7,
});
const result = await model.invoke("What is the capital of France?");

Hierarchy

  • BaseChatGoogleVertexAI<GoogleAuthOptions>
    • 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, GoogleAuthOptions<JSONClient>>

examples

examples: ChatExample[] = []

maxOutputTokens

maxOutputTokens: number = 1024

model

model: string = "chat-bison"

streamedConnection

streamedConnection: GoogleVertexAILLMConnection<BaseLanguageModelCallOptions, GoogleVertexAIChatInstance, GoogleVertexAIChatPrediction, GoogleAuthOptions<JSONClient>>

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