查询用户记忆内容
更新时间:2025-05-13
功能介绍
本接口用于查询用户记忆内容,支持查询单个用户所有的记忆内容或单条记忆内容:
- 查询单个用户所有的记忆内容,即根据用户人设标识userMemoryId和应用appId查询对应的用户所有的记忆内容。
- 查询单个用户的单条记忆内容,即根据用户人设标识userMemoryId、应用appId和单条记忆内容id,查询对应单条用户记忆内容。
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
Bash
1POST /v2/memory?Action=DescribeUserMemory HTTP/1.1
2Host: qianfan.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
5
6{
7 "appId": "48xxx17",
8 "userMemoryId":"um-j4gnxxxxxv4ii" # 替换需查询记忆的用户的唯一userMemoryId
9}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值DescribeUserMemory |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
appId | string | 是 | 千帆应用AppId,说明: (1)在控制台-系统管理与统计-应用接入页面查看,如下图所示: ![]() (2)如果应用列表无应用,请先创建应用,请查看创建应用操作步骤 |
userMemoryId | string | 是 | 用户人设标识,对应传入模型的uid |
marker | string | 否 | 本次查询的起始位置,如果不传,默认为0 |
maxKeys | int | 否 | 返回的列表长度,如果不传,默认为100 |
memoryContentId | List<string> | 否 | 用户的单条记忆内容id,说明:如果使用此参数,目前单次请求仅支持查询一个内容id |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | object | 请求结果,请求成功时返回 |
result说明
名称 | 类型 | 描述 |
---|---|---|
appId | string | 千帆应用AppId |
userMemoryId | string | 用户人设标识id |
description | string | 用户人设描述 |
memories | List<List<object>> | 用户记忆内容列表 |
memories说明
名称 | 类型 | 描述 |
---|---|---|
role | string | 角色类型,说明: · user:用户 · system:系统 |
content | string | 文本内容 |
memoryContentId | List<string> | 说明: · 用户户人设标识id下的单条记忆内容id · 单条记忆内容中包含user和system的一个问答对,问与答共享一个id · 目前单次请求仅支持传入一个内容id |
type | string | 说明: · explicit: 显式记忆 · implicit: 隐式记忆 · profile: 用户画像记忆 |
请求示例
- 查询单个用户所有的记忆内容
Bash
1# 替换下列示例中的Authorization值
2curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=DescribeUserMemory'\
3--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44xxxxx016e374525543'\
4--header 'Content-Type: application/json'\
5--data '{
6 "appId": "48xxx17",
7 "userMemoryId":"um-j4gnxxxxxv4ii" # 替换需查询记忆的用户的唯一userMemoryId
8}'
- 查询单个用户的单条记忆内容
Bash
1# 替换下列示例中的Authorization值
2curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=DescribeUserMemory'\
3--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44xxxxx016e374525543'\
4--header 'Content-Type: application/json'\
5--data '{
6 "appId":"112xxx706",
7 "userMemoryId": "um-nbb5xxxxxs43", #替换需查询记忆的用户的唯一userMemoryId
8 "memoryContentId": ["WCtm35QBKRPsy3wO9_px"] # 对应的用户单条记忆内容id,目前单次请求仅支持查询一个内容id
9 }'
响应示例
- 查询单个用户所有的记忆内容
JSON
1{
2 "requestId": "616142e9-fdac-4c49-8d91-b1da7c187370",
3 "result": {
4 "appId": "11xxxx06",
5 "userMemoryId": "um-j4gnxxxxxxv4ii",
6 "description": "用户A是一名女性,今年25岁,北京人。她最常点茉莉绿茶和珍珠奶茶,热衷尝试新品。",
7 "memories": [
8 [
9 {
10 "memoryContentId": "jNyxRZQB38Wmv6Rt4QHZ",
11 "role": "user",
12 "content": "你好,我叫小A,我的口味偏清淡,喜欢喝绿茶,很注重饮食健康。",
13 "type": "profile"
14 },
15 {
16 "memoryContentId": "jNyxRZQB38Wmv6Rt4QHZ",
17 "role": "system",
18 "content": "好的小A,我推荐你下单茉莉绿茶或抹茶牛奶,这两种饮品都很健康,且符合你的口味。",
19 "type": "profile"
20 }
21 ],
22 [
23 {
24 "memoryContentId": "i9yxRZQB38Wmv6Rt4QHZ",
25 "role": "user",
26 "content": "记住我的点单偏好:不另外加糖、少冰、不加小料。",
27 "type": "profile"
28 },
29 {
30 "memoryContentId": "i9yxRZQB38Wmv6Rt4QHZ",
31 "role": "system",
32 "content": "好的小A,我已经记住了你的偏好。",
33 "type": "profile"
34 }
35 ]
36 ]
37 }
38}
- 查询单个用户的单条记忆内容
JSON
1{
2 "requestId": "6d0fd2c9-22d3-4cb0-a134-c5ad273bc346",
3 "result": {
4 "appId": "112xxx706",
5 "userMemoryId": "um-nbbxxxxxs43",
6 "description": "用户A是一名女性,今年25岁,北京人。她最常点茉莉绿茶和珍珠奶茶,热衷尝试新品",
7 "memories": [
8 [
9 {
10 "memoryContentId": "WCtm35QBKRPsy3wO9_px",
11 "role": "user",
12 "content": "记住我的点单偏好:不另外加糖、少冰、加很多小料。",
13 "type": "profile"
14 },
15 {
16 "memoryContentId": "WCtm35QBKRPsy3wO9_px",
17 "role": "system",
18 "content": "好的小A,我已经记住了你的偏好。",
19 "type": "profile"
20 }
21 ]
22 ]
23 }
24}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
Plain Text
1{
2 "requestId":"6ba7b810-xxxc04fd430c8",
3 "code":"AccessDenied",
4 "message":"Access denied."
5}
更多其他错误码,也可以查看错误码说明。