Uses of Interface
org.springframework.ai.chat.prompt.ChatOptions

Packages that use ChatOptions

Package	Description
org.springframework.ai.anthropic
org.springframework.ai.azure.openai
org.springframework.ai.bedrock.converse
org.springframework.ai.bedrock.converse.api
org.springframework.ai.chat.client	Chat client.
org.springframework.ai.chat.model
org.springframework.ai.chat.prompt
org.springframework.ai.deepseek
org.springframework.ai.minimax
org.springframework.ai.mistralai
org.springframework.ai.model.tool
org.springframework.ai.oci.cohere
org.springframework.ai.ollama
org.springframework.ai.ollama.api
org.springframework.ai.openai
org.springframework.ai.vertexai.gemini
org.springframework.ai.zhipuai

Uses of ChatOptions in org.springframework.ai.anthropic

Classes in org.springframework.ai.anthropic that implement ChatOptions

Modifier and Type	Class	Description
class	AnthropicChatOptions	The options to be used when sending a chat request to the Anthropic API.

Methods in org.springframework.ai.anthropic that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	AnthropicChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.azure.openai

Classes in org.springframework.ai.azure.openai that implement ChatOptions

Modifier and Type	Class	Description
class	AzureOpenAiChatOptions	The configuration information for a chat completions request.

Uses of ChatOptions in org.springframework.ai.bedrock.converse

Classes in org.springframework.ai.bedrock.converse that implement ChatOptions

Modifier and Type	Class	Description
class	BedrockChatOptions	The options to be used when sending a chat request to the Bedrock API.

Methods in org.springframework.ai.bedrock.converse that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	BedrockProxyChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.bedrock.converse.api

Methods in org.springframework.ai.bedrock.converse.api with parameters of type ChatOptions

Modifier and Type	Method	Description
static software.amazon.awssdk.core.document.Document	ConverseApiUtils.getChatOptionsAdditionalModelRequestFields(ChatOptions defaultOptions, ModelOptions promptOptions)

Uses of ChatOptions in org.springframework.ai.chat.client

Methods in org.springframework.ai.chat.client with type parameters of type ChatOptions

Modifier and Type	Method	Description
<T extends ChatOptions> ChatClient.ChatClientRequestSpec	ChatClient.ChatClientRequestSpec.options(T options)
<T extends ChatOptions> ChatClient.ChatClientRequestSpec	DefaultChatClient.DefaultChatClientRequestSpec.options(T options)

Methods in org.springframework.ai.chat.client that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	DefaultChatClient.DefaultChatClientRequestSpec.getChatOptions()

Methods in org.springframework.ai.chat.client with parameters of type ChatOptions

Modifier and Type	Method	Description
ChatClient.Builder	ChatClient.Builder.defaultOptions(ChatOptions chatOptions)
ChatClient.Builder	DefaultChatClientBuilder.defaultOptions(ChatOptions chatOptions)

Constructors in org.springframework.ai.chat.client with parameters of type ChatOptions

Modifier	Constructor	Description
	DefaultChatClientRequestSpec(ChatModel chatModel, String userText, Map<String,Object> userParams, String systemText, Map<String,Object> systemParams, List<ToolCallback> toolCallbacks, List<Message> messages, List<String> toolNames, List<Media> media, ChatOptions chatOptions, List<Advisor> advisors, Map<String,Object> advisorParams, io.micrometer.observation.ObservationRegistry observationRegistry, ChatClientObservationConvention observationConvention, Map<String,Object> toolContext, TemplateRenderer templateRenderer)

Uses of ChatOptions in org.springframework.ai.chat.model

Methods in org.springframework.ai.chat.model that return ChatOptions

Modifier and Type	Method	Description
default ChatOptions	ChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.chat.prompt

Classes in org.springframework.ai.chat.prompt that implement ChatOptions

Modifier and Type	Class	Description
class	DefaultChatOptions	Default implementation for the ChatOptions.

Methods in org.springframework.ai.chat.prompt with type parameters of type ChatOptions

Modifier and Type	Method	Description
<T extends ChatOptions> T	ChatOptions.copy()	Returns a copy of this ChatOptions.
<T extends ChatOptions> T	DefaultChatOptions.copy()

Methods in org.springframework.ai.chat.prompt that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	ChatOptions.Builder.build()	Build the ChatOptions.
ChatOptions	DefaultChatOptionsBuilder.build()
ChatOptions	Prompt.getOptions()

Methods in org.springframework.ai.chat.prompt with parameters of type ChatOptions

Modifier and Type	Method	Description
Prompt.Builder	Prompt.Builder.chatOptions(ChatOptions chatOptions)
Prompt	ChatPromptTemplate.create(Map<String,Object> model, ChatOptions modelOptions)
Prompt	ChatPromptTemplate.create(ChatOptions modelOptions)
Prompt	PromptTemplate.create(Map<String,Object> additionalVariables, ChatOptions modelOptions)
Prompt	PromptTemplate.create(ChatOptions modelOptions)
Prompt	PromptTemplateActions.create(Map<String,Object> model, ChatOptions modelOptions)
Prompt	PromptTemplateActions.create(ChatOptions modelOptions)

