Index
All Classes and Interfaces|All Packages
A
- AbstractBuilder() - Constructor for class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- addCitationDocument(AnthropicCitationDocument) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- allowedDomains(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder
- ANTHROPIC - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkillType
-
Pre-built skills provided by Anthropic (xlsx, pptx, docx, pdf).
- AnthropicCacheOptions - Class in org.springframework.ai.anthropic
-
Anthropic cache options for configuring prompt caching behavior with the Anthropic Java SDK.
- AnthropicCacheOptions(AnthropicCacheStrategy, Function<String, Integer>, Map<MessageType, AnthropicCacheTtl>, Map<MessageType, Integer>, Boolean, Boolean) - Constructor for class org.springframework.ai.anthropic.AnthropicCacheOptions
- AnthropicCacheOptions.Builder - Class in org.springframework.ai.anthropic
- AnthropicCacheStrategy - Enum Class in org.springframework.ai.anthropic
-
Defines the caching strategy for Anthropic prompt caching.
- AnthropicCacheTtl - Enum Class in org.springframework.ai.anthropic
-
Anthropic cache TTL (time-to-live) options for specifying how long cached prompts remain valid.
- AnthropicChatModel - Class in org.springframework.ai.anthropic
- AnthropicChatModel.Builder - Class in org.springframework.ai.anthropic
-
Builder for creating
AnthropicChatModelinstances. - AnthropicChatOptions - Class in org.springframework.ai.anthropic
-
Chat options for
AnthropicChatModel. - AnthropicChatOptions(String, String, String, Duration, Integer, Proxy, Map<String, String>, Integer, Metadata, List<String>, Double, Double, Integer, ToolChoice, ThinkingConfigParam, Boolean, List<ToolCallback>, Map<String, Object>, List<AnthropicCitationDocument>, AnthropicCacheOptions, OutputConfig, Map<String, String>, AnthropicSkillContainer, String, AnthropicWebSearchTool, AnthropicServiceTier) - Constructor for class org.springframework.ai.anthropic.AnthropicChatOptions
- AnthropicChatOptions.AbstractBuilder<B extends AnthropicChatOptions.AbstractBuilder<B>> - Class in org.springframework.ai.anthropic
- AnthropicChatOptions.Builder - Class in org.springframework.ai.anthropic
-
Builder for creating
AnthropicChatOptionsinstances. - AnthropicCitationDocument - Class in org.springframework.ai.anthropic
-
Builder class for creating citation-enabled documents using the Anthropic Java SDK.
- AnthropicCitationDocument.Builder - Class in org.springframework.ai.anthropic
-
Builder class for AnthropicCitationDocument.
- AnthropicCitationDocument.DocumentType - Enum Class in org.springframework.ai.anthropic
-
Document types supported by Anthropic Citations API.
- anthropicClient(AnthropicClient) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Sets the synchronous Anthropic client.
- anthropicClientAsync(AnthropicClientAsync) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Sets the asynchronous Anthropic client.
- AnthropicHttpClientBuilderCustomizer - Interface in org.springframework.ai.anthropic.http.okhttp
-
Callback for customizing the
SpringAiAnthropicHttpClient.Builderused byAnthropicChatModelbefore the underlyingOkHttpClientis built. - AnthropicRateLimit - Class in org.springframework.ai.anthropic.metadata
-
RateLimitimplementation for the Anthropic SDK. - AnthropicRateLimit(Long, Long, Duration, Long, Long, Duration, Long, Long, Duration, Long, Long, Duration) - Constructor for class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
- AnthropicServiceTier - Enum Class in org.springframework.ai.anthropic
-
Service tier for controlling capacity routing on Anthropic API requests.
- AnthropicSetup - Class in org.springframework.ai.anthropic
-
Factory class for creating and configuring Anthropic SDK client instances.
- AnthropicSkill - Enum Class in org.springframework.ai.anthropic
-
Enum representing the pre-built Anthropic Skills available for Claude.
- AnthropicSkillContainer - Class in org.springframework.ai.anthropic
-
Container for Claude Skills in a chat completion request.
- AnthropicSkillContainer(List<AnthropicSkillRecord>) - Constructor for class org.springframework.ai.anthropic.AnthropicSkillContainer
- AnthropicSkillContainer.Builder - Class in org.springframework.ai.anthropic
- AnthropicSkillRecord - Class in org.springframework.ai.anthropic
-
Represents a Claude Skill - either pre-built Anthropic skill or custom skill.
- AnthropicSkillRecord(AnthropicSkillType, String) - Constructor for class org.springframework.ai.anthropic.AnthropicSkillRecord
-
Create a skill with default "latest" version.
- AnthropicSkillRecord(AnthropicSkillType, String, String) - Constructor for class org.springframework.ai.anthropic.AnthropicSkillRecord
-
Create a skill with a specific version.
- AnthropicSkillRecord.Builder - Class in org.springframework.ai.anthropic
- AnthropicSkillsResponseHelper - Class in org.springframework.ai.anthropic
-
Helper utilities for working with Anthropic Claude Skills responses and files.
- AnthropicSkillType - Enum Class in org.springframework.ai.anthropic
-
Enum representing the type of a Claude Skill.
- AnthropicWebSearchResult - Record Class in org.springframework.ai.anthropic
-
Represents an individual web search result returned by Anthropic's built-in web search tool.
- AnthropicWebSearchResult(String, String, String) - Constructor for record class org.springframework.ai.anthropic.AnthropicWebSearchResult
-
Creates an instance of a
AnthropicWebSearchResultrecord class. - AnthropicWebSearchTool - Class in org.springframework.ai.anthropic
-
Configuration for Anthropic's built-in web search tool.
- AnthropicWebSearchTool() - Constructor for class org.springframework.ai.anthropic.AnthropicWebSearchTool
- AnthropicWebSearchTool.Builder - Class in org.springframework.ai.anthropic
- AnthropicWebSearchTool.UserLocation - Record Class in org.springframework.ai.anthropic
-
Approximate user location for localizing web search results.
- apiKey(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- AUTO - Enum constant in enum class org.springframework.ai.anthropic.AnthropicServiceTier
-
Use priority capacity if available, otherwise fall back to standard capacity.
B
- backend(Backend) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- baseUrl(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- blockedDomains(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder
- build() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- build() - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Builds a new
AnthropicChatModelinstance. - build() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- build() - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
-
Build the AnthropicCitationDocument.
- build() - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
- build() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder
- build() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder
- build() - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- builder() - Static method in class org.springframework.ai.anthropic.AnthropicCacheOptions
- builder() - Static method in class org.springframework.ai.anthropic.AnthropicChatModel
-
Creates a new builder for
AnthropicChatModel. - builder() - Static method in class org.springframework.ai.anthropic.AnthropicChatOptions
-
Creates a new builder for AnthropicChatOptions.
- builder() - Static method in class org.springframework.ai.anthropic.AnthropicCitationDocument
- builder() - Static method in class org.springframework.ai.anthropic.AnthropicSkillContainer
- builder() - Static method in class org.springframework.ai.anthropic.AnthropicSkillRecord
- builder() - Static method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- builder() - Static method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient
- Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicChatOptions.Builder
- Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
- Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
- Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder
- Builder() - Constructor for class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder
C
- CacheEligibilityResolver - Class in org.springframework.ai.anthropic
-
Resolves cache eligibility for messages based on the provided
AnthropicCacheOptions. - CacheEligibilityResolver(AnthropicCacheStrategy, Map<MessageType, AnthropicCacheTtl>, Map<MessageType, Integer>, Function<String, Integer>, Set<MessageType>) - Constructor for class org.springframework.ai.anthropic.CacheEligibilityResolver
- cacheOptions(AnthropicCacheOptions) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- cacheToolResults(Boolean) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
-
Place a
cache_controlbreakpoint on the last tool result message of the request so that tool outputs are cached across tool-calling rounds. - call(Prompt) - Method in class org.springframework.ai.anthropic.AnthropicChatModel
- CHAR_LOCATION - Enum constant in enum class org.springframework.ai.anthropic.Citation.LocationType
-
Character-based location for plain text documents
- Citation - Class in org.springframework.ai.anthropic
-
Represents a citation reference in a Claude response.
- Citation.LocationType - Enum Class in org.springframework.ai.anthropic
-
Types of citation locations based on document format.
- citationDocuments(List<AnthropicCitationDocument>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- citationDocuments(AnthropicCitationDocument...) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- citationsEnabled(boolean) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
-
Enable or disable citations for this document.
- city() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation
-
Returns the value of the
cityrecord component. - clone() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- close() - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient
- combineWith(ChatOptions.Builder<?>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- CONTENT_BLOCK_LOCATION - Enum constant in enum class org.springframework.ai.anthropic.Citation.LocationType
-
Block-based location for custom content documents
- contentLengthFunction(Function<String, Integer>) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- context(String) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
-
Set the document context.
- CONVERSATION_HISTORY - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy
-
Cache the entire conversation history up to (but not including) the current user question.
- country() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation
-
Returns the value of the
countryrecord component. - CUSTOM - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkillType
-
Custom skills uploaded to the workspace.
- CUSTOM_CONTENT - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType
-
Custom content with user-defined blocks and block-based citations.
- customContent(String...) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
-
Create a custom content document from text blocks.
- customHeaders(Map<String, String>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- customize(SpringAiAnthropicHttpClient.Builder) - Method in interface org.springframework.ai.anthropic.http.okhttp.AnthropicHttpClientBuilderCustomizer
-
Customize the
SpringAiAnthropicHttpClient.Builderprior to building the underlying OkHttp client.
D
- DEFAULT_MAX_TOKENS - Static variable in class org.springframework.ai.anthropic.AnthropicChatOptions
-
Default max tokens for chat completions.
- DEFAULT_MODEL - Static variable in class org.springframework.ai.anthropic.AnthropicChatOptions
-
Default model to use for chat completions.
- disabled() - Static method in class org.springframework.ai.anthropic.AnthropicCacheOptions
-
Returns a new disabled cache options instance with strategy
NONE. - disableParallelToolUse(Boolean) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- dispatcherExecutor(ExecutorService) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Sets the executor used by the underlying OkHttp dispatcher for both the sync and async clients.
- dispatcherExecutorService(ExecutorService) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
-
Sets the executor used by the OkHttp dispatcher.
- DOCX - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkill
-
Word document generation.
- downloadAllFiles(ChatResponse, AnthropicClient, Path) - Static method in class org.springframework.ai.anthropic.AnthropicSkillsResponseHelper
-
Download all files from a Skills response to a target directory.
E
- effort(OutputConfig.Effort) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Convenience method to set the effort level for the model's response.
- equals(Object) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions
- equals(Object) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- equals(Object) - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation
-
Indicates whether some other object is "equal to" this one.
- execute(HttpRequest, RequestOptions) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient
- executeAsync(HttpRequest, RequestOptions) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient
- extractContainerId(ChatResponse) - Static method in class org.springframework.ai.anthropic.AnthropicSkillsResponseHelper
-
Extract container ID from a chat response for multi-turn conversation reuse.
- extractFileIds(ChatResponse) - Static method in class org.springframework.ai.anthropic.AnthropicSkillsResponseHelper
-
Extract all file IDs from a chat response.
F
- FIVE_MINUTES - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheTtl
- from(Headers) - Static method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
-
Parses Anthropic rate-limit headers from the given
Headers. - from(AnthropicCacheOptions) - Static method in class org.springframework.ai.anthropic.CacheEligibilityResolver
- fromId(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicSkill
-
Look up a pre-built Anthropic skill by its ID.
G
- getAllowedDomains() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- getAnthropicClient() - Method in class org.springframework.ai.anthropic.AnthropicChatModel
-
Returns the underlying synchronous Anthropic SDK client.
- getAnthropicClientAsync() - Method in class org.springframework.ai.anthropic.AnthropicChatModel
-
Returns the underlying asynchronous Anthropic SDK client.
- getApiKey() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getBaseUrl() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getBlockedDomains() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- getCacheOptions() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getCitationDocuments() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getCitedText() - Method in class org.springframework.ai.anthropic.Citation
- getContentLengthFunction() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions
- getCustomHeaders() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getDescription() - Method in enum class org.springframework.ai.anthropic.AnthropicSkill
- getDisableParallelToolUse() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getDocumentIndex() - Method in class org.springframework.ai.anthropic.Citation
- getDocumentTitle() - Method in class org.springframework.ai.anthropic.Citation
- getEndBlockIndex() - Method in class org.springframework.ai.anthropic.Citation
- getEndCharIndex() - Method in class org.springframework.ai.anthropic.Citation
- getEndPageNumber() - Method in class org.springframework.ai.anthropic.Citation
- getFrequencyPenalty() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getHttpHeaders() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getInferenceGeo() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getInputTokensLimit() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
-
Returns the maximum number of input tokens allowed within the rate-limit window.
- getInputTokensRemaining() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
-
Returns the number of input tokens remaining within the current rate-limit window.
- getInputTokensReset() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
-
Returns the duration until the input-token rate-limit window resets.
- getLocationDescription() - Method in class org.springframework.ai.anthropic.Citation
-
Get a human-readable location description.
- getMaxRetries() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getMaxTokens() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getMaxUses() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- getMessageTypeMinContentLengths() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions
- getMessageTypeTtl() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions
- getMetadata() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getModel() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getOptions() - Method in class org.springframework.ai.anthropic.AnthropicChatModel
-
Gets the chat options for this model.
- getOutputConfig() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getOutputSchema() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getOutputTokensLimit() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
-
Returns the maximum number of output tokens allowed within the rate-limit window.
- getOutputTokensRemaining() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
-
Returns the number of output tokens remaining within the current rate-limit window.
- getOutputTokensReset() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
-
Returns the duration until the output-token rate-limit window resets.
- getPresencePenalty() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getProxy() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getRequestsLimit() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
- getRequestsRemaining() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
- getRequestsReset() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
- getSdkTtl() - Method in enum class org.springframework.ai.anthropic.AnthropicCacheTtl
- getServiceTier() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getSkillContainer() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getSkillId() - Method in enum class org.springframework.ai.anthropic.AnthropicSkill
- getSkillId() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord
- getSkills() - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer
- getStartBlockIndex() - Method in class org.springframework.ai.anthropic.Citation
- getStartCharIndex() - Method in class org.springframework.ai.anthropic.Citation
- getStartPageNumber() - Method in class org.springframework.ai.anthropic.Citation
- getStopSequences() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getStrategy() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions
- getTemperature() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getThinking() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getTimeout() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getTokensLimit() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
- getTokensRemaining() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
- getTokensReset() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
- getToolCallbacks() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getToolChoice() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getToolContext() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getTopK() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getTopP() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- getType() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord
- getType() - Method in class org.springframework.ai.anthropic.Citation
- getUrl() - Method in class org.springframework.ai.anthropic.Citation
- getUserLocation() - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- getValue() - Method in enum class org.springframework.ai.anthropic.AnthropicSkillType
- getVersion() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord
- getWebSearchTool() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
H
- hashCode() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions
- hashCode() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
- hashCode() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation
-
Returns a hash code value for this object.
- hostnameVerifier(HostnameVerifier) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- httpClientBuilderCustomizer(AnthropicHttpClientBuilderCustomizer) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Registers an
AnthropicHttpClientBuilderCustomizerthat mutates the underlying OkHttp client builder before the Anthropic clients are constructed. - httpClientBuilderCustomizers(List<AnthropicHttpClientBuilderCustomizer>) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Sets the full list of
customizersto apply, replacing any customizers registered earlier on this builder. - httpHeaders(Map<String, String>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
I
- inferenceGeo(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Sets the geographic region for inference processing.
- interceptor(Interceptor) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
-
Adds an OkHttp application interceptor.
- internalCall(Prompt, ChatResponse) - Method in class org.springframework.ai.anthropic.AnthropicChatModel
-
Internal method to handle synchronous chat completion calls with tool execution support.
- internalStream(Prompt, ChatResponse) - Method in class org.springframework.ai.anthropic.AnthropicChatModel
-
Internal method to handle streaming chat completion calls with tool execution support.
- isCacheToolResults() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions
-
Whether a
cache_controlbreakpoint is placed on the last tool result message of a request, so that tool outputs are written to (and read from) the cache across tool-calling rounds. - isCachingEnabled() - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver
- isCitationsEnabled() - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument
- isMultiBlockSystemCaching() - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions
K
- keepAliveDuration(Duration) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
M
- maxIdleConnections(Integer) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- maxRetries(Integer) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- maxUses(long) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder
- messageTypeMinContentLength(MessageType, Integer) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- messageTypeMinContentLengths(Map<MessageType, Integer>) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- messageTypeTtl(Map<MessageType, AnthropicCacheTtl>) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- messageTypeTtl(MessageType, AnthropicCacheTtl) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- metadata(Metadata) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- meterRegistry(MeterRegistry) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Sets the meter registry used to bind OkHttp connection-pool gauges (active/idle connections).
- meterRegistry(MeterRegistry) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
-
Registers a meter registry to bind OkHttp connection-pool gauges (active/idle connections).
- meterTags(Iterable<Tag>) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
-
Tags applied to the connection-pool gauges registered with the
MeterRegistry. - model(Model) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- multiBlockSystemCaching(Boolean) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- mutate() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
N
- NONE - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy
-
No caching (default behavior).
O
- observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Sets the observation registry for metrics and tracing.
- observationRegistry(ObservationRegistry) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
-
Registers the Micrometer observation registry used by the OkHttp interceptor.
- ofCharLocation(String, int, String, int, int) - Static method in class org.springframework.ai.anthropic.Citation
-
Create a character location citation for plain text documents.
- ofContentBlockLocation(String, int, String, int, int) - Static method in class org.springframework.ai.anthropic.Citation
-
Create a content block location citation for custom content documents.
- ofPageLocation(String, int, String, int, int) - Static method in class org.springframework.ai.anthropic.Citation
-
Create a page location citation for PDF documents.
- ofWebSearchResultLocation(String, String, String) - Static method in class org.springframework.ai.anthropic.Citation
-
Create a web search result location citation.
- ONE_HOUR - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheTtl
- options(AnthropicChatOptions) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Sets the chat options.
- org.springframework.ai.anthropic - package org.springframework.ai.anthropic
-
Spring AI integration with Anthropic's Claude models using the official Anthropic Java SDK.
- org.springframework.ai.anthropic.http.okhttp - package org.springframework.ai.anthropic.http.okhttp
-
Spring AI's customized OkHttp-backed implementation of the Anthropic Java SDK's
HttpClientcontract. - org.springframework.ai.anthropic.metadata - package org.springframework.ai.anthropic.metadata
-
Metadata support classes for the Anthropic chat model.
- outputConfig(OutputConfig) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Sets the output configuration for controlling response format and effort.
- outputSchema(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
P
- PAGE_LOCATION - Enum constant in enum class org.springframework.ai.anthropic.Citation.LocationType
-
Page-based location for PDF documents
- pageAge() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult
-
Returns the value of the
pageAgerecord component. - pdf(byte[]) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
-
Create a PDF document from byte array.
- PDF - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType
-
PDF document with page-based citations.
- PDF - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkill
-
PDF document creation.
- pdfFile(String) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
-
Create a PDF document from file path.
- PLAIN_TEXT - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType
-
Plain text document with character-based citations.
- plainText(String) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
-
Create a plain text document.
- PPTX - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkill
-
PowerPoint presentation creation.
- proxy(Proxy) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- proxy(Proxy) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- proxyAuthenticator(ProxyAuthenticator) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
R
- region() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation
-
Returns the value of the
regionrecord component. - resolve(MessageType, String) - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver
- resolveToolCacheControl() - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver
S
- serviceTier(AnthropicServiceTier) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Sets the service tier for capacity routing.
- setAllowedDomains(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- setBlockedDomains(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- setMaxUses(Long) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- setObservationConvention(ChatModelObservationConvention) - Method in class org.springframework.ai.anthropic.AnthropicChatModel
-
Use the provided convention for reporting observation data.
- setupAsyncClient(String, String, Duration, Integer, Proxy, Map<String, String>) - Static method in class org.springframework.ai.anthropic.AnthropicSetup
-
Creates an asynchronous Anthropic client with the specified configuration.
- setupAsyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry) - Static method in class org.springframework.ai.anthropic.AnthropicSetup
-
Creates an asynchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer.
- setupAsyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, ExecutorService) - Static method in class org.springframework.ai.anthropic.AnthropicSetup
-
Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor.
- setupAsyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, ExecutorService, List<AnthropicHttpClientBuilderCustomizer>) - Static method in class org.springframework.ai.anthropic.AnthropicSetup
-
Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers.
- setupSyncClient(String, String, Duration, Integer, Proxy, Map<String, String>) - Static method in class org.springframework.ai.anthropic.AnthropicSetup
-
Creates a synchronous Anthropic client with the specified configuration.
- setupSyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry) - Static method in class org.springframework.ai.anthropic.AnthropicSetup
-
Creates a synchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer: each HTTP attempt emits an observation (span + metric +
traceparentpropagation), and, when aMeterRegistryis supplied, OkHttp connection-pool gauges are bound to it. - setupSyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, ExecutorService) - Static method in class org.springframework.ai.anthropic.AnthropicSetup
-
Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor (e.g. one built around
Executors.newVirtualThreadPerTaskExecutor()on Java 21+). - setupSyncClient(String, String, Duration, Integer, Proxy, Map<String, String>, ObservationRegistry, MeterRegistry, ExecutorService, List<AnthropicHttpClientBuilderCustomizer>) - Static method in class org.springframework.ai.anthropic.AnthropicSetup
-
Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers.
- setUserLocation(AnthropicWebSearchTool.UserLocation) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool
- skill(String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- skill(String) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
-
Add a skill by its ID or name.
- skill(String, String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- skill(String, String) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
-
Add a skill by its ID or name with a specific version.
- skill(AnthropicSkill) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- skill(AnthropicSkill) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
-
Add a pre-built Anthropic skill using the enum.
- skill(AnthropicSkillRecord) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- skill(AnthropicSkillRecord) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
-
Add a skill record directly.
- skill(AnthropicSkill, String) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- skill(AnthropicSkill, String) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
-
Add a pre-built Anthropic skill with a specific version.
- skillContainer(AnthropicSkillContainer) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- skillId(String) - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder
- skills(String...) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- skills(String...) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
-
Add multiple skills by their IDs or names.
- skills(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- skills(List<String>) - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer.Builder
-
Add multiple skills from a list of IDs or names.
- SpringAiAnthropicHttpClient - Class in org.springframework.ai.anthropic.http.okhttp
-
OkHttp-backed
HttpClientfor the Anthropic Java SDK, with Micrometer'sOkHttpObservationInterceptorattached so each HTTP attempt produces an observation (span + metric + traceparent propagation). - SpringAiAnthropicHttpClient.Builder - Class in org.springframework.ai.anthropic.http.okhttp
-
Builder for
SpringAiAnthropicHttpClient. - sslSocketFactory(SSLSocketFactory) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- STANDARD_ONLY - Enum constant in enum class org.springframework.ai.anthropic.AnthropicServiceTier
-
Always use standard capacity.
- strategy(AnthropicCacheStrategy) - Method in class org.springframework.ai.anthropic.AnthropicCacheOptions.Builder
- stream(Prompt) - Method in class org.springframework.ai.anthropic.AnthropicChatModel
-
Streams the chat completion as a
FluxofChatResponseevents. - SYSTEM_AND_TOOLS - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy
-
Cache system instructions and tool definitions.
- SYSTEM_ONLY - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy
-
Cache system instructions only.
T
- thinking(ThinkingConfigParam) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- thinkingAdaptive() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Convenience method to let Claude adaptively decide whether to think.
- thinkingAdaptive(ThinkingConfigAdaptive.Display) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Convenience method to let Claude adaptively decide whether to think, with a display setting.
- thinkingDisabled() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Convenience method to explicitly disable thinking.
- thinkingEnabled(long) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Convenience method to enable thinking with a specific budget in tokens.
- thinkingEnabled(long, ThinkingConfigEnabled.Display) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Convenience method to enable thinking with a specific budget and display setting.
- timeout(Duration) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- timeout(Timeout) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- timeout(Duration) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- timezone() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation
-
Returns the value of the
timezonerecord component. - title() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult
-
Returns the value of the
titlerecord component. - title(String) - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument.Builder
-
Set the document title.
- toDocumentBlockParam() - Method in class org.springframework.ai.anthropic.AnthropicCitationDocument
-
Convert this citation document to an SDK
DocumentBlockParam. - toJsonMap() - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord
-
Convert to a map suitable for JSON serialization via
JsonValue.from(). - toolCallingManager(ToolCallingManager) - Method in class org.springframework.ai.anthropic.AnthropicChatModel.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- toolChoice(ToolChoice) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
- TOOLS_ONLY - Enum constant in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy
-
Cache tool definitions only.
- toSdkServiceTier() - Method in enum class org.springframework.ai.anthropic.AnthropicServiceTier
-
Converts this enum to the corresponding SDK
MessageCreateParams.ServiceTiervalue. - toSkill() - Method in enum class org.springframework.ai.anthropic.AnthropicSkill
-
Convert to an
AnthropicSkillRecordwith latest version. - toSkill(String) - Method in enum class org.springframework.ai.anthropic.AnthropicSkill
-
Convert to an
AnthropicSkillRecordwith specific version. - toSkillsList() - Method in class org.springframework.ai.anthropic.AnthropicSkillContainer
-
Convert to a list of maps suitable for JSON serialization via
JsonValue.from(Map.of("skills", container.toSkillsList())). - toString() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation
-
Returns a string representation of this record class.
- toString() - Method in class org.springframework.ai.anthropic.Citation
- toString() - Method in class org.springframework.ai.anthropic.metadata.AnthropicRateLimit
- trustManager(X509TrustManager) - Method in class org.springframework.ai.anthropic.http.okhttp.SpringAiAnthropicHttpClient.Builder
- type(AnthropicSkillType) - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder
U
- url() - Method in record class org.springframework.ai.anthropic.AnthropicWebSearchResult
-
Returns the value of the
urlrecord component. - useCacheBlock() - Method in class org.springframework.ai.anthropic.CacheEligibilityResolver
- userLocation(String, String, String, String) - Method in class org.springframework.ai.anthropic.AnthropicWebSearchTool.Builder
- UserLocation(String, String, String, String) - Constructor for record class org.springframework.ai.anthropic.AnthropicWebSearchTool.UserLocation
-
Creates an instance of a
UserLocationrecord class.
V
- validateCitationConsistency() - Method in class org.springframework.ai.anthropic.AnthropicChatOptions
-
Validate that all citation documents have consistent citation settings.
- valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicCacheTtl
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicServiceTier
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicSkill
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.anthropic.AnthropicSkillType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.ai.anthropic.Citation.LocationType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.ai.anthropic.AnthropicCacheStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.anthropic.AnthropicCacheTtl
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.anthropic.AnthropicCitationDocument.DocumentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.anthropic.AnthropicServiceTier
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.anthropic.AnthropicSkill
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.anthropic.AnthropicSkillType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.ai.anthropic.Citation.LocationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version(String) - Method in class org.springframework.ai.anthropic.AnthropicSkillRecord.Builder
W
- WEB_SEARCH_RESULT_LOCATION - Enum constant in enum class org.springframework.ai.anthropic.Citation.LocationType
-
URL-based location for web search results
- webSearchTool(AnthropicWebSearchTool) - Method in class org.springframework.ai.anthropic.AnthropicChatOptions.AbstractBuilder
-
Enables Anthropic's built-in web search tool with the given configuration.
X
- XLSX - Enum constant in enum class org.springframework.ai.anthropic.AnthropicSkill
-
Excel spreadsheet generation and manipulation.
All Classes and Interfaces|All Packages
AnthropicChatModelis superseded byToolCallingAdvisorused viaChatClient.