Class GradientEmbeddings

Class for generating embeddings using the Gradient AI's API. Extends the Embeddings class and implements GradientEmbeddingsParams and

Hierarchy

  • Embeddings
    • GradientEmbeddings

Implements

Constructors

constructor

Properties

batchSize caller gradientAccessKey? model workspaceId?

Methods

embedDocuments embedQuery setModel

Constructors

constructor

Properties

batchSize

batchSize: number = 128

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.

OptionalgradientAccessKey

gradientAccessKey?: string

Gradient AI Access Token. Provide Access Token if you do not wish to automatically pull from env.

model

model: any

OptionalworkspaceId

workspaceId?: string

Gradient Workspace Id. Provide workspace id if you do not wish to automatically pull from env.

Methods

embedDocuments

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

  • Method to generate embeddings for an array of documents. Splits the documents into batches and makes requests to the Gradient API to generate embeddings.

    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.

setModel

Settings

Member Visibility

On This Page

Constructors
Properties
Methods