接口定义
本接口
flush_states()用于清空会话中的所有状态数据。注意:
本接口功能为删除当前会话中的全部状态键值对。此操作执行后数据将不可恢复,请您务必谨慎确认!
def flush_states(session_id: str,memory_id: str | None = None,actor_id: str | None = None) -> Dict[str, Any]
使用示例
import jsonfrom tdaimemory import MemoryClientflush_result = client.flush_states(session_id="session-Y5oi****",)print(json.dumps(flush_result, ensure_ascii=False))
请求参数
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
memory_id | 否 | 指定需清空会话状态的 Memory ID。 | |
actor_id | 是 | 指定需清空会话状态的用户 ID。 | 数据类型:String 长度限制:[1,20] 字符规则:任意字符 |
session_id | 是 | 指定需清空会话状态的会话 ID。 |
响应消息
执行成功,输出如下信息。
>>> print(json.dumps(flush_result, ensure_ascii=False)){"affected_count": 2}
参数名 | 参数含义 |
affected_count | 返回清空的状态键数量。 |