Input to a Google Vertex AI embeddings class.

interface GoogleVertexAIEmbeddingsInput {
    apiKey?: string;
    apiVersion?: string;
    authOptions?: WebGoogleAuthOptions;
    endpoint?: string;
    location?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    model: string;
    onFailedAttempt?: FailedAttemptHandler;
    platformType?: GooglePlatformType;
}

Hierarchy

  • GoogleEmbeddingsInput
    • GoogleVertexAIEmbeddingsInput

Properties

apiKey?: string

Some APIs allow an API key instead

apiVersion?: string

The version of the API functions. Part of the path.

authOptions?: WebGoogleAuthOptions
endpoint?: string

Hostname for the API call (if this is running on GCP)

location?: string

Region where the LLM is stored (if this is running on GCP)

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

model: string
onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

platformType?: GooglePlatformType

What platform to run the service on. If not specified, the class should determine this from other means. Either way, the platform actually used will be in the "platform" getter.