Interface MistralAIEmbeddingsParams

Interface for MistralAIEmbeddings parameters. Extends EmbeddingsParams and defines additional parameters specific to the MistralAIEmbeddings class.

interface MistralAIEmbeddingsParams {
    apiKey?: string;
    batchSize?: number;
    beforeRequestHooks?: BeforeRequestHook[];
    encodingFormat?: string;
    endpoint?: string;
    httpClient?: HTTPClient;
    maxConcurrency?: number;
    maxRetries?: number;
    model?: string;
    modelName?: string;
    onFailedAttempt?: FailedAttemptHandler;
    requestErrorHooks?: RequestErrorHook[];
    responseHooks?: ResponseHook[];
    serverURL?: string;
    stripNewLines?: boolean;
}

Hierarchy

  • EmbeddingsParams
    • MistralAIEmbeddingsParams

Implemented by

Properties

apiKey? batchSize? beforeRequestHooks? encodingFormat? endpoint? httpClient? maxConcurrency? maxRetries? model? modelName? onFailedAttempt? requestErrorHooks? responseHooks? serverURL? stripNewLines?

Properties

OptionalapiKey

apiKey?: string

The API key to use.

Default

{process.env.MISTRAL_API_KEY}

OptionalbatchSize

batchSize?: number

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

OptionalencodingFormat

encodingFormat?: string

The format of the output data.

Default

{"float"}

Optionalendpoint

endpoint?: string

Override the default server URL used by the Mistral SDK.

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.

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Optionalmodel

model?: string

The name of the model to use.

Default

{"mistral-embed"}

OptionalmodelName

modelName?: string

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

Default

{"mistral-embed"}

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

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.

OptionalstripNewLines

stripNewLines?: boolean

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

Default

{true}

Settings

Member Visibility

On This Page

Properties