查询应用内所有用户记忆id

更新时间：2025-02-14

功能介绍

本接口用于查询应用内所有用户记忆id，即根据用户提供的应用appId查询对应的用户所有的记忆内容。

鉴权说明

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

请求结构

Bash

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

{
    "appId": "699xxx92"
}

请求头域

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

请求参数

Query参数

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

Body参数

名称	类型	必填	描述
appId	string	是	千帆应用AppId，说明：（1）在控制台-系统管理与统计-应用接入页面查看，如下图所示：（2）如果应用列表无应用，请先创建应用，请查看创建应用操作步骤
marker	string	否	本次查询的起始位置，如果不传，默认为0
maxKeys	int	否	返回的列表长度，如果不传，默认为100

响应头域

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

响应参数

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

result说明

名称	类型	描述
items	array[object]	标签数组
pageInfo	object	分页信息

items说明

名称	类型	描述
appId	string	千帆应用id
userMemoryId	string	用户人设id
description	string	用户人设描述

pageInfo说明

名称	类型	描述
marker	string	本次查询的起始位置标识
isTruncated	bool	后面是否还有数据。true表示后面还有数据，false表示已经是最后一页
nextMarker	string	下次查询的起始位置标记，示例："um-dnqpsnv1sahwj604"
maxKeys	int	本次查询的页大小，同请求值

请求示例

Bash

curl -i --location POST 'https://qianfan.baidubce.com/v2/memory?Action=DescribeUserMemories' \
--header 'Authorization: bce-auth-v1/f0ee7a166b93xxxx79702c13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee***25543' \
--header 'Content-Type: application/json' \
--data '{    
    "appId": "699xxx92"
}'

响应示例

JSON

{
    "requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
    "result": {
        "items": [
            {
                "appId": "699xxx92",
                "userMemoryId": "um-9a8cxxx58",
                "description": "用户A是一名女性，今年25岁，北京人。她最常点茉莉绿茶和珍珠奶茶，热衷尝试新品。"
            },
            {
                "appId": "69976792",
                "userMemoryId": "um-9a8cfb8ee59",
                "description": "用户B是一名男性，今年30岁，天津人。他有健身习惯，最喜欢晚上到店喝果汁。"
            }
        ],
        "pageInfo": {
            "marker": "um-9a8cfb8ee59",
            "isTruncated": false,
            "nextMarker": "um-9a8cfb8ee55",
            "maxKeys": 3
        }
    }
}

错误码

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

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

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

查询用户记忆内容

修改用户记忆内容