单词故事 项目简介
## 项目简介
**单词故事** ：听故事 = 复习 + 记忆单词！
单词故事利用 AI 将用户提供的一组单词或短语编成一个有趣的小故事，然后合成音频，使用户可以通过听故事来复习之前记过的单词——将枯燥的单词记忆变得轻松有趣起来！
----------
## 项目荣誉
本项目参与了两个同期进行的比赛，均已入围。
- 成功获得[GitCode × 文心大模型 × 智源研究院 AI应用开发大赛](https://competition.gitcode.com/competition/1957267936704454657/intro)**创新奖**。
- 成功入围[「小有可为」AI 开源公益创新挑战赛](https://modelscope.cn/competition/136/%E2%9C%A8%E5%85%A5%E5%9B%B4%E5%85%AC%E7%A4%BA%E2%9C%A8)。
要判断本项目的人气的话可以从上面的视频页面（目前播放量242）或下面modelscope页面（目前浏览量1171）来判断。
----------
## 功能特色
| 功能 | 说明 |
| --------------- | ----------------------- |
| ✍️ 中英文故事生成 | 用单词或短语生成轻松有趣的英文小故事和对应的中文翻译，每个故事最多由7个单词或短语构成——基于George A. Miller (1956) 的论文[The Magical Number **Seven**, Plus or Minus Two](https://labs.la.utexas.edu/gilden/files/2016/04/MagicNumberSeven-Miller1956.pdf)所揭示的记忆规律。|
| 语音合成 | 生成的音频故事包含各单词或短语的发音、释义、中英文故事，可在[网站上](https://mathjoy.eu.org/wordstory/category/%E8%80%83%E7%A0%94/)或下载到手机或电脑反复使用。 |
| 一站式学习闭环 | 可与[英酷词典](https://mathjoy.eu.org/products/engkudict/)（可负责记录陌生单词）和[Anki](https://apps.ankiweb.net/)（负责单词视觉记忆）配套使用，单词故事也可导出为Anki记忆卡片，从“陌生单词记录 → 单词视觉记忆 → 单词复习”打造一站式学习闭环！ |
| 语义上下文学习 | 通过听觉与语境加深记忆，提高单词理解 |
----------
## 在线使用
要体验请自己在本地部署（方法见后文）或访问
- https://www.modelscope.cn/studios/redstoneleo/WordsStory/
，和本地部署的效果一致。
- https://mathjoy.eu.org/wordstory/category/%E8%80%83%E7%A0%94/
，这是我部署在自己网站上面的版本，上面包含一些已经生成的内容，如考研、四六级、雅思托福等等，方便直接使用。
---
## 开发说明
该项目融合了以下技术：
- **LLM 模型 - **文心大模型4.5 (旗舰版API)**** — 用于生成英文故事。
- **TTS 引擎 - Azure TTS** — 将生成的故事转换为音频。
- **Gradio Web 界面** — 让用户可直接在浏览器中交互、试听与下载故事。
----------
## ⚙️ 部署指南
### 1️⃣ 克隆项目
```bash
# Make sure git-lfs is installed (https://git-lfs.com)
git lfs install
git clone https://huggingface.co/spaces/redstoneleo/WordsStory
# If you want to clone without large files - just their pointers
GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/spaces/redstoneleo/WordsStory
cd WordsStory
```
### 2️⃣ 创建虚拟环境
这里使用 `uv` ：
```bash
uv venv SiteEnv
source SiteEnv/bin/activate # Windows: .\SiteEnv\Scripts\activate
```
### 3️⃣ 安装依赖
```bash
uv pip install -r requirements.txt
```
> 若使用 `pip`：
>
> ```bash
> pip install -r requirements.txt
>
> ```
### 4️⃣ 设置环境变量
这里以Windows上的PowerShell设置为例
```bash
setx AZURE_TTS_KEY "your_AZURE_TTS_KEY"
setx OPENAI_API_KEY "your_BAIDU_CHATAI_KEY"
```
其中Azure TTS的API Key可以按照[文档说明](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/batch-synthesis#get-batch-synthesis)去获取，需要绑定信用卡。文心大模型4.5 旗舰版API Key可以到[这里](https://aistudio.baidu.com/account/accessToken)获取。
### 5️⃣ 启动 Gradio Web 界面
```bash
python app.py
```
然后打开浏览器访问 [http://127.0.0.1:7860](http://127.0.0.1:7860/)
## 许可证
本项目采用GPL v3 License。
----------
## ❤️ 致谢
- [KwaiKAT AI](https://streamlake.com/)
- [Kiro IDE](https://kiro.dev/)
- 文心一言
- Microsoft Azure Speech
MathJoy