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

Chat options for AnthropicChatModel. Supports model selection, sampling parameters (temperature, topP, topK), output control (maxTokens, stopSequences), and tool calling configuration.

Options can be set as defaults during model construction or overridden per-request via the Prompt.

Since:

1.0.0

Author:

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

See Also:

• AnthropicChatModel
• Anthropic Messages API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AnthropicChatOptions.AbstractBuilder<B extends AnthropicChatOptions.AbstractBuilder<B>>
static class	AnthropicChatOptions.Builder	Builder for creating AnthropicChatOptions instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	DEFAULT_MAX_TOKENS	Default max tokens for chat completions.
static final String	DEFAULT_MODEL	Default model to use for chat completions.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AnthropicChatOptions(@Nullable String baseUrl, @Nullable String apiKey, @Nullable String model, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, @Nullable Integer maxTokens, @Nullable com.anthropic.models.messages.Metadata metadata, @Nullable List<String> stopSequences, @Nullable Double temperature, @Nullable Double topP, @Nullable Integer topK, @Nullable com.anthropic.models.messages.ToolChoice toolChoice, @Nullable com.anthropic.models.messages.ThinkingConfigParam thinking, @Nullable Boolean disableParallelToolUse, @Nullable List<ToolCallback> toolCallbacks, @Nullable Map<String,Object> toolContext, @Nullable List<AnthropicCitationDocument> citationDocuments, @Nullable AnthropicCacheOptions cacheOptions, @Nullable com.anthropic.models.messages.OutputConfig outputConfig, @Nullable Map<String,String> httpHeaders, @Nullable AnthropicSkillContainer skillContainer, @Nullable String inferenceGeo, @Nullable AnthropicWebSearchTool webSearchTool, @Nullable AnthropicServiceTier serviceTier)

Method Summary

Modifier and Type	Method	Description
static AnthropicChatOptions.Builder	builder()	Creates a new builder for AnthropicChatOptions.
boolean	equals(@Nullable Object o)
@Nullable String	getApiKey()
@Nullable String	getBaseUrl()
AnthropicCacheOptions	getCacheOptions()
@Nullable List<AnthropicCitationDocument>	getCitationDocuments()
@Nullable Map<String,String>	getCustomHeaders()
@Nullable Boolean	getDisableParallelToolUse()
@Nullable Double	getFrequencyPenalty()	Returns the frequency penalty to use for the chat.
@Nullable Map<String,String>	getHttpHeaders()
@Nullable String	getInferenceGeo()
@Nullable Integer	getMaxRetries()
Integer	getMaxTokens()	Returns the maximum number of tokens to use for the chat.
@Nullable com.anthropic.models.messages.Metadata	getMetadata()
String	getModel()	Returns the model to use for the chat.
@Nullable com.anthropic.models.messages.OutputConfig	getOutputConfig()
@Nullable String	getOutputSchema()
@Nullable Double	getPresencePenalty()	Returns the presence penalty to use for the chat.
@Nullable Proxy	getProxy()
@Nullable AnthropicServiceTier	getServiceTier()
@Nullable AnthropicSkillContainer	getSkillContainer()
@Nullable List<String>	getStopSequences()	Returns the stop sequences to use for the chat.
@Nullable Double	getTemperature()	Returns the temperature to use for the chat.
@Nullable com.anthropic.models.messages.ThinkingConfigParam	getThinking()
@Nullable Duration	getTimeout()
@Nullable List<ToolCallback>	getToolCallbacks()	ToolCallbacks to be registered with the ChatModel.
@Nullable com.anthropic.models.messages.ToolChoice	getToolChoice()
@Nullable Map<String,Object>	getToolContext()	Get the configured tool context.
@Nullable Integer	getTopK()	Returns the top K to use for the chat.
@Nullable Double	getTopP()	Returns the top P to use for the chat.
@Nullable AnthropicWebSearchTool	getWebSearchTool()
int	hashCode()
AnthropicChatOptions.Builder	mutate()	Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions.
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

Field Details

DEFAULT_MODEL

public static final String DEFAULT_MODEL

Default model to use for chat completions.

DEFAULT_MAX_TOKENS

public static final Integer DEFAULT_MAX_TOKENS

