更新一言系统记忆
更新时间:2024-09-30
功能介绍
本接口用于更新一言系统记忆。
SDK调用
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js 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"
update_resp = resources.Memory.modify_system_memory(system_memory_id='sm-xxxx', memories=[
[
{
"role": "user",
"content": "你叫什么?"
},
{
"role": "system",
"content": "你好,我叫小度!"
}
],
])
print(update_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
"ModifySystemMemory",
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]any{
"systemMemoryId": "sm-4u7nmxxxxx",
"memories": [][]map[string]any{
{
{
"role": "user",
"content": "你叫什么?",
},
{
"role": "system",
"content": "你好,我叫金威,你可以叫我金老师!",
},
},
},
})
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("ModifySystemMemory")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"systemMemoryId", "sm-58a8f44a21a5",
"memories",new Map[][]{
{
CollUtils.mapOf(
"role", "user",
"content", "你叫什么?"
),
CollUtils.mapOf(
"role", "system",
"content", "你好,我叫金威,你可以叫我金老师!"
)
},
{
}
}
))
.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: 'ModifySystemMemory', data: {
"systemMemoryId": "sm-58a8f44a21a5",
"memories":[
[
{
"role": "user",
"content": "你叫什么?"
},
{
"role": "system",
"content": "你好,我叫金威,你可以叫我金老师!"
}
],
[
...
]
]
}
});
console.log(res);
}
main();
返回示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": True
}
{
"requestId": "02e47924-4268-4380-a339-a70b6d5ec518",
"result": true
}
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": true
}
{
requestId:'1bef3f87-c5b2-4419-936b-50f9884f10d4',
result: true
}
请求参数
注意:以下为Python SDK参数说明,Go SDK、Java SDK、Node.js SDK参数说明请参考本文HTTP调用-请求说明。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
systemMemoryId | string | 是 | 系统人设标识id,说明: 通过调用接口查询记忆列表,获取systemMemoryId字段值 |
memories | list[][object] | 是 | 记忆数据的内容,说明: (1)列表长度必须大于0,小于等于1000 (2)列表的元素为数组,每个数组有两个Object,代表一轮对话 |
memories说明
名称 | 类型 | 描述 |
---|---|---|
role | string | 角色,说明: · user:用户问题 · system:系统回答 |
content | string | 问答内容 |
返回参数
请参考本文HTTP调用-响应说明。
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 | 是 | 方法名称,固定值ModifySystemMemory |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
systemMemoryId | string | 是 | 系统人设标识id,说明: 通过调用接口查询记忆列表,获取systemMemoryId字段值 |
memories | list[][object] | 是 | 记忆数据的内容,说明: (1)列表长度必须大于0,小于等于1000 (2)列表的元素为数组,每个数组有两个Object,代表一轮对话 |
memories说明
名称 | 类型 | 描述 |
---|---|---|
role | string | 角色,说明: · user:用户问题 · system:系统回答 |
content | string | 问答内容 |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | bool | 请求结果,请求成功时返回 |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=ModifySystemMemory'\
--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 '{
"systemMemoryId": "sm-58a8f44a21a5",
"memories":[
[
{
"role": "user",
"content": "你叫什么?"
},
{
"role": "system",
"content": "你好,我叫金威,你可以叫我金老师!"
}
],
[
...
]
]
}'
响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": true
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。