资讯 社区 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

创建系统记忆

接口描述

本接口用于创建系统记忆。

注意事项

本文API一般需要与推理服务相关API配合调用,使用方法可以参考系统记忆机制实践教程

鉴权说明

调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明

请求结构

POST /v2/memory?Action=CreateSystemMemory HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "appId": "488xxx017",
    "description": "系统人设描述"
}

请求头域

除公共头域外,无其它特殊头域。

请求参数

  • Query参数
名称 类型 必填 描述
Action string 方法名称,固定值CreateSystemMemory
  • Body参数
名称 类型 必填 描述
appId string 千帆应用AppId,说明:
(1)在控制台-在线服务-应用接入页面查看,如下图所示:
image.png
(2)如果应用列表无应用,请先创建应用,请查看创建应用操作步骤
description string 系统记忆的备注描述,不含记忆功能

响应头域

除公共头域外,无其它特殊头域。

响应参数

名称 类型 描述
requestId string 请求ID
code string 错误码,错误时返回
message string 错误信息,请求失败时返回
result string 系统人设标识id

请求示例

# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=CreateSystemMemory'\
--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 '{
    "appId": "488xxx017",
    "description": "系统人设描述"
}'

响应示例

{
    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
    "result":"sm-8f1g6xxxkbn"
}

错误码

若请求错误,服务器将返回的JSON文本包含以下参数:

名称 描述
requestId 请求ID
code 错误码
message 错误描述信息,帮助理解和解决发生的错误

例如错误返回:

{
    "requestId":"6ba7b810-xxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码,也可以查看错误码说明

上一篇
Prompt工程
下一篇
查询系统记忆列表