Interface MistralAIEmbeddingsParams

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

Hierarchy

Implemented by

Properties

apiKey?: string

The API key to use.

Default

{process.env.MISTRAL_API_KEY}
batchSize?: number

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

Default

{512}
encodingFormat?: string

The format of the output data.

Default

{"float"}
endpoint?: string

Override the default endpoint.

maxConcurrency?: number

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

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.

modelName?: string

The name of the model to use.

Default

{"mistral-embed"}
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.

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}

Generated using TypeDoc