修改README
This commit is contained in:
31
README.md
31
README.md
@@ -6,10 +6,9 @@
|
||||
|
||||
- **LLM增强**:集成阿里云千问大模型,智能识别和提取需求
|
||||
- **多格式支持**:支持PDF和Docx格式的SRS文档
|
||||
- **非严格GJB结构**:支持不完全遵循GJB 438B标准的文档结构
|
||||
- **非严格文档结构**:支持不规范的文档结构
|
||||
- **智能过滤**:自动过滤系统描述、重复需求等非需求内容
|
||||
- **结构化输出**:按章节层次组织的JSON格式输出
|
||||
- **灵活模式**:支持纯规则提取和LLM增强两种模式
|
||||
- **表格需求识别**:支持从表格中提取功能/接口/其他需求
|
||||
|
||||
## 快速开始
|
||||
@@ -34,8 +33,8 @@ export DASHSCOPE_API_KEY="your-api-key"
|
||||
$env:DASHSCOPE_API_KEY="your-api-key"
|
||||
|
||||
# 方式2:在config.yaml中配置
|
||||
# llm:
|
||||
# api_key: "your-api-key"
|
||||
llm:
|
||||
api_key: "your-api-key"
|
||||
```
|
||||
|
||||
### 运行
|
||||
@@ -70,7 +69,7 @@ python -c "from src.document_parser import DocxParser; parser = DocxParser('test
|
||||
| 字段 | 说明 |
|
||||
|------|------|
|
||||
| **接口名称** | 接口的名称
|
||||
| **接口类型** | 接口的类型(如:CAN总线接口、以太网接口、串口等) |
|
||||
| **接口类型** | 接口的类型
|
||||
| **来源** | 数据或信号的来源/发送方 |
|
||||
| **目的地** | 数据或信号的目的地/接收方 |
|
||||
|
||||
@@ -87,16 +86,16 @@ SRS_reqs_qwen/
|
||||
├── main.py # 主程序入口
|
||||
├── config.yaml # 配置文件
|
||||
├── requirements.txt # 依赖
|
||||
├── src/
|
||||
│ ├── document_parser.py # 文档解析器
|
||||
│ ├── requirement_extractor.py # 需求提取器
|
||||
│ ├── json_generator.py # JSON生成器
|
||||
│ ├── llm_interface.py # LLM接口
|
||||
│ └── utils.py # 工具函数
|
||||
├── docs/
|
||||
│ ├── README.md # 项目说明
|
||||
│ ├── ARCHITECTURE.md # 架构文档
|
||||
│ └── USAGE.md # 使用指南
|
||||
└── tests/ # 测试文件
|
||||
├── json_to_excel.py # JSON转Excel工具
|
||||
├── README.md # 项目说明
|
||||
├── input/ # 输入文档目录
|
||||
├── output/ # 输出结果目录
|
||||
└── src/ # 源代码目录
|
||||
├── __init__.py
|
||||
├── document_parser.py # 文档解析器
|
||||
├── requirement_extractor.py # 需求提取器
|
||||
├── json_generator.py # JSON生成器
|
||||
├── llm_interface.py # LLM接口
|
||||
└── utils.py # 工具函数
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user