请求方法

POST

客户端对记忆库服务器请求的操作类型

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

基于AK/SK生成的签名信息

collection_name

String

否

要检索的记忆库名称。

project_name

String

否

记忆库所属项目。

resource_id

String

否

记忆库唯一的资源 id。可选择直接传 resource_id，或同时传 collection_name 和 project_name 作为记忆库的唯一标识。

query

String

否

用户的检索查询语句（最大长度 4000 字符）

• 当传输 query 时，会针对 query 内容对记忆进行语义化匹配召回，召回记忆数量与 limit 值有关；
• 当不传 query 时，会返回符合 filter 条件的记忆列表，按照时间顺序返回（优先取最近的），召回记忆数量与 limit 值有关。

filter

Object

是

检索过滤条件和返回设置。

• user_id

String or Array of String

否

用户 ID，支持单个 ID 或 ID 列表。

• assistant_id

String or Array of String

否

助手 ID，支持单个 ID 或 ID 列表。

• primary_key

String or Array of String

否

用于过滤的画像主键表达式。可以是单个或列表，比如画像主键名为kb_id，想查询kb_id为1的数据，则
检索条件为 primary_key="kb_id=1"

• start_time

Integer

否

检索记忆的起始时间，毫秒级时间戳。

• end_time

Integer

否

检索记忆的终止时间，毫秒级时间戳。

• memory_type

String or Array of String

是

要检索的记忆类型。可以是具体的事件类型 (EventType) 或画像类型 (ProfileType) 名称，或它们的列表。

• group_id

String or Array of String

否

用于过滤的群组ID。可以是单个ID或ID列表。

• session_id

String or Array of String

否

用于过滤的session ID。可以是单个ID或ID列表

limit

Integer

否

返回的检索结果条数，默认为10，取值范围[1, 5000]。

code

Integer

状态码，0 表示成功，其他表示错误。

message

String

返回信息。

data

Object

返回的详细检索结果。

• collection_name

String

被检索的记忆库名称。

• count

Integer

返回的检索结果数量。

• result_list

Array of Object

检索结果列表。

• -id

String

记忆条目（事件或画像实例）的唯一ID。

• -score

Float

与查询的相关性得分。

• -memory_type

String

记忆条目的类型（EventType 或 ProfileType）名称。

• -user_id

Array of String

关联的用户ID列表。

• -assistant_id

Array of String

关联的助手ID列表。

• -session_id

String

关联的会话ID。

• -group_id

String

关联的群组ID。

• -time

Integer

记忆发生或最后更新的时间戳（毫秒）。

• -status

String

记忆条目的状态（预留字段）。

• -labels

String

记忆条目的标签（预留字段）。

• -memory_info

Object

额外的详细信息。其结构取决于memory_type。
对于事件，是事件的属性，再加上原始的多轮对话信息，例如：

{
    "original_messages": "tutor_001(assistant):Okay, let's talk about weather. How would you say “今天天气多云但很暖和” in English?\nstudent_A(user):Today is cloudy but very warm.\ntutor_001(assistant):That's a good start! You can also say, “It's cloudy but warm today”. Your sentence structure was correct. Great job!",
    "answer": "Today is cloudy but very warm.",
    "knowledge_point_name": "天气相关表达",
    "question": "How would you say “今天天气多云但很暖和” in English?",
    "rating": "good",
    "rating_reasoning": "学生能够正确地用英语描述天气，符合该知识点能够基本正确描述天气的良好评价标准",
    "rating_score": 7
}

对于画像，则只包含画像的属性。 例如：

{
    "answer_bad_count": 0,
    "answer_good_count": 3,
    "count": 3,
    "has_been_taught": 0,
    "issues": [],
    "rating_score_max": 1,
    "rating_score_sum": 3
}

• token_usage

Integer

本次检索消耗的token数量。

request_id

String

标识每个请求的唯一ID。