Constructors in org.springframework.ai.chat.prompt with parameters of type ChatOptions

Modifier	Constructor	Description
	Prompt(String contents, ChatOptions chatOptions)
	Prompt(List<Message> messages, ChatOptions chatOptions)
	Prompt(Message message, ChatOptions chatOptions)

Uses of ChatOptions in org.springframework.ai.deepseek

Classes in org.springframework.ai.deepseek that implement ChatOptions

Modifier and Type	Class	Description
class	DeepSeekChatOptions	Chat completions options for the DeepSeek chat API.

Methods in org.springframework.ai.deepseek that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	DeepSeekChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.minimax

Classes in org.springframework.ai.minimax that implement ChatOptions

Modifier and Type	Class	Description
class	MiniMaxChatOptions	MiniMaxChatOptions represents the options for performing chat completion using the MiniMax API.

Methods in org.springframework.ai.minimax that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	MiniMaxChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.mistralai

Classes in org.springframework.ai.mistralai that implement ChatOptions

Modifier and Type	Class	Description
class	MistralAiChatOptions	Options for the Mistral AI Chat API.

Methods in org.springframework.ai.mistralai that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	MistralAiChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.model.tool

Subinterfaces of ChatOptions in org.springframework.ai.model.tool

Modifier and Type	Interface	Description
interface	ToolCallingChatOptions	A set of options that can be used to configure the interaction with a chat model, including tool calling.

Classes in org.springframework.ai.model.tool that implement ChatOptions

Modifier and Type	Class	Description
class	DefaultToolCallingChatOptions	Default implementation of ToolCallingChatOptions.

Methods in org.springframework.ai.model.tool with type parameters of type ChatOptions

Modifier and Type	Method	Description
<T extends ChatOptions> T	DefaultToolCallingChatOptions.copy()

Methods in org.springframework.ai.model.tool with parameters of type ChatOptions

Modifier and Type	Method	Description
static boolean	ToolCallingChatOptions.isInternalToolExecutionEnabled(ChatOptions chatOptions)
default boolean	ToolExecutionEligibilityChecker.isInternalToolExecutionEnabled(ChatOptions chatOptions)	Determines if tool execution should be performed by the Spring AI or by the client.
default boolean	ToolExecutionEligibilityChecker.isToolExecutionRequired(ChatOptions promptOptions, ChatResponse chatResponse)	Determines if tool execution should be performed based on the prompt options and chat response.
default boolean	ToolExecutionEligibilityPredicate.isToolExecutionRequired(ChatOptions promptOptions, ChatResponse chatResponse)	Determines if tool execution should be performed based on the prompt options and chat response.
boolean	DefaultToolExecutionEligibilityPredicate.test(ChatOptions promptOptions, ChatResponse chatResponse)

Uses of ChatOptions in org.springframework.ai.oci.cohere

Classes in org.springframework.ai.oci.cohere that implement ChatOptions

Modifier and Type	Class	Description
class	OCICohereChatOptions	The configuration information for OCI chat requests.

Methods in org.springframework.ai.oci.cohere that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	OCICohereChatOptions.copy()
ChatOptions	OCICohereChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.ollama

Methods in org.springframework.ai.ollama that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	OllamaChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.ollama.api

Classes in org.springframework.ai.ollama.api that implement ChatOptions

Modifier and Type	Class	Description
class	OllamaOptions	Helper class for creating strongly-typed Ollama options.

Uses of ChatOptions in org.springframework.ai.openai

Classes in org.springframework.ai.openai that implement ChatOptions

Modifier and Type	Class	Description
class	OpenAiChatOptions	Options for the OpenAI Chat API.

Methods in org.springframework.ai.openai that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	OpenAiChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.vertexai.gemini

Classes in org.springframework.ai.vertexai.gemini that implement ChatOptions

Modifier and Type	Class	Description
class	VertexAiGeminiChatOptions	Options for the Vertex AI Gemini Chat API.

Methods in org.springframework.ai.vertexai.gemini that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	VertexAiGeminiChatModel.getDefaultOptions()

Uses of ChatOptions in org.springframework.ai.zhipuai

Classes in org.springframework.ai.zhipuai that implement ChatOptions

Modifier and Type	Class	Description
class	ZhiPuAiChatOptions	ZhiPuAiChatOptions represents the options for the ZhiPuAiChat model.

Methods in org.springframework.ai.zhipuai that return ChatOptions

Modifier and Type	Method	Description
ChatOptions	ZhiPuAiChatModel.getDefaultOptions()

Methods in org.springframework.ai.zhipuai with parameters of type ChatOptions

Modifier and Type	Method	Description
ToolCallingChatOptions	ZhiPuAiChatOptions.merge(ChatOptions options)