Interface GoogleGenerativeAIEmbeddingsParams

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

Hierarchy

Implemented by

Properties

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

Properties

Optional apiKey

apiKey?: string

Google API key to use

Optional maxConcurrency

maxConcurrency?: number

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

Optional maxRetries

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.

Optional modelName

modelName?: string

Model Name to use

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

Optional onFailedAttempt

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.

Optional stripNewLines

stripNewLines?: boolean

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

Optional taskType

taskType?: TaskType

Type of task for which the embedding will be used

Note: currently only supported by embedding-001 model

Optional title

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

Theme

On This Page

Generated using TypeDoc