Mistral AI Chat

Spring AI supports the various AI language models from Mistral AI. You can interact with Mistral AI language models and create a multilingual conversational assistant based on Mistral models.spring-doc.cn

Mistral AI offers an OpenAI API-compatible endpoint as well. Check the OpenAI API compatibility section to learn how to use the Spring AI OpenAI integration to talk to a Mistral endpoint.

Prerequisites

You will need to create an API with Mistral AI to access Mistral AI language models. Create an account at Mistral AI registration page and generate the token on the API Keys page. The Spring AI project defines a configuration property named spring.ai.mistralai.api-key that you should set to the value of the API Key obtained from console.mistral.ai. Exporting an environment variable is one way to set that configuration property:spring-doc.cn

export SPRING_AI_MISTRALAI_API_KEY=<INSERT KEY HERE>

Add Repositories and BOM

Spring AI artifacts are published in Spring Milestone and Snapshot repositories. Refer to the Repositories section to add these repositories to your build system.spring-doc.cn

To help with dependency management, Spring AI provides a BOM (bill of materials) to ensure that a consistent version of Spring AI is used throughout the entire project. Refer to the Dependency Management section to add the Spring AI BOM to your build system.spring-doc.cn

Auto-configuration

Spring AI provides Spring Boot auto-configuration for the Mistral AI Chat Client. To enable it add the following dependency to your project’s Maven pom.xml file:spring-doc.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mistral-ai-spring-boot-starter</artifactId>
</dependency>

or to your Gradle build.gradle build file.spring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-mistral-ai-spring-boot-starter'
}
Refer to the Dependency Management section to add the Spring AI BOM to your build file.

Chat Properties

Retry Properties

The prefix spring.ai.retry is used as the property prefix that lets you configure the retry mechanism for the Mistral AI chat model.spring-doc.cn

Property Description Default

spring.ai.retry.max-attemptsspring-doc.cn

Maximum number of retry attempts.spring-doc.cn

10spring-doc.cn

spring.ai.retry.backoff.initial-intervalspring-doc.cn

Initial sleep duration for the exponential backoff policy.spring-doc.cn

2 sec.spring-doc.cn

spring.ai.retry.backoff.multiplierspring-doc.cn

Backoff interval multiplier.spring-doc.cn

5spring-doc.cn

spring.ai.retry.backoff.max-intervalspring-doc.cn

Maximum backoff duration.spring-doc.cn

3 min.spring-doc.cn

spring.ai.retry.on-client-errorsspring-doc.cn

If false, throw a NonTransientAiException, and do not attempt retry for 4xx client error codesspring-doc.cn

falsespring-doc.cn

spring.ai.retry.exclude-on-http-codesspring-doc.cn

List of HTTP status codes that should not trigger a retry (e.g. to throw NonTransientAiException).spring-doc.cn

emptyspring-doc.cn

spring.ai.retry.on-http-codesspring-doc.cn

List of HTTP status codes that should trigger a retry (e.g. to throw TransientAiException).spring-doc.cn

emptyspring-doc.cn

Connection Properties

The prefix spring.ai.mistralai is used as the property prefix that lets you connect to OpenAI.spring-doc.cn

Property Description Default

spring.ai.mistralai.base-urlspring-doc.cn

The URL to connect tospring-doc.cn

api.mistral.aispring-doc.cn

spring.ai.mistralai.api-keyspring-doc.cn

The API Keyspring-doc.cn

-spring-doc.cn

Configuration Properties

The prefix spring.ai.mistralai.chat is the property prefix that lets you configure the chat model implementation for Mistral AI.spring-doc.cn

Property Description Default

spring.ai.mistralai.chat.enabledspring-doc.cn

Enable Mistral AI chat model.spring-doc.cn

truespring-doc.cn

spring.ai.mistralai.chat.base-urlspring-doc.cn

Optional override for the spring.ai.mistralai.base-url property to provide chat-specific URL.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.api-keyspring-doc.cn

