USAGE / DEPLOYMENT

使用与部署

从安装到查看审查报告的完整工作流，以及可配置的环境参数。

SPEC.USE.001 · CLI · PYTHON 3.12+ · v0.1.0

FLOW.01

使用流程

五步完成一次稿件初审：准备稿件、配置 Key、运行命令、查看产物。

01 准备稿件 DOCX / PDF / TXT

02 配置 API Key .env 文件

03 运行命令 aipreview

04 查看 output output/ 目录

05 打开报告 HTML / DOCX

INSTALL.02

安装步骤

terminal

# 克隆项目并进入目录
cd AiPreView

# 创建虚拟环境
python3 -m venv .venv
source .venv/bin/activate

# 安装依赖
pip install -r requirements.txt
pip install -e .

# 复制环境变量模板
cp .env.example .env

CONFIG.03

API Key 配置

系统默认使用 deepseek_official，也可显式切换 volcengine_agent_plan。建议优先使用 AIPREVIEW_* 环境变量：

.env

# Provider 选择：deepseek_official 默认，可切换 volcengine_agent_plan
AIPREVIEW_LLM_PROVIDER=deepseek_official

# DeepSeek 官方
AIPREVIEW_DEEPSEEK_API_KEY=sk-xxxxxxxxxxxxxxxxxxxx
AIPREVIEW_DEEPSEEK_BASE_URL=https://api.deepseek.com
AIPREVIEW_DEEPSEEK_MODEL=deepseek-v4-pro

# 火山引擎备用 Provider
# AIPREVIEW_VOLCENGINE_API_KEY=...
# AIPREVIEW_VOLCENGINE_MODEL=deepseek-v4-pro

# 无 API Key 时系统自动跳过 LLM 技能
# 代码技能仍然正常运行

RUN.04

运行命令

terminal

# 基本用法：指定稿件路径
aipreview path/to/manuscript.docx

# 断点续跑：从上次中断处继续
aipreview path/to/manuscript.docx --resume

# 支持 PDF 输入
aipreview path/to/manuscript.pdf

# 支持 TXT 输入
aipreview path/to/manuscript.txt

# 兼容入口仍可使用
python src/workflow.py path/to/manuscript.docx

OUTPUT.05

输出目录结构

每次审查会在 output/ 下生成一个以稿件名命名的子目录：

file tree

output/output_{doc_name}/
├── 初审报告.html              # HTML 初审报告
├── editor_explanation.html    # 决策追溯可视化
├── review_result.json         # 完整审查数据
├── *_初审标注.docx            # 初审标注稿
├── *_审阅标注.docx            # 结构化审阅稿
└── *_标注.pdf                 # PDF 标注稿

PARAMS.06

常见配置参数

通过环境变量或 .env 文件配置系统行为：

参数	说明	默认值
`AIPREVIEW_MAX_PAGES`	PDF 最大解析页数	200
`AIPREVIEW_CHUNK_SIZE`	分块大小（段落数）	40
`AIPREVIEW_CHUNK_OVERLAP`	分块重叠（段落数）	10
`AIPREVIEW_MAX_AGENTS`	最大并发审稿技能数	3
`AIPREVIEW_LLM_TIMEOUT`	LLM 调用超时（秒）	120
`AIPREVIEW_ANNOTATE_DOCX`	是否生成标注 DOCX	true