Interface GoogleGenerativeAIEmbeddingsParams

Interface that extends EmbeddingsParams and defines additional parameters specific to the GoogleGenerativeAIEmbeddings class.

interface GoogleGenerativeAIEmbeddingsParams {
    apiKey?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    model?: string;
    modelName?: string;
    onFailedAttempt?: FailedAttemptHandler;
    stripNewLines?: boolean;
    taskType?: TaskType;
    title?: string;
}

Hierarchy

  • EmbeddingsParams
    • GoogleGenerativeAIEmbeddingsParams

Implemented by

Properties

apiKey? maxConcurrency? maxRetries? model? modelName? onFailedAttempt? stripNewLines? taskType? title?

Properties

OptionalapiKey

apiKey?: string

Google API key to use

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.

Optionalmodel

model?: string

Model Name to use

Note: The format must follow the pattern - {model}

OptionalmodelName

modelName?: string

Model Name to use

Alias for model

Note: The format must follow the pattern - {model}

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.

OptionalstripNewLines

stripNewLines?: boolean

Whether to strip new lines from the input text. Default to true

OptionaltaskType

taskType?: TaskType

Type of task for which the embedding will be used

Note: currently only supported by embedding-001 model

Optionaltitle

title?: string

An optional title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT

Note: currently only supported by embedding-001 model

Settings

Member Visibility

On This Page

Properties