Interface GoogleGenerativeAIEmbeddingsParams

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

interface GoogleGenerativeAIEmbeddingsParams {
    apiKey?: string;
    modelName?: string;
    stripNewLines?: boolean;
    taskType?: TASK_TYPE_UNSPECIFIED | RETRIEVAL_QUERY | RETRIEVAL_DOCUMENT | SEMANTIC_SIMILARITY | CLASSIFICATION | CLUSTERING;
    title?: string;
}

Hierarchy (view full)

  • Toolkit
    • GoogleGenerativeAIEmbeddingsParams

Implemented by

Properties

apiKey? modelName? stripNewLines? taskType? title?

Properties

Optional apiKey

apiKey?: string

Google API key to use

Optional modelName

modelName?: string

Model Name to use

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

Optional stripNewLines

stripNewLines?: boolean

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

Optional taskType

taskType?: TASK_TYPE_UNSPECIFIED | RETRIEVAL_QUERY | RETRIEVAL_DOCUMENT | SEMANTIC_SIMILARITY | CLASSIFICATION | CLUSTERING

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