[FEATURE] Option to pass extra parameters to RAG/Tool via AI service

[langchain4j]

TODO
Currently only memory id can be passed around.
It would be great to be able to pass custom parameters.
For example, to be able to set Filter expression.

[Yellow--]

how about this?

• add annotationUserDatawhich will be used by AiService Interface
• add annotationToolUserDatawhich indicated that relatived parameter in tools is userData
• the userData passed in the AiService method will by bypass to tools and MetaData of RAG

Example

    // the definition of tool
    public static class SendMailTools {
        public void sendEmail(String content, @ToolUserData Map<String, Object> userData) {
            String subject = (String) userData.getOrDefault("subject", "default subject");
            log.info("send email with content: {} userData: {}", content, subject);
        }
    }
  
    //the definition of AiService
    public interface ChatService {
        @UserMessage("summary text ```{{text}}``` and send summary by email")
        String summaryAndSendEmail(@V("text") String text, @UserData Map<String, Object> userData);
    }

    //example
    public static void main(String[] args) {
        ChatService chatService = AiServices.builder(ChatService.class)
                .tools(new SendMailTools())
                .build();
        Map<String, Object> userData = Collections.singletonMap("subject", "customizeSubject");
        chatService.summaryAndSendEmail("a very long text", userData);
    }

Things may need to discuss

• does the annotation name understandable?may be need another name?
• does strict the UserData to Map<String, Object> is good?

@langchain4j

[langchain4j]

@Yellow-- Sounds good!

does the annotation name understandable?may be need another name?

We should consider other names, because this data might not be really a user data, but something related to the tenant or the whole app

does strict the UserData to Map<String, Object> is good?

Ideally we shouldn't restrict the type (as it is done for memory id)

[Yellow--]

@langchain4j
with you advices
the final look may be like this?

    // the definition of tool
    public static class SendMailTools {
        public void sendEmail(String content, @ToolTransparentData Map<String, Object> emailContext) {
            String subject = (String) userData.getOrDefault("subject", "default subject");
            log.info("send email with content: {} userData: {}", content, subject);
        }
    }
  
    //the definition of AiService
    //the ```@TransparentData``` parameter type is not restricted,you could pass any object as you like
    public interface ChatService {
        @UserMessage("summary text ```{{text}}``` and send summary by email")
        String summaryAndSendEmail(@V("text") String text, @TransparentData Map<String, Object> emailContext);
    }

    //example
    public static void main(String[] args) {
        ChatService chatService = AiServices.builder(ChatService.class)
                .tools(new SendMailTools())
                .build();
        Map<String, Object> userData = Collections.singletonMap("subject", "customizeSubject");
        chatService.summaryAndSendEmail("a very long text", userData);
    }