Skip navigation links
  • Overview
  • Package
  • Class
  • Use
  • Tree
  • Deprecated
  • Index
  • Help

Deprecated API

Contents

  • Terminally Deprecated
  • Interfaces
  • Classes
  • Enum Classes
  • Record Classes
  • Fields
  • Methods
  • Constructors
  • Enum Constants
  • Terminally Deprecated Elements
    Element
    Description
    org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec.tools(String...)
  • Deprecated Interfaces
    Interface
    Description
    org.springframework.ai.chat.client.advisor.api.CallAroundAdvisor
    in favor of CallAdvisor
    org.springframework.ai.chat.client.advisor.api.CallAroundAdvisorChain
    in favor of CallAdvisorChain
    org.springframework.ai.chat.client.advisor.api.StreamAroundAdvisor
    in favor of StreamAdvisor
    org.springframework.ai.chat.client.advisor.api.StreamAroundAdvisorChain
    in favor of StreamAdvisorChain
    org.springframework.ai.rag.postretrieval.compression.DocumentCompressor
    in favour of DocumentPostProcessor.
    org.springframework.ai.rag.postretrieval.ranking.DocumentRanker
    in favour of DocumentPostProcessor.
    org.springframework.ai.rag.postretrieval.selection.DocumentSelector
    in favour of DocumentPostProcessor.
  • Deprecated Classes
    Class
    Description
    org.springframework.ai.chat.client.advisor.api.AdvisedResponseStreamUtils
    in favour of AdvisorUtils.
    org.springframework.ai.chat.client.DefaultChatClient.DefaultCallPromptResponseSpec
    org.springframework.ai.chat.client.DefaultChatClient.DefaultStreamPromptResponseSpec
    org.springframework.ai.chat.client.observation.ChatClientInputContentObservationFilter
    in favor of ChatClientPromptContentObservationFilter.
    org.springframework.ai.chat.memory.InMemoryChatMemory
    in favor of MessageWindowChatMemory, which internally uses InMemoryChatMemoryRepository.
    org.springframework.ai.chat.memory.jdbc.JdbcChatMemory
    in favor of building a MessageWindowChatMemory (or other ChatMemory implementations) with a JdbcChatMemoryRepository instance.
    org.springframework.ai.chat.memory.jdbc.JdbcChatMemoryConfig
    in favor of using JdbcChatMemoryRepository.builder().
  • Deprecated Enum Classes
    Enum Class
    Description
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Type
    advisors don't have types anymore, they're all "around"
    org.springframework.ai.chat.client.ChatClientAttributes
    only introduced to smooth the transition to the new APIs and ensure backward compatibility
    org.springframework.ai.chat.prompt.TemplateFormat
    in favor of TemplateRenderer.
  • Deprecated Record Classes
    Record Class
    Description
    org.springframework.ai.chat.client.advisor.api.AdvisedRequest
    Use ChatClientRequest instead.
    org.springframework.ai.chat.client.advisor.api.AdvisedResponse
    Use ChatClientResponse instead.
  • Deprecated Fields
    Field
    Description
    org.springframework.ai.chat.client.advisor.AbstractChatMemoryAdvisor.DEFAULT_CHAT_MEMORY_CONVERSATION_ID
    in favor of ChatMemory.DEFAULT_CONVERSATION_ID.
    org.springframework.ai.chat.prompt.PromptTemplate.template
    will become private in the next release. If you're subclassing this class, re-consider using the built-in implementation together with the new PromptTemplateRenderer interface, designed to give you more flexibility and control over the rendering process.
    org.springframework.ai.chat.prompt.PromptTemplate.templateFormat
    in favor of TemplateRenderer
    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.chat.client.advisor.api.AdvisedRequest.advisorParams()
    org.springframework.ai.chat.client.advisor.api.AdvisedRequest.Builder.advisorParams(Map<String, Object>)
    in favor of AdvisedRequest.Builder.adviseContext(Map)
    org.springframework.ai.chat.client.advisor.api.BaseAdvisor.after(AdvisedResponse)
    in favor of BaseAdvisor.after(ChatClientResponse,AdvisorChain)
    org.springframework.ai.chat.client.advisor.api.BaseAdvisor.aroundCall(AdvisedRequest, CallAroundAdvisorChain)
    org.springframework.ai.chat.client.advisor.api.BaseAdvisor.aroundStream(AdvisedRequest, StreamAroundAdvisorChain)
    org.springframework.ai.chat.client.advisor.api.BaseAdvisor.before(AdvisedRequest)
    in favor of BaseAdvisor.before(ChatClientRequest,AdvisorChain)
    org.springframework.ai.chat.client.advisor.api.CallAdvisor.aroundCall(AdvisedRequest, CallAroundAdvisorChain)
    use CallAdvisor.adviseCall(ChatClientRequest, CallAroundAdvisorChain)
    org.springframework.ai.chat.client.advisor.api.CallAdvisorChain.nextAroundCall(AdvisedRequest)
    use CallAdvisorChain.nextCall(ChatClientRequest)
    org.springframework.ai.chat.client.advisor.api.CallAroundAdvisor.aroundCall(AdvisedRequest, CallAroundAdvisorChain)
    in favor of CallAdvisor.adviseCall(ChatClientRequest, CallAroundAdvisorChain)
    org.springframework.ai.chat.client.advisor.api.CallAroundAdvisorChain.nextAroundCall(AdvisedRequest)
    in favor of CallAdvisorChain.nextCall(ChatClientRequest)
    org.springframework.ai.chat.client.advisor.api.StreamAdvisor.aroundStream(AdvisedRequest, StreamAroundAdvisorChain)
    use StreamAdvisor.adviseStream(ChatClientRequest, StreamAroundAdvisorChain)
    org.springframework.ai.chat.client.advisor.api.StreamAdvisorChain.nextAroundStream(AdvisedRequest)
    use StreamAdvisorChain.nextStream(ChatClientRequest)
    org.springframework.ai.chat.client.advisor.api.StreamAroundAdvisor.aroundStream(AdvisedRequest, StreamAroundAdvisorChain)
    in favor of StreamAdvisor.adviseStream(ChatClientRequest, StreamAroundAdvisorChain)
    org.springframework.ai.chat.client.advisor.api.StreamAroundAdvisorChain.nextAroundStream(AdvisedRequest)
    in favor of StreamAdvisorChain.nextStream(ChatClientRequest)
    org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.nextAroundCall(AdvisedRequest)
    Use DefaultAroundAdvisorChain.nextCall(ChatClientRequest) instead
    org.springframework.ai.chat.client.advisor.DefaultAroundAdvisorChain.nextAroundStream(AdvisedRequest)
    Use DefaultAroundAdvisorChain.nextStream(ChatClientRequest) instead.
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder.advisedRequest(AdvisedRequest)
    use AdvisorObservationContext.Builder.chatClientRequest(ChatClientRequest) instead
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder.advisorRequestContext(Map<String, Object>)
    use AdvisorObservationContext.Builder.chatClientRequest(ChatClientRequest) instead
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder.advisorResponseContext(Map<String, Object>)
    use AdvisorObservationContext.setChatClientResponse(ChatClientResponse) instead
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.Builder.advisorType(AdvisorObservationContext.Type)
    advisors don't have types anymore, they're all "around"
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.getAdvisedRequest()
    not used anymore
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.getAdvisorRequestContext()
    use AdvisorObservationContext.getChatClientRequest() instead
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.getAdvisorResponseContext()
    use AdvisorObservationContext.getChatClientResponse() instead
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.getAdvisorType()
    advisors don't have types anymore, they're all "around"
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.setAdvisedRequest(AdvisedRequest)
    immutable object, use the builder instead to create a new instance
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.setAdvisorRequestContext(Map<String, Object>)
    not supported anymore, use AdvisorObservationContext.getChatClientRequest() instead
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext.setAdvisorResponseContext(Map<String, Object>)
    use AdvisorObservationContext.setChatClientResponse(ChatClientResponse) instead
    org.springframework.ai.chat.client.advisor.observation.DefaultAdvisorObservationConvention.advisorType(AdvisorObservationContext)
    advisors don't have types anymore, they're all "around"
    org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor.Builder.userTextAdvise(String)
    in favour of QuestionAnswerAdvisor.Builder.promptTemplate(PromptTemplate)
    org.springframework.ai.chat.client.ChatClient.Builder.defaultTools(String...)
    org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec.tools(String...)
    org.springframework.ai.chat.client.DefaultChatClient.toDefaultChatClientRequestSpec(AdvisedRequest, ObservationRegistry, ChatClientObservationConvention)
    org.springframework.ai.chat.client.DefaultChatClientBuilder.defaultFunction(String, String, Function<I, O>)
    org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder.withFormat(String)
    not used anymore. The format instructions are already included in the ChatModelObservationContext.
    org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder.withRequest(ChatClientRequest)
    org.springframework.ai.chat.client.observation.ChatClientObservationContext.Builder.withStream(boolean)
    org.springframework.ai.chat.client.observation.ChatClientObservationContext.getFormat()
    not used anymore. The format instructions are already included in the ChatModelObservationContext.
    org.springframework.ai.chat.client.observation.ChatClientObservationContext.setFormat(String)
    not used anymore. The format instructions are already included in the ChatModelObservationContext.
    org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention.chatClientAdvisorParams(KeyValues, ChatClientObservationContext)
    risk to expose sensitive information or break the instrumentation since the advisor context map is used to pass arbitrary Java objects between advisors and not necessarily serializable. The conversation ID, previously part of this, is already included in the DefaultChatClientObservationConvention.conversationId(KeyValues, ChatClientObservationContext) method.
    org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention.toolCallbacks(KeyValues, ChatClientObservationContext)
    in favor of DefaultChatClientObservationConvention.tools(KeyValues, ChatClientObservationContext)
    org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention.toolNames(KeyValues, ChatClientObservationContext)
    in favor of DefaultChatClientObservationConvention.tools(KeyValues, ChatClientObservationContext)
    org.springframework.ai.chat.memory.ChatMemory.get(String, int)
    in favor of using MessageWindowChatMemory.
    org.springframework.ai.chat.memory.MessageWindowChatMemory.get(String, int)
    org.springframework.ai.chat.prompt.Prompt.Builder.addMessage(Message)
    org.springframework.ai.chat.prompt.PromptTemplate.getInputVariables()
    in favor of TemplateRenderer.
    org.springframework.ai.chat.prompt.PromptTemplate.getTemplateFormat()
    in favor of TemplateRenderer
    org.springframework.ai.chat.prompt.PromptTemplate.validate(Map<String, Object>)
    in favor of TemplateRenderer.
    org.springframework.ai.content.Media.Builder.data(URL)
    in favour of Media.Builder.data(URI)
    org.springframework.ai.model.tool.ToolCallingChatOptions.isInternalToolExecutionEnabled()
    org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.after(AdvisedResponse)
    in favour of RetrievalAugmentationAdvisor.after(ChatClientResponse, AdvisorChain)
    org.springframework.ai.rag.advisor.RetrievalAugmentationAdvisor.before(AdvisedRequest)
    in favour of RetrievalAugmentationAdvisor.before(ChatClientRequest, AdvisorChain)
    org.springframework.ai.vectorstore.filter.antlr4.FiltersLexer.getTokenNames()
    org.springframework.ai.vectorstore.filter.antlr4.FiltersParser.getTokenNames()
  • Deprecated Constructors
    Constructor
    Description
    org.springframework.ai.anthropic.api.AnthropicApi(String)
    org.springframework.ai.anthropic.api.AnthropicApi(String, String)
    org.springframework.ai.anthropic.api.AnthropicApi(String, String, String, RestClient.Builder, WebClient.Builder, ResponseErrorHandler)
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationContext(String, AdvisorObservationContext.Type, AdvisedRequest, Map<String, Object>, Map<String, Object>, int)
    use the builder instead
    org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor(VectorStore, SearchRequest)
    in favor of the builder: QuestionAnswerAdvisor.builder(VectorStore)
    org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor(VectorStore, SearchRequest, String)
    in favor of the builder: QuestionAnswerAdvisor.builder(VectorStore)
    org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor(VectorStore, SearchRequest, String, boolean)
    in favor of the builder: QuestionAnswerAdvisor.builder(VectorStore)
    org.springframework.ai.chat.client.advisor.vectorstore.QuestionAnswerAdvisor(VectorStore, SearchRequest, String, boolean, int)
    in favor of the builder: QuestionAnswerAdvisor.builder(VectorStore)
    org.springframework.ai.chat.messages.UserMessage(String, Collection<Media>, Map<String, Object>)
    use UserMessage.builder() instead. Will be made private in the next release.
    org.springframework.ai.chat.messages.UserMessage(String, List<Media>)
    use UserMessage.builder() instead.
    org.springframework.ai.chat.messages.UserMessage(String, Media...)
    use UserMessage.builder() instead.
    org.springframework.ai.chat.messages.UserMessage(MessageType, String, Collection<Media>, Map<String, Object>)
    use UserMessage.builder() instead.
    org.springframework.ai.chat.prompt.PromptTemplate(String, Map<String, Object>)
    in favor of PromptTemplate.builder().
    org.springframework.ai.chat.prompt.PromptTemplate(Resource, Map<String, Object>)
    in fahvor of PromptTemplate.builder().
    org.springframework.ai.content.Media(MimeType, URL)
    in favour of Media(MimeType, URI)
    org.springframework.ai.ollama.api.OllamaApi()
    org.springframework.ai.ollama.api.OllamaApi(String)
    org.springframework.ai.ollama.api.OllamaApi(String, RestClient.Builder, WebClient.Builder)
  • Deprecated Enum Constants
    Enum Constant
    Description
    org.springframework.ai.chat.client.advisor.observation.AdvisorObservationDocumentation.LowCardinalityKeyNames.ADVISOR_TYPE
    advisors don't have types anymore, they're all "around"
    org.springframework.ai.chat.client.ChatClientAttributes.ADVISORS
    org.springframework.ai.chat.client.ChatClientAttributes.CHAT_MODEL
    org.springframework.ai.chat.client.ChatClientAttributes.OUTPUT_FORMAT
    org.springframework.ai.chat.client.ChatClientAttributes.SYSTEM_PARAMS
    org.springframework.ai.chat.client.ChatClientAttributes.USER_PARAMS
    org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_ADVISOR_PARAMS
    risk to expose sensitive information or break the instrumentation since the advisor context map is used to pass arbitrary Java objects between advisors and not necessarily serializable. The conversation ID, previously part of this, is already included in the ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_CONVERSATION_ID method.
    org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_SYSTEM_PARAM
    replaced by ChatClientObservationDocumentation.HighCardinalityKeyNames.PROMPT
    org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_SYSTEM_TEXT
    replaced by ChatClientObservationDocumentation.HighCardinalityKeyNames.PROMPT
    org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_TOOL_FUNCTION_CALLBACKS
    replaced by ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_TOOL_NAMES
    org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_TOOL_FUNCTION_NAMES
    replaced by ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_TOOL_NAMES
    org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_USER_PARAMS
    replaced by ChatClientObservationDocumentation.HighCardinalityKeyNames.PROMPT
    org.springframework.ai.chat.client.observation.ChatClientObservationDocumentation.HighCardinalityKeyNames.CHAT_CLIENT_USER_TEXT
    replaced by ChatClientObservationDocumentation.HighCardinalityKeyNames.PROMPT

Copyright © 2025 VMware Inc.. All rights reserved.