Interface MistralAIEmbeddingsParams

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

interface MistralAIEmbeddingsParams {
    apiKey?: string;
    batchSize?: number;
    encodingFormat?: string;
    endpoint?: string;
    model?: string;
    modelName?: string;
    stripNewLines?: boolean;
}

Hierarchy

  • EmbeddingsParams
    • MistralAIEmbeddingsParams

Implemented by

Properties

apiKey? batchSize? encodingFormat? endpoint? model? modelName? 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 model

model?: string

The name of the model to use.

Default

{"mistral-embed"}

Optional modelName

modelName?: string

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

Default

{"mistral-embed"}

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