查询系统记忆列表
更新时间：2024-11-08
功能介绍
本接口用于查询系统记忆列表。
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址： https://qianfan.baidubce.com/v2/memory
请求方式： POST
- Header参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值application/json |
| x-bce-date | string | 是 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息。更多参见鉴权认证，签名工具可参考IAM签名工具 |
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeSystemMemories |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| appId | string | 否 | 千帆应用AppID，在控制台-在线服务-应用接入页面查看，如下图所示： |
| marker | string | 否 | 本次查询的起始位置，默认值是0 |
| maxKeys | int | 否 | 返回的列表长度，默认值是100 |
响应说明
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| code | string | 错误码，错误时返回 |
| message | string | 错误信息，请求失败时返回 |
| result | object | 请求结果，请求成功时返回 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| items | array[object] | 标签数组 |
| pageInfo | object | 分页信息 |
items说明
| 名称 | 类型 | 说明 |
|---|---|---|
| appId | string | 千帆应用AppID |
| systemMemoryId | string | 系统人设标识id |
| description | string | 系统人设描述 |
pageInfo说明
| 名称 | 类型 | 说明 |
|---|---|---|
| marker | string | 本次查询的起始位置标识 |
| isTruncated | bool | 是否只返回了部分数据，说明： · true：表示只返回部分结果，未返回全部结果 · false：表示返回全部结果 |
| nextMarker | string | 下次查询的起始位置标记，示例："pl-dnqpsnv1sahwj604" |
| maxKeys | int | 本次查询的页大小，同请求值 |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=DescribeSystemMemories'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee5xxxxe374525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"appId": "48886017"
}'响应示例
{
"requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"items": [
{
"appId": "48886017",
"systemMemoryId": "sm-9a8cfb8ee58",
"description": "系统人设描述1"
},
{
"appId": "48886019",
"systemMemoryId": "sm-9a8cfb8ee58",
"description": "系统人设描述2"
}
],
"pageInfo": {
"marker": "jseqvd194abe3umb",
"isTruncated": false,
"nextMarker": "sdsfds516ca2f4d02",
"maxKeys": 3
}
}
}SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考查询系统记忆列表。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。