创建用户记忆id
更新时间:2025-02-14
接口描述
本接口用于创建用户记id。用户记忆id标记着不同用户的独特身份,后续需根据用户记忆id对用户记忆进行增删改查。
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/memory?Action=CreateUserMemory HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"appId": "488xxx17",
"description": "用户A是一名女性,今年25岁,北京人。她最常点茉莉绿茶和珍珠奶茶,热衷尝试新品。"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值application/json |
x-bce-date | string | 是 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息。更多参见鉴权认证,签名工具可参考IAM签名工具 |
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值CreateUserMemory |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
appId | string | 是 | 千帆应用AppId,说明: (1)在控制台-系统管理与统计-应用接入页面查看,如下图所示: ![]() (2)如果应用列表无应用,请先创建应用,请查看创建应用操作步骤 |
description | string | 是 | 用户人设描述 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | object | 请求结果,请求成功时返回 |
result说明
名称 | 类型 | 描述 |
---|---|---|
userMemoryId | string | 用户人设标识id,对应传入模型的uid |
请求示例
# 替换下列示例中的Authorization值
curl -i --location 'https://qianfan.baidubce.com/v2/memory?Action=CreateUserMemory'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8xxxx16e374525543'\
--header 'Content-Type: application/json'\
--data '{
"appId": "488xxx17",
"description": "用户A是一名女性,今年25岁,北京人。她最常点茉莉绿茶和珍珠奶茶,热衷尝试新品。"
}'
响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"userMemoryId" : "um-9axxxe58"
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
Code | 错误码 |
Message | 错误描述信息,帮助理解和解决发生的错误 |
更多千帆大模型平台其他错误码,也可以查看错误码说明。