查询一言系统记忆
更新时间:2025-05-16
功能介绍
本接口用于查询一言系统记忆。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
SDK调用
调用示例
1import os
2from qianfan import resources
3
4# 通过环境变量初始化认证信息
5# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9
10
11resp = resources.console.utils.call_action(
12 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
13 "/v2/memory",
14 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
15 "DescribeSystemMemory",
16 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
17 {
18 "systemMemoryId": "sm-9axxxx58"
19 }
20)
21
22print(resp.body)
1package main
2
3import (
4 "context"
5 "fmt"
6 "os"
7
8 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
9)
10
11func main() {
12 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
13 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
14 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
15
16 ca := qianfan.NewConsoleAction()
17
18 res, err := ca.Call(context.TODO(),
19 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
20 "/v2/memory",
21 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
22 "DescribeSystemMemory",
23 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
24 map[string]any{
25 "systemMemoryId": "sm-4u7nmxxxxx",
26 })
27 if err != nil {
28 panic(err)
29 }
30 fmt.Println(string(res.Body))
31
32}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.console.ConsoleResponse;
3import com.baidubce.qianfan.util.CollUtils;
4import com.baidubce.qianfan.util.Json;
5import java.util.Map;
6
7public class Dome {
8 public static void main(String args[]){
9 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
11
12 ConsoleResponse<Map<String, Object>> response = qianfan.console()
13 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
14 .route("/v2/memory")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DescribeSystemMemory")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "systemMemoryId", "smo-9a8cfb8ee58"
22 ))
23 .execute();
24
25 System.out.println(Json.serialize(response));
26 }
27}
1import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7async function main() {
8 //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
9 //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
10 //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
11 const res = await consoleAction({base_api_route: '/v2/memory', action: 'DescribeSystemMemory', data: {
12 "systemMemoryId": "smo-9a8cfb8ee58"
13 }
14 });
15
16 console.log(res);
17}
18
19main();
返回示例
1{
2 "requestId": "fe423cec-d942-48bc-97e0-6368ba9a6688",
3 "result": {
4 "appId": "44555428",
5 "systemMemoryId": "sm-4u7nmxxxxx",
6 "description": "test da系统人设描述",
7 "memories": [
8 [{
9 "memoryContentId": "boE8UJEBHCl5GDJWlUJy",
10 "role": "user",
11 "content": "你叫什么?"
12 }, {
13 "memoryContentId": "boE8UJEBHCl5GDJWlUJy",
14 "role": "system",
15 "content": "你好,我叫金威,你可以叫我金老师!"
16 }]
17 ]
18 }
19}
1{
2 "requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
3 "result": {
4 "systemMemoryId": "sm-9a8cfb8ee58",
5 "memories": [
6 [
7 {
8 "role": "user",
9 "content": "你叫什么?"
10 },
11 {
12 "role": "system",
13 "content": "你好,我叫金威,你可以叫我金老师!"
14 }
15 ],
16 [
17 {
18 "role": "user",
19 "content": "你喜欢喝什么?"
20 },
21 {
22 "role": "system",
23 "content": "我喜欢喝无糖可乐"
24 }
25 ]
26 ]
27 }
28}
1{
2 requestId: '1bef3f87-c5b2-4419-936b-50f9884f10d4',
3 result: {
4 systemMemoryId: 'sm-9a8cfb8ee58',
5 memories: [
6 [
7 {
8 role: 'user',
9 content: '你叫什么?'
10 },
11 {
12 role: 'system',
13 content: '你好,我叫金威,你可以叫我金老师!'
14 }
15 ],
16 [
17 {
18 role: 'user',
19 content: '你喜欢喝什么?'
20 },
21 {
22 role: 'system',
23 content: '我喜欢喝无糖可乐'
24 }
25 ]
26 ]
27 }
28}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
systemMemoryId | string | 是 | 系统人设标识id,说明:通过调用接口查询记忆列表,获取systemMemoryId字段值 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | object | 请求结果,请求成功时返回 |
rusult说明
名称 | 类型 | 描述 |
---|---|---|
systemMemoryId | string | 系统人设标识id |
memories | List<List<object>> | 记忆数据的内容,说明: (1)列表长度必须大于0,小于等于1000 (2)列表的元素为数组,每个数组有两个Object,代表一轮对话 |
memories说明
名称 | 类型 | 描述 |
---|---|---|
role | string | 角色,说明: · user:用户问题 · system:系统回答 |
content | string | 问答内容 |