langchain.js
    Preparing search index...

    Interface MistralAIInput

    interface MistralAIInput {
        apiKey?: string;
        batchSize?: number;
        beforeRequestHooks?: BeforeRequestHook[];
        endpoint?: string;
        httpClient?: HTTPClient;
        maxTokens?: number;
        model?: string;
        randomSeed?: number;
        requestErrorHooks?: RequestErrorHook[];
        responseHooks?: ResponseHook[];
        serverURL?: string;
        streaming?: boolean;
        temperature?: number;
        topP?: number;
        useFim?: boolean;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    apiKey? batchSize? beforeRequestHooks? endpoint? httpClient? maxTokens? model? randomSeed? requestErrorHooks? responseHooks? serverURL? streaming? temperature? topP? useFim?

    Properties

    apiKey?: string

    The API key to use.

    {process.env.MISTRAL_API_KEY}
    batchSize?: number

    Batch size to use when passing multiple documents to generate

    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

    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.

    maxTokens?: number

    The maximum number of tokens to generate in the completion. The token count of your prompt plus maxTokens cannot exceed the model's context length.

    model?: string

    The name of the model to use.

    "codestral-latest"
    randomSeed?: number

    The seed to use for random sampling. If set, different calls will generate deterministic results. Alias for seed

    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.

    streaming?: boolean

    Whether or not to stream the response.

    {false}
    temperature?: number

    What sampling temperature to use, between 0.0 and 2.0. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

    {0.7}
    topP?: number

    Nucleus sampling, where the model considers the results of the tokens with topP probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. Should be between 0 and 1.

    {1}
    useFim?: boolean

    Whether to use the Fill-In-Middle (FIM) API for code completion. When true, uses client.fim.complete() / client.fim.stream(). When false, uses client.chat.complete() / client.chat.stream() with the prompt wrapped as a user message.

    FIM is only supported for code models like codestral-latest. For general-purpose models like mistral-large-latest, set this to false.

    true for codestral models, false for other models

    Settings

    Member Visibility

    On This Page

    Properties