Interface ChatMistralAIInput

Input to chat model class.

interface ChatMistralAIInput {
    apiKey?: string;
    beforeRequestHooks?: BeforeRequestHook[];
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    disableStreaming?: boolean;
    endpoint?: string;
    frequencyPenalty?: number;
    httpClient?: HTTPClient;
    maxConcurrency?: number;
    maxRetries?: number;
    maxTokens?: number;
    metadata?: Record<string, unknown>;
    model?: string;
    modelName?: string;
    numCompletions?: number;
    onFailedAttempt?: FailedAttemptHandler;
    presencePenalty?: number;
    randomSeed?: number;
    requestErrorHooks?: RequestErrorHook[];
    responseHooks?: ResponseHook[];
    safeMode?: boolean;
    safePrompt?: boolean;
    seed?: number;
    serverURL?: string;
    streamUsage?: boolean;
    streaming?: boolean;
    tags?: string[];
    temperature?: number;
    topP?: number;
    verbose?: boolean;
}

Hierarchy

Implemented by

Properties

apiKey? beforeRequestHooks? cache? callbackManager? callbacks? disableStreaming? endpoint? frequencyPenalty? httpClient? maxConcurrency? maxRetries? maxTokens? metadata? model? modelName? numCompletions? onFailedAttempt? presencePenalty? randomSeed? requestErrorHooks? responseHooks? safeMode? safePrompt? seed? serverURL? streamUsage? streaming? tags? temperature? topP? verbose?

Properties

OptionalapiKey

apiKey?: string

The API key to use.

Default

{process.env.MISTRAL_API_KEY}

OptionalbeforeRequestHooks

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.

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

OptionaldisableStreaming

disableStreaming?: boolean

Whether to disable streaming.

If streaming is bypassed, then stream() will defer to invoke().

  • If true, will always bypass streaming case.
  • If false (default), will always use streaming case if available.

Optionalendpoint

endpoint?: string

Override the default server URL used by the Mistral SDK.

Deprecated

use serverURL instead

OptionalfrequencyPenalty

frequencyPenalty?: number

Penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.

OptionalhttpClient

httpClient?: HTTPClient

Custom HTTP client to manage API requests. Allows users to add custom fetch implementations, hooks, as well as error and response processing.

OptionalmaxConcurrency

maxConcurrency?: number

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

OptionalmaxRetries

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.

OptionalmaxTokens

maxTokens?: number

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

Optionalmetadata

metadata?: Record<string, unknown>

Optionalmodel

model?: string

The name of the model to use.

Default

{"mistral-small-latest"}

OptionalmodelName

modelName?: string

The name of the model to use. Alias for model

Deprecated

Use model instead.

Default

{"mistral-small-latest"}

OptionalnumCompletions

numCompletions?: number

Number of completions to return for each request, input tokens are only billed once.

OptionalonFailedAttempt

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.

OptionalpresencePenalty

presencePenalty?: number

Determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.

OptionalrandomSeed

randomSeed?: number

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

OptionalrequestErrorHooks

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.

OptionalresponseHooks

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.

OptionalsafeMode

safeMode?: boolean

Whether to inject a safety prompt before all conversations.

Default

{false}

Deprecated

use safePrompt instead

OptionalsafePrompt

safePrompt?: boolean

Whether to inject a safety prompt before all conversations.

Default

{false}

Optionalseed

seed?: number

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

OptionalserverURL

serverURL?: string

Override the default server URL used by the Mistral SDK.

OptionalstreamUsage

streamUsage?: boolean

Whether or not to include token usage in the stream.

Default

{true}

Optionalstreaming

streaming?: boolean

Whether or not to stream the response.

Default

{false}

Optionaltags

tags?: string[]

Optionaltemperature

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.

Default

{0.7}

OptionaltopP

topP?: number

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

Default

{1}

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties