写入用户记忆内容

更新时间：2025-02-14

功能介绍

本接口用于在用户记忆中写入多条记忆内容，即更新一个appId 下某userMemoryId 的记忆内容。支持以下：

全量写入/更新用户记忆内容，新存入的用户记忆信息会覆盖用户过往所有的历史记忆信息。
写入用户记忆内容。

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求结构

Bash

POST /v2/memory?Action=ModifyUserMemory HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "appId":"112xxx706", 
    "userMemoryId": "um-58a8xxxxa5",
    "operator":"cover",
    "memories":[
        [
            {   "role": "user",
                "content": "你好，我叫小A，我的口味偏清淡，喜欢喝绿茶，很注重饮食健康。"
            },
            {
                "role": "system",
                "content": "好的小A，我记住你的口味清淡，喜欢健康饮食，而且喜欢喝绿茶"
            }
         ],
         [
            {
                "role": "user",
                "content": "记住我的点单偏好：不另外加糖、少冰、不加小料。"
            },
            {
                "role": "system",
                "content": "好的小A，我已经记住了你的偏好。"
            }
         ]
    ]
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

Query参数

名称	类型	必填	描述
Action	string	是	方法名称，固定值ModifyUserMemory

Body参数

名称	类型	必填	描述
appId	string	是	千帆应用AppId，说明：（1）在控制台-系统管理与统计-应用接入页面查看，如下图所示：（2）如果应用列表无应用，请先创建应用，请查看创建应用操作步骤
operator	string	否	操作，可选值： · cover：全量覆盖，默认值为cover · insert ：插入一条记忆问答组
userMemoryId	string	是	用户人设标识id
memories	list[][object]	是	记忆数据的内容，说明：（1）列表长度必须大于0，小于等于1000 （2）以数组为元素的列表，每个数组有两个Object，代表一轮对话

memories说明

两个角色一问一答为一组

名称	类型	描述
role	string	角色，说明： · user：用户问题 · system：系统回答
content	string	问答内容

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
requestId	string	请求ID
code	string	错误码，错误时返回
message	string	错误信息，请求失败时返回
result	bool	请求结果，请求成功时返回

请求示例

全量写入/更新用户记忆内容

Bash

# 替换下列示例中的Authorization值
curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=ModifyUserMemory'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44axxxx0016e374525543'\ 
--header 'Content-Type: application/json'\ 
--data '{
    "appId":"112xxx706", 
    "userMemoryId": "um-58a8xxxxa5",
    "operator":"cover",
    "memories":[
        [
            {   "role": "user",
                "content": "你好，我叫小A，我的口味偏清淡，喜欢喝绿茶，很注重饮食健康。"
            },
            {
                "role": "system",
                "content": "好的小A，我记住你的口味清淡，喜欢健康饮食，而且喜欢喝绿茶"
            }
         ],
         [
            {
                "role": "user",
                "content": "记住我的点单偏好：不另外加糖、少冰、不加小料。"
            },
            {
                "role": "system",
                "content": "好的小A，我已经记住了你的偏好。"
            }
         ]
    ]
}'

写入用户记忆内容

Bash

# 替换下列示例中的Authorization值
curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=ModifyUserMemory'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44axxxx0016e374525543'\ 
--header 'Content-Type: application/json'\ 
--data '{
    "appId":"112xxx706", 
    "userMemoryId": "um-j4gnxxxxii", 
    "operator": "insert",
    "memories":[
        [
            {
                "role": "user",
                "content": "我很喜欢吃粤菜。"
            },
            {
                "role": "system",
                "content": "已记住您的菜系偏好。"
            }
        ]
    ]
}'

响应示例

全量写入/更新用户记忆内容

JSON

{
    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
    "result": true
}

写入用户记忆内容

JSON

{
    "requestId":"74e3a9fb-d962-49e5-9c4f-fe73f751233c",
    "result": true
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
Code	错误码
Message	错误描述信息，帮助理解和解决发生的错误

更多千帆大模型平台其他错误码，也可以查看错误码说明。

创建用户记忆id

查询用户记忆内容