Class VertexAIBackend

Configuration class for the Agent Platform Gemini API (formerly known as the Vertex AI Gemini API).

Use this with AIOptions when initializing the AI service via getAI() to specify the Agent Platform Gemini API as the backend.

Deprecated

Use AgentPlatformBackend instead.

Hierarchy (View Summary)

Backend
- VertexAIBackend

Index

Constructors

Methods

_getModelPath _getTemplatePath

Properties

backendType location

Constructors

constructor

new VertexAIBackend(location?: string): VertexAIBackend
Creates a configuration object for the Agent Platform Gemini API (formerly known as the Vertex AI Gemini API) backend.
Parameters
- Optionallocation: string
  The region identifier, defaulting to us-central1; see Agent Platform Gemini API locations for a list of supported locations.
Returns VertexAIBackend
Overrides Backend.constructor
- Defined in backend.ts:112

Methods

_getModelPath

_getModelPath(project: string, model: string): string
Internal
Parameters
- project: string
- model: string
Returns string
Overrides Backend._getModelPath
- Defined in backend.ts:122

_getTemplatePath

_getTemplatePath(project: string, templateId: string): string
Internal
Parameters
- project: string
- templateId: string
Returns string
Overrides Backend._getTemplatePath
- Defined in backend.ts:129

Properties

`Readonly`backendType

backendType: BackendType

Specifies the backend type.

`Readonly`location

location: string = LEGACY_DEFAULT_LOCATION

The region identifier. See Agent Platform Gemini API locations for a list of supported locations.