Optional override for the spring.ai.mistralai.api-key to provide chat-specific API Key.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.modelspring-doc.cn

This is the Mistral AI Chat model to usespring-doc.cn

open-mistral-7b, open-mixtral-8x7b, open-mixtral-8x22b, mistral-small-latest, mistral-large-latestspring-doc.cn

spring.ai.mistralai.chat.options.temperaturespring-doc.cn

The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict.spring-doc.cn

0.8spring-doc.cn

spring.ai.mistralai.chat.options.maxTokensspring-doc.cn

The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model’s context length.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.safePromptspring-doc.cn

Indicates whether to inject a security prompt before all conversations.spring-doc.cn

falsespring-doc.cn

spring.ai.mistralai.chat.options.randomSeedspring-doc.cn

This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.stopspring-doc.cn

Stop generation if this token is detected. Or if one of these tokens is detected when providing an array.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.topPspring-doc.cn

An alternative to sampling with temperature, called 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. We generally recommend altering this or temperature but not both.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.responseFormatspring-doc.cn

An object specifying the format that the model must output. Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.toolsspring-doc.cn

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.toolChoicespring-doc.cn

Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function. Specifying a particular function via {"type: "function", "function": {"name": "my_function"}} forces the model to call that function. none is the default when no functions are present. auto is the default if functions are present.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.functionsspring-doc.cn

List of functions, identified by their names, to enable for function calling in a single prompt requests. Functions with those names must exist in the functionCallbacks registry.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.functionCallbacksspring-doc.cn

Mistral AI Tool Function Callbacks to register with the ChatModel.spring-doc.cn

-spring-doc.cn

spring.ai.mistralai.chat.options.proxy-tool-callsspring-doc.cn

If true, the Spring AI will not handle the function calls internally, but will proxy them to the client. Then is the client’s responsibility to handle the function calls, dispatch them to the appropriate function, and return the results. If false (the default), the Spring AI will handle the function calls internally. Applicable only for chat models with function calling supportspring-doc.cn

falsespring-doc.cn
You can override the common spring.ai.mistralai.base-url and spring.ai.mistralai.api-key for the ChatModel and EmbeddingModel implementations. The spring.ai.mistralai.chat.base-url and spring.ai.mistralai.chat.api-key properties, if set, take precedence over the common properties. This is useful if you want to use different Mistral AI accounts for different models and different model endpoints.
All properties prefixed with spring.ai.mistralai.chat.options can be overridden at runtime by adding request-specific Runtime Options to the Prompt call.

Runtime Options

The MistralAiChatOptions.java provides model configurations, such as the model to use, the temperature, the frequency penalty, etc.spring-doc.cn

On start-up, the default options can be configured with the MistralAiChatModel(api, options) constructor or the spring.ai.mistralai.chat.options.* properties.spring-doc.cn

At run-time, you can override the default options by adding new, request-specific options to the Prompt call. For example, to override the default model and temperature for a specific request:spring-doc.cn

ChatResponse response = chatModel.call(
    new Prompt(
        "Generate the names of 5 famous pirates.",
        MistralAiChatOptions.builder()
            .withModel(MistralAiApi.ChatModel.LARGE.getValue())
            .withTemperature(0.5)
        .build()
    ));
In addition to the model specific MistralAiChatOptions you can use a portable ChatOptions instance, created with ChatOptionsBuilder#builder().

Function Calling

You can register custom Java functions with the MistralAiChatModel and have the Mistral AI model intelligently choose to output a JSON object containing arguments to call one or many of the registered functions. This is a powerful technique to connect the LLM capabilities with external tools and APIs. Read more about Mistral AI Function Calling.spring-doc.cn

OpenAI API Compatibility

Mistral is OpenAI API-compatible and you can use the Spring AI OpenAI client to talk to Mistrial. For this, you need to configure the OpenAI base URL to the Mistral AI platform: spring.ai.openai.chat.base-url=https://api.mistral.ai, and select a Mistral model: spring.ai.openai.chat.options.model=mistral-small-latest and set the Mistral AI API key: spring.ai.openai.chat.api-key=<YOUR MISTRAL API KEY.spring-doc.cn

Check the MistralWithOpenAiChatModelIT.java tests for examples of using Mistral over Spring AI OpenAI.spring-doc.cn

Sample Controller (Auto-configuration)

Create a new Spring Boot project and add the spring-ai-mistral-ai-spring-boot-starter to your pom (or gradle) dependencies.spring-doc.cn

Add a application.properties file under the src/main/resources directory to enable and configure the Mistral AI chat model:spring-doc.cn

spring.ai.mistralai.api-key=YOUR_API_KEY
spring.ai.mistralai.chat.options.model=mistral-small
spring.ai.mistralai.chat.options.temperature=0.7
Replace the api-key with your Mistral AI credentials.

This will create a MistralAiChatModel implementation that you can inject into your classes. Here is an example of a simple @RestController class that uses the chat model for text generations.spring-doc.cn

@RestController
public class ChatController {

    private final MistralAiChatModel chatModel;

    @Autowired
    public ChatController(MistralAiChatModel chatModel) {
        this.chatModel = chatModel;
    }

    @GetMapping("/ai/generate")
    public Map<String,String> generate(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        return Map.of("generation", this.chatModel.call(message));
    }

    @GetMapping("/ai/generateStream")
	public Flux<ChatResponse> generateStream(@RequestParam(value = "message", defaultValue = "Tell me a joke") String message) {
        var prompt = new Prompt(new UserMessage(message));
        return this.chatModel.stream(prompt);
    }
}

Manual Configuration

The MistralAiChatModel implements the ChatModel and StreamingChatModel and uses the Low-level MistralAiApi Client to connect to the Mistral AI service.spring-doc.cn

Add the spring-ai-mistral-ai dependency to your project’s Maven pom.xml file:spring-doc.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-mistral-ai</artifactId>
</dependency>

or to your Gradle build.gradle build file.spring-doc.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-mistral-ai'
}
Refer to the Dependency Management section to add the Spring AI BOM to your build file.

