Class GradientEmbeddings

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

Hierarchy

Implements

Constructors

constructor

Properties

batchSize caller model gradientAccessKey? 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.

model

model: any

Optional gradientAccessKey

gradientAccessKey?: string

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

Optional workspaceId

workspaceId?: string

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

Methods

embedDocuments

  • 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

  • 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

  • Method to set the model to use for generating embeddings.

    Returns Promise<void>

    Sets

    the class' model value to that of the retrieved Embeddings Model.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc