SuperAPI AI 工具集

create-retrieval-plugin

智能体与模型

查看项目

更新于 10-16 07:23

技能介绍

用途:引导开发者为 AutoRAG-Research 创建自定义检索流水线插件,属于开发辅助技能。

主要流程与能力:

  1. 脚手架:运行 autorag-research plugin create my_search --type=retrieval,生成 pipeline.py、pyproject.toml、YAML 配置和测试文件。
  2. 实现:参考 ai_instructions 下的 pipeline_implementer.md、pipeline_test_writer.md、pipeline_architecture_mapper.md 规则,实现两个抽象方法:_retrieve_by_id(query_id, top_k) 和 _retrieve_by_text(query_text, top_k)。两者需返回 list[dict[str, Any]],包含 doc_id(chunk ID)与 score 键。
  3. 注意事项:不要自行添加 asyncio.gather、asyncio.Semaphore 等并发控制,基类 run() 已通过 run_with_concurrency_limit() 处理并行,由 max_concurrency 配置控制;每个方法只处理单个查询逻辑。自定义参数需在配置类加字段,经 get_pipeline_kwargs() 传入流水线构造函数,可参考 bm25.py 示例。
  4. 测试与安装:pip install -e .(或 uv pip install -e .),再执行 autorag-research plugin sync,用 ls configs/pipelines/retrieval/my_search.yaml 验证。

关键文件:BaseRetrievalPipelineConfig(autorag_research/config.py)、BaseRetrievalPipeline(pipelines/retrieval/base.py)、RetrievalPipelineService、plugin_registry.py。可参考的现有实现:bm25.py、vector_search.py、hybrid.py、hyde.py,及对应 YAML 配置。

限制:资料仅说明上述流程与规则,未提供收费、平台或效果信息;具体实现细节需以仓库内文档为准。