Interface GoogleGenerativeAIEmbeddingsParams

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

interface GoogleGenerativeAIEmbeddingsParams {
    apiKey?: string;
    model?: string;
    modelName?: string;
    stripNewLines?: boolean;
    taskType?: TaskType;
    title?: string;
}

Hierarchy (view full)

  • Toolkit
    • GoogleGenerativeAIEmbeddingsParams

Implemented by

Properties

apiKey? model? modelName? stripNewLines? taskType? title?

Properties

OptionalapiKey

apiKey?: string

Google API key to use

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}

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