langchain.js
    Preparing search index...

    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;
        model?: string;
        modelName?: string;
        requestErrorHooks?: RequestErrorHook[];
        responseHooks?: ResponseHook[];
        serverURL?: string;
        stripNewLines?: boolean;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

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

    Properties

    apiKey?: string

    The API key to use.

    {process.env.MISTRAL_API_KEY}
    batchSize?: number

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

    {512}
    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

    encodingFormat?: string

    The format of the output data.

    {"float"}
    endpoint?: string

    Override the default server URL used by the Mistral SDK.

    use serverURL instead

    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?: string

    The name of the model to use.

    {"mistral-embed"}
    modelName?: string

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

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

    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

    serverURL?: string

    Override the default server URL used by the Mistral SDK.

    stripNewLines?: boolean

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

    {true}

    Settings

    Member Visibility

    On This Page

    Properties