Package org.springframework.ai.anthropic

Class AnthropicChatOptions

java.lang.Object

org.springframework.ai.anthropic.AnthropicChatOptions

All Implemented Interfaces:

ChatOptions, ModelOptions, StructuredOutputChatOptions, ToolCallingChatOptions

public class AnthropicChatOptions
extends Object
implements ToolCallingChatOptions, StructuredOutputChatOptions

The options to be used when sending a chat request to the Anthropic API.

Since:

1.0.0

Author:

Christian Tzolov, Thomas Vitale, Alexandros Pappas, Ilayaperumal Gopinathan, Soby Chacko, Austin Dase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AnthropicChatOptions.Builder

Field Summary

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

DEFAULT_TOOL_EXECUTION_ENABLED

Constructor Summary

Constructors

Constructor	Description
AnthropicChatOptions()

Method Summary

Modifier and Type	Method	Description
static AnthropicChatOptions.Builder	builder()
AnthropicChatOptions	copy()	Returns a copy of this ChatOptions.
boolean	equals(Object o)
static AnthropicChatOptions	fromOptions(AnthropicChatOptions fromOptions)
AnthropicCacheOptions	getCacheOptions()
List<CitationDocument>	getCitationDocuments()
Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
Map<String,String>	getHttpHeaders()
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.
AnthropicApi.ChatCompletionRequest.Metadata	getMetadata()
String	getModel()	Returns the model to use for the chat.
AnthropicApi.ChatCompletionRequest.OutputFormat	getOutputFormat()
String	getOutputSchema()
Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
AnthropicApi.SkillContainer	getSkillContainer()
List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
Double	getTemperature()	Returns the temperature to use for the chat.
AnthropicApi.ChatCompletionRequest.ThinkingConfig	getThinking()
List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
AnthropicApi.ToolChoice	getToolChoice()
Map<String,Object>	getToolContext()	Get the configured tool context.
Set<String>	getToolNames()	Names of the tools to register with the ChatModel.
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	setCacheOptions(AnthropicCacheOptions cacheOptions)
void	setCitationDocuments(List<CitationDocument> citationDocuments)
void	setHttpHeaders(Map<String,String> httpHeaders)
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	setMetadata(AnthropicApi.ChatCompletionRequest.Metadata metadata)
void	setModel(String model)
void	setOutputFormat(AnthropicApi.ChatCompletionRequest.OutputFormat outputFormat)
void	setOutputSchema(String outputSchema)
void	setSkillContainer(AnthropicApi.SkillContainer skillContainer)
void	setStopSequences(List<String> stopSequences)
void	setTemperature(Double temperature)
void	setThinking(AnthropicApi.ChatCompletionRequest.ThinkingConfig thinking)
void	setToolCallbacks(List<ToolCallback> toolCallbacks)	Set the ToolCallbacks to be registered with the ChatModel.
void	setToolChoice(AnthropicApi.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	setTopK(Integer topK)
void	setTopP(Double topP)
void	validateCitationConsistency()	Validate that all citation documents have consistent citation settings.

Methods inherited from class java.lang.Object

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

Constructor Details

AnthropicChatOptions

public AnthropicChatOptions()

Method Details

getCacheOptions

public AnthropicCacheOptions getCacheOptions()

setCacheOptions

public void setCacheOptions(AnthropicCacheOptions cacheOptions)

builder

public static AnthropicChatOptions.Builder builder()

fromOptions

public static AnthropicChatOptions fromOptions(AnthropicChatOptions fromOptions)

getSkillContainer

public AnthropicApi.SkillContainer getSkillContainer()

setSkillContainer

public void setSkillContainer(AnthropicApi.SkillContainer skillContainer)

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)

getMetadata

public AnthropicApi.ChatCompletionRequest.Metadata getMetadata()

setMetadata

public void setMetadata(AnthropicApi.ChatCompletionRequest.Metadata metadata)

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)

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)

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

setTopK

public void setTopK(Integer topK)

getToolChoice

public AnthropicApi.ToolChoice getToolChoice()

setToolChoice

public void setToolChoice(AnthropicApi.ToolChoice toolChoice)

getThinking

public AnthropicApi.ChatCompletionRequest.ThinkingConfig getThinking()

setThinking

public void setThinking(AnthropicApi.ChatCompletionRequest.ThinkingConfig thinking)

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

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

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

getHttpHeaders

public Map<String,String> getHttpHeaders()

setHttpHeaders

public void setHttpHeaders(Map<String,String> httpHeaders)

getCitationDocuments

public List<CitationDocument> getCitationDocuments()

setCitationDocuments

public void setCitationDocuments(List<CitationDocument> citationDocuments)

validateCitationConsistency

public void validateCitationConsistency()

Validate that all citation documents have consistent citation settings. Anthropic requires all documents to have citations enabled if any do.

getOutputFormat

public AnthropicApi.ChatCompletionRequest.OutputFormat getOutputFormat()

setOutputFormat

public void setOutputFormat(AnthropicApi.ChatCompletionRequest.OutputFormat outputFormat)

getOutputSchema

public String getOutputSchema()

Specified by:

getOutputSchema in interface StructuredOutputChatOptions

setOutputSchema

public void setOutputSchema(String outputSchema)

Specified by:

setOutputSchema in interface StructuredOutputChatOptions

copy

public AnthropicChatOptions copy()

Description copied from interface: ChatOptions

Returns a copy of this ChatOptions.

Specified by:

copy in interface ChatOptions

Returns:

a copy of this ChatOptions

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object