Interface BaseGoogleEmbeddingsParams<AuthOptions>

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

interface BaseGoogleEmbeddingsParams<AuthOptions> {
    model: string;
    apiKey?: string;
    apiVersion?: string;
    authOptions?: AuthOptions;
    endpoint?: string;
    location?: string;
    platformType?: GooglePlatformType;
}

Type Parameters

  • AuthOptions

Hierarchy (view full)

Implemented by

Properties

model apiKey? apiVersion? authOptions? endpoint? location? platformType?

Properties

model

model: string

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

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)

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.

Settings

Member Visibility

On This Page

Properties