Package org.springframework.ai.anthropic

Class AnthropicChatOptions.AbstractBuilder<B extends AnthropicChatOptions.AbstractBuilder<B>>

java.lang.Object

org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder<B>

org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder<B>

org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder<B>

All Implemented Interfaces:

ChatOptions.Builder<B>, StructuredOutputChatOptions.Builder<B>, ToolCallingChatOptions.Builder<B>

Direct Known Subclasses:

AnthropicChatOptions.Builder

Enclosing class:

AnthropicChatOptions

protected abstract static class AnthropicChatOptions.AbstractBuilder<B extends AnthropicChatOptions.AbstractBuilder<B>>
extends DefaultToolCallingChatOptions.Builder<B>
implements StructuredOutputChatOptions.Builder<B>

Field Summary

Fields inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

internalToolExecutionEnabled, toolCallbacks, toolContext, toolNames

Fields inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
B	addCitationDocument(AnthropicCitationDocument citationDocument)
B	apiKey(@Nullable String apiKey)
B	baseUrl(@Nullable String baseUrl)
AnthropicChatOptions	build()	Build the ChatOptions.
B	cacheOptions(AnthropicCacheOptions cacheOptions)
B	citationDocuments(List<AnthropicCitationDocument> citationDocuments)
B	citationDocuments(AnthropicCitationDocument... citationDocuments)
B	combineWith(ChatOptions.Builder<?> other)	Mutate this builder by taking all other's values that are non-null, retaining this other values.
B	customHeaders(Map<String,String> customHeaders)
B	disableParallelToolUse(@Nullable Boolean disableParallelToolUse)
B	effort(com.anthropic.models.messages.OutputConfig.Effort effort)	Convenience method to set the effort level for the model's response.
B	httpHeaders(Map<String,String> httpHeaders)
B	maxRetries(@Nullable Integer maxRetries)
B	metadata(@Nullable com.anthropic.models.messages.Metadata metadata)
B	model(@Nullable com.anthropic.models.messages.Model model)
B	outputConfig(@Nullable com.anthropic.models.messages.OutputConfig outputConfig)	Sets the output configuration for controlling response format and effort.
B	outputSchema(@Nullable String outputSchema)
B	proxy(@Nullable Proxy proxy)
B	skill(String skillIdOrName)
B	skill(String skillIdOrName, String version)
B	skill(AnthropicSkill anthropicSkill)
B	skill(AnthropicSkillRecord skill)
B	skill(AnthropicSkill anthropicSkill, String version)
B	skillContainer(@Nullable AnthropicSkillContainer skillContainer)
B	skills(String... skillIds)
B	skills(List<String> skillIds)
B	thinking(@Nullable com.anthropic.models.messages.ThinkingConfigParam thinking)
B	thinkingAdaptive()	Convenience method to let Claude adaptively decide whether to think.
B	thinkingDisabled()	Convenience method to explicitly disable thinking.
B	thinkingEnabled(long budgetTokens)	Convenience method to enable thinking with a specific budget in tokens.
B	timeout(@Nullable Duration timeout)
B	toolChoice(@Nullable com.anthropic.models.messages.ToolChoice toolChoice)

Methods inherited from class org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder

internalToolExecutionEnabled, toolCallbacks, toolCallbacks, toolContext, toolContext, toolNames, toolNames

Methods inherited from class org.springframework.ai.chat.prompt.DefaultChatOptionsBuilder

frequencyPenalty, maxTokens, model, presencePenalty, self, stopSequences, temperature, topK, topP

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.model.tool.ToolCallingChatOptions.Builder

frequencyPenalty, maxTokens, model, presencePenalty, stopSequences, temperature, topK, topP

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

outputSchema

public B outputSchema(@Nullable String outputSchema)

Specified by:

outputSchema in interface StructuredOutputChatOptions.Builder<B extends AnthropicChatOptions.AbstractBuilder<B>>

baseUrl

public B baseUrl(@Nullable String baseUrl)

apiKey

public B apiKey(@Nullable String apiKey)

timeout

public B timeout(@Nullable Duration timeout)

maxRetries

public B maxRetries(@Nullable Integer maxRetries)

proxy

public B proxy(@Nullable Proxy proxy)

customHeaders

public B customHeaders(Map<String,String> customHeaders)

model

public B model(@Nullable com.anthropic.models.messages.Model model)

metadata

public B metadata(@Nullable com.anthropic.models.messages.Metadata metadata)

toolChoice

public B toolChoice(@Nullable com.anthropic.models.messages.ToolChoice toolChoice)

thinking

public B thinking(@Nullable com.anthropic.models.messages.ThinkingConfigParam thinking)

thinkingEnabled

public B thinkingEnabled(long budgetTokens)

Convenience method to enable thinking with a specific budget in tokens.

Parameters:

budgetTokens - the thinking budget (must be >= 1024 and invalid input: '<' maxTokens)

thinkingAdaptive

public B thinkingAdaptive()

Convenience method to let Claude adaptively decide whether to think.

thinkingDisabled

public B thinkingDisabled()

Convenience method to explicitly disable thinking.

disableParallelToolUse

public B disableParallelToolUse(@Nullable Boolean disableParallelToolUse)

citationDocuments

public B citationDocuments(List<AnthropicCitationDocument> citationDocuments)

citationDocuments

public B citationDocuments(AnthropicCitationDocument... citationDocuments)

addCitationDocument

public B addCitationDocument(AnthropicCitationDocument citationDocument)

cacheOptions

public B cacheOptions(AnthropicCacheOptions cacheOptions)

outputConfig

public B outputConfig(@Nullable com.anthropic.models.messages.OutputConfig outputConfig)

Sets the output configuration for controlling response format and effort.

Parameters:

outputConfig - the output configuration

Returns:

this builder

effort

public B effort(com.anthropic.models.messages.OutputConfig.Effort effort)

Convenience method to set the effort level for the model's response.

Parameters:

effort - the desired effort level (LOW, MEDIUM, HIGH, MAX)

Returns:

this builder

httpHeaders

public B httpHeaders(Map<String,String> httpHeaders)

skillContainer

public B skillContainer(@Nullable AnthropicSkillContainer skillContainer)

skill

public B skill(String skillIdOrName)

skill

public B skill(String skillIdOrName,
 String version)

skill

public B skill(AnthropicSkill anthropicSkill)

skill

public B skill(AnthropicSkill anthropicSkill,
 String version)

skill

public B skill(AnthropicSkillRecord skill)

skills

public B skills(String... skillIds)

skills

public B skills(List<String> skillIds)

combineWith

public B combineWith(ChatOptions.Builder<?> other)

Description copied from interface: ChatOptions.Builder

Mutate this builder by taking all other's values that are non-null, retaining this other values.

Specified by:

combineWith in interface ChatOptions.Builder<B extends AnthropicChatOptions.AbstractBuilder<B>>

Overrides:

combineWith in class DefaultToolCallingChatOptions.Builder<B extends AnthropicChatOptions.AbstractBuilder<B>>

build

public AnthropicChatOptions build()

Description copied from interface: ChatOptions.Builder

Build the ChatOptions.

Specified by:

build in interface ChatOptions.Builder<B extends AnthropicChatOptions.AbstractBuilder<B>>

Specified by:

build in interface ToolCallingChatOptions.Builder<B extends AnthropicChatOptions.AbstractBuilder<B>>

Overrides:

build in class DefaultToolCallingChatOptions.Builder<B extends AnthropicChatOptions.AbstractBuilder<B>>

Returns:

the Chat options.