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: string
apiKey?: string

Some APIs allow an API key instead

apiVersion?: string

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

authOptions?: AuthOptions
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)

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.