Interface GoogleConnectionParams<AuthOptions>

Parameters needed to setup the client connection. AuthOptions are something like GoogleAuthOptions (from google-auth-library) or WebGoogleAuthOptions.

interface GoogleConnectionParams<AuthOptions> {
    apiKey?: string;
    apiVersion?: string;
    authOptions?: AuthOptions;
    endpoint?: string;
    location?: string;
    platformType?: "gai" | "gcp";
}

Type Parameters

  • AuthOptions

Hierarchy (view full)

Implemented by

Properties

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

Properties

Optional apiKey

apiKey?: string

Some APIs allow an API key instead

Optional apiVersion

apiVersion?: string

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

Optional authOptions

authOptions?: AuthOptions

Optional endpoint

endpoint?: string

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

Optional location

location?: string

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

Optional platformType

platformType?: "gai" | "gcp"

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

Theme

On This Page

Generated using TypeDoc