Default max tokens for chat completions.

Constructor Details

AnthropicChatOptions

protected AnthropicChatOptions(@Nullable String baseUrl,
 @Nullable String apiKey,
 @Nullable String model,
 @Nullable Duration timeout,
 @Nullable Integer maxRetries,
 @Nullable Proxy proxy,
 @Nullable Map<String,String> customHeaders,
 @Nullable Integer maxTokens,
 @Nullable com.anthropic.models.messages.Metadata metadata,
 @Nullable List<String> stopSequences,
 @Nullable Double temperature,
 @Nullable Double topP,
 @Nullable Integer topK,
 @Nullable com.anthropic.models.messages.ToolChoice toolChoice,
 @Nullable com.anthropic.models.messages.ThinkingConfigParam thinking,
 @Nullable Boolean disableParallelToolUse,
 @Nullable List<ToolCallback> toolCallbacks,
 @Nullable Map<String,Object> toolContext,
 @Nullable List<AnthropicCitationDocument> citationDocuments,
 @Nullable AnthropicCacheOptions cacheOptions,
 @Nullable com.anthropic.models.messages.OutputConfig outputConfig,
 @Nullable Map<String,String> httpHeaders,
 @Nullable AnthropicSkillContainer skillContainer,
 @Nullable String inferenceGeo,
 @Nullable AnthropicWebSearchTool webSearchTool,
 @Nullable AnthropicServiceTier serviceTier)

Method Details

builder

public static AnthropicChatOptions.Builder builder()

Creates a new builder for AnthropicChatOptions.

Returns:

a new builder instance

getBaseUrl

public @Nullable String getBaseUrl()

getApiKey

public @Nullable String getApiKey()

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

getTimeout

public @Nullable Duration getTimeout()

getMaxRetries

public @Nullable Integer getMaxRetries()

getProxy

public @Nullable Proxy getProxy()

getCustomHeaders

public @Nullable Map<String,String> getCustomHeaders()

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

getMetadata

public @Nullable com.anthropic.models.messages.Metadata getMetadata()

getStopSequences

public @Nullable 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

getTemperature

public @Nullable 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

getTopP

public @Nullable 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

getTopK

public @Nullable 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

getToolChoice

public @Nullable com.anthropic.models.messages.ToolChoice getToolChoice()

getThinking

public @Nullable com.anthropic.models.messages.ThinkingConfigParam getThinking()

getDisableParallelToolUse

public @Nullable Boolean getDisableParallelToolUse()

getToolCallbacks

public @Nullable List<ToolCallback> getToolCallbacks()

Description copied from interface: ToolCallingChatOptions

ToolCallbacks to be registered with the ChatModel.

Specified by:

getToolCallbacks in interface ToolCallingChatOptions

getToolContext

public @Nullable 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.

getCitationDocuments

public @Nullable List<AnthropicCitationDocument> getCitationDocuments()

validateCitationConsistency

public void validateCitationConsistency()

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

getCacheOptions

public AnthropicCacheOptions getCacheOptions()

getOutputConfig

public @Nullable com.anthropic.models.messages.OutputConfig getOutputConfig()

getHttpHeaders

public @Nullable Map<String,String> getHttpHeaders()

getSkillContainer

public @Nullable AnthropicSkillContainer getSkillContainer()

getInferenceGeo

public @Nullable String getInferenceGeo()

getWebSearchTool

public @Nullable AnthropicWebSearchTool getWebSearchTool()

getServiceTier

public @Nullable AnthropicServiceTier getServiceTier()

getOutputSchema

public @Nullable String getOutputSchema()

Specified by:

getOutputSchema in interface StructuredOutputChatOptions

getFrequencyPenalty

public @Nullable 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 @Nullable 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

mutate

public AnthropicChatOptions.Builder mutate()

Description copied from interface: ToolCallingChatOptions

Returns a new ToolCallingChatOptions.Builder initialized with the values of this ToolCallingChatOptions. Narrows the return type of ChatOptions.mutate() so generic tool calling code can chain methods without casting.

Specified by:

mutate in interface ChatOptions

Specified by:

mutate in interface StructuredOutputChatOptions

Specified by:

mutate in interface ToolCallingChatOptions

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object