How to set ID in Human and AI messages using RedisChatMessageHistory?

[mironnn]

Checked other resources

• I added a very descriptive title to this question.
• I searched the LangChain documentation with the integrated search.
• I used the GitHub search to find a similar question and didn't find it.

Commit to Help

• I commit to help with one of those options 👆

Example Code

def get_message_history_connection_obj(
    session_id: str, corp_acct_nbr: str
) -> RedisChatMessageHistory:
    """Get message history connection for a session."""

    return RedisChatMessageHistory(
        session_id,
        corp_acct_nbr,
        hosts=_sentinel_hosts,
        master_name=CONFIG.redis_sentinel.master_name,  # pylint: disable=E1101
        ttl=CONFIG.redis_sentinel.ttl,  # pylint: disable=E1101
        timeout=CONFIG.redis_sentinel.timeout,  # pylint: disable=E1101
    )

conversational_rag_chain = RunnableWithMessageHistory(
    rag_chain,
    get_message_history_connection_obj,
    input_messages_key="input",
    history_messages_key="chat_history",
    output_messages_key="answer",
    history_factory_config=[
        ConfigurableFieldSpec(
            id="session_id",
            annotation=str,
            name="Session ID",
            description="Unique identifier for a session.",
            default="",
            is_shared=True,
        ),
        ConfigurableFieldSpec(
            id="corp_acct_nbr",
            annotation=str,
            name="Corporate Account Number",
            description="Unique identifier for the company.",
            default="",
            is_shared=True,
        ),
    ],
)

    response: dict = conversational_rag_chain.invoke(
        {
            "input": last_customer_message.content,
            "id": last_customer_message.message_uuid,
        },
        config={
            "configurable": {
                "session_id": session_uuid,
                "corp_acct_nbr": corp_acct_nbr,
            },
        },
    )

Description

I'm using RedisChatMessageHistory. I want to save id to messages I receive from other services. But I can't find where and how to set them.
Thanks

System Info

langchain-community = "0.0.32"
langchain-core = "0.1.42"

[dosubot[bot]]

To address your issue with setting IDs in Human and AI messages using RedisChatMessageHistory in LangChain, you can consider the following approach:

1. Embed the ID within the Message Object: Since Redis lists, which are used to store messages in RedisChatMessageHistory, do not support explicit message IDs for each entry, you can modify the message object to include an id field before storing it. This involves changing how you serialize and deserialize your message objects. When retrieving messages, you'll extract the ID from each message object.

Here's an example of how you might implement this:

def add_message_with_id(self, message: BaseMessage, message_id: str) -> None:
    """Append the message with an ID to the record in Redis"""
    message_dict = message_to_dict(message)
    message_dict["id"] = message_id  # Add the ID to the message dictionary
    self.redis_client.lpush(self.key, json.dumps(message_dict))
    if self.ttl:
        self.redis_client.expire(self.key, self.ttl)

This approach allows you to maintain the order of messages and associate each message with a unique ID by embedding the ID within the message object itself.

Remember, any modifications to the RedisChatMessageHistory class could potentially affect the functionality of the RunnableWithMessageHistory class if these changes alter the methods or properties that RunnableWithMessageHistory relies on. Therefore, it's important to ensure that any changes made are compatible with the rest of your implementation.

Additionally, you'll need to update or extend existing unit tests for both the RedisChatMessageHistory class and the RunnableWithMessageHistory class to cover the new functionality of supporting message IDs. This ensures that your implementation works as expected and integrates properly with the rest of the system.

For more detailed implementation and testing, you might want to refer to the source code and unit tests of the RedisChatMessageHistory and RunnableWithMessageHistory classes in the LangChain repository.

Details

Sources

• libs/langchain/langchain/memory/chat_message_histories/redis.py
• libs/community/langchain_community/chat_message_histories/redis.py
• libs/core/langchain_core/messages/base.py
• libs/core/langchain_core/runnables/history.py
• libs/core/tests/unit_tests/runnables/test_history.py
• libs/langchain/tests/integration_tests/memory/test_redis.py

About Dosu
This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

To continue the conversation, mention @dosu.

[mironnn]

It looks like, a suggestion from the bot is not very helpful. How to pass the message_id from conversational_rag_chain.invoke() to the actual Redis handler adding the message to Redis.

[DanielEstehghariSopra]

We are having the same issue. It seems like a very commonsense feature to have in your implementation, for example if you want to store user feedback on specific messages.