Package org.springframework.ai.mistralai

Class MistralAiChatOptions

java.lang.Object

org.springframework.ai.mistralai.MistralAiChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, StructuredOutputChatOptions, ToolCallingChatOptions

public class MistralAiChatOptions
extends Object
implements ToolCallingChatOptions, StructuredOutputChatOptions

Options for the Mistral AI Chat API.

Since:

0.8.1

Author:

Ricken Bazolo, Christian Tzolov, Thomas Vitale, Alexandros Pappas, Jason Smith, Sebastien Deleuze, Nicolas Krier

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	MistralAiChatOptions.AbstractBuilder<B extends MistralAiChatOptions.AbstractBuilder<B>>
static class	MistralAiChatOptions.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MistralAiChatOptions(@Nullable String model, @Nullable Double temperature, @Nullable Double topP, @Nullable Integer maxTokens, @Nullable Boolean safePrompt, @Nullable Integer randomSeed, @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat, @Nullable List<String> stop, @Nullable MistralAiApi.ChatCompletionRequest.ReasoningEffort reasoningEffort, @Nullable Double frequencyPenalty, @Nullable Double presencePenalty, @Nullable Integer n, @Nullable List<MistralAiApi.FunctionTool> tools, @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice, @Nullable List<ToolCallback> toolCallbacks, @Nullable Map<String,Object> toolContext)

Method Summary

Modifier and Type	Method	Description
static MistralAiChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
boolean	equals(@Nullable Object obj)
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
@Nullable Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
@Nullable Integer	getN()
@Nullable String	getOutputSchema()
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
@Nullable Integer	getRandomSeed()
@Nullable MistralAiApi.ChatCompletionRequest.ReasoningEffort	getReasoningEffort()
@Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat	getResponseFormat()
Boolean	getSafePrompt()
@Nullable List<String>	getStop()
@Nullable List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
@Nullable List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
@Nullable MistralAiApi.ChatCompletionRequest.ToolChoice	getToolChoice()
@Nullable Map<String,Object>	getToolContext()	Get the configured tool context.
@Nullable List<MistralAiApi.FunctionTool>	getTools()
@Nullable Integer	getTopK()	Returns the top K to use for the chat.
Double	getTopP()	Returns the top P to use for the chat.
int	hashCode()
MistralAiChatOptions.Builder	mutate()	Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MistralAiChatOptions

protected MistralAiChatOptions(@Nullable String model,
 @Nullable Double temperature,
 @Nullable Double topP,
 @Nullable Integer maxTokens,
 @Nullable Boolean safePrompt,
 @Nullable Integer randomSeed,
 @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat,
 @Nullable List<String> stop,
 @Nullable MistralAiApi.ChatCompletionRequest.ReasoningEffort reasoningEffort,
 @Nullable Double frequencyPenalty,
 @Nullable Double presencePenalty,
 @Nullable Integer n,
 @Nullable List<MistralAiApi.FunctionTool> tools,
 @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice,
 @Nullable List<ToolCallback> toolCallbacks,
 @Nullable Map<String,Object> toolContext)

Method Details

builder

public static MistralAiChatOptions.Builder builder()

Description copied from interface: ToolCallingChatOptions

A builder to create a new ToolCallingChatOptions instance.

Returns:

Returns a new ChatOptions.Builder.

getModel

public String getModel()

Description copied from interface: ChatOptions

Returns the model to use for the chat.

Specified by:

getModel in interface ChatOptions

Returns:

the model to use for the chat

getMaxTokens

public @Nullable Integer getMaxTokens()

Description copied from interface: ChatOptions

Returns the maximum number of tokens to use for the chat.

Specified by:

getMaxTokens in interface ChatOptions

Returns:

the maximum number of tokens to use for the chat

getSafePrompt

public Boolean getSafePrompt()

getRandomSeed

public @Nullable Integer getRandomSeed()

getResponseFormat

public @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat getResponseFormat()

getStopSequences

public @Nullable List<String> getStopSequences()

Description copied from interface: ChatOptions

Returns the stop sequences to use for the chat.

Specified by:

getStopSequences in interface ChatOptions

Returns:

the stop sequences to use for the chat

getStop

public @Nullable List<String> getStop()

getReasoningEffort

public @Nullable MistralAiApi.ChatCompletionRequest.ReasoningEffort getReasoningEffort()

getTools

public @Nullable List<MistralAiApi.FunctionTool> getTools()

getToolChoice

public @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice getToolChoice()

getTemperature

public Double getTemperature()

Description copied from interface: ChatOptions

Returns the temperature to use for the chat.

Specified by:

getTemperature in interface ChatOptions

Returns:

the temperature to use for the chat

getTopP

public Double getTopP()

Description copied from interface: ChatOptions

Returns the top P to use for the chat.

Specified by:

getTopP in interface ChatOptions

Returns:

the top P to use for the chat

getFrequencyPenalty

public Double getFrequencyPenalty()

Description copied from interface: ChatOptions

Returns the frequency penalty to use for the chat.

Specified by:

getFrequencyPenalty in interface ChatOptions

Returns:

the frequency penalty to use for the chat

getPresencePenalty

public Double getPresencePenalty()

Description copied from interface: ChatOptions

Returns the presence penalty to use for the chat.

Specified by:

getPresencePenalty in interface ChatOptions

Returns:

the presence penalty to use for the chat

getN

public @Nullable Integer getN()

getToolCallbacks

public @Nullable List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

getTopK

public @Nullable Integer getTopK()

Description copied from interface: ChatOptions

Returns the top K to use for the chat.

Specified by:

getTopK in interface ChatOptions

Returns:

the top K to use for the chat

getToolContext

public @Nullable Map<String,Object> getToolContext()

Description copied from interface: ToolCallingChatOptions

Get the configured tool context.

Specified by:

getToolContext in interface ToolCallingChatOptions

Returns:

the tool context map.

getOutputSchema

public @Nullable String getOutputSchema()

Specified by:

getOutputSchema in interface StructuredOutputChatOptions

mutate

public MistralAiChatOptions.Builder mutate()

Description copied from interface: ToolCallingChatOptions

Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions. Narrows the return type of ChatOptions.mutate() so generic tool calling code can chain methods without casting.

Specified by:

mutate in interface ChatOptions

Specified by:

mutate in interface StructuredOutputChatOptions

Specified by:

mutate in interface ToolCallingChatOptions

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object