AI 生词本项目教程

AI 生词本项目教程

ai-vocabulary-builder 一个使用了 AI 技术的智能生词本工具，特色功能：自动添加生词、读故事助记单词。 项目地址: https://gitcode.com/gh_mirrors/ai/ai-vocabulary-builder

1. 项目的目录结构及介绍

ai-vocabulary-builder/
├── github/
│   └── workflows/
├── voc_builder/
├── voc_frontend/
├── flake8/
├── gitignore
├── LICENSE
├── Makefile
├── README.md
├── poetry.lock
├── pyproject.toml
└── ...

• github/workflows/: 包含项目的 GitHub Actions 工作流配置文件。
• voc_builder/: 包含项目的主要代码，负责生词本的构建和管理。
• voc_frontend/: 包含项目的前端代码，用于提供 Web 界面。
• flake8/: 包含 Flake8 配置文件，用于代码风格检查。
• gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• Makefile: 项目的 Makefile，包含一些常用的构建命令。
• README.md: 项目的说明文档。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: Poetry 项目配置文件。

2. 项目的启动文件介绍

项目的启动文件主要有两个：

• aivoc run: 启动交互式命令行模式。
• aivoc notebook: 启动 Web App 模式。

2.1 交互式命令行模式

在终端中运行以下命令启动交互式命令行模式：

aivoc run

在该模式下，你可以快速完成添加生词、阅读故事等操作。

2.2 Web App 模式

在终端中运行以下命令启动 Web App 模式：

aivoc notebook

该命令会在浏览器中打开可交互式的 Web App，推荐使用此模式进行操作。

3. 项目的配置文件介绍

项目的配置主要通过环境变量来完成，以下是一些常用的配置项：

3.1 OPENAI_API_KEY

工具调用 OpenAI 的 API 时所使用的 API Key，必须设置。

export OPENAI_API_KEY='your_api_key'

3.2 OPENAI_API_BASE

工具所使用的 OpenAI 的 API 地址，可选设置，仅当默认 API 地址（https://api.openai.com/v1）无法正常访问时指定。

export OPENAI_API_BASE="https://www.my-openai-proxy.com/v1"

3.3 AIVOC_DATA_DIR

指定生词本储存数据文件的路径，默认路径为当前登录用户的 home 目录。

export AIVOC_DATA_DIR="$HOME/Documents"

通过这些配置项，你可以根据需要自定义项目的运行环境。

ai-vocabulary-builder 一个使用了 AI 技术的智能生词本工具，特色功能：自动添加生词、读故事助记单词。 项目地址: https://gitcode.com/gh_mirrors/ai/ai-vocabulary-builder