# prompt_evaluator

**Repository Path**: blues_c/prompt_evaluator

## Basic Information

- **Project Name**: prompt_evaluator
- **Description**: 本项目是一个提示词质量评估工具，它能从 4 个维度给你的提示词打分
、识别 7 类常见错误、告诉你如何改进，并提供优化后的示例、支持多轮对话，帮你不断改进提示词。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-23
- **Last Updated**: 2026-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 提示词质量评估工具

> 🎯 基于 DeepSeek AI 的专业提示词评估工具，4 维度智能分析，自动识别问题并给出优化建议

<div align="center">

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![DeepSeek](https://img.shields.io/badge/Powered%20by-DeepSeek-blue)](https://www.deepseek.com/)

</div>

---

## 🎯 这是什么？

一个帮你优化提示词（Prompt）的专业工具。输入你的提示词，AI 会从 4 个维度评分、找出问题、给出改进建议和重写示例。

**默认使用 DeepSeek API**（兼容 OpenAI 接口，成本更低，中文更强）

---

## ✨ 核心功能

| 功能 | 说明 |
|------|------|
| 📊 **四维度评分** | 结构清晰度、约束有效性、语义明确性、输出要求清晰度 |
| 🔍 **智能识别问题** | 自动发现重复约束、矛盾约束、模糊表达等 7 类常见问题 |
| 💡 **具体改进建议** | 不只是打分，还告诉你怎么改进 |
| ✏️ **重写示例** | 直接给出优化后的提示词版本 |
| 💾 **结果保存** | 支持保存为 Markdown 格式，方便对比和分享 |
| 🚀 **多种使用方式** | 命令行、Web 界面、Python 代码集成 |

---

## 🚀 快速开始

### 方式一：命令行（推荐新手）

```bash
# 克隆项目
git clone <your-repo-url>
cd prompt_evaluator

# 创建并激活虚拟环境（强烈推荐）
python -m venv venv
venv\Scripts\activate     # Windows
source venv/bin/activate  # Linux/Mac

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

# 配置 API Key（复制并编辑 .env 文件）
copy .env.example .env    # Windows
cp .env.example .env      # Linux/Mac
# 然后编辑 .env 文件，填入你的 DeepSeek API Key

# 运行评估
python cli.py interactive              # 交互式评估（推荐）
python cli.py evaluate your_prompt.txt # 评估文件
python cli.py                          # 默认进入交互模式
python cli.py help                     # 查看帮助
```

> **💡 提示：** 工具默认配置为使用 DeepSeek API，通过 OpenAI 兼容接口调用。

### 方式二：Web 界面（推荐团队使用）

```bash
# 创建并激活虚拟环境
python -m venv venv
venv\Scripts\activate     # Windows
source venv/bin/activate  # Linux/Mac

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

# 配置 API Key
copy .env.example .env    # Windows
cp .env.example .env      # Linux/Mac
# 编辑 .env 文件，填入你的 DeepSeek API Key

# 启动 Web 服务
python web_app.py

# 浏览器访问
# http://localhost:5000
```

### 方式三：Python 代码集成

```python
import sys
sys.path.insert(0, 'src')  # 添加 src 目录到路径

from prompt_evaluator import PromptEvaluator

# 初始化
evaluator = PromptEvaluator()

# 评估提示词
prompt = "你是一个代码助手，帮用户写代码。"
result = evaluator.evaluate_prompt(prompt)

print(result)  # 查看评估结果
evaluator.save_evaluation("result.md")  # 保存报告
```


---

## 🏗️ 项目架构

### 技术栈

| 类别 | 技术 | 说明 |
|------|------|------|
| **核心语言** | Python 3.8+ | 主开发语言 |
| **AI 服务** | DeepSeek API | 提示词评估引擎（兼容 OpenAI API） |
| **命令行** | Click | 构建友好的 CLI 界面 |
| **输出美化** | Rich | 终端彩色输出和格式化 |
| **Web 框架** | Flask | 提供 Web 界面服务 |
| **配置管理** | python-dotenv | 环境变量管理 |
| **测试框架** | pytest | 单元测试和集成测试 |

### 架构设计

```
┌─────────────────────────────────────────────────────────────┐
│                        用户接口层                             │
├──────────────────┬──────────────────┬──────────────────────┤
│   CLI 命令行      │   Web 界面        │   Python API         │
│   (cli/app.py)   │  (web/app.py)    │   (直接导入使用)       │
└────────┬─────────┴────────┬─────────┴──────────┬───────────┘
         │                  │                    │
         └──────────────────┼────────────────────┘
                            ▼
         ┌─────────────────────────────────────────┐
         │          核心评估引擎                     │
         │      (core/evaluator.py)                │
         │  • PromptEvaluator 类                   │
         │  • 四维度评分算法                         │
         │  • 问题识别与分析                         │
         │  • 优化建议生成                          │
         └──────────────┬──────────────────────────┘
                        ▼
         ┌─────────────────────────────────────────┐
         │          AI 服务层                       │
         │  • DeepSeek API 调用                    │
         │  • OpenAI 兼容接口                       │
         │  • 请求重试与错误处理                     │
         └─────────────────────────────────────────┘
```

### 核心模块说明

#### 1. 核心评估模块 (`core/evaluator.py`)
- **职责**：提示词评估的核心逻辑
- **主要功能**：
  - 四维度评分（结构清晰度、约束有效性、语义明确性、输出要求清晰度）
  - 问题识别（7 类常见问题自动检测）
  - 优化建议生成
  - 提示词重写示例
  - 评估结果格式化与保存

#### 2. 命令行接口 (`cli/app.py`)
- **职责**：提供用户友好的命令行交互
- **主要功能**：
  - 交互式评估模式
  - 文件批量评估
  - 会话管理
  - 结果保存

#### 3. Web 界面 (`web/app.py`)
- **职责**：提供可视化的 Web 操作界面
- **主要功能**：
  - 在线提示词输入与评估
  - 实时结果展示
  - 历史记录管理（规划中）

#### 4. 配置管理 (`config/settings.py`)
- **职责**：统一管理配置项
- **主要功能**：
  - API 密钥管理
  - 模型参数配置
  - 默认值设置

#### 5. 工具函数 (`utils/helpers.py`)
- **职责**：提供通用工具方法
- **主要功能**：
  - 文件读写
  - 格式转换
  - 日志记录

---