查询应用内所有用户记忆id
更新时间：2025-02-19
功能介绍
本接口用于查询应用内所有用户记忆id，即根据用户提供的应用appId查询对应的用户所有的记忆内容。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考SDK安装及使用流程。
SDK调用
调用示例
import os
from qianfan import resources
# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
resp = resources.console.utils.call_action(
# 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
"/v2/memory",
# 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action
"DescribeUserMemories",
# 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
{
"appId": "699xxx92"
}
)
print(resp.body)package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
ca := qianfan.NewConsoleAction()
res, err := ca.Call(context.TODO(),
// 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
"/v2/memory",
// 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action
"DescribeUserMemories",
// 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
map[string]interface{}{
"appId": "699xxx92",
})
if err != nil {
panic(err)
}
fmt.Println(string(res.Body))
}import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;
public class Dome {
public static void main(String args[]){
// 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
ConsoleResponse<String> response = qianfan.console()
// 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
.route("/v2/memory")
// 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action
.action("DescribeUserMemories")
// 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
.body(CollUtils.mapOf(
"appId", "699xxx92"
))
.execute(String.class);
System.out.println(response.getResult());
}
}import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
async function main() {
//base_api_route:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
//action:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action
//data:请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
const res = await consoleAction({base_api_route: '/v2/memory', action: 'DescribeUserMemories', data: {
"appId": "699xxx92"
}
});
console.log(res);
}
main();返回示例
{
"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
}
}
}{
"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
}
}
}{
"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
}
}
}{
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
}
}
}请求参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| 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 | 本次查询的页大小，同请求值 |