Class MistralAIEmbeddings

Class for generating embeddings using the MistralAI API.

Hierarchy

  • Embeddings
    • MistralAIEmbeddings

Implements

Constructors

constructor

Properties

apiKey batchSize beforeRequestHooks? caller encodingFormat endpoint httpClient? model modelName requestErrorHooks? responseHooks? serverURL? stripNewLines

Methods

addAllHooksToHttpClient embedDocuments embedQuery removeAllHooksFromHttpClient removeHookFromHttpClient

Constructors

constructor

Properties

apiKey

apiKey: string

The API key to use.

Default

{process.env.MISTRAL_API_KEY}

batchSize

batchSize: number = 512

The maximum number of documents to embed in a single request.

Default

{512}

OptionalbeforeRequestHooks

beforeRequestHooks?: BeforeRequestHook[]

A list of custom hooks that must follow (req: Request) => Awaitable<Request | void> They are automatically added when a ChatMistralAI instance is created

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.

encodingFormat

encodingFormat: string = "float"

The format of the output data.

Default

{"float"}

endpoint

endpoint: string

Deprecated

use serverURL instead

OptionalhttpClient

httpClient?: HTTPClient

Optional custom HTTP client to manage API requests Allows users to add custom fetch implementations, hooks, as well as error and response processing.

model

model: string = "mistral-embed"

The name of the model to use.

Default

{"mistral-embed"}

modelName

modelName: string = "mistral-embed"

The name of the model to use. Alias for model.

Default

{"mistral-embed"}

OptionalrequestErrorHooks

requestErrorHooks?: RequestErrorHook[]

A list of custom hooks that must follow (err: unknown, req: Request) => Awaitable They are automatically added when a ChatMistralAI instance is created

OptionalresponseHooks

responseHooks?: ResponseHook[]

A list of custom hooks that must follow (res: Response, req: Request) => Awaitable They are automatically added when a ChatMistralAI instance is created

OptionalserverURL

serverURL?: string

Override the default server URL used by the Mistral SDK.

stripNewLines

stripNewLines: boolean = true

Whether to strip new lines from the input text. This is recommended, but may not be suitable for all use cases.

Default

{true}

Methods

addAllHooksToHttpClient

embedDocuments

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

  • Method to generate embeddings for an array of documents. Splits the documents into batches and makes requests to the MistralAI 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 embeddingWithRetry 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.

removeAllHooksFromHttpClient

removeHookFromHttpClient

Settings

Member Visibility

On This Page

Constructors
Properties
Methods