Class YandexGPTEmbeddings

Class for generating embeddings using the YandexGPT Foundation models API. Extends the Embeddings class and implements YandexGPTEmbeddings

Hierarchy

Implements

Constructors

constructor

Properties

caller model modelVersion apiKey? folderID? iamToken? modelURI?

Methods

embedDocuments embedQuery

Constructors

constructor

Properties

caller

caller: AsyncCaller

The async caller should be used by subclasses to make any async calls, which will thus benefit from the concurrency and retry logic.

model

model: string = "text-search-query"

Model name to use.

modelVersion

modelVersion: string = "latest"

Model version to use.

Optional apiKey

apiKey?: string

Yandex Cloud Api Key for service account with the ai.languageModels.user role.

Optional folderID

folderID?: string

Yandex Cloud Folder ID.

Optional iamToken

iamToken?: string

Yandex Cloud IAM token for service or user account with the ai.languageModels.user role.

Optional modelURI

modelURI?: string

Model URI to use.

Methods

embedDocuments

  • Method to generate embeddings for an array of documents.

    Parameters

    • texts: string[]

      Array of documents to generate embeddings for.

    Returns Promise<number[][]>

    Promise that resolves to a 2D array of embeddings for each document.

embedQuery

  • Method to generate an embedding for a single document. Calls the embedDocuments method with the document as the input.

    Parameters

    • text: string

      Document to generate an embedding for.

    Returns Promise<number[]>

    Promise that resolves to an embedding for the document.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc