Package org.springframework.ai.mistralai

Class MistralAiChatOptions

java.lang.Object

org.springframework.ai.mistralai.MistralAiChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, ToolCallingChatOptions

public class MistralAiChatOptions
extends Object
implements ToolCallingChatOptions

Options for the Mistral AI Chat API.

Since:

0.8.1

Author:

Ricken Bazolo, Christian Tzolov, Thomas Vitale, Alexandros Pappas, Jason Smith

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MistralAiChatOptions.Builder

Field Summary

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

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
MistralAiChatOptions()

Method Summary

Modifier and Type	Method	Description
static MistralAiChatOptions.Builder	builder()	A builder to create a new ToolCallingChatOptions instance.
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.
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.
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
Integer	getN()
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
Integer	getRandomSeed()
MistralAiApi.ChatCompletionRequest.ResponseFormat	getResponseFormat()
Boolean	getSafePrompt()
List<String>	getStop()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
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.
List<MistralAiApi.FunctionTool>	getTools()
Integer	getTopK()	Returns the top K to use for the chat.
Double	getTopP()	Returns the top P to use for the chat.
int	hashCode()
void	setFrequencyPenalty(Double frequencyPenalty)
void	setInternalToolExecutionEnabled(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(Integer maxTokens)
void	setModel(String model)
void	setN(Integer n)
void	setPresencePenalty(Double presencePenalty)
void	setRandomSeed(Integer randomSeed)
void	setResponseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat)
void	setSafePrompt(Boolean safePrompt)
void	setStop(List<String> stop)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setToolCallbacks(List<ToolCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolChoice(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(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()

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.

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 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(Integer maxTokens)

getSafePrompt

public Boolean getSafePrompt()

setSafePrompt

public void setSafePrompt(Boolean safePrompt)

getRandomSeed

public Integer getRandomSeed()

setRandomSeed

public void setRandomSeed(Integer randomSeed)

getResponseFormat

public MistralAiApi.ChatCompletionRequest.ResponseFormat getResponseFormat()

setResponseFormat

public void setResponseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat)

getStopSequences

public 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 List<String> getStop()

setStop

public void setStop(List<String> stop)

getTools

public List<MistralAiApi.FunctionTool> getTools()

setTools

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

getToolChoice

public MistralAiApi.ChatCompletionRequest.ToolChoice getToolChoice()

setToolChoice

public void setToolChoice(MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)

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

setTemperature

public void setTemperature(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 Integer getN()

setN

public void setN(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

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

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object