Class GradientEmbeddings

constructor

• new GradientEmbeddings(fields): GradientEmbeddings

• Parameters

  • fields: GradientEmbeddingsParams

  Returns GradientEmbeddings

batchSize

model

Optional gradientAccessKey

Optional workspaceId

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

• setModel(): Promise<void>

• 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.