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

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Modifier	Constructor	Description
	MistralAiChatOptions()
protected	MistralAiChatOptions(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 Double frequencyPenalty, @Nullable Double presencePenalty, @Nullable Integer n, @Nullable List<MistralAiApi.FunctionTool> tools, @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice, @Nullable List<ToolCallback> toolCallbacks, @Nullable Set<String> toolNames, @Nullable Boolean internalToolExecutionEnabled, @Nullable Map<String,Object> toolContext)

Method Summary

Modifier and Type	Method	Description
static MistralAiChatOptions.Builder	builder()
MistralAiChatOptions	copy()	Returns a copy of this ChatOptions.
boolean	equals(Object obj)
static MistralAiChatOptions	fromOptions(MistralAiChatOptions fromOptions)
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
@Nullable Boolean	getInternalToolExecutionEnabled()	Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
@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.ResponseFormat	getResponseFormat()
Boolean	getSafePrompt()
@Nullable List<String>	getStop()
@Nullable List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
@Nullable Double	getTemperature()	Returns the temperature to use for the chat.
List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
@Nullable MistralAiApi.ChatCompletionRequest.ToolChoice	getToolChoice()
Map<String,Object>	getToolContext()	Get the configured tool context.
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
@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 ChatOptions.Builder initialized with the values of this ChatOptions.
void	setFrequencyPenalty(Double frequencyPenalty)
void	setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled)	Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.
void	setMaxTokens(@Nullable Integer maxTokens)
void	setModel(String model)
void	setN(@Nullable Integer n)
void	setOutputSchema(String outputSchema)
void	setPresencePenalty(Double presencePenalty)
void	setRandomSeed(@Nullable Integer randomSeed)
void	setResponseFormat(@Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat)
void	setSafePrompt(Boolean safePrompt)
void	setStop(@Nullable List<String> stop)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(@Nullable Double temperature)
void	setToolCallbacks(List<ToolCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolChoice(@Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)
void	setToolContext(Map<String,Object> toolContext)	Set the tool context values as map.
void	setToolNames(Set<String> toolNames)	Set the names of the tools to register with the ChatModel.
void	setTools(@Nullable List<MistralAiApi.FunctionTool> tools)
void	setTopP(Double topP)

Methods inherited from class java.lang.Object

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

Constructor Details

MistralAiChatOptions

public MistralAiChatOptions()

MistralAiChatOptions

protected MistralAiChatOptions(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 Double frequencyPenalty,
 @Nullable Double presencePenalty,
 @Nullable Integer n,
 @Nullable List<MistralAiApi.FunctionTool> tools,
 @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice,
 @Nullable List<ToolCallback> toolCallbacks,
 @Nullable Set<String> toolNames,
 @Nullable Boolean internalToolExecutionEnabled,
 @Nullable Map<String,Object> toolContext)

Method Details

builder

public static MistralAiChatOptions.Builder builder()

fromOptions

public static MistralAiChatOptions fromOptions(MistralAiChatOptions fromOptions)

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

setModel

public void setModel(String model)

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

setMaxTokens

public void setMaxTokens(@Nullable Integer maxTokens)

getSafePrompt

public Boolean getSafePrompt()

setSafePrompt

public void setSafePrompt(Boolean safePrompt)

getRandomSeed

public @Nullable Integer getRandomSeed()

setRandomSeed

public void setRandomSeed(@Nullable Integer randomSeed)

getResponseFormat

public @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat getResponseFormat()

setResponseFormat

public void setResponseFormat(@Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat)

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

setStopSequences

public void setStopSequences(List<String> stopSequences)

getStop

public @Nullable List<String> getStop()

setStop

public void setStop(@Nullable List<String> stop)

getTools

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

setTools

public void setTools(@Nullable List<MistralAiApi.FunctionTool> tools)

getToolChoice

public @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice getToolChoice()

setToolChoice

public void setToolChoice(@Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)

getTemperature

public @Nullable 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

setTemperature

public void setTemperature(@Nullable Double temperature)

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

setTopP

public void setTopP(Double topP)

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

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

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

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

getN

public @Nullable Integer getN()

setN

public void setN(@Nullable Integer n)

getToolCallbacks

public List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

setToolCallbacks

public void setToolCallbacks(List<ToolCallback> toolCallbacks)

Description copied from interface: ToolCallingChatOptions

Set the ToolCallbacks to be registered with the ChatModel.

Specified by:

setToolCallbacks in interface ToolCallingChatOptions

getToolNames

public Set<String> getToolNames()

Description copied from interface: ToolCallingChatOptions

Names of the tools to register with the ChatModel.

Specified by:

getToolNames in interface ToolCallingChatOptions

setToolNames

public void setToolNames(Set<String> toolNames)

Description copied from interface: ToolCallingChatOptions

Set the names of the tools to register with the ChatModel.

Specified by:

setToolNames in interface ToolCallingChatOptions

getInternalToolExecutionEnabled

public @Nullable Boolean getInternalToolExecutionEnabled()

Description copied from interface: ToolCallingChatOptions

Whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.

Specified by:

getInternalToolExecutionEnabled in interface ToolCallingChatOptions

setInternalToolExecutionEnabled

public void setInternalToolExecutionEnabled(@Nullable Boolean internalToolExecutionEnabled)

Description copied from interface: ToolCallingChatOptions

Set whether the ChatModel is responsible for executing the tools requested by the model or if the tools should be executed directly by the caller.

Specified by:

setInternalToolExecutionEnabled 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 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.

setToolContext

public void setToolContext(Map<String,Object> toolContext)

Description copied from interface: ToolCallingChatOptions

Set the tool context values as map.

Specified by:

setToolContext in interface ToolCallingChatOptions

Parameters:

toolContext - as map

getOutputSchema

public @Nullable String getOutputSchema()

Specified by:

getOutputSchema in interface StructuredOutputChatOptions

setOutputSchema

public void setOutputSchema(String outputSchema)

Specified by:

setOutputSchema in interface StructuredOutputChatOptions

copy

public MistralAiChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions

mutate

public MistralAiChatOptions.Builder mutate()

Description copied from interface: ChatOptions

Returns a new ChatOptions.Builder initialized with the values of this ChatOptions. Concrete ChatOptions classes must override this to return the most concrete builder implementation.

Specified by:

mutate in interface ChatOptions

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object