From c975a8fa51b0c6f9c86582fe502cf096a124413b Mon Sep 17 00:00:00 2001
From: Xinwei Xiong <3293172751NSS@gmail.com>
Date: Sat, 8 Jun 2024 22:16:21 +0800
Subject: [PATCH] Update README.md

---
 README.md | 139 +++++++++++++++++++++++++++++++++---------------------
 1 file changed, 85 insertions(+), 54 deletions(-)

diff --git a/README.md b/README.md
index e0ff666..206fd67 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,3 @@
-# AI Commons
-
-**反馈通用工具库**
-
 ## 目录
 - [简介](#简介)
 - [安装](#安装)
@@ -18,39 +14,74 @@
 
 AI Commons 是一个通用工具库，旨在支持企业级 AI 驱动的智能反馈系统的开发。该库包含多种实用工具，如 API 客户端、数据清洗、文件解析、模型定义和异步任务处理。
 
-## 目录
+## 目录结构
 
 ```bash
-feedback-commons/
-|-- .github/
-├── docs/
-│   ├── API.md
-│   ├── DATA.md
-│   └── README.md
-├── src/
-│   ├── api/
+ai-commons/
+├── README.md
+├── LICENSE
+├── setup.py
+├── requirements.txt
+├── ai_commons/
+│   ├── __init__.py
+│   ├── file_processing/
 │   │   ├── __init__.py
-│   │   ├── openai_client.py
-│   │   └── ...
-│   ├── utils/
+│   │   ├── excel_parser.py
+│   │   ├── json_validator.py
+│   │   └── data_cleaner.py
+│   ├── database/
 │   │   ├── __init__.py
-│   │   ├── data_cleaning.py
-│   │   ├── file_parser.py
-│   │   └── ...
-│   ├── models/
+│   │   ├── database_connector.py
+│   │   ├── query_executor.py
+│   │   └── orm_wrapper.py
+│   ├── api_clients/
 │   │   ├── __init__.py
-│   │   ├── feedback.py
-│   │   └── ...
-│   └── tasks/
+│   │   ├── openai_client.py
+│   │   ├── slack_client.py
+│   │   └── webhook_handler.py
+│   ├── async_tasks/
+│   │   ├── __init__.py
+│   │   ├── task_scheduler.py
+│   │   ├── celery_task_manager.py
+│   └── data_processing/
 │       ├── __init__.py
-│       ├── async_tasks.py
-│       └── ...
-├── tests/
-│   ├── test_api.py
-│   ├── test_utils.py
-│   └── ...
-├── requirements.txt
-└── setup.py
+│       ├── data_splitter.py
+│       ├── tag_aggregator.py
+│       └── theme_generator.py
+│   ├── logging_monitoring/
+│   │   ├── __init__.py
+│   │   ├── logger.py
+│   │   ├── metrics_collector.py
+│   │   └── error_tracker.py
+│   ├── security/
+│   │   ├── __init__.py
+│   │   ├── auth_manager.py
+│   │   └── access_control.py
+│   ├── data_export/
+│   │   ├── __init__.py
+│   │   ├── data_exporter.py
+│   │   └── report_generator.py
+│   ├── config/
+│   │   ├── __init__.py
+│   │   ├── config_loader.py
+│   │   └── environment_manager.py
+│   ├── ui_tools/
+│   │   ├── __init__.py
+│   │   ├── file_uploader.py
+│   │   ├── form_validator.py
+│   │   └── data_visualizer.py
+└── tests/
+    ├── __init__.py
+    ├── test_file_processing.py
+    ├── test_database.py
+    ├── test_api_clients.py
+    ├── test_async_tasks.py
+    ├── test_data_processing.py
+    ├── test_logging_monitoring.py
+    ├── test_security.py
+    ├── test_data_export.py
+    ├── test_config.py
+    └── test_ui_tools.py
 ```
 
 ## 安装
@@ -60,6 +91,23 @@ pip install -r requirements.txt
 python setup.py install
 ```
 
+### 工具模块概述
+
+1. **API 客户端**：
+   - `openai_client.py`：封装与 OpenAI API 的交互，简化调用过程。
+
+2. **数据清洗工具**：
+   - `data_cleaner.py`：提供数据清洗函数，如处理缺失值、数据标准化等。
+
+3. **文件解析工具**：
+   - `excel_parser.py`：支持 Excel、JSON、YAML 等文件格式的解析和转换。
+
+4. **模型定义**：
+   - `feedback.py`：定义反馈系统的数据模型，如用户、问题、反馈、标签等。
+
+5. **异步任务**：
+   - `celery_task_manager.py`：使用 Celery 实现异步任务处理，包括数据评分和分类等任务。
+
 ## 使用
 
 ### API 客户端
@@ -69,7 +117,7 @@ python setup.py install
 #### 示例代码
 
 ```python
-from ai_commons.api.openai_client import OpenAIClient
+from ai_commons.api_clients.openai_client import OpenAIClient
 
 client = OpenAIClient(api_key='your_api_key')
 response = client.get_response(prompt="Summarize the following feedback...")
@@ -83,7 +131,7 @@ print(response)
 #### 示例代码
 
 ```python
-from ai_commons.utils.data_cleaning import clean_data
+from ai_commons.file_processing.data_cleaner import clean_data
 
 data = {"field1": "value1", "field2": None}
 cleaned_data = clean_data(data)
@@ -97,7 +145,7 @@ print(cleaned_data)
 #### 示例代码
 
 ```python
-from ai_commons.utils.file_parser import parse_excel
+from ai_commons.file_processing.excel_parser import parse_excel
 
 data = parse_excel('path/to/file.xlsx')
 print(data)
@@ -123,7 +171,7 @@ print(feedback)
 #### 示例代码
 
 ```python
-from ai_commons.tasks.async_tasks import process_feedback
+from ai_commons.async_tasks.celery_task_manager import process_feedback
 
 task = process_feedback.delay(feedback_data)
 print(task.id)
@@ -131,26 +179,9 @@ print(task.id)
 
 ## 贡献
 
-欢迎对 Feedback Commons 做出贡献！请阅读 [贡献指南](docs/CONTRIBUTING.md) 了解详细信息。
+欢迎对 AI Commons 做出贡献！请阅读 [贡献指南](docs/CONTRIBUTING.md) 了解详细信息。
 
 ## 许可证
 
-Feedback Commons 使用 MIT 许可证。详情请参阅 [LICENSE](LICENSE) 文件。
-```
-
-### 工具模块概述
-
-1. **API 客户端**：
-   - `openai_client.py`：封装与 OpenAI API 的交互，简化调用过程。
-
-2. **数据清洗工具**：
-   - `data_cleaning.py`：提供数据清洗函数，如处理缺失值、数据标准化等。
-
-3. **文件解析工具**：
-   - `file_parser.py`：支持 Excel、JSON、YAML 等文件格式的解析和转换。
+AI Commons 使用 MIT 许可证。详情请参阅 [LICENSE](LICENSE) 文件。
 
-4. **模型定义**：
-   - `feedback.py`：定义反馈系统的数据模型，如用户、问题、反馈、标签等。
-
-5. **异步任务**：
-   - `async_tasks.py`：使用 Celery 实现异步任务处理，包括数据评分和分类等任务。