Package org.springframework.ai.chat.client.advisor.api

Interface Advisor

All Superinterfaces:
org.springframework.core.Ordered
All Known Subinterfaces:
BaseAdvisor, BaseChatMemoryAdvisor, CallAdvisor, StreamAdvisor
All Known Implementing Classes:
ChatModelCallAdvisor, ChatModelStreamAdvisor, MessageChatMemoryAdvisor, PromptChatMemoryAdvisor, SafeGuardAdvisor, SimpleLoggerAdvisor
public interface Advisor extends org.springframework.core.Ordered
Parent advisor interface for all advisors.
Since:
1.0.0
Author:
Christian Tzolov, Dariusz Jedrzejczyk
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER
    Useful constant for the default Chat Memory precedence order.

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Return the name of the advisor.

    Methods inherited from interface org.springframework.core.Ordered

    getOrder

  • Field Details

    • DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER

      static final int DEFAULT_CHAT_MEMORY_PRECEDENCE_ORDER
      Useful constant for the default Chat Memory precedence order. Ensures this order has lower priority (e.g. precedences) than the Spring AI internal advisors. It leaves room (1000 slots) for the user to plug in their own advisors with higher priority.
      See Also:

  • Method Details

    • getName

      String getName()
      Return the name of the advisor.
      Returns:
      the advisor name.