删除用户记忆id和记忆内容
更新时间:2025-02-14
功能介绍
本接口用于删除用户记忆id和对应的记忆内容,支持以下:
- 删除用户记忆id及该id对应的所有用户记忆内容,即根据用户人设标识id和应用appid,删除用户记忆id下所有记忆内容。
- 删除单条用户记忆内容,即删除用户人设标识id下的单条记忆内容。
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/memory?Action=DeleteUserMemory HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"appId":"112xxx706",
"userMemoryId":"um-j4gnxxxx4ii"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值DeleteUserMemory |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
appId | string | 是 | 千帆应用AppId,说明: (1)在控制台-系统管理与统计-应用接入页面查看,如下图所示: ![]() (2)如果应用列表无应用,请先创建应用,请查看创建应用操作步骤 |
userMemoryId | string | 是 | 用户人设标识id |
memoryContentId | string[] | 否 | 记忆ID列表,说明: · 用户人设标识id下的单条记忆内容id · 单条记忆内容中包含user和system的一个问答对,问与答共享一个id · 目前单次请求仅支持传入一个内容id |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | bool | 请求结果,请求成功时返回 |
请求示例
- 删除用户记忆id和全部记忆
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=DeleteUserMemory'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8xxx0016e374525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"appId":"112xxx706",
"userMemoryId":"um-j4gnxxxx4ii"
}'
- 删除用户单条记忆内容
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=DeleteUserMemory'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8xxx0016e374525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"appId":"112xxx706",
"userMemoryId":"um-cc60xxxxxc5t",
"memoryContentId": ["sa4WpZAB-hEbLPWpi_dn"]
}'
响应示例
- 删除用户记忆id和全部记忆
{
"requestId": "b800a9ef-4538-4998-99dd-f9d92a79fdda",
"result": true
}
- 删除用户单条记忆内容
{
"requestId": "9f23711b-3aa3-48f2-b2e1-3cb81e69a498",
"result": true
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
Code | 错误码 |
Message | 错误描述信息,帮助理解和解决发生的错误 |
更多千帆大模型平台其他错误码,也可以查看错误码说明。