Class FireworksEmbeddings

A class for generating embeddings using the Fireworks AI API.

Hierarchy

  • Embeddings
    • FireworksEmbeddings

Implements

Constructors

constructor

Properties

apiUrl basePath? batchSize caller headers? model modelName

Methods

embedDocuments embedQuery

Constructors

constructor

Properties

apiUrl

apiUrl: string

OptionalbasePath

basePath?: string = "https://api.fireworks.ai/inference/v1"

batchSize

batchSize: number = 8

The maximum number of documents to embed in a single request. This is limited by the Fireworks AI API to a maximum of 8.

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.

Optionalheaders

headers?: Record<string, string>

model

model: string = "nomic-ai/nomic-embed-text-v1.5"

Model name to use.

modelName

modelName: string = "nomic-ai/nomic-embed-text-v1.5"

Deprecated

Use model instead.

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.

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.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods