Class AnthropicChatOptions.Builder

java.lang.Object

org.springframework.ai.anthropic.AnthropicChatOptions.Builder

Enclosing class:

AnthropicChatOptions

public static final class AnthropicChatOptions.Builder
extends Object

Since:

1.0.0

Author:

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AnthropicChatOptions.Builder	addCitationDocument(CitationDocument document)	Add a single citation document.
AnthropicChatOptions.Builder	anthropicSkill(AnthropicApi.AnthropicSkill anthropicSkill)	Deprecated. Use skill(AnthropicApi.AnthropicSkill) instead
AnthropicChatOptions.Builder	anthropicSkill(AnthropicApi.AnthropicSkill anthropicSkill, String version)	Deprecated. Use skill(AnthropicApi.AnthropicSkill, String) instead
AnthropicChatOptions	build()
AnthropicChatOptions.Builder	cacheOptions(AnthropicCacheOptions cacheOptions)
AnthropicChatOptions.Builder	citationDocuments(List<CitationDocument> citationDocuments)	Set citation documents for the request.
AnthropicChatOptions.Builder	citationDocuments(CitationDocument... documents)	Set citation documents from variable arguments.
AnthropicChatOptions.Builder	customSkill(String skillId)	Deprecated. Use skill(String) instead
AnthropicChatOptions.Builder	customSkill(String skillId, String version)	Deprecated. Use skill(String, String) instead
AnthropicChatOptions.Builder	httpHeaders(Map<String,String> httpHeaders)
AnthropicChatOptions.Builder	internalToolExecutionEnabled(Boolean internalToolExecutionEnabled)
AnthropicChatOptions.Builder	maxTokens(Integer maxTokens)
AnthropicChatOptions.Builder	metadata(AnthropicApi.ChatCompletionRequest.Metadata metadata)
AnthropicChatOptions.Builder	model(String model)
AnthropicChatOptions.Builder	model(AnthropicApi.ChatModel model)
AnthropicChatOptions.Builder	outputFormat(AnthropicApi.ChatCompletionRequest.OutputFormat outputFormat)
AnthropicChatOptions.Builder	outputSchema(String outputSchema)
AnthropicChatOptions.Builder	skill(String skillIdOrName)	Add a skill by its ID or name.
AnthropicChatOptions.Builder	skill(String skillIdOrName, String version)	Add a skill by its ID or name with a specific version.
AnthropicChatOptions.Builder	skill(AnthropicApi.AnthropicSkill anthropicSkill)	Add a pre-built Anthropic skill using the enum.
AnthropicChatOptions.Builder	skill(AnthropicApi.AnthropicSkill anthropicSkill, String version)	Add a pre-built Anthropic skill with specific version.
AnthropicChatOptions.Builder	skill(AnthropicApi.Skill skill)	Add a Skill record directly.
AnthropicChatOptions.Builder	skillContainer(AnthropicApi.SkillContainer skillContainer)	Set the Skills container for this request.
AnthropicChatOptions.Builder	skills(String... skillIds)	Add multiple skills by their IDs or names.
AnthropicChatOptions.Builder	skills(List<String> skillIds)	Add multiple skills from a list of IDs or names.
AnthropicChatOptions.Builder	stopSequences(List<String> stopSequences)
AnthropicChatOptions.Builder	temperature(Double temperature)
AnthropicChatOptions.Builder	thinking(AnthropicApi.ChatCompletionRequest.ThinkingConfig thinking)
AnthropicChatOptions.Builder	thinking(AnthropicApi.ThinkingType type, Integer budgetTokens)
AnthropicChatOptions.Builder	toolCallbacks(List<org.springframework.ai.tool.ToolCallback> toolCallbacks)
AnthropicChatOptions.Builder	toolCallbacks(org.springframework.ai.tool.ToolCallback... toolCallbacks)
AnthropicChatOptions.Builder	toolChoice(AnthropicApi.ToolChoice toolChoice)
AnthropicChatOptions.Builder	toolContext(Map<String,Object> toolContext)
AnthropicChatOptions.Builder	toolNames(String... toolNames)
AnthropicChatOptions.Builder	toolNames(Set<String> toolNames)
AnthropicChatOptions.Builder	topK(Integer topK)
AnthropicChatOptions.Builder	topP(Double topP)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

model

public AnthropicChatOptions.Builder model(String model)

model

public AnthropicChatOptions.Builder model(AnthropicApi.ChatModel model)

maxTokens

public AnthropicChatOptions.Builder maxTokens(Integer maxTokens)

metadata

public AnthropicChatOptions.Builder metadata(AnthropicApi.ChatCompletionRequest.Metadata metadata)

stopSequences

public AnthropicChatOptions.Builder stopSequences(List<String> stopSequences)

temperature

public AnthropicChatOptions.Builder temperature(Double temperature)

topP

public AnthropicChatOptions.Builder topP(Double topP)

topK

public AnthropicChatOptions.Builder topK(Integer topK)

toolChoice

public AnthropicChatOptions.Builder toolChoice(AnthropicApi.ToolChoice toolChoice)

thinking

public AnthropicChatOptions.Builder thinking(AnthropicApi.ChatCompletionRequest.ThinkingConfig thinking)

thinking

public AnthropicChatOptions.Builder thinking(AnthropicApi.ThinkingType type,
 Integer budgetTokens)

toolCallbacks

public AnthropicChatOptions.Builder toolCallbacks(List<org.springframework.ai.tool.ToolCallback> toolCallbacks)

toolCallbacks

public AnthropicChatOptions.Builder toolCallbacks(org.springframework.ai.tool.ToolCallback... toolCallbacks)

