Class YandexGPTEmbeddings

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

Hierarchy

  • Embeddings
    • YandexGPTEmbeddings

Implements

Constructors

constructor

Properties

apiKey? caller folderID? iamToken? model modelURI? modelVersion

Methods

embedDocuments embedQuery

Constructors

constructor

Properties

OptionalapiKey

apiKey?: string

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

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.

OptionalfolderID

folderID?: string

Yandex Cloud Folder ID.

OptionaliamToken

iamToken?: string

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

model

model: string = "text-search-query"

Model name to use.

OptionalmodelURI

modelURI?: string

Model URI to use.

modelVersion

modelVersion: string = "latest"

Model version to use.

Methods

embedDocuments

  • embedDocuments(texts): Promise<number[][]>

  • 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

  • embedQuery(text): Promise<number[]>

  • 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

On This Page

Constructors
Properties
Methods