Skip to content

Latest commit

 

History

History
65 lines (37 loc) · 4.53 KB

File metadata and controls

65 lines (37 loc) · 4.53 KB

0.x 目标行为合同

参考 · 面向使用者的目标承诺,不是当前 SDK 文档

本页是 lorebit 后续实现的公开用户行为事实源。它说明 0.x 目标版本必须让使用者获得什么结果、看见什么状态、在失败时得到什么边界。它不表示这些 API、命令或 adapter 已经发布;请先阅读当前可用性

合同总览

编号 目标行为 使用者可以依赖的结果
U1 定义范围 一条知识流程有可复查的问题、允许资料、适用范围、证据要求和拒答边界。
U2 准入资料 每份可用资料有来源、负责人、修订、适用条件与可引用位置。
U3 管理处理状态 使用者知道资料是待审阅、处理中、已激活、已替代还是已撤回。
U4 交付可追溯回答 关键结论与证据片段、来源、修订、适用范围和限制一起交付。
U5 处理变化 更新、替代、撤回和部分处理会暴露影响范围与当前保证。
U6 协商能力 adapter 的能力与缺失能力对查询、处理和结果的影响可见。
U7 诊断与恢复 来源、版本、引用、状态和能力缺口能引导使用者恢复,而非只给内部错误。

U1:范围必须先于实现

使用者能创建或复查一条知识流程的业务边界:为谁服务、回答什么、不能回答什么、允许依据什么、需要怎样的证据。实现不得把这些边界隐藏在模型提示、硬编码条件或某个 provider 的私有配置里。

不允许的结果: 一条流程看似成功,但任何人无法判断它是否回答了超出地区、套餐或时间范围的问题。

U2:资料必须成为可追溯证据

一份资料若要作为默认依据,使用者必须能确认它来自哪里、谁负责、哪一版有效、适用于什么,以及回答可回到哪里。资料多不等于可信;没有身份或定位的内容只能是待补资料,不能自动变成主证据。

不允许的结果: 系统只显示一段“相似文本”,却无法说明原文、版本或适用条件。

U3:处理状态必须可见

0.x 需要区分发现、审阅、处理、激活、替代和撤回等用户语义。实现可以用队列、任务或其他机制,但“处理中”“部分完成”和“已可回答”必须对使用者有不同含义。

不允许的结果: 索引或处理失败后,结果仍被描述为完整、最新或可默认使用。

U4:回答与证据是同一个结果

回答至少包含可行动的结论、适用范围、支撑结论的证据、来源与修订,以及当前限制。证据不足时,结果可以缩小、要求补充信息、提示等待更新或转人工;不可以用无依据的流畅文本替代事实。

不允许的结果: 调用方必须猜测哪一段检索文本真正支撑哪个结论,或错误被静默吞掉。

U5:变化必须保持可追踪

资料修订、替代和撤回要说明旧新关系、受影响范围、处理进度和历史结果边界。旧内容可以为了审计与回溯保留,但被替代后不得继续承担新问题的默认主证据角色。

不允许的结果: 新资料覆盖旧资料后,团队既无法解释历史答案,也不知道哪些当前回答需要复查。

U6:能力必须先于 provider 名称

使用者按需要的文档保存、语义检索、关键词检索、过滤、关系、版本和检查点能力选择 adapter。若能力缺失,系统需要说明哪条用户结果会受影响,并提供确定性的降级或不支持语义。

不允许的结果: 把“支持某数据库”或“能存向量”宣传为完整、可信的知识工作流。

U7:恢复要从事实边界开始

出现来源不明、版本冲突、引用缺失、处理未完成或能力不足时,使用者应先看见:发生了什么、影响什么、当前还能保证什么、谁或哪一步能恢复。错误消息可以携带技术细节,但不能替代这些业务结果。

不允许的结果: 只有内部异常或重试按钮,而使用者不知道结果还能不能用于业务决定。

合同如何演进

未来实现可以补充 API、CLI、配置和 adapter,但不能悄悄弱化 U1–U7。若用户可见行为、默认保证或失败语义需要改变,必须先修订本页和对应的验收场景,再发布实现与接入文档。

下一步:用端到端场景验收合同