Optional
fields: ChatMistralAIInputThe API key to use.
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
frequencyPenalizes 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.
Optional
httpCustom 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 tokens to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length.
The name of the model to use.
Optional
numNumber of completions to return for each request, input tokens are only billed once.
Optional
presenceDetermines 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.
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
Whether to inject a safety prompt before all conversations.
Optional
seedThe seed to use for random sampling. If set, different calls will generate deterministic results.
Optional
serverOverride the default server URL used by the Mistral SDK.
Whether or not to stream the response.
Whether or not to include token usage in the stream.
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.
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.
Optional
kwargs: Partial<CallOptions>Calls the MistralAI API with retry logic in case of failures.
The input to send to the MistralAI API.
The response from the MistralAI API.
Calls the MistralAI API with retry logic in case of failures.
The input to send to the MistralAI API.
The response from the MistralAI API.
Get the parameters used to invoke the model
Optional
options: unknownOptional
config: anyOptional
config: anyStatic
lc_
Mistral AI chat model integration.
Setup: Install
@langchain/mistralai
and set an environment variable namedMISTRAL_API_KEY
.Constructor args
Runtime args
Runtime args can be passed as the second argument to any of the base runnable methods
.invoke
..stream
,.batch
, etc. They can also be passed via.withConfig
, or the second arg in.bindTools
, like shown in the examples below:Examples
Instantiate
Invoking
Streaming Chunks
Aggregate Streamed Chunks
Bind tools
Structured Output
Usage Metadata