接口介绍
本接口(/memory/v1/record/query)用于查询指定条件下的长期记忆。
支持根据 Memory ID、Actor ID、Seesion ID等条件筛选 Record。
支持分页,便于管理和浏览记录数据。
Method 与 URL
POST https://{服务访问地址}/memory/v1/record/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/record/query \\-d '{"memory_id": "tdai-mem-8i8t****","actor_id": "user-test-001","session_id": "session-PTVM****","order_by": {"created_at": -1},"limit": 3,"offset": 0}'
请求参数
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
memory_id | 是 | 指定查询 Record 所关联的 Memory ID。 | |
actor_id | 是 | 指定查询 Record 用户的唯一标识 ID。 | 数据类型:String 长度限制:[1,20] 字符规则:任意字符 |
session_id | 是 | 指定查询 Record 的 Session ID。 | |
where | 是 | 指定查询条件的对象,通过键值对指定字段的匹配规则,返回满足指定条件的事件。 说明: 当前仅支持使用 record_id、created_at、updated_at 字段设置查询条件。 | 支持使用的操作符。 比较操作符:$eq(等于,默认可省略)、$ne(不等于)、$gt(大于)、$gte(大于等于)、$lt(小于)、$lte(小于等于)。 集合操作符:$in(包含在数组中)、$nin(不包含在数组中) 查询条件设置示例。
|
order_by | 否 | 指定返回的 Record 的排序方式。 | 支持如下两种方式。 -1:降序。默认按照 Record 的创建时间降序排列。 1:升序。 |
limit | 否 | 指定返回的 Record 数量。 | 数据类型:int,正整数。 取值范围:1~100。 默认值:10。 |
offset | 否 | 指定返回结果列表的起始偏移量。 | 数据类型:int,正整数。 默认值:0,表示从数据集的第一条记录开始返回。 示例:offset=20表示跳过前20条记录,从第21条开始返回。 |
响应消息
执行成功,输出如下信息。
{"code": 0,"message": "","data": {"records": [{"created_at": 1757384673,"event_ids": ["event-Ej9s****"],"record_content": "用户对人少、安静的地方有强烈的偏好","record_id": "record-rCYY****","strategy_name": "User Perference Strategy","updated_at": 1757384673},{"created_at": 1757384676,"event_ids": ["event-Ej9s****"],"record_content": "用户对美食有浓厚的兴趣","record_id": "record-ChVi****","strategy_name": "User Perference Strategy","updated_at": 1757384676},{"created_at": 1757384678,"event_ids": ["event-Ej9s****"],"record_content": "用户对花生严重过敏,需要特别注意","record_id": "record-4gbj****","strategy_name": "User Perference Strategy","updated_at": 1757384678}],"total_count": 18}}
参数名 | 子参数(一级) | 子参数(二级) | 参数含义 |
data | records | record_id | 长期记忆 ID,唯一标识该记录的标识符。 |
| | record_content | 记录内容,描述 Record 记忆的实际信息。 |
| | strategy_name | 生成该记录的策略名称。 |
| | created_at | Record 创建时间。 |
| | updated_at | Record 最后一次更新时间。 |
| total_count | - | 符合查询条件的总 Record 数量。 |