Class GoogleVertexAI

Enables calls to the Google Cloud's Vertex AI API to access Large Language Models.

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 GoogleVertexAI({
  temperature: 0.7,
});
const stream = await model.stream(
  "What would be a good company name for a company that makes colorful socks?",
);
for await (const chunk of stream) {
  console.log(chunk);
}

Hierarchy

  • BaseGoogleVertexAI<GoogleAuthOptions>
    • GoogleVertexAI

Constructors

constructor

Properties

maxOutputTokens model temperature topK topP connection streamedConnection

Methods

extractGenerationFromPrediction extractPredictionFromResponse formatInstance formatInstanceCode formatInstanceText formatParameters

Constructors

constructor

Properties

maxOutputTokens

maxOutputTokens: number = 1024

model

model: string = "text-bison"

temperature

temperature: number = 0.7

topK

topK: number = 40

topP

topP: number = 0.8

Protected connection

connection: GoogleVertexAILLMConnection<BaseLanguageModelCallOptions, GoogleVertexAILLMInstance, TextPrediction, GoogleAuthOptions<JSONClient>>

Protected streamedConnection

streamedConnection: GoogleVertexAILLMConnection<BaseLanguageModelCallOptions, GoogleVertexAILLMInstance, TextPrediction, GoogleAuthOptions<JSONClient>>

Methods

extractGenerationFromPrediction

  • Parameters

    • prediction: TextPrediction

    Returns Generation

extractPredictionFromResponse

  • Extracts the prediction from the API response.

    Parameters

    • result: GoogleVertexAILLMResponse<TextPrediction>

      The API response from which to extract the prediction.

    Returns TextPrediction

    A TextPrediction object representing the extracted prediction.

formatInstance

  • Formats the input instance for the Google Vertex AI model based on the model type (text or code).

    Parameters

    • prompt: string

      Prompt to be formatted as an instance.

    Returns GoogleVertexAILLMInstance

    A GoogleVertexAILLMInstance object representing the formatted instance.

formatInstanceCode

  • Formats the input instance as a code instance for the Google Vertex AI model.

    Parameters

    • prompt: string

      Prompt to be formatted as a code instance.

    Returns GoogleVertexAILLMInstance

    A GoogleVertexAILLMInstance object representing the formatted code instance.

formatInstanceText

  • Formats the input instance as a text instance for the Google Vertex AI model.

    Parameters

    • prompt: string

      Prompt to be formatted as a text instance.

    Returns GoogleVertexAILLMInstance

    A GoogleVertexAILLMInstance object representing the formatted text instance.

formatParameters

  • Returns GoogleVertexAIModelParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc