P376 · 上下文管理

按具体版本查询文档

Version-Grounded Documentation Retrieval

确认库名和所需版本后,再使用检索到的 API 指引。

编辑审核

以下示例与示意结果由本站编写,用于说明方法,不是模型实测结果。

使用场景

项目要接入中间件,但你记得的是另一个主版本的例子。教学项目锁文件显示框架 example-web 2.4,用户要求保持 2.x;文档目录同时有 1.x 与 2.x。名称相似和搜索排名靠前都不能代替版本核对。

具体做法

先查项目实际解析版本与用户目标,解决两者差异。检索时确认库身份和版本入口,再读与任务相关的小节;使用文档明确支持的接口并引用来源。达到约定检索预算仍缺关键事实时保留未知,不从旧记忆补造 API。示例版本为虚构教学值。

反例

看到 example-web 搜索结果就复制记忆里的 1.x 中间件写法,忽略锁文件 2.4 和保持 2.x 的要求。

改进写法

先核对上述锁文件的 example-web 2.4 与用户 2.x 目标。选择明确对应库与 2.x 的权威文档入口,读取中间件注册小节,记录文档版本和支持的接口;再根据当前项目实现。若 2.x 文档不可获得或无法确认 API,说明缺口,不用 1.x 名称猜写,也不擅自升级依赖。

为什么这样改

训练记忆或泛化检索可能返回同名库的旧接口。把身份、解析版本与任务小节绑定,能说明一段指引为什么适用于当前依赖,避免因为例子看起来熟悉就越过实际版本边界。

如何验证

示意记录应显示 example-web=2.4、目标=2.x、选中 2.x 小节及对应接口证据。检查实现与测试使用该版本支持的名称。

若目录只有 1.x,合格结果保留缺口而不声称已经确认 2.x。检索工具返回一个候选也不代表其内容已经读到。

适用边界

文档可能滞后或只覆盖部分版本,锁文件也需与实际构建解析一致。查询上限不构成编造接口的许可;冻结来源中的工具名称与限制是来源实例,不要求所有项目安装同一个文档工具。

原文与版本

如何收录这些方法