Skip to content
v1.0.0

API站接口汇总-用于对外的接口文档


Default


记忆API

POST
/v1/memories

此接口用于将大模型对话上下文消息提交为记忆体的长期记忆

并发消耗:30点

📌注意

为尽可能贴近人类长期记忆的形成机制,系统在执行记忆功能时,会对对话上下文进行多维度深度分析。该过程包括对基础语义信息的提取、实体及其关系的构建,以及与既有历史记忆的冲突检测与可溯源变更分析。同时,系统还会对历史实体关系中的不一致情况进行修正,并对关系图进行必要的重组与更新。由于上述处理涉及多阶段认知分析与推理,整体记忆过程相对耗时。

基础介绍

  1. 记忆时需要传递对话上下文,上下文结构是在OpenAI对话上下文的基础之上进行了增强,对话上下文中的每句role为user的对话都可以传递一个character字段,character字段用于告知记忆体本句对话发言者的名字,这不仅可以让记忆体知道用户的名字,同时还可以适应更加复杂的多人对话上下文场景(即存在多个不同的character),如果不指定character字段,那么role为user的对话,character默认为“用户”
  2. 记忆接口支持国际化,请通过language参数进行配置
  3. 记忆过程中会产生记忆摘要,记忆摘要可以以记忆体第一人称视角进行提取,也可以以第三人称视角进行获取,可以通过isThirdPerson进行配置,如非特殊情况,推荐使用第一人称
  4. 人类记忆的产生往往会伴随一些元信息,例如在哪里发生的记忆,在什么场景下发生的记忆等,这些元信息往往对记忆具有增强的作用,我们提供了metadata参数,用于记录任何的元信息
  5. 记忆是一个十分耗时的操作,因此提供了同步和异步两种调用方式,同步调用立即开始记忆但一次性允许传入的对话上下文少一些,异步调用会进行排队等待但允许一次性传入大量要记忆的上下文

注意事项

  1. 服务不保证幂等性,重复以相同的对话上下文调用可能产生多条相似记忆
  2. 上下文中单条content字数上限约为192字,超过字数上限的content将会被智能切分为多个content
  3. 同步模式请求耗时最长为200秒以内

最佳实践

  1. 在正常的自然语言对话场景中,推荐以16条对话上下文为单位进行记忆(即每聊16句话触发一次记忆功能,对最新的16句对话上下文进行记忆)
  2. 由于记忆过程本身较为耗时,建议在对话内容提交为记忆后,不要立即将对应的对话上下文从会话中移除。在后续经过若干轮正常对话后,再将已完成记忆的历史上下文移除,可获得更自然且稳定的交互效果
  3. 如非特殊情况,使用第一人称进行记忆效果最佳

Parameters

Header Parameters

Authorization

令牌 api-key

Typestring
Example"Token <api-key>"

Request Body

application/json
JSON
{
"memoryAgentName": "string",
"messages": [
{
"role": "string",
"content": "string",
"character": "string"
}
],
"language": "string",
"isThirdPerson": 0,
"metadata": "string",
"asyncMode": 0
}

Responses

application/json
JSON
{
"code": "string",
"msg": "string",
"data": {
"tip": "string",
"usage": {
"consumedPoints": "string",
"consumedMemoryCount": "string",
"consumedRecallCount": "string",
"consumedThinkingCount": "string",
"consumedDreamCount": "string",
"consumedCommonMemoryWords": "string",
"hasRemainingQuota": true
},
"memoriesInfo": {
"newMemoryCount": 0,
"summarys": [
"string"
],
"entityRelationship": {
"nodes": [
{
"name": "string"
}
],
"links": [
{
"sourceEntityName": "string",
"targetEntityName": "string",
"relations": [
{
"relation": "string"
}
]
}
]
},
"historyMemorySummaryConflictAnalyses": [
{
"summary": "string",
"statusBeforeChange": "string",
"statusAfterChange": "string",
"memoryChangeExplain": "string"
}
],
"historyEntityRelationCorrections": [
{
"sourceEntityName": "string",
"targetEntityName": "string",
"originalRelation": "string",
"correctionReason": "string"
}
]
},
"taskId": "string"
}
}

Playground

Headers
Body

Samples

cURL
JavaScript
PHP
Python

Powered by VitePress OpenAPI