Deprecated API

Contents

• Terminally Deprecated
• Interfaces
• Classes
• Fields
• Methods
• Constructors
• Enum Constants

Terminally Deprecated Elements

Element	Description
org.springframework.ai.document.Document.Builder.content(String)	since 1.0.0-M5, use Document.Builder.text(String) instead as it more accurately reflects that this Document instance will contain text rather than generic content. This method will be removed in a future release.
org.springframework.ai.embedding.EmbeddingOptions.EMPTY
org.springframework.ai.mistralai.api.MistralAiApi.ChatModel.MEDIUM

Deprecated Interfaces

Interface	Description
org.springframework.ai.chat.client.RequestResponseAdvisor	since 1.0.0 M3 please use CallAroundAdvisor or StreamAroundAdvisor instead.

Deprecated Classes

Class	Description
org.springframework.ai.bedrock.anthropic.BedrockAnthropicChatModel	in favor of the BedrockProxyChatModel.
org.springframework.ai.bedrock.anthropic3.BedrockAnthropic3ChatModel	in favor of the BedrockProxyChatModel.
org.springframework.ai.bedrock.cohere.BedrockCohereChatModel	in favor of the BedrockProxyChatModel.
org.springframework.ai.bedrock.jurassic2.BedrockAi21Jurassic2ChatModel	in favor of the BedrockProxyChatModel.
org.springframework.ai.bedrock.llama.BedrockLlamaChatModel	in favor of the BedrockProxyChatModel.
org.springframework.ai.bedrock.titan.BedrockTitanChatModel	in favor of the BedrockProxyChatModel.
org.springframework.ai.model.function.FunctionCallbackWrapper	in favor of FunctionCallback.Builder
org.springframework.ai.model.function.FunctionCallbackWrapper.Builder	in favor of DefaultFunctionCallbackBuilder

Deprecated Fields

Field	Description
org.springframework.ai.embedding.EmbeddingOptions.EMPTY
org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer.tokenNames	Use FiltersLexer.VOCABULARY instead.
org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.tokenNames	Use FiltersParser.VOCABULARY instead.

Deprecated Methods

Method	Description
org.springframework.ai.bedrock.converse.BedrockProxyChatModel.Builder.withFunctionCallbackContext(FunctionCallbackResolver)	Use BedrockProxyChatModel.Builder.functionCallbackResolver(FunctionCallbackResolver) instead.
org.springframework.ai.chat.client.ChatClient.Builder.defaultFunction(String, String, BiFunction<I, ToolContext, O>)	use ChatClient.Builder.defaultFunctions(FunctionCallback...) instead.
org.springframework.ai.chat.client.ChatClient.Builder.defaultFunction(String, String, Function<I, O>)	use ChatClient.Builder.defaultFunctions(FunctionCallback...) instead.
org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec.function(String, String, Class<I>, Function<I, O>)	use ChatClient.ChatClientRequestSpec.functions(FunctionCallback...) instead.
org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec.function(String, String, BiFunction<I, ToolContext, O>)	use ChatClient.ChatClientRequestSpec.functions(FunctionCallback...) instead.
org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec.function(String, String, Function<I, O>)	use ChatClient.ChatClientRequestSpec.functions(FunctionCallback...) instead.
org.springframework.ai.chat.model.ChatResponse.Builder.withGenerations(List<Generation>)	Use ChatResponse.Builder.generations(List) instead.
org.springframework.ai.chat.model.ChatResponse.Builder.withMetadata(String, Object)	Use ChatResponse.Builder.metadata(String, Object) instead.
org.springframework.ai.document.Document.Builder.content(String)	since 1.0.0-M5, use Document.Builder.text(String) instead as it more accurately reflects that this Document instance will contain text rather than generic content. This method will be removed in a future release.
org.springframework.ai.document.Document.getContentFormatter()	We are considering getting rid of this, please comment on https://github.com/spring-projects/spring-ai/issues/1782
org.springframework.ai.model.Content.getContent()	Use getText
org.springframework.ai.model.function.FunctionCallbackWrapper.builder(BiFunction<I, ToolContext, O>)	use FunctionCallback.builder() instead.
org.springframework.ai.model.function.FunctionCallbackWrapper.builder(Function<I, O>)	use FunctionCallback.builder() instead.
org.springframework.ai.model.ModelOptionsUtils.getJsonSchema(Class<?>, boolean)	use ModelOptionsUtils.getJsonSchema(Type, boolean) instead.
org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder.function(String)
org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder.functionCallbacks(List<FunctionCallback>)
org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder.functionCallbacks(FunctionCallback...)
org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder.functions(Set<String>)
org.springframework.ai.model.tool.DefaultToolCallingChatOptions.Builder.proxyToolCalls(Boolean)
org.springframework.ai.model.tool.ToolCallingChatOptions.Builder.function(String)
org.springframework.ai.model.tool.ToolCallingChatOptions.Builder.functionCallbacks(List<FunctionCallback>)
org.springframework.ai.model.tool.ToolCallingChatOptions.Builder.functionCallbacks(FunctionCallback...)
org.springframework.ai.model.tool.ToolCallingChatOptions.Builder.functions(Set<String>)
org.springframework.ai.model.tool.ToolCallingChatOptions.Builder.proxyToolCalls(Boolean)
org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.maxTokens()
org.springframework.ai.openai.metadata.OpenAiUsage.getAcceptedPredictionTokens()	Use OpenAiUsage.getCompletionTokenDetails() instead.
org.springframework.ai.openai.metadata.OpenAiUsage.getAudioTokens()	Use OpenAiUsage.getCompletionTokenDetails() instead.
org.springframework.ai.openai.metadata.OpenAiUsage.getPromptTokensDetailsCachedTokens()	Use OpenAiUsage.getPromptTokensDetails() instead.
org.springframework.ai.openai.metadata.OpenAiUsage.getReasoningTokens()	Use OpenAiUsage.getCompletionTokenDetails() instead.
org.springframework.ai.openai.metadata.OpenAiUsage.getRejectedPredictionTokens()	Use OpenAiUsage.getCompletionTokenDetails() instead.
org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer.getTokenNames()
org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.getTokenNames()

Deprecated Constructors

Constructor	Description
org.springframework.ai.evaluation.EvaluationResponse(boolean, float, String, Map<String, Object>)
org.springframework.ai.model.Media(MimeType, Resource, String)	Use Media.Builder instead.

Deprecated Enum Constants

Enum Constant	Description
org.springframework.ai.anthropic.api.AnthropicApi.ChatModel.CLAUDE_INSTANT_1_2
org.springframework.ai.mistralai.api.MistralAiApi.ChatModel.MEDIUM