Class PremEmbeddings

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

Hierarchy

  • Embeddings
    • PremEmbeddings

Implements

Constructors

constructor

Properties

batchSize client model project_id apiKey? encoding_format?

Methods

embedDocuments embedQuery

Constructors

constructor

Properties

batchSize

batchSize: number = 128

client

client: Prem

model

model: string

The model to generate the embeddings.

project_id

project_id: number

The ID of the project to use.

Optional apiKey

apiKey?: string

The Prem API key to use for requests.

Default

process.env.PREM_API_KEY

Optional encoding_format

encoding_format?: "base64" | "float"

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc