Package org.springframework.ai.anthropic

Class AnthropicChatModel

java.lang.Object

org.springframework.ai.chat.model.AbstractToolCallSupport

org.springframework.ai.anthropic.AnthropicChatModel

All Implemented Interfaces:

ChatModel, StreamingChatModel, Model<Prompt,ChatResponse>, StreamingModel<Prompt,ChatResponse>

public class AnthropicChatModel
extends AbstractToolCallSupport
implements ChatModel

The ChatModel implementation for the Anthropic service.

Since:

1.0.0

Author:

Christian Tzolov, luocongqiu, Mariusz Bernacki, Thomas Vitale, Claudio Silva Junior

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	DEFAULT_MAX_TOKENS
static final String	DEFAULT_MODEL_NAME
static final Double	DEFAULT_TEMPERATURE
final org.springframework.retry.support.RetryTemplate	retryTemplate	The retry template used to retry the OpenAI API calls.

Fields inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

functionCallbackContext, functionCallbackRegister, IS_RUNTIME_CALL

Constructor Summary

Constructors

Constructor	Description
AnthropicChatModel(AnthropicApi anthropicApi)	Construct a new AnthropicChatModel instance.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions)	Construct a new AnthropicChatModel instance.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, org.springframework.retry.support.RetryTemplate retryTemplate)	Construct a new AnthropicChatModel instance.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, org.springframework.retry.support.RetryTemplate retryTemplate, FunctionCallbackContext functionCallbackContext)	Construct a new AnthropicChatModel instance.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, org.springframework.retry.support.RetryTemplate retryTemplate, FunctionCallbackContext functionCallbackContext, List<FunctionCallback> toolFunctionCallbacks)	Construct a new AnthropicChatModel instance.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, org.springframework.retry.support.RetryTemplate retryTemplate, FunctionCallbackContext functionCallbackContext, List<FunctionCallback> toolFunctionCallbacks, io.micrometer.observation.ObservationRegistry observationRegistry)	Construct a new AnthropicChatModel instance.

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
ChatOptions	getDefaultOptions()
void	setObservationConvention(ChatModelObservationConvention observationConvention)	Use the provided convention for reporting observation data
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

buildToolCallConversation, executeFunctions, getFunctionCallbackRegister, handleToolCalls, isProxyToolCalls, isToolCall, isToolCall, resolveFunctionCallbacks, runtimeFunctionCallbackConfigurations

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.chat.model.ChatModel

call, call

Methods inherited from interface org.springframework.ai.chat.model.StreamingChatModel

stream, stream

Field Details

DEFAULT_MODEL_NAME

public static final String DEFAULT_MODEL_NAME

DEFAULT_MAX_TOKENS

public static final Integer DEFAULT_MAX_TOKENS

DEFAULT_TEMPERATURE

public static final Double DEFAULT_TEMPERATURE

retryTemplate

public final org.springframework.retry.support.RetryTemplate retryTemplate

The retry template used to retry the OpenAI API calls.

Constructor Details

AnthropicChatModel

public AnthropicChatModel(AnthropicApi anthropicApi)

Construct a new AnthropicChatModel instance.

Parameters:

anthropicApi - the lower-level API for the Anthropic service.

AnthropicChatModel

public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions)

Construct a new AnthropicChatModel instance.

Parameters:

anthropicApi - the lower-level API for the Anthropic service.

defaultOptions - the default options used for the chat completion requests.

AnthropicChatModel

public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Construct a new AnthropicChatModel instance.

Parameters:

anthropicApi - the lower-level API for the Anthropic service.

defaultOptions - the default options used for the chat completion requests.

retryTemplate - the retry template used to retry the Anthropic API calls.

AnthropicChatModel

public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 FunctionCallbackContext functionCallbackContext)

Construct a new AnthropicChatModel instance.

Parameters:

anthropicApi - the lower-level API for the Anthropic service.

defaultOptions - the default options used for the chat completion requests.

retryTemplate - the retry template used to retry the Anthropic API calls.

functionCallbackContext - the function callback context used to store the state of the function calls.

AnthropicChatModel

public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 FunctionCallbackContext functionCallbackContext,
 List<FunctionCallback> toolFunctionCallbacks)

Construct a new AnthropicChatModel instance.

Parameters:

anthropicApi - the lower-level API for the Anthropic service.

defaultOptions - the default options used for the chat completion requests.

retryTemplate - the retry template used to retry the Anthropic API calls.

functionCallbackContext - the function callback context used to store the state of the function calls.

toolFunctionCallbacks - the tool function callbacks used to handle the tool calls.

AnthropicChatModel

public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 FunctionCallbackContext functionCallbackContext,
 List<FunctionCallback> toolFunctionCallbacks,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Construct a new AnthropicChatModel instance.

Parameters:

anthropicApi - the lower-level API for the Anthropic service.

defaultOptions - the default options used for the chat completion requests.

retryTemplate - the retry template used to retry the Anthropic API calls.

functionCallbackContext - the function callback context used to store the state of the function calls.

toolFunctionCallbacks - the tool function callbacks used to handle the tool calls.

Method Details

call

public ChatResponse call(Prompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ChatModel

Specified by:

call in interface Model<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the response from the AI model

stream

public reactor.core.publisher.Flux<ChatResponse> stream(Prompt prompt)

Description copied from interface: StreamingModel

Executes a method call to the AI model.

Specified by:

stream in interface ChatModel

Specified by:

stream in interface StreamingChatModel

Specified by:

stream in interface StreamingModel<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the streaming response from the AI model

getDefaultOptions

public ChatOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface ChatModel

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention