简介

会话数据管理工具，实例化后将是一个全局变量。提供保存对话数据与获取历史数据的方法。

应用场景

必须在 AgentRuntime 启动的服务中使用。

Python基本用法

1、实例化UserSession().__init__ -> UserSession

方法参数

方法功能

初始化 UserSession

示例代码

user_session = UserSession()

2、获取同个 session 中名为 key 的历史变量UserSession().get_history(self, key: str, limit: int=10) -> List[Message]:

方法参数

方法功能

获取同个 session 中名为 key 的历史变量。在非服务化版本中从内存获取。在服务化版本中，将从数据库获取。

方法返回值

List[Message]

衍生类Message定义如下:

class Message(BaseModel, Generic[_T], extra=Extra.allow):
    content: Optional[_T] = {}
    name: Optional[str] = "msg"
    mtype: Optional[str] = "dict"
    id: Optional[str] = str(uuid.uuid4())

示例代码

history_queries = user_session.get_history("query", limit=1)

3、将 message_dict 中的变量保存到 session 中UserSession().append(self, message_dict: Dict[str, Message]) -> None

方法参数

方法功能

将 message_dict 中的变量保存到 session 中。在非服务化版本中使用内存存储。在服务化版本中，将使用数据库进行存储。

示例代码

user_session.append({
            "query": message,
            "answer": answer,
        }) 

4、UserSession结合AgentRuntime使用以及user_session.db文件读取

• UserSession结合AgentRuntime使用以及user_session.db文件读取