Class VoyageEmbeddings

A class for generating embeddings using the Voyage AI API.

Hierarchy

Embeddings
- VoyageEmbeddings

Implements

VoyageEmbeddingsParams

Index

Constructors

Properties

apiUrl batchSize modelName basePath? headers?

Methods

embedDocuments embedQuery

Constructors

constructor

new VoyageEmbeddings(fields?): VoyageEmbeddings
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
Overrides Embeddings.constructor
- Defined in docs/api_refs/langchain/src/embeddings/voyage.ts:60

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.

modelName

modelName: string = "voyage-01"

`Optional` basePath

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

`Optional` headers

headers?: Record<string, string>

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.
Overrides Embeddings.embedDocuments
- Defined in docs/api_refs/langchain/src/embeddings/voyage.ts:88

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.
Overrides Embeddings.embedQuery
- Defined in docs/api_refs/langchain/src/embeddings/voyage.ts:118

Generated using TypeDoc