Package org.springframework.ai.mistralai

Class MistralAiChatOptions

java.lang.Object

org.springframework.ai.mistralai.MistralAiChatOptions

All Implemented Interfaces:

ChatOptions, FunctionCallingOptions, ModelOptions

public class MistralAiChatOptions
extends Object
implements FunctionCallingOptions

Options for the Mistral AI Chat API.

Since:

0.8.1

Author:

Ricken Bazolo, Christian Tzolov, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MistralAiChatOptions.Builder

Constructor Summary

Constructors

Constructor	Description
MistralAiChatOptions()

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.
List<FunctionCallback>	getFunctionCallbacks()	Function Callbacks to be registered with the ChatModel.
Set<String>	getFunctions()
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
String	getModel()	Returns the model to use for the chat.
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
Boolean	getProxyToolCalls()
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.
MistralAiApi.ChatCompletionRequest.ToolChoice	getToolChoice()
Map<String,Object>	getToolContext()
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	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Set the Function Callbacks to be registered with the ChatModel.
void	setFunctions(Set<String> functions)	Set the list of function names from the ChatModel registry to be used in the next chat completion requests.
void	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setProxyToolCalls(Boolean proxyToolCalls)
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	setToolChoice(MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)
void	setToolContext(Map<String,Object> toolContext)
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()

Returns:

Returns FunctionCallingOptionsBuilder to create a new instance of FunctionCallingOptions.

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)

getFunctionCallbacks

public List<FunctionCallback> getFunctionCallbacks()

Description copied from interface: FunctionCallingOptions

Function Callbacks to be registered with the ChatModel. For Prompt Options the functionCallbacks are automatically enabled for the duration of the prompt execution. For Default Options the FunctionCallbacks are registered but disabled by default. You have to use "functions" property to list the function names from the ChatModel registry to be used in the chat completion requests.

Specified by:

getFunctionCallbacks in interface FunctionCallingOptions

Returns:

Return the Function Callbacks to be registered with the ChatModel.

setFunctionCallbacks

public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Description copied from interface: FunctionCallingOptions

Set the Function Callbacks to be registered with the ChatModel.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

Parameters:

functionCallbacks - the Function Callbacks to be registered with the ChatModel.

getFunctions

public Set<String> getFunctions()

Specified by:

getFunctions in interface FunctionCallingOptions

Returns:

Set of function names from the ChatModel registry to be used in the next chat completion requests.

setFunctions

public void setFunctions(Set<String> functions)

Description copied from interface: FunctionCallingOptions

Set the list of function names from the ChatModel registry to be used in the next chat completion requests.

Specified by:

setFunctions in interface FunctionCallingOptions

Parameters:

functions - the list of function names from the ChatModel registry to be used in the next chat completion requests.

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

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

getProxyToolCalls

public Boolean getProxyToolCalls()

Specified by:

getProxyToolCalls in interface FunctionCallingOptions

setProxyToolCalls

public void setProxyToolCalls(Boolean proxyToolCalls)

Specified by:

setProxyToolCalls in interface FunctionCallingOptions

getToolContext

public Map<String,Object> getToolContext()

Specified by:

getToolContext in interface FunctionCallingOptions

setToolContext

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

Specified by:

setToolContext in interface FunctionCallingOptions

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