召回记忆
接口说明
检索用户和分身之间的长期记忆
长期记忆可以理解为对话历史记录提取的重要信息
记忆召回接口支持多种基础用法,推荐大部分用户使用默认参数即可,默认参数可以获取【基础记忆能力】。
根据内部实验,使用【基础记忆能力】对比【不使用能力】更具优势,并且针对长对话场景尤其适合。
【基础记忆能力】会包含用户画像和重点信息总结
- 用户画像信息
- 基础属性:用户的年龄、性别、职业等基本信息
- 兴趣爱好:用户在对话中表达的兴趣偏好
- 性格特征:用户表现出的性格特点和行为模式
- 重点信息总结
- 具体的对话片段和事件记录
- 有时间和上下文信息
使用限制
该域名只有在分身专属开发环境抖音云中才可以访问
基本信息
名称 | 描述 |
---|---|
HTTP URL | http://open-ai-byted-org.dyc.ivolces.com/dy_open_api/avatar/atomic/api/recall_memory/ |
HTTP Method | POST |
Scope | bytedance.avatar_arch.atomic_service_proxy |
请求参数
请求头
content-type必填String
固定值"application/json"
Body展开全部子属性
params必填Struct
展开子属性
request_info必填Struct
展开子属性
请求示例
curl --location --request POST 'http://open-ai-byted-org.dyc.ivolces.com/dy_open_api/avatar/atomic/api/recall_memory/' \ --header 'content-type: application/json' \ --data '{ "params": {}, "request_info": { "provider_id": "0", "biz_id": "format", "traffic_source": { "source": "", "enter_from": "", "traffic_type": "" }, "open_id": "your_open_id", "avatar_app_id": "your_app_id" } }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:"access_token无效"
错误描述
err_no必填Int32
示例:28001003
错误码
log_id必填String
示例:"202405291440576E078D8757B9"
日志id
响应示例
{ "data": { "memories": [ { "memory_id": "mem_12345", "user_id": "user_67890", "avatar_id": "avatar_54321", "memory_type": 1, // 1 代表重点信息总结,2 代表用户画像 "memory_name": "新工作第一天", "group": "工作经历", "sub_group": "职业里程碑", "content": "今天是我在字节跳动的第一天。我见到了新的团队成员,并了解了我们的主要项目。办公环境非常现代化,充满协作氛围。我对未来的挑战感到兴奋,也很期待能在前沿AI技术领域工作。" "created_at_unix_milli": 1640995200000, "last_updated_at_unix_milli": 1641081600000, "memory_date_at_unix_sec": 1640908800 } ] } }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 28001005 | 系统内部错误,请重试 | 请求重试,若依然无解请向平台提交反馈 |
200 | 28001003 | access_token无效 | 重新请求生成access_token |
200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
200 | 28001016 | 当前应用已被封禁或下线 | clientKey被封禁或者下线 |
200 | 28001006 | 网络调用错误,请重试 | 重试即可 |
200 | 28001014 | 应用未授权任何能力 | 确认应用是否授权能力 |
200 | 28001018 | 应用未获得该能力 | 开通相关能力 |
200 | 28003017 | quota已用完 | 联系平台处理 |
200 | 28001019 | 应用该能力已被封禁 | 该能力被封禁,联系平台处理 |
200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
200 | -40001 | 具体缺失或错误的请求字段信息 | 按照错误消息修改入参后重新请求 |
200 | -41003 | 记忆未配置 | 记忆未在平台配置,前往开放平台进行记忆相关信息配置 |