Interface BaseGoogleEmbeddingsParams<AuthOptions>

Defines the parameters required to initialize a GoogleEmbeddings instance. It extends EmbeddingsParams and GoogleConnectionParams.

interface BaseGoogleEmbeddingsParams<AuthOptions> {
    apiKey?: string;
    apiVersion?: string;
    authOptions?: AuthOptions;
    dimensions?: number;
    endpoint?: string;
    location?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    model: string;
    onFailedAttempt?: FailedAttemptHandler;
    outputDimensionality?: number;
    platformType?: GooglePlatformType;
    vertexai?: boolean;
}

Type Parameters

  • AuthOptions

Hierarchy (view full)

Properties

apiKey? apiVersion? authOptions? dimensions? endpoint? location? maxConcurrency? maxRetries? model onFailedAttempt? outputDimensionality? platformType? vertexai?

Properties

OptionalapiKey

apiKey?: string

Some APIs allow an API key instead

OptionalapiVersion

apiVersion?: string

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

OptionalauthOptions

authOptions?: AuthOptions

Optionaldimensions

dimensions?: number

Used to specify output embedding size. If set, output embeddings will be truncated to the size specified.

Optionalendpoint

endpoint?: string

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

Optionallocation

location?: string

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

OptionalmaxConcurrency

maxConcurrency?: number

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

OptionalmaxRetries

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

model: string

OptionalonFailedAttempt

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.

OptionaloutputDimensionality

outputDimensionality?: number

An alias for "dimensions"

OptionalplatformType

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.

Optionalvertexai

vertexai?: boolean

For compatibility with Google's libraries, should this use Vertex? The "platformType" parmeter takes precedence.

Settings

Member Visibility

On This Page

Properties