查询一言系统记忆

更新时间：2025-01-20

功能介绍

本接口用于查询一言系统记忆。

使用说明

本文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 
    "DescribeSystemMemory", 
    # 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    {
        "systemMemoryId": "sm-9axxxx58"
    }
)

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 
    "DescribeSystemMemory",
    // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    map[string]any{
		"systemMemoryId": "sm-4u7nmxxxxx",
	})
    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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
                .route("/v2/memory")
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
                .action("DescribeSystemMemory")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
                .body(CollUtils.mapOf(
                     "systemMemoryId", "smo-9a8cfb8ee58"
                ))
                .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，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
  //action:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
  //data:请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
  const res = await consoleAction({base_api_route: '/v2/memory', action: 'DescribeSystemMemory', data: {
        "systemMemoryId": "smo-9a8cfb8ee58"
    }
  });    
    
  console.log(res);
}

main();

返回示例

{
	"requestId": "fe423cec-d942-48bc-97e0-6368ba9a6688",
	"result": {
		"appId": "44555428",
		"systemMemoryId": "sm-4u7nmxxxxx",
		"description": "test da系统人设描述",
		"memories": [
			[{
				"memoryContentId": "boE8UJEBHCl5GDJWlUJy",
				"role": "user",
				"content": "你叫什么?"
			}, {
				"memoryContentId": "boE8UJEBHCl5GDJWlUJy",
				"role": "system",
				"content": "你好，我叫金威，你可以叫我金老师!"
			}]
		]
	}
}

{
	"requestId": "fe423cec-d942-48bc-97e0-6368ba9a6688",
	"result": {
		"appId": "44555428",
		"systemMemoryId": "sm-4u7nmxxxxx",
		"description": "test da系统人设描述",
		"memories": [
			[{
				"memoryContentId": "boE8UJEBHCl5GDJWlUJy",
				"role": "user",
				"content": "你叫什么?"
			}, {
				"memoryContentId": "boE8UJEBHCl5GDJWlUJy",
				"role": "system",
				"content": "你好，我叫金威，你可以叫我金老师!"
			}]
		]
	}
}

{
    "requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
    "result": {
        "systemMemoryId": "sm-9a8cfb8ee58",
        "memories": [
            [
                {
                    "role": "user",
                    "content": "你叫什么?"
                },
                {
                    "role": "system",
                    "content": "你好，我叫金威，你可以叫我金老师!"
                }
            ],
            [
                {
                    "role": "user",
                    "content": "你喜欢喝什么?"
                },
                {
                    "role": "system",
                    "content": "我喜欢喝无糖可乐"
                }
            ]
        ]
    }
}

{
    requestId: '1bef3f87-c5b2-4419-936b-50f9884f10d4',
    result: {
        systemMemoryId: 'sm-9a8cfb8ee58',
        memories: [
            [
                {
                    role: 'user',
                    content: '你叫什么?'
                },
                {
                    role: 'system',
                    content: '你好，我叫金威，你可以叫我金老师!'
                }
            ],
            [
                {
                    role: 'user',
                    content: '你喜欢喝什么?'
                },
                {
                    role: 'system',
                    content: '我喜欢喝无糖可乐'
                }
            ]
        ]
    }
}

请求参数

名称	类型	必填	描述
systemMemoryId	string	是	系统人设标识id，说明：通过调用接口查询记忆列表，获取systemMemoryId字段值

返回参数

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

rusult说明

名称	类型	描述
systemMemoryId	string	系统人设标识id
memories	list[][object]	记忆数据的内容，说明：（1）列表长度必须大于0，小于等于1000 （2）列表的元素为数组，每个数组有两个Object，代表一轮对话

memories说明

名称	类型	描述
role	string	角色，说明： · user：用户问题 · system：系统回答
content	string	问答内容

删除系统记忆

更新一言系统记忆