查询系统记忆列表
更新时间:2024-11-06
功能介绍
本接口用于查询系统记忆列表。
使用说明
本文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
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
list_sm_resp = resources.Memory.describe_system_memories(app_id="262xxx42")
print(list_sm_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,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
"/v2/memory",
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
"DescribeSystemMemories",
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]interface{}{
"appId": "445xxx28",
})
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<Map<String, Object>> response = qianfan.console()
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
.route("/v2/memory")
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
.action("DescribeSystemMemories")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"appId", "48886017"
))
.execute();
System.out.println(Json.serialize(response));
}
}
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,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
//action:调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
//data:对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
const res = await consoleAction({base_api_route: '/v2/memory', action: 'DescribeSystemMemories', data: {
"appId": "48886017"
}
});
console.log(res);
}
main();
返回示例
{
"requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"items": [
{
"appId": "48886017",
"systemMemoryId": "sm-9a8cxxx",
"description": "系统人设描述1"
},
{
"appId": "48886019",
"systemMemoryId": "sm-9a8xxx",
"description": "系统人设描述2"
}
],
"pageInfo": {
"marker": "jseqvd194abe3umb",
"isTruncated": false,
"nextMarker": "sdsfds516ca2f4d02",
"maxKeys": 3
}
}
}
{
"requestId": "015dbc85-5de7-4d90-ba3e-7893cecd9dac",
"result": {
"items": [{
"description": "test系统人设描述",
"appId": "44555428",
"systemMemoryId": "sm-6egwxxxxx"
}, {
"description": "test da系统人设描述",
"appId": "44555428",
"systemMemoryId": "sm-4u7nxxxxx"
}, {
"description": "test",
"appId": "44555428",
"systemMemoryId": "sm-8f1gxxxxx"
}],
"PageInfo": {
"marker": "",
"isTruncated": false,
"nextMarker": "",
"maxKeys": 100
}
}
}
{
"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
}
}
}
{
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请求参数说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
app_id | string | 否 | 千帆应用AppID,在控制台-在线服务-应用接入页面查看,如下图所示: |
marker | string | 否 | 本次查询的起始位置,默认值是0 |
max_keys | int | 否 | 返回的列表长度,默认值是100 |
- 其它SDK请求参数说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
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 | 本次查询的页大小,同请求值 |