New Constructor for PromptChatMemoryAdvisor

[KushParsaniya]

Feature Proposal: Overloaded Constructor for PromptChatMemoryAdvisor with Default systemTextAdvise

Summary

Currently, the PromptChatMemoryAdvisor requires passing a systemTextAdvise string when a custom ConversationId is used. To enhance usability, this proposal suggests adding an overloaded constructor to allow users to pass only the ChatMemory, ConversationId, and chatHistoryWindowSize, while the systemTextAdvise defaults to DEFAULT_SYSTEM_TEXT_ADVISE.

Problem

When using PromptChatMemoryAdvisor, developers are required to pass the systemTextAdvise explicitly, even when a default value would suffice. This is inconvenient, especially in cases where the developer is already passing a custom ConversationId and doesn't need to customize the systemTextAdvise.

For example:

@GetMapping("/{prompt}")
public String prompt(@PathVariable String prompt, HttpServletRequest request) {
    return chatClient
            .prompt()
            .advisors(new PromptChatMemoryAdvisor(
                    jdbcChatMemory,
                    request.getHeader("id"),
                    20,
                    """
                    Use the conversation memory from the MEMORY section to provide accurate answers.

                    ---------------------
                    MEMORY:
                    {memory}
                    ---------------------

                    """))
            .user(prompt)
            .call().content();
}

Proposed Solution

To streamline this, I propose introducing an overloaded constructor in PromptChatMemoryAdvisor that only requires the ChatMemory, ConversationId, and chatHistoryWindowSize. The systemTextAdvise should default to a predefined value, such as DEFAULT_SYSTEM_TEXT_ADVISE, when not provided.

The new constructor could look like this:

public PromptChatMemoryAdvisor(ChatMemory chatMemory, String defaultConversationId, int chatHistoryWindowSize) {
    this(chatMemory, defaultConversationId, chatHistoryWindowSize, DEFAULT_SYSTEM_TEXT_ADVISE);
}

public PromptChatMemoryAdvisor(ChatMemory chatMemory, String defaultConversationId, int chatHistoryWindowSize, String systemTextAdvise) {
    // current implementation
}

This would allow developers to simplify their usage:

@GetMapping("/{prompt}")
public String prompt(@PathVariable String prompt, HttpServletRequest request) {
    return chatClient
            .prompt()
            .advisors(new PromptChatMemoryAdvisor(
                    jdbcChatMemory,
                    request.getHeader("id"),
                    20))
            .user(prompt)
            .call().content();
}