Deprecated API

Contents

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

Terminally Deprecated Elements

Element	Description
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withMaxTokens(Integer)	use AnthropicApi.ChatCompletionRequestBuilder.maxTokens(Integer) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withMessages(List<AnthropicApi.AnthropicMessage>)	use AnthropicApi.ChatCompletionRequestBuilder.messages(List) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withMetadata(AnthropicApi.ChatCompletionRequest.Metadata)	use AnthropicApi.ChatCompletionRequestBuilder.metadata(ChatCompletionRequest.Metadata) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withModel(String)	use AnthropicApi.ChatCompletionRequestBuilder.model(String) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withModel(AnthropicApi.ChatModel)	use AnthropicApi.ChatCompletionRequestBuilder.model(ChatModel) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withStopSequences(List<String>)	use AnthropicApi.ChatCompletionRequestBuilder.stopSequences(List) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withStream(Boolean)	use AnthropicApi.ChatCompletionRequestBuilder.stream(Boolean) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withSystem(String)	use AnthropicApi.ChatCompletionRequestBuilder.system(String) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withTemperature(Double)	use AnthropicApi.ChatCompletionRequestBuilder.temperature(Double) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withThinking(AnthropicApi.ChatCompletionRequest.ThinkingConfig)	use AnthropicApi.ChatCompletionRequestBuilder.thinking(ChatCompletionRequest.ThinkingConfig) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withThinking(AnthropicApi.ThinkingType, Integer)	use AnthropicApi.ChatCompletionRequestBuilder.thinking(ThinkingType, Integer) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withTools(List<AnthropicApi.Tool>)	use AnthropicApi.ChatCompletionRequestBuilder.tools(List) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withTopK(Integer)	use AnthropicApi.ChatCompletionRequestBuilder.topK(Integer) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withTopP(Double)	use AnthropicApi.ChatCompletionRequestBuilder.topP(Double) instead.
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore)
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore, String)
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore, String, int)
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore, String, int, int)
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore, String, int, String)
org.springframework.ai.chat.observation.ChatModelObservationContext.Builder.requestOptions(ChatOptions)	ChatOptions are passed in the Prompt object and should not be set separately anymore.
org.springframework.ai.chat.observation.ChatModelObservationContext.getRequestOptions()	Use {@link #getRequest().getOptions()} instead.
org.springframework.ai.embedding.observation.EmbeddingModelObservationContext.Builder.requestOptions(EmbeddingOptions)	EmbeddingOptions are passed in the EmbeddingRequest object and should not be set separately anymore.
org.springframework.ai.embedding.observation.EmbeddingModelObservationContext.getRequestOptions()	Use {@link #getRequest().getOptions()} instead.
org.springframework.ai.image.observation.ImageModelObservationContext.Builder.requestOptions(ImageOptions)	ImageOptions are passed in the ImagePrompt object and should not be set separately anymore.
org.springframework.ai.image.observation.ImageModelObservationContext.getRequestOptions()	Use {@link #getRequest().getOptions()} instead.
org.springframework.ai.vectorstore.SimpleVectorStoreContent.withEmbedding(float[])

Deprecated Interfaces

Interface	Description
org.springframework.ai.model.function.FunctionCallback	in favor of ToolCallback.
org.springframework.ai.model.function.FunctionCallback.Builder	Use specific builder for the type of tool you need, e.g. FunctionToolCallback.Builder and MethodToolCallback.Builder.
org.springframework.ai.model.function.FunctionCallbackResolver	Use ToolCallbackResolver instead.
org.springframework.ai.model.function.FunctionCallingOptions	in favor of ToolCallingChatOptions.

Deprecated Classes

Class	Description
org.springframework.ai.chat.model.AbstractToolCallSupport	Use ToolCallingManager instead.
org.springframework.ai.model.function.DefaultCommonCallbackInvokingSpec	Use specific builder for the type of tool you need, e.g. FunctionToolCallback.Builder and MethodToolCallback.Builder.
org.springframework.ai.model.function.DefaultFunctionCallbackBuilder	Use specific builder for the type of tool you need, e.g. FunctionToolCallback.Builder and MethodToolCallback.Builder.
org.springframework.ai.model.function.DefaultFunctionCallbackResolver	Use SpringBeanToolCallbackResolver instead.
org.springframework.ai.model.function.DefaultFunctionCallingOptions	in favor of DefaultToolCallingChatOptions.
org.springframework.ai.model.function.DefaultFunctionCallingOptionsBuilder	in favor of DefaultToolCallingChatOptions.Builder.
org.springframework.ai.model.function.FunctionCallingHelper	Use ToolCallingManager instead.
org.springframework.ai.model.function.FunctionInvokingFunctionCallback	in favor of FunctionToolCallback.
org.springframework.ai.model.function.MethodInvokingFunctionCallback	in favor of MethodToolCallback.
org.springframework.ai.model.tool.LegacyToolCallingManager	Only to help moving away from AbstractToolCallSupport. It will be removed in the next milestone.

Deprecated Fields

Field	Description
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.anthropic.AnthropicChatOptions.Builder.function(String)
org.springframework.ai.anthropic.AnthropicChatOptions.Builder.functionCallbacks(List<FunctionCallback>)
org.springframework.ai.anthropic.AnthropicChatOptions.Builder.functions(Set<String>)
org.springframework.ai.anthropic.AnthropicChatOptions.Builder.proxyToolCalls(Boolean)
org.springframework.ai.anthropic.AnthropicChatOptions.getFunctionCallbacks()
org.springframework.ai.anthropic.AnthropicChatOptions.getFunctions()
org.springframework.ai.anthropic.AnthropicChatOptions.getProxyToolCalls()
org.springframework.ai.anthropic.AnthropicChatOptions.setFunctionCallbacks(List<FunctionCallback>)
org.springframework.ai.anthropic.AnthropicChatOptions.setFunctions(Set<String>)
org.springframework.ai.anthropic.AnthropicChatOptions.setProxyToolCalls(Boolean)
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withMaxTokens(Integer)	use AnthropicApi.ChatCompletionRequestBuilder.maxTokens(Integer) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withMessages(List<AnthropicApi.AnthropicMessage>)	use AnthropicApi.ChatCompletionRequestBuilder.messages(List) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withMetadata(AnthropicApi.ChatCompletionRequest.Metadata)	use AnthropicApi.ChatCompletionRequestBuilder.metadata(ChatCompletionRequest.Metadata) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withModel(String)	use AnthropicApi.ChatCompletionRequestBuilder.model(String) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withModel(AnthropicApi.ChatModel)	use AnthropicApi.ChatCompletionRequestBuilder.model(ChatModel) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withStopSequences(List<String>)	use AnthropicApi.ChatCompletionRequestBuilder.stopSequences(List) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withStream(Boolean)	use AnthropicApi.ChatCompletionRequestBuilder.stream(Boolean) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withSystem(String)	use AnthropicApi.ChatCompletionRequestBuilder.system(String) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withTemperature(Double)	use AnthropicApi.ChatCompletionRequestBuilder.temperature(Double) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withThinking(AnthropicApi.ChatCompletionRequest.ThinkingConfig)	use AnthropicApi.ChatCompletionRequestBuilder.thinking(ChatCompletionRequest.ThinkingConfig) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withThinking(AnthropicApi.ThinkingType, Integer)	use AnthropicApi.ChatCompletionRequestBuilder.thinking(ThinkingType, Integer) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withTools(List<AnthropicApi.Tool>)	use AnthropicApi.ChatCompletionRequestBuilder.tools(List) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withTopK(Integer)	use AnthropicApi.ChatCompletionRequestBuilder.topK(Integer) instead.
org.springframework.ai.anthropic.api.AnthropicApi.ChatCompletionRequestBuilder.withTopP(Double)	use AnthropicApi.ChatCompletionRequestBuilder.topP(Double) instead.
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.Builder.function(String)
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.Builder.functionCallbacks(List<FunctionCallback>)
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.Builder.functions(Set<String>)
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.Builder.proxyToolCalls(Boolean)
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.getFunctionCallbacks()
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.getFunctions()
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.getProxyToolCalls()
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.setFunctionCallbacks(List<FunctionCallback>)
org.springframework.ai.azure.openai.AzureOpenAiChatOptions.setProxyToolCalls(Boolean)
org.springframework.ai.chat.client.ChatClient.Builder.defaultFunctions(String...)	in favor of ChatClient.Builder.defaultTools(String...)
org.springframework.ai.chat.client.ChatClient.Builder.defaultFunctions(FunctionCallback...)	in favor of ChatClient.Builder.defaultTools(Object...)
org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec.functions(String...)
org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec.functions(FunctionCallback...)
org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec.functions(String...)
org.springframework.ai.chat.client.DefaultChatClient.DefaultChatClientRequestSpec.functions(FunctionCallback...)
org.springframework.ai.chat.client.DefaultChatClientBuilder.defaultFunction(String, String, BiFunction<I, ToolContext, O>)
org.springframework.ai.chat.client.DefaultChatClientBuilder.defaultFunction(String, String, Function<I, O>)
org.springframework.ai.chat.client.DefaultChatClientBuilder.defaultFunctions(String...)
org.springframework.ai.chat.client.DefaultChatClientBuilder.defaultFunctions(FunctionCallback...)
org.springframework.ai.chat.model.AbstractToolCallSupport.buildToolCallConversation(List<Message>, AssistantMessage, ToolResponseMessage)
org.springframework.ai.chat.model.AbstractToolCallSupport.executeFunctions(AssistantMessage, ToolContext)
org.springframework.ai.chat.model.AbstractToolCallSupport.getFunctionCallbackRegister()
org.springframework.ai.chat.model.AbstractToolCallSupport.handleToolCalls(Prompt, ChatResponse)
org.springframework.ai.chat.model.AbstractToolCallSupport.isProxyToolCalls(Prompt, FunctionCallingOptions)
org.springframework.ai.chat.model.AbstractToolCallSupport.isToolCall(ChatResponse, Set<String>)
org.springframework.ai.chat.model.AbstractToolCallSupport.isToolCall(Generation, Set<String>)
org.springframework.ai.chat.model.AbstractToolCallSupport.resolveFunctionCallbacks(Set<String>)
org.springframework.ai.chat.model.AbstractToolCallSupport.runtimeFunctionCallbackConfigurations(FunctionCallingOptions)
org.springframework.ai.chat.observation.ChatModelObservationContext.Builder.requestOptions(ChatOptions)	ChatOptions are passed in the Prompt object and should not be set separately anymore.
org.springframework.ai.chat.observation.ChatModelObservationContext.getRequestOptions()	Use {@link #getRequest().getOptions()} instead.
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.embedding.observation.EmbeddingModelObservationContext.Builder.requestOptions(EmbeddingOptions)	EmbeddingOptions are passed in the EmbeddingRequest object and should not be set separately anymore.
org.springframework.ai.embedding.observation.EmbeddingModelObservationContext.getRequestOptions()	Use {@link #getRequest().getOptions()} instead.
org.springframework.ai.image.observation.ImageModelObservationContext.Builder.requestOptions(ImageOptions)	ImageOptions are passed in the ImagePrompt object and should not be set separately anymore.
org.springframework.ai.image.observation.ImageModelObservationContext.getRequestOptions()	Use {@link #getRequest().getOptions()} instead.
org.springframework.ai.mistralai.MistralAiChatOptions.Builder.function(String)
org.springframework.ai.mistralai.MistralAiChatOptions.Builder.functionCallbacks(List<FunctionCallback>)
org.springframework.ai.mistralai.MistralAiChatOptions.Builder.functions(Set<String>)
org.springframework.ai.mistralai.MistralAiChatOptions.Builder.proxyToolCalls(Boolean)
org.springframework.ai.mistralai.MistralAiChatOptions.getFunctionCallbacks()
org.springframework.ai.mistralai.MistralAiChatOptions.getFunctions()
org.springframework.ai.mistralai.MistralAiChatOptions.getProxyToolCalls()
org.springframework.ai.mistralai.MistralAiChatOptions.setFunctionCallbacks(List<FunctionCallback>)
org.springframework.ai.mistralai.MistralAiChatOptions.setFunctions(Set<String>)
org.springframework.ai.mistralai.MistralAiChatOptions.setProxyToolCalls(Boolean)
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.ollama.api.OllamaOptions.Builder.function(String)
org.springframework.ai.ollama.api.OllamaOptions.Builder.functionCallbacks(List<FunctionCallback>)
org.springframework.ai.ollama.api.OllamaOptions.Builder.functions(Set<String>)
org.springframework.ai.ollama.api.OllamaOptions.Builder.proxyToolCalls(Boolean)
org.springframework.ai.ollama.api.OllamaOptions.getFunctionCallbacks()
org.springframework.ai.ollama.api.OllamaOptions.getFunctions()
org.springframework.ai.ollama.api.OllamaOptions.getProxyToolCalls()
org.springframework.ai.ollama.api.OllamaOptions.setFunctionCallbacks(List<FunctionCallback>)
org.springframework.ai.ollama.api.OllamaOptions.setFunctions(Set<String>)
org.springframework.ai.ollama.api.OllamaOptions.setProxyToolCalls(Boolean)
org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.maxTokens()
org.springframework.ai.openai.OpenAiChatOptions.Builder.function(String)
org.springframework.ai.openai.OpenAiChatOptions.Builder.functionCallbacks(List<FunctionCallback>)
org.springframework.ai.openai.OpenAiChatOptions.Builder.functions(Set<String>)
org.springframework.ai.openai.OpenAiChatOptions.Builder.proxyToolCalls(Boolean)
org.springframework.ai.openai.OpenAiChatOptions.getFunctionCallbacks()
org.springframework.ai.openai.OpenAiChatOptions.getFunctions()
org.springframework.ai.openai.OpenAiChatOptions.getProxyToolCalls()
org.springframework.ai.openai.OpenAiChatOptions.setFunctionCallbacks(List<FunctionCallback>)
org.springframework.ai.openai.OpenAiChatOptions.setFunctions(Set<String>)
org.springframework.ai.openai.OpenAiChatOptions.setProxyToolCalls(Boolean)
org.springframework.ai.tool.ToolCallback.getDescription()
org.springframework.ai.tool.ToolCallback.getInputTypeSchema()
org.springframework.ai.tool.ToolCallback.getName()
org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer.getTokenNames()
org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.getTokenNames()
org.springframework.ai.vectorstore.SimpleVectorStoreContent.withEmbedding(float[])
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel.Builder.functionCallbackResolver(FunctionCallbackResolver)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel.Builder.toolFunctionCallbacks(List<FunctionCallback>)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.Builder.function(String)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.Builder.functionCallbacks(List<FunctionCallback>)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.Builder.functions(Set<String>)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.Builder.proxyToolCalls(boolean)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.getFunctionCallbacks()
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.getFunctions()
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.getProxyToolCalls()
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.setFunctionCallbacks(List<FunctionCallback>)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.setFunctions(Set<String>)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatOptions.setProxyToolCalls(Boolean)

Deprecated Constructors

Constructor	Description
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore)
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore, String)
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore, String, int)
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore, String, int, int)
org.springframework.ai.chat.client.advisor.vectorstore.VectorStoreChatMemoryAdvisor(VectorStore, String, int, String)
org.springframework.ai.chat.model.AbstractToolCallSupport(FunctionCallbackResolver)
org.springframework.ai.chat.model.AbstractToolCallSupport(FunctionCallbackResolver, FunctionCallingOptions, List<FunctionCallback>)
org.springframework.ai.evaluation.EvaluationResponse(boolean, float, String, Map<String, Object>)
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel(VertexAI)	Use VertexAiGeminiChatModel.Builder.
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel(VertexAI, VertexAiGeminiChatOptions)	Use VertexAiGeminiChatModel.Builder.
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel(VertexAI, VertexAiGeminiChatOptions, FunctionCallbackResolver)	Use VertexAiGeminiChatModel.Builder.
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel(VertexAI, VertexAiGeminiChatOptions, FunctionCallbackResolver, List<FunctionCallback>)	Use VertexAiGeminiChatModel.Builder.
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel(VertexAI, VertexAiGeminiChatOptions, FunctionCallbackResolver, List<FunctionCallback>, RetryTemplate)	Use VertexAiGeminiChatModel.Builder.
org.springframework.ai.vertexai.gemini.VertexAiGeminiChatModel(VertexAI, VertexAiGeminiChatOptions, FunctionCallbackResolver, List<FunctionCallback>, RetryTemplate, ObservationRegistry)	Use VertexAiGeminiChatModel.Builder.