Next, create a MistralAiChatModel and use it for text generations:spring-doc.cn

var mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));

var chatModel = new MistralAiChatModel(this.mistralAiApi, MistralAiChatOptions.builder()
                .withModel(MistralAiApi.ChatModel.LARGE.getValue())
                .withTemperature(0.4)
                .withMaxTokens(200)
                .build());

ChatResponse response = this.chatModel.call(
    new Prompt("Generate the names of 5 famous pirates."));

// Or with streaming responses
Flux<ChatResponse> response = this.chatModel.stream(
    new Prompt("Generate the names of 5 famous pirates."));

The MistralAiChatOptions provides the configuration information for the chat requests. The MistralAiChatOptions.Builder is a fluent options-builder.spring-doc.cn

Low-level MistralAiApi Client

The MistralAiApi provides is lightweight Java client for Mistral AI API.spring-doc.cn

Here is a simple snippet showing how to use the API programmatically:spring-doc.cn

MistralAiApi mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));

ChatCompletionMessage chatCompletionMessage =
    new ChatCompletionMessage("Hello world", Role.USER);

// Sync request
ResponseEntity<ChatCompletion> response = this.mistralAiApi.chatCompletionEntity(
    new ChatCompletionRequest(List.of(this.chatCompletionMessage), MistralAiApi.ChatModel.LARGE.getValue(), 0.8, false));

// Streaming request
Flux<ChatCompletionChunk> streamResponse = this.mistralAiApi.chatCompletionStream(
        new ChatCompletionRequest(List.of(this.chatCompletionMessage), MistralAiApi.ChatModel.LARGE.getValue(), 0.8, true));

Follow the MistralAiApi.java's JavaDoc for further information.spring-doc.cn

MistralAiApi Samples