Class VoyageEmbeddings

A class for generating embeddings using the Voyage AI API.

Hierarchy

Implements

Constructors

constructor

Properties

apiUrl batchSize caller modelName basePath? headers?

Methods

embedDocuments embedQuery

Constructors

constructor

  • Constructor for the VoyageEmbeddings class.

    Parameters

    • Optional fields: Partial<VoyageEmbeddingsParams> & {
          apiKey?: string;
          verbose?: boolean;
      }

      An optional object with properties to configure the instance.

    Returns VoyageEmbeddings

Properties

apiUrl

apiUrl: string

batchSize

batchSize: number = 8

The maximum number of documents to embed in a single request. This is limited by the Voyage AI API to a maximum of 8.

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.

modelName

modelName: string = "voyage-01"

Optional basePath

basePath?: string = "https://api.voyageai.com/v1"

Optional headers

headers?: Record<string, string>

Methods

embedDocuments

  • Generates embeddings for an array of texts.

    Parameters

    • texts: string[]

      An array of strings to generate embeddings for.

    Returns Promise<number[][]>

    A Promise that resolves to an array of embeddings.

embedQuery

  • Generates an embedding for a single text.

    Parameters

    • text: string

      A string to generate an embedding for.

    Returns Promise<number[]>

    A Promise that resolves to an array of numbers representing the embedding.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc