查询一言系统记忆
更新时间: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 | 是 | 方法名称,固定值DescribeSystemMemory |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
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 | 问答内容 |
请求示例
python label=Python
curl --location --request POST 'https://qianfan.baidubce.com/v2/memory?Action=DescribeSystemMemory' \
--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": "smo-9a8cfb8ee58"
}'
响应示例
{
"requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"systemMemoryId": "sm-9a8cfb8ee58",
"memories": [
[
{
"role": "user",
"content": "你叫什么?"
},
{
"role": "system",
"content": "你好,我叫金威,你可以叫我金老师!"
}
],
[
{
"role": "user",
"content": "你喜欢喝什么?"
},
{
"role": "system",
"content": "我喜欢喝无糖可乐"
}
]
]
}
}
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."
}
更多其他错误码,也可以查看错误码说明。