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, ChatOptions

Since:

0.8.1

Author:

Ricken Bazolo, Christian Tzolov

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()
List<FunctionCallback>	getFunctionCallbacks()	Function Callbacks to be registered with the ChatClient.
Set<String>	getFunctions()
Integer	getMaxTokens()
String	getModel()
Integer	getRandomSeed()
MistralAiApi.ChatCompletionRequest.ResponseFormat	getResponseFormat()
Boolean	getSafePrompt()
Float	getTemperature()
MistralAiApi.ChatCompletionRequest.ToolChoice	getToolChoice()
List<MistralAiApi.FunctionTool>	getTools()
Integer	getTopK()
Float	getTopP()
void	setFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Set the Function Callbacks to be registered with the ChatClient.
void	setFunctions(Set<String> functions)	Set the list of function names from the ChatClient registry to be used in the next chat completion requests.
void	setMaxTokens(Integer maxTokens)
void	setModel(String model)
void	setRandomSeed(Integer randomSeed)
void	setResponseFormat(MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat)
void	setSafePrompt(Boolean safePrompt)
void	setTemperature(Float temperature)
void	setToolChoice(MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)
void	setTools(List<MistralAiApi.FunctionTool> tools)
void	setTopK(Integer topK)
void	setTopP(Float topP)

Methods inherited from class java.lang.Object

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

Constructor Details

MistralAiChatOptions

public MistralAiChatOptions()

Method Details

builder

public static MistralAiChatOptions.Builder builder()

getModel

public String getModel()

setModel

public void setModel(String model)

getMaxTokens

public Integer getMaxTokens()

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)

setTools

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

getTools

public List<MistralAiApi.FunctionTool> getTools()

setToolChoice

public void setToolChoice(MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)

getToolChoice

public MistralAiApi.ChatCompletionRequest.ToolChoice getToolChoice()

getTemperature

public Float getTemperature()

Specified by:

getTemperature in interface ChatOptions

setTemperature

public void setTemperature(Float temperature)

getTopP

public Float getTopP()

Specified by:

getTopP in interface ChatOptions

setTopP

public void setTopP(Float topP)

getTopK

public Integer getTopK()

Specified by:

getTopK in interface ChatOptions

setTopK

public void setTopK(Integer topK)

getFunctionCallbacks

public List<FunctionCallback> getFunctionCallbacks()

Description copied from interface: FunctionCallingOptions

Function Callbacks to be registered with the ChatClient. 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 ChatClient 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 ChatClient.

setFunctionCallbacks

public void setFunctionCallbacks(List<FunctionCallback> functionCallbacks)

Description copied from interface: FunctionCallingOptions

Set the Function Callbacks to be registered with the ChatClient.

Specified by:

setFunctionCallbacks in interface FunctionCallingOptions

Parameters:

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

getFunctions

public Set<String> getFunctions()

Specified by:

getFunctions in interface FunctionCallingOptions

Returns:

List of function names from the ChatClient 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 ChatClient 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 ChatClient registry to be used in the next chat completion requests.