Class VoyageEmbeddings

A class for generating embeddings using the Voyage AI API.

Hierarchy

  • Embeddings
    • VoyageEmbeddings

Implements

Constructors

constructor

Properties

apiUrl basePath? batchSize caller encodingFormat? headers? inputType? modelName outputDimension? outputDtype? truncation?

Methods

embedDocuments embedQuery

Constructors

constructor

Properties

apiUrl

apiUrl: string

OptionalbasePath

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

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.

OptionalencodingFormat

encodingFormat?: string

The format of the output embeddings. Can be "float", "base64", or "ubinary".

Optionalheaders

headers?: Record<string, string>

OptionalinputType

inputType?: string

Input type for the embeddings request.

modelName

modelName: string = "voyage-01"

OptionaloutputDimension

outputDimension?: number

The desired dimension of the output embeddings.

OptionaloutputDtype

outputDtype?: string

The data type of the output embeddings. Can be "float" or "int8".

Optionaltruncation

truncation?: boolean

Whether to truncate the input texts to the maximum length allowed by the model.

Methods

embedDocuments

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

  • 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

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

  • 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

On This Page

Constructors
Properties
Methods