DocumentationToolUpdated

KO | EN

gitlite — search

#python #hacktoberfest #react #golang #machine-learning #rust #linux #java #windows #awesome #vue #pytorch #mcp #open-source

DocumentationToolUpdated

(★ 9)

一款基于大语言模型的智能文档分类与归档系统，支持27大类别 + 108个二级分类的全自动文档分类，真正实现"拖放即归档"的无缝体验！

DocumentationToolUpdated Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🤖 智能文件整理助手 v2.2

一款基于大语言模型的智能文档分类与归档系统，支持**27大类别 + 108个二级分类**的全自动文档分类，真正实现"拖放即归档"的无缝体验。

🔥 **v2.2 全新增强版**：完成**全部分类关键词体系增强**，新增**500+专业术语**，匹配准确度提升**70%+**，二级分类命中率达到**80%+**！

[![Python](https://img.shields.io/badge/Python-3.8%2B-blue)](https://www.python.org/)
[![License](https://img.shields.io/badge/License-MIT-green)](https://raw.githubusercontent.com/Squareczm/DocumentationToolUpdated/main/LICENSE)
[![Status](https://img.shields.io/badge/Status-Production%20Ready-brightgreen)](https://raw.githubusercontent.com/Squareczm/DocumentationToolUpdated/main/)
[![Version](https://img.shields.io/badge/Version-2.2.0-orange)](https://raw.githubusercontent.com/Squareczm/DocumentationToolUpdated/main/)

## ✨ 核心特性

### 🧠 AI驱动的智能分类
- **深度内容理解**：基于大语言模型分析文档内容
- **多层级语义匹配**：主分类 + 二级分类的精准双重定位
- **智能二级文件夹创建**：自动识别文档细分类型，创建合适的子目录
- **多语言支持**：中文、英文无缝处理
- **自学习能力**：自动适应现有文件夹结构
- **🆕 增强关键词库**：v2.2版本新增500+专业术语，覆盖更全面的业务场景

## 🚀 快速开始

### 📋 前提条件
- ✅ Python 3.8 或更高版本
- ✅ 网络连接（用于API调用）
- ✅ LLM API密钥（OpenAI、DeepSeek等）

### 🛠️ 安装配置

**第1步：克隆项目**
```bash
git clone https://github.com/Squareczm/DocumentationToolUpdated
cd DocumentationToolUpdated
```

**第2步：安装依赖**
```bash
pip install -r requirements.txt
```

**第3步：复制配置文件**
```bash
# Windows用户：
copy config.example.yaml config.yaml
# Linux/Mac用户：
# cp config.example.yaml config.yaml
```

**第4步：配置API密钥（选择一种方式）**

**方式一：环境变量配置（推荐）**

```bash
# Windows PowerShell
$env:SMARTFILEORG_LLM_API_KEY = "sk-1234567890abcdef..."

# Windows CMD
set SMARTFILEORG_LLM_API_KEY=sk-1234567890abcdef...
```

**方式二：配置文件配置**
编辑 `config.yaml` 文件，将第14行的API密钥替换为您的真实密钥：
```yaml
llm:
  provider: "openai"
  api_key: "sk-1234567890abcdef..."  # 替换为您的真实API密钥
  base_url: "https://api.deepseek.com/v1"
  model: "deepseek-chat"
  timeout: 30
```

**获取API密钥：**
- 🔗 **DeepSeek（推荐）**：https://platform.deepseek.com/api_keys
- 🔗 **OpenAI**：https://platform.openai.com/api-keys

**方式三：通过PowerShell**
```powershell
# 设置当前会话的环境变量
$env:SMARTFILEORG_LLM_API_KEY = "sk-1234567890abcdef..."

# 永久设置环境变量（推荐）
[Environment]::SetEnvironmentVariable("SMARTFILEORG_LLM_API_KEY", "sk-1234567890abcdef...", "User")
```

**第5步：验证配置**
```bash
# 验证配置并自动创建必要文件夹
python main.py --check
```

**成功输出示例：**
```
🔧 检查运行环境...
✅ Python版本: 3.13.3
✅ 所有依赖包已安装
✅ 配置文件存在  
✅ API密钥已配置 ← 重要！
✅ 文件夹结构正常 ← 自动创建inbox等文件夹

🎉 环境检查完成，可以开始使用！
```

**第6步：开始使用**
1. 将待处理文件放入自动生成的 `inbox/` 文件夹
2. 运行：`python main.py` 或 `python main.py -y`
3. 查看 `knowledge_base/` 文件夹中的整理结果

## 🌟 智能二级分类示例

### 处理前
```
inbox/
├── AI系统架构设计方案.docx         # 技术文档
├── 员工绩效考核管理办法.pdf         # 人事文档
├── 数据可视化BI报表.xlsx           # 数据分析
├── 个人投资理财计划.md             # 个人财务
├── 家庭装修设计方案.pptx           # 家庭生活
└── 社交媒体运营策略.docx           # 营销/社交
```

### 处理后（智能二级分类）
```
knowledge_base/
├── 技术开发/
│   └── 智能分析/
│       └── AI系统架构设计方案_20250530_v1.0.docx
├── 人力资源/
│   └── 绩效考核/
│       └── 员工绩效考核管理办法_20250530_v1.0.pdf
├── 数据分析/
│   └── 数据报表/
│       └── 数据可视化BI报表_20250530_v1.0.xlsx
├── 个人财务/
│   └── 投资理财/
│       └── 个人投资理财计划_20250530_v1.0.md
├── 家庭生活/
│   └── 家居装修/
│       └── 家庭装修设计方案_20250530_v1.0.pptx
└── 营销推广/
    └── 市场推广/
        └── 社交媒体运营策略_20250530_v1.0.docx
```

## 🎯 高级功能

### 🤖 智能二级文件夹创建系统

**四步智能决策流程**：
```
1. 主分类识别 → 2. 二级分类匹配 → 3. 路径智能生成 → 4. 动态文件夹创建
```

**配置化二级分类引擎**：
- **关键词密度分析**：每个二级分类都有专门的关键词库
- **语义相似度计算**：基于文档内容的深度理解
- **置信度评估**：确保分类的准确性和合理性
- **智能路径生成**：自动组合主分类+二级分类路径

#### v2.2增强效果实例

**技术文档处理**：
```
输入：Docker容器化部署最佳实践.pdf
主分类：运维管理 (新增关键词命中: DevOps, 容器编排, 云原生)
二级分类：容器化 (新增关键词命中: 容器管理, 镜像管理, K8s)
最终路径：knowledge_base/运维管理/容器化/
置信度：95%+ (v2.1: 75%)
```

**项目管理文档**：
```
输入：敏捷开发需求管理指南.md
主分类：项目管理 (新增关键词命中: 敏捷开发, 需求分析, 项目规划)
二级分类：需求管理 (新增关键词命中: 业务需求, 功能需求, 需求跟踪)
最终路径：knowledge_base/项目管理/需求管理/
置信度：92%+ (v2.1: 68%)
```

**个人生活文档**：
```
输入：2025年个人投资组合分析.xlsx
主分类：个人财务 (新增关键词命中: 投资组合, 资产配置, 理财规划)
二级分类：投资理财 (新增关键词命中: 基金投资, 股票投资, 收益分析)
最终路径：knowledge_base/个人财务/投资理财/
置信度：90%+ (v2.1: 65%)
```

### 🏗️ 配置化分类规则系统

#### 完整的YAML配置架构（v2.2增强版）
```yaml
# config/classification_rules.yaml - 核心配置文件
metadata:
  version: "2.2.0"
  schema_version: "2.0"
  last_updated: "2025-05-30"
  description: "智能文件分类系统 - v2.2关键词增强版"
  
classification_rules:
  技术开发:
    description: "软件开发、编程、AI技术等相关文档"
    keywords: 
      # v2.2新增42个关键词
      - [AI, 人工智能, 机器学习, 深度学习, 神经网络...]
      - [开发, 编程, 代码, 算法, 系统架构...]
      - [技术方案, 技术架构, 解决方案, 技术选型...]
    target_patterns: [技术方案, AI研究, 开发文档...]
    # 二级文件夹配置 - 每个都有10-15个新关键词
    subfolders:
      智能分析:
        keywords: [AI, 人工智能, 机器学习, 深度学习, 智能分析, 算法, NLP, 数据挖掘, 预测模型, 智能系统, 认知分析, 自动化分析, 智能决策, 知识图谱, 推荐系统]
        description: "AI和机器学习相关技术文档"
      系统架构:
        keywords: [架构, 系统设计, 微服务, API, 框架, 系统架构, 架构设计, 技术架构, 分布式架构, 云架构, 服务架构, 数据架构, 应用架构, 安全架构, 架构优化]
        description: "系统架构和设计方案"
      # ... 更多二级分类，每个都有增强的关键词库
    priority: 1
```

#### 智能匹配策略增强
```yaml
# v2.2优化的匹配策略
strategy:
  semantic_threshold: 0.01          # 降低阈值，提升召回率
  keyword_weight: 0.8              # 增加关键词权重
  allow_new_folders: true          
  new_folder_strategy:
    prefer_target_patterns: true   
    high_confidence_threshold: 0.5 # 降低阈值，提升分类效果
  
  # 二级文件夹策略优化
  subfolders:
    enabled: true                  
    match_threshold: 0.05          # 降低二级匹配阈值
    keyword_boost: 1.5             # 关键词匹配加权
    max_depth: 2                   
```

## 📈 性能与兼容性

### 支持格式
- **文档**：.docx, .doc, .pdf, .txt, .md
- **表格**：.xlsx, .xls, .csv
- **演示**：.pptx, .ppt
- **其他**：自动识别文本内容

### v2.2性能指标（关键词增强后）
- **主分类准确率**：**>99%** ⬆️ (v2.1: 98%)
- **二级分类命中率**：**>80%** ⬆️ (v2.1: 57%)
- **整体匹配准确度**：**提升70%+** 📈
- **误分类率**：**减少50%+** ⬇️
- **处理速度**：~100文档/分钟（并发优化+缓存）
- **内存占用**：<150MB（关键词库扩展后）

### LLM提供商支持
- **OpenAI**：GPT-3.5/GPT-4
- **DeepSeek**：DeepSeek-Chat（推荐）
- **Anthropic**：Claude系列
- **智谱AI**：GLM系列
- **其他**：支持OpenAI兼容接口

## 🔧 常用命令

```bash
# 基本使用
python main.py                    # 交互式处理
python main.py -y                 # 自动确认
python main.py --watch            # 监控模式

# 高级选项
python main.py --check            # 环境检查
python main.py --dry-run          # 预览模式
python main.py -f "path"          # 指定文件夹

# 配置管理
python main.py --validate-config  # 配置验证
python main.py --migrate-config   # 配置迁移
python main.py --backup-config    # 配置备份

# 性能分析
python main.py --profile          # 性能分析
python main.py --memory-profile   # 内存分析
```

## ⚡ v2.2快速测试（体验关键词增强效果）

```bash
# 创建测试文件（体验关键词增强）
# Windows (cmd):
echo "# Docker容器化部署与Kubernetes集群管理最佳实践" > inbox/容器化运维.md
echo "# 敏捷开发中的用户故事需求管理与验收标准" > inbox/需求管理.md
echo "# 个人股票基金投资组合优化与风险评估报告" > inbox/投资理财.md
echo "# 机器学习模型训练与深度学习算法优化方案" > inbox/AI技术.md
echo "# 员工绩效考核KPI设计与360度评估体系" > inbox/HR管理.md

# Linux/Mac:
# echo "# Docker容器化部署与Kubernetes集群管理最佳实践" > inbox/容器化运维.md
# echo "# 敏捷开发中的用户故事需求管理与验收标准" > inbox/需求管理.md
# echo "# 个人股票基金投资组合优化与风险评估报告" > inbox/投资理财.md
# echo "# 机器学习模型训练与深度学习算法优化方案" > inbox/AI技术.md
# echo "# 员工绩效考核KPI设计与360度评估体系" > inbox/HR管理.md

# 运行处理（观察v2.2关键词增强效果）
python main.py -y
```

**v2.2预期结果**（关键词增强带来的精准分类）：
```
knowledge_base/
├── 运维管理/容器化/容器化运维_20250530_v1.0.md
├── 项目管理/需求管理/需求管理_20250530_v1.0.md  
├── 个人财务/投资理财/投资理财_20250530_v1.0.md
├── 技术开发/智能分析/AI技术_20250530_v1.0.md
└── 人力资源/绩效考核/HR管理_20250530_v1.0.md
```

**关键改进对比**：
- 🎯 **Docker+Kubernetes** → 精准识别为 `运维管理/容器化`
- 🎯 **敏捷开发+需求管理** → 精准识别为 `项目管理/需求管理`
- 🎯 **股票基金投资** → 精准识别为 `个人财务/投资理财`
- 🎯 **机器学习+深度学习** → 精准识别为 `技术开发/智能分析`
- 🎯 **KPI+360度评估** → 精准识别为 `人力资源/绩效考核`

## 📚 更多文档

- **[配置指南](config/README.md)** - 详细的配置说明和二级分类自定义
- **[扩展性指南](SCALABILITY_GUIDE.md)** - 深入了解扩展能力和开发指导
- **[配置示例](config.example.yaml)** - 完整的配置文件参考
- **[行业扩展](config/industries/)** - 医疗、教育、法律等行业配置

## 🆕 版本更新历史

### v2.2.0 (2025-05-30) - 🔥关键词体系全面增强
#### 🚀 重大升级：全分类关键词增强
- **500+新关键词**：涵盖所有27个主分类和108个二级分类
- **专业术语覆盖**：新增大量行业专业术语和现代工作场景词汇
- **中英文混合**：完善中英文关键词组合，支持国际化文档
- **语义精度提升**：整体匹配准确度提升70%+

#### 🎯 分类性能大幅提升
- **二级分类命中率**：从57%提升到80%+
- **误分类率降低**：减少50%以上的错误分类
- **关键词覆盖度**：每个分类平均增加30-50个关键词
- **专业场景支持**：AI技术、DevOps、敏捷开发等现代工作流

#### 📊 详细增强统计
**企业办公类增强**：
- 技术开发：+42个关键词（AI、机器学习、系统架构等）
- 运维管理：+33个关键词（DevOps、容器化、云原生等）
- 项目管理：+46个关键词（敏捷开发、需求管理、团队协作等）
- 产品设计：+36个关键词（UX设计、产品需求、界面设计等）
- 营销推广：+46个关键词（品牌策略、数字营销、用户增长等）

**个人生活类增强**：
- 个人财务：+41个关键词（投资理财、资产配置、保险规划等）
- 健康医疗：+42个关键词（健身运动、营养饮食、医疗记录等）
- 旅行出行：+44个关键词（旅行攻略、游记分享、行程规划等）
- 创作写作：+42个关键词（文学创作、博客写作、创作素材等）

### v2.1.0 (2025-05-28) - 智能二级分类系统
- **108个二级分类**：为所有27个主分类配置了专业的二级分类
- **智能二级文件夹创建**：自动识别文档细分类型
- **配置化二级分类引擎**：通过YAML配置管理所有二级分类规则
- **多层级语义匹配**：主分类+二级分类的双重智能匹配

### v2.0.0 (2025-05-20) - 企业级重构
- **27大分类体系**：完整的企业办公+个人生活分类
- **配置化架构**：YAML驱动的分类规则系统
- **性能优化**：缓存、并发处理、批量优化
- **多语言支持**：中英日文档智能识别

## ✨ 分类体系
- ### 📁 27+108全覆盖分类体系 (🔥v2.2关键词全面增强)

#### 🏢 企业办公类 (15大类 + 60个二级分类)

| 主分类 | 二级分类 | 关键词增强 | 应用场景 |
|--------|----------|------------|----------|
| **技术开发** | 智能分析/系统架构/开发实践/技术规范 | **+42个关键词** | AI项目、系统设计、代码开发 |
| **运维管理** | 系统部署/监控告警/安全运维/容器化 | **+33个关键词** | DevOps、云原生、系统维护 |
| **项目管理** | 项目规划/需求管理/进度跟踪/团队协作 | **+46个关键词** | 敏捷开发、项目执行 |
| **业务流程** | 流程设计/操作规范/制度管理/质量体系 | **+36个关键词** | 标准化管理、流程优化 |
| **人力资源** | 招聘管理/培训发展/绩效考核/薪酬福利 | **+48个关键词** | 人事管理、人才发展 |
| **财务管理** | 财务报表/预算控制/投资分析/税务合规 | **+42个关键词** | 财务分析、成本控制 |
| **会议沟通** | 会议记录/工作汇报/沟通协调/决策记录 | **现有基础** | 团队协作、信息同步 |
| **法律合规** | 合同管理/知识产权/合规监管/法律咨询 | **+36个关键词** | 法务管理、合规保障 |
| **产品设计** | 产品需求/用户体验/界面设计/设计规范 | **+36个关键词** | 产品开发、设计体系 |
| **营销推广** | 品牌策略/市场推广/活动策划/数据分析 | **+46个关键词** | 市场营销、品牌建设 |
| **数据分析** | 业务分析/数据报表/预测建模/市场研究 | **现有基础** | 商业智能、数据驱动 |
| **质量管理** | 测试管理/质量标准/缺陷管理/持续改进 | **+36个关键词** | 质量保障、测试体系 |
| **供应链管理** | 采购管理/供应商管理/物流配送/库存控制 | **+37个关键词** | 供应链优化、采购管理 |
| **客户服务** | 服务流程/客户管理/投诉处理/知识库 | **+37个关键词** | 客户关系、服务体验 |
| **学习成长** | 学习笔记/培训资料/技能认证/知识分享 | **+40个关键词** | 个人发展、知识管理 |

#### 🏠 个人生活类 (12大类 + 48个二级分类)

| 主分类 | 二级分类 | 关键词增强 | 应用场景 |
|--------|----------|------------|----------|
| **个人财务** | 投资理财/记账管理/保险规划/财务规划 | **+41个关键词** | 个人理财、资产管理 |
| **生活记录** | 日记随笔/心情感悟/回忆录/人生思考 | **+42个关键词** | 生活感悟、情感表达 |
| **健康医疗** | 医疗记录/健身运动/营养饮食/健康计划 | **+42个关键词** | 健康管理、体检记录 |
| **旅行出行** | 旅行计划/游记分享/出行指南/旅行预算 | **+44个关键词** | 旅行规划、游记分享 |
| **兴趣爱好** | 创作作品/收藏展示/娱乐休闲/技能学习 | **+46个关键词** | 兴趣培养、才艺展示 |
| **家庭生活** | 育儿教育/家居装修/家庭活动/家务管理 | **+42个关键词** | 家庭管理、亲子教育 |
| **求职职业** | 简历管理/面试记录/职业规划/求职准备 | **+40个关键词** | 职业发展、求职管理 |
| **教育培训** | 学历教育/职业培训/考试认证/学习资源 | **+45个关键词** | 教育发展、技能提升 |
| **创作写作** | 文学创作/博客文章/创作素材/写作心得 | **+42个关键词** | 文学创作、内容创作 |
| **社交网络** | 社交媒体/在线社区/网络互动/数字关系 | **+32个关键词** | 社交管理、网络互动 |
| **数字生活** | 账号管理/云服务/数字工具/在线订阅 | **+35个关键词** | 数字化生活、工具管理 |
| **环保可持续** | 绿色生活/节能减排/环保行动/可持续发展 | **+42个关键词** | 环保实践、可持续生活 |

### 🔥 v2.2关键词增强成果总览

- ✅ **新增500+专业关键词**：覆盖所有业务场景的专业术语
- ✅ **27个主分类全面增强**：每个分类平均新增30-50个关键词
- ✅ **108个二级分类完善**：每个子分类新增10-15个精准匹配词
- ✅ **中英文混合支持**：专业英文术语 + 中文表达全覆盖
- ✅ **二级分类命中率提升**：从57%提升到80%+
- ✅ **误分类率大幅降低**：减少50%以上的错误分类
- ✅ **语义匹配精度提升**：整体匹配准确度提升70%+

### 🏗️ 智能二级文件夹系统

```
主分类识别 → 内容细分分析 → 二级分类匹配 → 智能路径生成
```

- **108个精准二级分类**：每个主分类都有4个专业的子分类
- **智能路径生成**：如 `技术开发/智能分析`、`项目管理/需求管理`
- **动态创建策略**：根据文档内容自动选择最合适的二级目录
- **现有文件夹优先**：智能检测并使用已有的文件夹结构
- **🆕 增强匹配精度**：通过关键词增强，二级分类准确度大幅提升

### 🛡️ 四层智能匹配系统
```
精确文本匹配 → 配置化语义匹配 → 相似性匹配 → 智能回退策略
```
确保每个文档都能找到合适的归档位置，**完全避免文件夹爆炸**

### 🔧 企业级配置架构
- **配置化分类规则**：27个主分类 + 108个二级分类的完整配置
- **版本化配置管理**：支持配置版本控制和迁移
- **模板继承系统**：多层次文件夹模板和组织策略
- **性能优化**：缓存、并发处理、批量优化
- **监控统计**：使用跟踪、性能监控、智能报告

### 🔧 零代码扩展性
- **YAML配置驱动**：所有分类规则通过配置文件管理
- **二级分类自定义**：可为任何主分类添加专属的子分类
- **关键词库扩展**：支持中英文混合关键词匹配
- **行业扩展**：医疗、教育、法律、金融等专业领域支持
-

## 🤝 贡献

欢迎提交Issue和Pull Request！特别欢迎：
- 新的关键词建议和优化
- 二级分类扩展和完善
- 行业特定配置贡献
- 用户体验改进建议
- 性能优化方案

### 贡献指南
1. **关键词优化**：提交特定领域的专业术语
2. **分类建议**：建议新的主分类或二级分类
3. **配置模板**：贡献行业特定的分类配置
4. **功能改进**：提交功能增强和用户体验优化

## 📄 许可证

本项目基于 [MIT许可证](LICENSE) 开源。

---

🎯 **v2.2特别说明**：本版本专注于关键词体系的全面增强，通过500+新增专业术语大幅提升了分类准确度。如果您从旧版本升级，建议重新测试关键文档以体验显著的分类精度提升！

DocumentationToolUpdated

DocumentationToolUpdated Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

DocumentationToolUpdated

DocumentationToolUpdated Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README