接口介绍
按完整路径读取一份场景记忆 Markdown 文件全文。传入目标路径,系统返回该场景记忆的原文与时间戳:
目标定位:通过
path 指定场景记忆的完整路径(必填),例如 工作/交付物/2026Q1.md。路径承载:
path 由 JSON body 承载,无需 encodeURIComponent,可直接包含中文、深层目录与特殊字符。项 | 值 |
HTTP 方法与路径 | POST /v2/scenario/read |
HTTP 文档 | |
函数签名 | read_scenario(path) |
说明:
若
path 不存在或不属于当前调用上下文,统一返回业务错误码 404。使用示例
result = client.read_scenario(path="工作/交付物/2026Q1.md")print(result["content"])
说明:
请求参数
参数名 | 类型 | 必填 | 描述说明 |
path | str | 是 | 目标记忆文件的完整路径。 格式要求:必须传入包含目录和文件扩展名的全路径(区分大小写,不支持模糊匹配或相对路径)。 正确示例:"工作/交付物/2026Q1.md"。 说明: 请勿传入仅含目录的路径(如 "工作/交付物/"),否则系统将无法定位到具体文件。 |
返回信息
返回字典包含场景记忆原文、摘要、时间戳与请求追踪 ID:
{"path": "工作/交付物/2026Q1.md","content": "# 2026Q1 交付物清单\\n...","summary": "2026 年第一季度交付物归档","created_at": "2026-04-01T09:00:00+08:00","updated_at": "2026-05-22T14:30:00+08:00","trace_id": "tr-xxxxxxxx-xxxxxxxx"}
字段名 | 类型 | 说明 |
path | str | 场景记忆文件的完整存储路径。作为全局唯一标识,例如 "工作/交付物/2026Q1.md"。包含完整的目录层级与文件拓展名。 |
content | str | 场景记忆的全量原始正文。通常为 Markdown 格式的字符串。存储该记忆节点所保存的详细文本数据。 |
summary | str | 由大模型或系统后台自动生成的记忆摘要。对 content 长文本的高度提炼与概括,用于在非详情(如列表、检索预览)场景下提供快速业务认知。 |
created_at | str | 该场景记忆文件的首次创建时间戳。采用 ISO 8601 标准格式(如 "2026-04-01T09:00:00+08:00"),一旦生成,在后续的覆盖写入中保持不变。 |
updated_at | str | 该场景记忆文件的最后修改时间戳。采用 ISO 8601 标准格式。任何对 content 的覆盖写入或系统的摘要更新都会触发此时间戳刷新。 |
trace_id | str | 请求追踪 ID。用于全链路日志排查。该值与 HTTP 响应头中的 x-trace-id 保持一致,用于审计和定位单次读取操作。 |
错误处理
错误码 | 触发场景 | 处理建议 |
404 | path 不存在或不属于当前调用上下文。 | 请校验路径合法性。 |
500 | 服务端错误。 | 记录 trace_id 后重试或上报。 |