Package org.springframework.ai.anthropic.api

Class AnthropicApi

java.lang.Object

org.springframework.ai.anthropic.api.AnthropicApi

public class AnthropicApi
extends Object

The Anthropic API client.

Since:

1.0.0

Author:

Christian Tzolov, Mariusz Bernacki, Thomas Vitale, Jihoon Kim

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AnthropicApi.AnthropicMessage	Input messages.
static final record	AnthropicApi.ChatCompletionRequest	Chat completion request object.
static final class	AnthropicApi.ChatCompletionRequestBuilder
static final record	AnthropicApi.ChatCompletionResponse	Chat completion response object.
static enum	AnthropicApi.ChatModel	Check the Models overview and model comparison for additional details and options.
static final record	AnthropicApi.ContentBlock	The content block of the message.
static final record	AnthropicApi.ContentBlockDeltaEvent	Content block delta event.
static final record	AnthropicApi.ContentBlockStartEvent	Content block start event.
static final record	AnthropicApi.ContentBlockStopEvent	Content block stop event.
static final record	AnthropicApi.ErrorEvent	Error event.
static enum	AnthropicApi.EventType	The event type of the streamed chunk.
static final record	AnthropicApi.MessageDeltaEvent	Message delta event.
static final record	AnthropicApi.MessageStartEvent	Message start event.
static final record	AnthropicApi.MessageStopEvent	Message stop event.
static final record	AnthropicApi.PingEvent	Ping event.
static enum	AnthropicApi.Role	The role of the author of this message.
static interface	AnthropicApi.StreamEvent
static final record	AnthropicApi.Tool	Tool description.
static class	AnthropicApi.ToolUseAggregationEvent	Special event used to aggregate multiple tool use events into a single event with list of aggregated ContentBlockToolUse.
static final record	AnthropicApi.Usage	Usage statistics.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BETA_MAX_TOKENS
static final String	DEFAULT_ANTHROPIC_BETA_VERSION
static final String	DEFAULT_ANTHROPIC_VERSION
static final String	DEFAULT_BASE_URL
static final String	PROVIDER_NAME

Constructor Summary

Constructors

Constructor	Description
AnthropicApi(String anthropicApiKey)	Create a new client api with DEFAULT_BASE_URL
AnthropicApi(String baseUrl, String anthropicApiKey)	Create a new client api.
AnthropicApi(String baseUrl, String anthropicApiKey, String anthropicVersion, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new client api.
AnthropicApi(String baseUrl, String anthropicApiKey, String anthropicVersion, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler, String anthropicBetaFeatures)	Create a new client api.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<AnthropicApi.ChatCompletionResponse>	chatCompletionEntity(AnthropicApi.ChatCompletionRequest chatRequest)	Creates a model response for the given chat conversation.
reactor.core.publisher.Flux<AnthropicApi.ChatCompletionResponse>	chatCompletionStream(AnthropicApi.ChatCompletionRequest chatRequest)	Creates a streaming chat response for the given chat conversation.

Methods inherited from class java.lang.Object

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

Field Details

PROVIDER_NAME

public static final String PROVIDER_NAME

DEFAULT_BASE_URL

public static final String DEFAULT_BASE_URL

See Also:

• Constant Field Values

DEFAULT_ANTHROPIC_VERSION

public static final String DEFAULT_ANTHROPIC_VERSION

See Also:

• Constant Field Values

DEFAULT_ANTHROPIC_BETA_VERSION

public static final String DEFAULT_ANTHROPIC_BETA_VERSION

See Also:

• Constant Field Values

BETA_MAX_TOKENS

public static final String BETA_MAX_TOKENS

See Also:

• Constant Field Values

Constructor Details

AnthropicApi

public AnthropicApi(String anthropicApiKey)

Create a new client api with DEFAULT_BASE_URL

Parameters:

anthropicApiKey - Anthropic api Key.

AnthropicApi

public AnthropicApi(String baseUrl,
 String anthropicApiKey)

Create a new client api.

Parameters:

baseUrl - api base URL.

anthropicApiKey - Anthropic api Key.

AnthropicApi

public AnthropicApi(String baseUrl,
 String anthropicApiKey,
 String anthropicVersion,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new client api.

Parameters:

baseUrl - api base URL.

anthropicApiKey - Anthropic api Key.

restClientBuilder - RestClient builder.

webClientBuilder - WebClient builder.

responseErrorHandler - Response error handler.

AnthropicApi

public AnthropicApi(String baseUrl,
 String anthropicApiKey,
 String anthropicVersion,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler,
 String anthropicBetaFeatures)

Create a new client api.

Parameters:

baseUrl - api base URL.

anthropicApiKey - Anthropic api Key.

anthropicVersion - Anthropic version.

restClientBuilder - RestClient builder.

webClientBuilder - WebClient builder.

responseErrorHandler - Response error handler.

anthropicBetaFeatures - Anthropic beta features.

Method Details

chatCompletionEntity

public org.springframework.http.ResponseEntity<AnthropicApi.ChatCompletionResponse> chatCompletionEntity(AnthropicApi.ChatCompletionRequest chatRequest)

Creates a model response for the given chat conversation.

Parameters:

chatRequest - The chat completion request.

Returns:

Entity response with AnthropicApi.ChatCompletionResponse as a body and HTTP status code and headers.

chatCompletionStream

public reactor.core.publisher.Flux<AnthropicApi.ChatCompletionResponse> chatCompletionStream(AnthropicApi.ChatCompletionRequest chatRequest)

Creates a streaming chat response for the given chat conversation.

Parameters:

chatRequest - The chat completion request. Must have the stream property set to true.

Returns:

Returns a Flux stream from chat completion chunks.