# GlossAI

**Repository Path**: LiamLMK/gloss-ai

## Basic Information

- **Project Name**: GlossAI
- **Description**: A fast and accurate bilingual translation and interpretation query platform
一个快速、精准的双语翻译和术语查询平台，专为需要处理专业术语翻译的用户设计。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-08
- **Last Updated**: 2025-03-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Python, Postgresql, llm

## README

# GlossAI

## 项目介绍

GlossAI 是一个快速、精准的双语翻译和术语查询平台，专为需要处理专业术语翻译的用户设计。本系统结合了多种大型语言模型（LLM）的能力，提供术语提取、翻译和管理功能，帮助用户更高效地进行双语内容处理。

## 功能特点

- **术语提取**：自动从文本中提取可能的专业术语
- **术语翻译**：支持中英文术语的精准翻译
- **术语库管理**：允许用户创建、上传、管理个人术语库
- **多模型支持**：集成多种LLM API（OpenAI、智谱AI、SparkAI、DeepSeek等）
- **用户系统**：完整的用户注册、登录和个人信息管理
- **术语共享**：支持术语集的公开与私有管理

## 部署指南

### 系统要求

- Python 3.9+
- PostgreSQL 数据库
- SMTP服务（用于邮件验证）

### 安装步骤

1. **克隆仓库**

```bash
git clone https://github.com/yourusername/gloss-ai.git
cd gloss-ai
```

2. **安装依赖**

```bash
pip install -r requirements.txt
```

3. **配置环境变量**

创建一个 `.env` 文件在项目根目录，参考以下配置：

```
# 数据库配置
DATABASE_URL=postgresql://username:password@localhost:5432/glossai

# JWT配置
JWT_SECRET=your_jwt_secret

# 邮件配置
MAIL_SERVER=smtp.example.com
MAIL_USE_TLS=True
MAIL_PORT=587
MAIL_USERNAME=your_email@example.com
MAIL_PASSWORD=your_email_password
MAIL_DEFAULT_SENDER=your_email@example.com
SECRET_KEY=your_secret_key

# LLM API配置
# OpenAI
OPENAI_KEY=your_openai_key
BASE_URL=https://api.openai.com/v1 

# SparkAI
SPARKAI_URL=wss://spark-api.xf-yun.com/v3.5/chat
SPARKAI_APP_ID=your_app_id
SPARKAI_API_SECRET=your_api_secret
SPARKAI_API_KEY=your_api_key
SPARKAI_DOMAIN=generalv3.5

# ZhipuAI
ZHIPUAI_KEY=your_zhipuai_key

# DeepSeek
DEEPSEEK_KEY=your_deepseek_key
```

4. **创建数据库**

在PostgreSQL中创建数据库：

```bash
createdb glossai
```

5. **启动应用**

```bash
python -m src.api_server.app
```

应用将在 http://localhost:5000 上运行。

## 项目架构

### 目录结构

```
gloss-ai/
├── .env                  # 环境变量配置文件
├── requirements.txt      # 项目依赖
├── LICENSE              
├── README.md            
├── README.en.md         
├── src/                  # 源代码目录
│   ├── __init__.py
│   ├── api_server/       # API服务相关代码
│   │   ├── app.py        # 应用入口
│   │   ├── route.py      # API路由
│   │   ├── page.py       # 页面路由
│   │   ├── verification.py # 用户验证
│   │   └── templates/    # 前端模板
│   ├── db_models/        # 数据库模型
│   │   ├── __init__.py
│   │   ├── base.py       # 数据库基础配置
│   │   └── models.py     # 数据模型定义
│   ├── llm_apis/         # LLM API 集成
│   │   ├── __init__.py
│   │   ├── select_api.py # API选择逻辑
│   │   ├── openai_service.py
│   │   ├── sparkai_service.py
│   │   ├── zhipuai_service.py
│   │   └── deepseek_service.py
│   ├── script/           # 辅助脚本
│   ├── prompts.py        # 提示词模板
│   ├── process_db.py     # 数据库操作功能
│   ├── process_text.py   # 文本处理功能
│   └── upload_file.py    # 文件上传处理
```

### 核心组件

1. **API服务器**：Flask后端，提供REST API和页面服务
2. **数据库模型**：
   - User：用户信息管理
   - TermCollection：术语集合管理
   - Term：术语条目存储
3. **LLM服务**：多种AI模型的接口集成
4. **业务逻辑**：
   - 术语提取与处理
   - 用户认证与授权
   - 术语集管理

## 核心功能使用说明

1. **注册与登录**：
   - 通过邮箱验证注册新账户
   - 使用邮箱和密码登录系统

2. **术语提取**：
   - 在页面输入文本
   - 选择使用的LLM模型
   - 系统自动提取和翻译术语

3. **术语集管理**：
   - 上传新术语集（支持CSV、Excel格式）
   - 查看/编辑个人术语集
   - 删除不需要的术语集

4. **术语搜索**：
   - 从输入文本中识别已有术语
   - 提供术语的标准翻译和示例

## 版本更新

### v1.0.0 (当前版本)
- 初始版本发布
- 实现基本的术语提取和翻译功能
- 用户系统与术语集管理
- 多LLM API支持

## 贡献指南

1. Fork 本仓库
2. 创建您的特性分支 (`git checkout -b feature/amazing-feature`)
3. 提交您的更改 (`git commit -m 'Add some amazing feature'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 创建 Pull Request

## 许可证

本项目采用 [LICENSE](LICENSE) 许可证 - 查看许可证文件获取详细信息。

## 联系方式

如有问题或建议，请通过以下方式联系：

- 项目维护者：[LiamLMK]
- 电子邮件：[627827969@qq.com]
- GitHub Issues：