Interface MistralAIEmbeddingsParams

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

Hierarchy

Implemented by

Properties

apiKey? batchSize? encodingFormat? endpoint? maxConcurrency? maxRetries? modelName? onFailedAttempt? stripNewLines?

Properties

Optional apiKey

apiKey?: string

The API key to use.

Default

{process.env.MISTRAL_API_KEY}

Optional batchSize

batchSize?: number

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

Default

{512}

Optional encodingFormat

encodingFormat?: string

The format of the output data.

Default

{"float"}

Optional endpoint

endpoint?: string

Override the default endpoint.

Optional maxConcurrency

maxConcurrency?: number

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

Optional maxRetries

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.

Optional modelName

modelName?: string

The name of the model to use.

Default

{"mistral-embed"}

Optional onFailedAttempt

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.

Optional stripNewLines

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

Theme

On This Page

Generated using TypeDoc