记忆管理
设备人物画像查询
接口描述
查询当前设备的人物画像信息
请求语法
1GET /api/v{version}/character-portraits HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| appId | String | 是 | RequestParam | 互动应用id |
| userId | String | 是 | RequestParam | 业务侧用户的唯一id |
请求示例
1GET /api/v1/character-portraits?appId=appxxx&userId=123456789
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| data | Array | 人物画像条目列表;该设备无画像时返回空数组 |
| +category | String | 画像类别 |
| +value | String | 该类别对应的画像内容 |
响应示例
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3date: Mon, 05 Sep 2022 03:25:43 GMT
4transfer-encoding: chunked
5content-type: application/json;charset=UTF-8
6cache-control: no-cache
7
8{
9 "data": [
10 {
11 "category": "兴趣喜好",
12 "value": "喜欢打篮球、听摇滚乐"
13 },
14 {
15 "category": "基本信息",
16 "value": "姓名:小明"
17 }
18 ]
19}
设备人物画像写入
为设备写入一组画像,该画像后续不会自动更新。 再次调用本接口可更新画像内容。
请求语法
1PUT /api/v{version}/character-portraits HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求体
| 参数名 | 类型 | 必要性 | 参数描述 |
|---|---|---|---|
| appId | String | 是 | 互动应用 ID |
| userId | String | 是 | 业务侧用户的唯一 ID |
| data | Array<Object> | 是 | 写入的画像数据 |
| +category | String | 是 | 画像类别 |
| +value | String | 是 | 画像内容 |
请求示例
1{
2 "appId": "appxxx",
3 "userId": "123456789",
4 "data": [
5 {
6 "category": "兴趣喜好",
7 "value": "喜欢打篮球、听摇滚乐"
8 },
9 {
10 "category": "会员等级",
11 "value": "黄金会员"
12 }
13 ]
14}
响应参数
无。
响应示例
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3content-type: application/json;charset=UTF-8
设备人物画像删除
删除指定类别的人物画像。
请求语法
1PUT /api/v{version}/character-portraits/remove HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求体
| 参数名 | 类型 | 必要性 | 参数描述 |
|---|---|---|---|
| appId | String | 是 | 互动应用 ID,不能为空 |
| userId | String | 是 | 业务侧用户的唯一 ID,不能为空 |
| categories | Array<String> | 是 | 待删除的画像类别,数组不能为空,数组元素不能为空 |
请求示例
1{
2 "appId": "appxxx",
3 "userId": "123456789",
4 "categories": [
5 "会员等级",
6 "兴趣喜好"
7 ]
8}
响应参数
无。
响应示例
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3content-type: application/json;charset=UTF-8
设备人物画像清空
接口描述
清空当前设备的人物画像信息
请求语法
1DELETE /api/v{version}/character-portraits HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| appId | String | 是 | RequestParam | 互动应用id |
| userId | String | 是 | RequestParam | 业务侧用户的唯一id |
请求示例
1DELETE /api/v1/character-portraits?appId=appxxx&userId=123456789
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
响应参数
无
响应示例
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3date: Mon, 05 Sep 2022 03:25:43 GMT
4transfer-encoding: chunked
5content-type: application/json;charset=UTF-8
6cache-control: no-cache
查询生效的画像维度
接口描述
查询应用或指定设备当前最终生效的画像维度。
传入 userId 时,生效维度为应用级配置和设备级配置合并去重后的结果;不传 userId 时,仅查询应用级配置。没有自定义维度时,使用系统默认画像维度。
请求语法
1GET /api/v{version}/character-portraits/categories HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| appId | String | 是 | RequestParam | 互动应用 ID |
| userId | String | 否 | RequestParam | 业务侧用户的唯一 ID。不传时查询应用级生效维度;传入时查询该设备合并应用级配置后的生效维度 |
请求示例
1GET /api/v1/character-portraits/categories?appId=appxxx&userId=123456789 HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| categories | Array<String> | 最终生效的画像维度列表 |
响应示例
1{
2 "categories": [
3 "基本信息",
4 "兴趣爱好",
5 "消费偏好"
6 ]
7}
添加画像维度
接口描述
向应用级或设备级自定义配置中添加画像维度。
同一层级内重复添加不会产生重复数据。需要注意:系统默认画像维度仅在应用级和设备级自定义配置均为空时生效;添加任意自定义维度后,最终生效列表将使用自定义配置,不再自动包含系统默认维度。
请求语法
1PUT /api/v{version}/character-portraits/categories HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求体
| 参数名 | 类型 | 必要性 | 参数描述 |
|---|---|---|---|
| appId | String | 是 | 互动应用 ID,不能为空 |
| userId | String | 否 | 业务侧用户的唯一 ID。不传时添加应用级维度;传入时添加设备级维度 |
| categories | Array<String> | 是 | 待添加的画像维度,数组不能为空,数组元素不能为空 |
请求示例
1{
2 "appId": "appxxx",
3 "userId": "123456789",
4 "categories": [
5 "消费偏好",
6 "出行习惯"
7 ]
8}
响应参数
无。
响应示例
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3content-type: application/json;charset=UTF-8
移除画像维度
接口描述
从应用级或设备级配置中移除指定画像维度。移除不存在的维度时幂等成功。
该接口只删除指定层级的配置。移除设备级维度不会删除或屏蔽同名的应用级维度。当应用级和设备级自定义配置均为空时,系统将重新使用默认画像维度。
请求语法
1PUT /api/v{version}/character-portraits/categories/remove HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求体
| 参数名 | 类型 | 必要性 | 参数描述 |
|---|---|---|---|
| appId | String | 是 | 互动应用 ID,不能为空 |
| userId | String | 否 | 业务侧用户的唯一 ID。不传时移除应用级维度;传入时移除设备级维度 |
| categories | Array<String> | 是 | 待移除的画像维度,数组不能为空,数组元素不能为空 |
请求示例
1{
2 "appId": "appxxx",
3 "userId": "123456789",
4 "categories": [
5 "出行习惯"
6 ]
7}
响应参数
无。
响应示例
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3content-type: application/json;charset=UTF-8
清空画像维度配置
接口描述
清空应用级或指定设备的画像维度配置。清空设备级配置后,该设备继续使用应用级配置;应用级和设备级配置均为空时,使用系统默认画像维度。
请求语法
1DELETE /api/v{version}/character-portraits/categories HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| appId | String | 是 | RequestParam | 互动应用 ID |
| userId | String | 否 | RequestParam | 业务侧用户的唯一 ID。不传时清空应用级配置;传入时清空该设备的设备级配置 |
请求示例
1DELETE /api/v1/character-portraits/categories?appId=appxxx&userId=123456789 HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
响应参数
无。
响应示例
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3content-type: application/json;charset=UTF-8
删除对话上下文
接口描述
删除指定用户在 appId + userId + role 维度下的对话上下文记录。支持按时间范围过滤,仅删除时间戳落在 [beginTime, endTime) 区间内的记录;beginTime 和 endTime 均不传时,删除该维度下全部对话上下文记录。
请求语法
1DELETE /api/v{version}/contexts HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求体
| 参数名 | 参数类型 | 必要性 | 参数描述 |
|---|---|---|---|
| appId | String | 是 | 应用 ID |
| userId | String | 是 | 用户设备 ID |
| role | String | 否 | 角色标识。不传时操作 role 为 null 的数据 |
| beginTime | Long | 否 | 时间范围起点(秒级时间戳,闭区间)。与 endTime 配合使用;不传时默认为 0 |
| endTime | Long | 否 | 时间范围终点(秒级时间戳,开区间)。与 beginTime 配合使用;不传时默认为 Long.MAX_VALUE |
请求示例
1{
2 "appId": "app_demo",
3 "userId": "device_001",
4 "role": "assistant",
5 "beginTime": 1778083200,
6 "endTime": 1778169600
7}
示例时间范围:2026-05-07 00:00:00 ~ 2026-05-08 00:00:00(北京时间)
响应参数
无
响应示例
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3date: Mon, 05 Sep 2022 03:25:43 GMT
4transfer-encoding: chunked
5content-type: application/json;charset=UTF-8
6cache-control: no-cache
评价此篇文章
