Skip to main content
复制本页的 curl 示例前,先选择 Cloud 区域。需要认证的调用必须使用与密钥同一区域的地址。下方示例都使用 MIROBODY_API_BASE:
SDK 示例中如果写有全球区的完整地址,中国区账户须换成对应的中国区地址。参阅区域。 数据以结构化记录和文件两种形态流入。记录会被标准化;上传文件保留原件与抽取文本。二者都可以为 agent 回答提供依据。本页补上最后一环:数据如何离开,由你决定。三个出口,从自动到彻底:
  1. 留存过期:有时限的写入(1h / 2h / 6h / 1d)自行过期;见数据留存。
  2. 删除会话:一次调用拆除一个具名的工作范围(见下)。
  3. 下线 Subject:一次调用擦除该 Subject 的一切(见下)。

会话

session_id 可以同时指代两种含义,也就是工作数据范围与 Agent API 对话:
  1. 限定 retention=session 数据:以 retention: "session" 通过 POST /v1/data(或 POST /v1/standardize 的 store=true)写入的记录必须携带 session_id。它们存活到会话被删除为止,而删除会话是唯一能清除它们的办法。
  2. 在 Agent API 上给对话命名:给 POST /v1/responses 传 session_id,这条对话就在该 id 下永续、可恢复。见状态与记忆。
结束工作数据范围:以此 session_id 写入、retention=session 的记录被擦除,会话范围的文件上传被移除,底层聊天会话被标记为已结束。
此端点不会删除已存储的响应对象。使用同一 session_id 创建的响应仍可通过 GET /v1/responses/{id} 获取,也仍可继续串联。请通过 DELETE /v1/responses/{id} 删除响应对象;需要擦除该 Subject 的全部存储响应时,请使用 Subject 下线。
传入与写入该会话数据时相同的 user;省略则指向你账户的默认 Subject。
deleted 统计会话范围的记录、文件与底层聊天会话,不包含已存储的响应对象。0 表示这几类资源均未匹配。

下线一个 Subject

一次调用实现被遗忘权。它擦除该 Subject 的一切:
  1. 结构化记录:经 POST /v1/data 写入的一切,加上存储的抽取结果,不论 retention 取值为何。
  2. 文件:经 POST /v1/files 上传的一切,立即从 API 中消失。
  3. 存储的 Agent API 对话:立即不可再读取(GET /v1/responses/{id} 返回 404),随后被永久删除。
  4. 身份映射:Subject 本身变得不可达。之后传入同一 user 的请求会铸造一个全新的空 Subject,与被擦除的那个毫无关联。
擦除绝不会创建它正要擦除的那个 Subject:解析只查找已有映射。传入一个你的账户从未用过的 user 会返回 404,不会铸造任何新 Subject。
需要更细粒度的删除时,改用按资源的删除接口:DELETE /v1/data(记录)、DELETE /v1/files/{key}(单个文件)、DELETE /v1/responses/{id}(单个存储响应)、DELETE /v1/sessions/{id}(会话范围的数据与文件)。完整的用户权利图景见合规。

错误

另见