RetrieveMemory - 召回记忆

召回记忆。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
agentrun:RetrieveMemorycreate
*全部资源
*

请求语法

POST /2025-09-10/agents/memories/{memoryName}/records HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

模版基础结构

queryobject

查询条件组合

userIdstring

查询 userId 对应的数据,必选参数

uid1
namespacestring

长期记忆所属的空间名称,例如是 preference、facts

preference
metadataobject

自定义 metadata 过滤条件

string

meta 信息

{}
memorystring

需要查询的长短期记忆内容

10
topkinteger

返回 topk 个数据

10
frominteger

查询开始时间点。该时间是指写入日志数据时指定的日志时间。

请求参数 from 和 to 定义的时间区间遵循左闭右开原则,即该时间区间包括区间开始时间点,但不包括区间结束时间点。如果 from 和 to 的值相同,则为无效区间,函数直接返回错误。 Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1756431013
tointeger

查询结束时间点。该时间是指写入日志数据时指定的日志时间。

请求参数 from 和 to 定义的时间区间遵循左闭右开原则,即该时间区间包括区间开始时间点,但不包括区间结束时间点。如果 from 和 to 的值相同,则为无效区间,函数直接返回错误。 Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1737856802
storestring

store 类型,分为长短期记忆,默认搜索长期记忆,值为 memory。如需搜索短期记忆,值为 event。

memory
memoryNamestring

记忆名称

test-memory

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

BC65E49E-1F6A-55E0-8A0E-7255DBFAA8F9
codestring

响应码。

SUCCESS
dataobject

返回结果

eventsarray<object>

多个短期记忆事件

eventsobject

单个 event 事件内容,由多个 key value 来表达。

string

短期记忆事件对象。

{"role":"user","message":"test"}
memoriesarray<object>

多个长期记忆

memoriesobject

单个长期记忆由多个 key value 表示

string

长期记忆体对象。

[{'memoryId': '9dd5beff783f45efa897211d160ec16c', 'description': u'\u7528\u6237\u5f20*\u661f\u753b\u50cf'}]

示例

正常返回示例

JSON格式

{
  "requestId": "BC65E49E-1F6A-55E0-8A0E-7255DBFAA8F9",
  "code": "SUCCESS",
  "data": {
    "events": [
      {
        "key": {
          "role": "user",
          "message": "test"
        }
      }
    ],
    "memories": [
      {
        "key": "[{'memoryId': '9dd5beff783f45efa897211d160ec16c', 'description': u'\\u7528\\u6237\\u5f20*\\u661f\\u753b\\u50cf'}]"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。