toolNames

public AnthropicChatOptions.Builder toolNames(Set<String> toolNames)

toolNames

public AnthropicChatOptions.Builder toolNames(String... toolNames)

internalToolExecutionEnabled

public AnthropicChatOptions.Builder internalToolExecutionEnabled(@Nullable
 Boolean internalToolExecutionEnabled)

toolContext

public AnthropicChatOptions.Builder toolContext(Map<String,Object> toolContext)

httpHeaders

public AnthropicChatOptions.Builder httpHeaders(Map<String,String> httpHeaders)

cacheOptions

public AnthropicChatOptions.Builder cacheOptions(AnthropicCacheOptions cacheOptions)

citationDocuments

public AnthropicChatOptions.Builder citationDocuments(List<CitationDocument> citationDocuments)

Set citation documents for the request.

Parameters:

citationDocuments - List of documents to include for citations

Returns:

Builder for method chaining

citationDocuments

public AnthropicChatOptions.Builder citationDocuments(CitationDocument... documents)

Set citation documents from variable arguments.

Parameters:

documents - Variable number of CitationDocument objects

Returns:

Builder for method chaining

addCitationDocument

public AnthropicChatOptions.Builder addCitationDocument(CitationDocument document)

Add a single citation document.

Parameters:

document - Citation document to add

Returns:

Builder for method chaining

outputFormat

public AnthropicChatOptions.Builder outputFormat(AnthropicApi.ChatCompletionRequest.OutputFormat outputFormat)

outputSchema

public AnthropicChatOptions.Builder outputSchema(String outputSchema)

skillContainer

public AnthropicChatOptions.Builder skillContainer(AnthropicApi.SkillContainer skillContainer)

Set the Skills container for this request.

Parameters:

skillContainer - Container with skills to make available

Returns:

Builder for method chaining

skill

public AnthropicChatOptions.Builder skill(String skillIdOrName)

Add a skill by its ID or name. Automatically detects whether it's a pre-built Anthropic skill (xlsx, pptx, docx, pdf) or a custom skill ID.

Example:

AnthropicChatOptions options = AnthropicChatOptions.builder()
    .model("claude-sonnet-4-5")
    .skill("xlsx")                          // Pre-built skill
    .skill("skill_01abc123...")             // Custom skill
    .build();

Parameters:

skillIdOrName - The skill ID or name

Returns:

Builder for method chaining

skill

public AnthropicChatOptions.Builder skill(String skillIdOrName,
 String version)

Add a skill by its ID or name with a specific version.

Parameters:

skillIdOrName - The skill ID or name

version - The version (e.g., "latest", "20251013")

Returns:

Builder for method chaining

skill

public AnthropicChatOptions.Builder skill(AnthropicApi.AnthropicSkill anthropicSkill)

Add a pre-built Anthropic skill using the enum.

Example:

AnthropicChatOptions options = AnthropicChatOptions.builder()
    .model("claude-sonnet-4-5")
    .skill(AnthropicSkill.XLSX)
    .skill(AnthropicSkill.PPTX)
    .build();

Parameters:

anthropicSkill - Pre-built Anthropic skill to add

Returns:

Builder for method chaining

skill

public AnthropicChatOptions.Builder skill(AnthropicApi.AnthropicSkill anthropicSkill,
 String version)

Add a pre-built Anthropic skill with specific version.

Parameters:

anthropicSkill - Pre-built Anthropic skill to add

version - Version of the skill (e.g., "latest", "20251013")

Returns:

Builder for method chaining

skill

public AnthropicChatOptions.Builder skill(AnthropicApi.Skill skill)

Add a Skill record directly.

Parameters:

skill - Skill to add

Returns:

Builder for method chaining

skills

public AnthropicChatOptions.Builder skills(String... skillIds)

Add multiple skills by their IDs or names.

Parameters:

skillIds - The skill IDs or names

Returns:

Builder for method chaining

skills

public AnthropicChatOptions.Builder skills(List<String> skillIds)

Add multiple skills from a list of IDs or names.

Parameters:

skillIds - The list of skill IDs or names

Returns:

Builder for method chaining

anthropicSkill

@Deprecated
public AnthropicChatOptions.Builder anthropicSkill(AnthropicApi.AnthropicSkill anthropicSkill)

Deprecated.

Use skill(AnthropicApi.AnthropicSkill) instead

Add an Anthropic pre-built skill (xlsx, pptx, docx, pdf).

Parameters:

anthropicSkill - Pre-built Anthropic skill to add

Returns:

Builder for method chaining

anthropicSkill

@Deprecated
public AnthropicChatOptions.Builder anthropicSkill(AnthropicApi.AnthropicSkill anthropicSkill,
 String version)

Deprecated.

Use skill(AnthropicApi.AnthropicSkill, String) instead

Add an Anthropic pre-built skill with specific version.

Parameters:

anthropicSkill - Pre-built Anthropic skill to add

version - Version of the skill (e.g., "latest", "20251013")

Returns:

Builder for method chaining

customSkill

@Deprecated
public AnthropicChatOptions.Builder customSkill(String skillId)

Deprecated.

Use skill(String) instead

Add a custom skill by ID.

Parameters:

skillId - Custom skill ID

Returns:

Builder for method chaining

customSkill

@Deprecated
public AnthropicChatOptions.Builder customSkill(String skillId,
 String version)

Deprecated.

Use skill(String, String) instead

Add a custom skill with specific version.

Parameters:

skillId - Custom skill ID

version - Version of the skill

Returns:

Builder for method chaining

build

public AnthropicChatOptions build()