接口介绍
本接口(
/memory/v1/event/query)用于查询会话中的事件。Method 与 URL
POST https://{服务访问地址}/memory/v1/event/query使用示例
curl -i -k -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer ******************************' \\-H "x-tdai-service-id: tdai-mem-8i8t****" \\https://memory.tdai.tencentyun.com/memory/v1/event/query \\-d '{"memory_id": "tdai-mem-8i8t****","where": {"role": "user"},"limit": 3,"offset": 0}'
请求参数
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
memory_id | 是 | 指定查询会话(Session)所关联的 Memory ID。 | |
actor_id | 否 | 指定查询会话(Session)中所属用户的唯一标识 ID。 | 数据类型:String。 长度限制:[1,128]。 字符规则:任意字符。 |
session_id | 否 | 指定查询事件的 Session ID。 | |
where | 否 | 指定查询条件的对象,通过键值对指定字段的匹配规则,返回满足指定条件的事件。 | 支持使用的操作符。 比较操作符:$eq(等于,默认可省略)、$ne(不等于)、$gt(大于)、$gte(大于等于)、$lt(小于)、$lte(小于等于)。 集合操作符:$in(包含在数组中)、$nin(不包含在数组中)。 查询条件设置示例。 如下表示查找 status 字段等于 "ACTIVE" 且 score 字段大于等于80的记录。
|
limit | 否 | 指定返回的事件数量。 | 数据类型:Integer,正整数。 取值范围:1~1000。 默认值:10。 |
offset | 否 | 指定返回结果列表的起始偏移量。 | 数据类型:Integer,正整数。 默认值:0,表示从数据集的第一条记录开始返回。 示例:offset=20表示跳过前20条记录,从第21条开始返回。 |
响应消息
执行成功,输出如下信息。
{"code": 0,"message": "success","data": {"memory_id": "tdai-mem-n0jm****","events": [{"event_id": "event-0e0bd919********","actor_id": "user-service-test","session_id": "session-7fd3b2dd********","messages": {"role": "user","content": "嗨,帮我规划一个下周去杭州的3天行程。","timestamp": "2025-12-01T10:00:05Z"}},{"event_id": "event-11c1a5c8********","actor_id": "user-service-test","session_id": "session-7fd3b2dd********","messages": {"role": "user","content": "我喜欢人少、安静的地方,对美食特别感兴趣。","timestamp": "2025-12-01T10:00:05Z"}},{"event_id": "event-33711753********","actor_id": "user-service-test","session_id": "session-7fd3b2dd********","messages": {"role": "user","content": "太好了,酒店要带健身房,另外我对花生严重过敏,预订餐厅时请务必注意。","timestamp": "2025-12-01T10:00:05Z"}}],"total_count": 4}}
参数名(一级) | 参数名(二级) | 参数名(三级) | 参数含义 |
data | events | event_id | 返回满足条件的事件 ID。 |
| | actor_id | 用户 ID。 |
| | session_id | Session 的唯一标识 ID。 |
| | messages | 返回事件的消息对象。 |
| total_count | - | 符合条件的事件总数。 |