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

Packages that use ChatOptions

Package	Description
org.springframework.ai.chat.model
org.springframework.ai.chat.prompt
org.springframework.ai.model.tool

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()
@Nullable 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, @Nullable ChatOptions chatOptions)
	Prompt(List<Message> messages, @Nullable ChatOptions chatOptions)
	Prompt(Message message, @Nullable ChatOptions chatOptions)

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

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

Modifier and Type	Interface	Description
interface	StructuredOutputChatOptions	Mixin interface for ChatModels that support structured output.
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.

Subinterfaces with type arguments of type ChatOptions in org.springframework.ai.model.tool

Modifier and Type	Interface	Description
interface	ToolExecutionEligibilityPredicate	Interface for determining when tool execution should be performed based on model responses.

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)