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, Alexandros Pappas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AnthropicChatModel.Builder

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

functionCallbackRegister, functionCallbackResolver, IS_RUNTIME_CALL

Constructor Summary

Constructors

Constructor	Description
AnthropicChatModel(AnthropicApi anthropicApi)	Deprecated. Use AnthropicChatModel.Builder.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions)	Deprecated. Use AnthropicChatModel.Builder.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, ToolCallingManager toolCallingManager, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, org.springframework.retry.support.RetryTemplate retryTemplate)	Deprecated. Use AnthropicChatModel.Builder.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, org.springframework.retry.support.RetryTemplate retryTemplate, FunctionCallbackResolver functionCallbackResolver)	Deprecated. Use AnthropicChatModel.Builder.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, org.springframework.retry.support.RetryTemplate retryTemplate, FunctionCallbackResolver functionCallbackResolver, List<FunctionCallback> toolFunctionCallbacks)	Deprecated. Use AnthropicChatModel.Builder.
AnthropicChatModel(AnthropicApi anthropicApi, AnthropicChatOptions defaultOptions, org.springframework.retry.support.RetryTemplate retryTemplate, FunctionCallbackResolver functionCallbackResolver, List<FunctionCallback> toolFunctionCallbacks, io.micrometer.observation.ObservationRegistry observationRegistry)	Deprecated. Use AnthropicChatModel.Builder.

Method Summary

Modifier and Type	Method	Description
static AnthropicChatModel.Builder	builder()
ChatResponse	call(Prompt prompt)
ChatOptions	getDefaultOptions()
ChatResponse	internalCall(Prompt prompt, ChatResponse previousChatResponse)
reactor.core.publisher.Flux<ChatResponse>	internalStream(Prompt prompt, ChatResponse previousChatResponse)
void	setObservationConvention(ChatModelObservationConvention observationConvention)	Use the provided convention for reporting observation data
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)

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

@Deprecated
public AnthropicChatModel(AnthropicApi anthropicApi)

Deprecated.

Use AnthropicChatModel.Builder.

Construct a new AnthropicChatModel instance.

Parameters:

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

AnthropicChatModel

@Deprecated
public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions)

Deprecated.

Use AnthropicChatModel.Builder.

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

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

Deprecated.

Use AnthropicChatModel.Builder.

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

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

Deprecated.

Use AnthropicChatModel.Builder.

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.

functionCallbackResolver - the function callback resolver used to resolve the function by its name.

AnthropicChatModel

@Deprecated
public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 FunctionCallbackResolver functionCallbackResolver,
 List<FunctionCallback> toolFunctionCallbacks)

Deprecated.

Use AnthropicChatModel.Builder.

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.

functionCallbackResolver - the function callback resolver used to resolve the function by its name.

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

AnthropicChatModel

@Deprecated
public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 @Nullable
 FunctionCallbackResolver functionCallbackResolver,
 @Nullable
 List<FunctionCallback> toolFunctionCallbacks,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Deprecated.

Use AnthropicChatModel.Builder.

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.

functionCallbackResolver - the function callback resolver used to resolve the function by its name.

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

AnthropicChatModel

public AnthropicChatModel(AnthropicApi anthropicApi,
 AnthropicChatOptions defaultOptions,
 ToolCallingManager toolCallingManager,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Method Details

call

public ChatResponse call(Prompt prompt)

Specified by:

call in interface ChatModel

Specified by:

call in interface Model<Prompt,ChatResponse>

internalCall

public ChatResponse internalCall(Prompt prompt,
 ChatResponse previousChatResponse)

stream

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

Specified by:

stream in interface ChatModel

Specified by:

stream in interface StreamingChatModel

Specified by:

stream in interface StreamingModel<Prompt,ChatResponse>

internalStream

public reactor.core.publisher.Flux<ChatResponse> internalStream(Prompt prompt,
 ChatResponse previousChatResponse)

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

builder

public static AnthropicChatModel.Builder builder()