ABI 文档

ABI 让科研人员和 AI Agent 通过统一、可预期且受确认门保护的接口运行可复现生物信息学流程。先选择目标，再从只读发现逐步进入经过审查的正式执行。

PyPI Python CI Docs
🌐 English  |  中文

从这里开始

你的目标

建议先阅读

理解组件和请求流

组件与架构

安全运行一次分析

使用 ABI：从生物学问题到分析结果

连接 AI Agent

Agent 使用指南

新增或修改工作流

ABI 全流程开发规范 和 插件开发指南

部署队列任务或生产环境

ABI Job Service、运行时与 HPC 开发指南 和 可发布的运行时锁

安装

ABI 支持 Python 3.10–3.13。

pip install abi-agent
abi --version

按需安装可选能力：

pip install "abi-agent[mcp]"       # MCP 服务
pip install "abi-agent[report]"    # 科研图形和增强报告

五分钟示例

在源码仓库根目录中，内置宏转录组 fixture 无需安装分析工具和参考索引，即可生成执行计划与 dry-run 结果。

abi list-types
abi query --type metatranscriptomics --what stages

abi plan \
  --type metatranscriptomics \
  --config examples/metatranscriptomics/config_demo.yaml \
  --sample-sheet examples/sample_sheet_transcriptomics.tsv \
  --outdir results/docs-plan

abi dry-run \
  --type metatranscriptomics \
  --config examples/metatranscriptomics/config_demo.yaml \
  --sample-sheet examples/sample_sheet_transcriptomics.tsv \
  --outdir results/docs-dry-run

该 fixture 包含参考资源占位路径，只用于演示规划和 dry-run，不是可直接执行的生物学配置。准备真实配置请继续阅读 使用 ABI：从生物学问题到分析结果。

理解 ABI

ABI 把传输、通用工作流机制、生物学插件、运行时执行和结果发布分开，使所有 Agent 集成都保持轻量，并共享相同的安全与结果契约。

组件与架构

使用 ABI

标准生命周期为 query -> plan -> check -> dry-run -> run -> inspect -> report，真实执行必须得到明确确认。

使用方法与示例

开发 ABI

从验收标准开始，选择正确的架构边界，添加回归测试，并运行与受影响发布表面相匹配的质量门禁。

开发规范

运维与发布

生产使用需要固定版本、验证工具和数据库、定义代表性生物学验收标准，并生成严格运行时锁。

运维与发布

组件摘要

层级

面向用户的职责

传输层

CLI、JSON、MCP、模型工具描述、dispatch 和 HTTP Job

核心层

规划、权限、诊断、契约、溯源、表格和报告

插件层

分析特有工具、DAG 分支、解析器、断言和结果解释

运行时

本地、Conda、Docker、Nextflow、Snakemake、HPC 和云端执行

结果层

执行计划、溯源、标准 TSV、报告和科研图形

生命周期和发现命令提供结构化 JSON，通常通过 --output-json 启用。管理命令的 准确参数以 abi <command> --help 为准；当前环境的权威插件列表以 abi list-types --output-json 为准。

索引与表