Optional
apiOptional
batchBatch size to use when passing multiple documents to generate
Optional
beforeA list of custom hooks that must follow (req: Request) => Awaitable<Request | void> They are automatically added when a ChatMistralAI instance is created
Optional
cacheOptional
callbackOptional
callbacksOptional
concurrencyOptional
endpointOverride the default server URL used by the Mistral SDK.
Optional
httpOptional custom HTTP client to manage API requests Allows users to add custom fetch implementations, hooks, as well as error and response processing.
Optional
maxThe maximum number of concurrent calls that can be made.
Defaults to Infinity
, which means no limit.
Optional
maxThe maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.
Optional
maxThe maximum number of tokens to generate in the completion. The token count of your prompt plus maxTokens cannot exceed the model's context length.
Optional
metadataOptional
modelThe name of the model to use.
Optional
onCustom 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.
Optional
randomThe seed to use for random sampling. If set, different calls will generate deterministic results.
Alias for seed
Optional
requestA list of custom hooks that must follow (err: unknown, req: Request) => Awaitable
Optional
responseA list of custom hooks that must follow (res: Response, req: Request) => Awaitable
Optional
serverURLOverride the default server URL used by the Mistral SDK.
Optional
streamingWhether or not to stream the response.
Optional
tagsOptional
temperatureWhat 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.
Optional
topPNucleus 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.
Optional
verbose
The API key to use.