Skip to content

Commit 5206b85

Browse files
ricken07tzolov
authored andcommitted
update mistralai-chat doc
1 parent b58ef6d commit 5206b85

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/clients/mistralai-chat.adoc

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,18 @@ The prefix `spring.ai.mistralai.chat` is the property prefix that lets you confi
6868
| spring.ai.mistralai.chat.enabled | Enable MistralAI chat client. | true
6969
| spring.ai.mistralai.chat.base-url | Optional overrides the spring.ai.mistralai.base-url to provide chat specific url | -
7070
| spring.ai.mistralai.chat.api-key | Optional overrides the spring.ai.mistralai.api-key to provide chat specific api-key | -
71-
| spring.ai.mistralai.chat.options.model | This is the MistralAI Chat model to use | `mistral-tiny` (the `gpt-3.5-turbo`, `gpt-4`, and `gpt-4-32k` point to the latest model versions)
71+
| spring.ai.mistralai.chat.options.model | This is the MistralAI Chat model to use | `open-mistral-7b`, `open-mixtral-8x7b`, `mistral-small-latest`, `mistral-medium-latest`, `mistral-large-latest`
7272
| spring.ai.mistralai.chat.options.temperature | 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. | 0.8
7373
| spring.ai.mistralai.chat.options.maxTokens | 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. | -
7474
| spring.ai.mistralai.chat.options.safePrompt | Indicates whether to inject a security prompt before all conversations. | false
7575
| spring.ai.mistralai.chat.options.randomSeed | 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. | -
7676
| spring.ai.mistralai.chat.options.stop | Up to 4 sequences where the API will stop generating further tokens. | -
7777
| spring.ai.mistralai.chat.options.topP | 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. | -
78+
| spring.ai.mistralai.chat.options.responseFormat | 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.| -
79+
| spring.ai.mistralai.chat.options.tools | 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. | -
80+
| spring.ai.mistralai.chat.options.toolChoice | 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. | -
81+
| spring.ai.mistralai.chat.options.functions | 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. | -
82+
| spring.ai.mistralai.chat.options.functionCallbacks | MistralAI Tool Function Callbacks to register with the ChatClient. | -
7883
|====
7984

8085
NOTE: You can override the common `spring.ai.mistralai.base-url` and `spring.ai.mistralai.api-key` for the `ChatClient` and `EmbeddingClient` implementations.
@@ -98,7 +103,7 @@ ChatResponse response = chatClient.call(
98103
new Prompt(
99104
"Generate the names of 5 famous pirates.",
100105
MistralAiChatOptions.builder()
101-
.withModel("mistral-medium")
106+
.withModel(MistralAiApi.ChatModel.LARGE.getValue())
102107
.withTemperature(0.5f)
103108
.build()
104109
));
@@ -181,7 +186,7 @@ Next, create a `MistralAiChatClient` and use it for text generations:
181186
var mistralAiApi = new MistralAiApi(System.getenv("MISTRAL_AI_API_KEY"));
182187
183188
var chatClient = new MistralAiChatClient(mistralAiApi, MistralAiChatOptions.builder()
184-
.withModel("mistral-small")
189+
.withModel(MistralAiApi.ChatModel.LARGE.getValue())
185190
.withTemperature(0.4f)
186191
.withMaxToken(200)
187192
.build());
@@ -213,15 +218,18 @@ ChatCompletionMessage chatCompletionMessage =
213218
214219
// Sync request
215220
ResponseEntity<ChatCompletion> response = mistralAiApi.chatCompletionEntity(
216-
new ChatCompletionRequest(List.of(chatCompletionMessage), "mistral-small", 0.8f, false));
221+
new ChatCompletionRequest(List.of(chatCompletionMessage), MistralAiApi.ChatModel.LARGE.getValue(), 0.8f, false));
217222
218223
// Streaming request
219224
Flux<ChatCompletionChunk> streamResponse = mistralAiApi.chatCompletionStream(
220-
new ChatCompletionRequest(List.of(chatCompletionMessage), "mistral-small", 0.8f, true));
225+
new ChatCompletionRequest(List.of(chatCompletionMessage), MistralAiApi.ChatModel.LARGE.getValue(), 0.8f, true));
221226
----
222227

223228
Follow the https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-mistral-ai/src/main/java/org/springframework/ai/mistralai/api/MistralAiApi.java[MistralAiApi.java]'s JavaDoc for further information.
224229

225230
==== MistralAiApi Samples
226-
The link:https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-mistral-ai/src/test/java/org/springframework/ai/mistralai/api/MistralAiApiIT.java[MistralAiApiIT.java] test provides some general examples how to use the lightweight library.
231+
* The link:https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-mistral-ai/src/test/java/org/springframework/ai/mistralai/api/MistralAiApiIT.java[MistralAiApiIT.java] test provides some general examples how to use the lightweight library.
227232

233+
* The link:https://github.com/spring-projects/spring-ai/blob/main/models/spring-ai-mistral-ai/src/test/java/org/springframework/ai/mistralai/api/tool/
234+
MistralAiApiToolFunctionCallIT.java[MistralAiApiToolFunctionCallIT.java] test shows how to use the low-level API to call tool functions.
235+
Based on the link:https://docs.mistral.ai/guides/function-calling/[MistralAI Function Calling] tutorial.

0 commit comments

Comments
 (0)