接口定义
本接口
search_sessions()
提供基于关键词规则匹配的会话搜索功能,可根据会话名称检索并返回符合条件的会话列表。def search_sessions(content: str,memory_id: str | None = None,actor_id: str | None = None,order_by: Dict[str, int] | None = None,limit: int | None = None) -> Dict[str, Any]
使用示例
import jsonfrom tdaimemory import MemoryClientsearch_result = client.search_sessions(content="Travel",order_by={"created_at": -1},limit=2)print(json.dumps(search_result, ensure_ascii=False))
入参描述
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
memory_id | 否 | 指定查询 Session 需关联的记忆库 ID。 | |
actor_id | 否 | 指定查询 Session 的用户 ID。 | 数据类型:String 长度限制:[1,20] 字符规则:任意字符 |
content | 是 | 指定搜索的关键词。 | 数据类型:String。 限制:当前仅支持使用 Session Name 中包含的关键词搜索。 |
order_by | 否 | 指定返回的 Session 的排序方式。 | 支持如下两种方式。 -1:降序。默认按照 Session 的创建时间降序排列。 1:升序。 |
limit | 否 | 返回的最大会话数量。 | 数据类型:int。 默认值:3 取值范围:[1,50]。 |
响应消息
执行成功,输出如下信息。
>>> print(json.dumps(search_result, ensure_ascii=False)){"sessions": [{"created_at": 1757579185, "session_id": "session-KaxA****", "session_name": "Travel_Consultation_update", "updated_at": 1757579197}], "total_count": 2}
参数名 | 参数含义 |
seesions | 列出满足查询条件的所有 Session。 session_id:Session 的唯一标识 ID。 session_name:Session 的会话名称。 created_at:Session 的创建时间。 updated_at:Session 的最后一次更新时间。 |
total_count | 满足查询条件的 Session 数量。 |