Skip to main content

A tool help you build your vocabulary book using AI.

Project description

AI 生词本

AI 生词本(“AI Vocabulary Builder” 简称 aivoc)是一个利用了 AI 技术的智能生词本工具,它能帮你快速构建起自己的生词库,学习起来事半功倍。

核心功能:

  • 提供高质量的整句翻译能力
  • 由 AI 自动提取生词及释义
  • 独创的故事模式助记生词
  • 支持 CSV 等格式导出生词本

工具截图:

image

↑ 交互式使用界面

image

↑ 使用 numbers 打开生词库表格(使用 CSV 纯文本格式,方便二次处理)

快速开始

本工具基于 Python 开发,请使用 pip 来安装本工具:

# 需要 Python 版本 3.7 及以上
pip install ai-vocabulary-builder

安装完成后,请在环境变量中设置你的 OpenAI API key

# 使用你在 OpenAI 官网上申请到的 key 替换该内容
export OPENAI_API_KEY='your_api_key'

之后执行 aivoc 启动工具,进入交互式命令行模式。

除环境变量外,你也可以通过 --api-key 参数完成设置:

aivoc --api-key "your_api_key"

使用指南

交互式命令行

执行 aivocaivoc run 命令,会进入交互式命令行模式,在该模式下,你可以快速完成添加生词、阅读故事等操作。

添加生词

默认情况下,命令行处于“添加生词”模式,此时你可以直接粘贴一小段英文:

Enter text> It depicted simply an enormous face, more than a metre wide

按下回车后,工具会开始翻译工作。它首先会将你所输入内容的中文翻译打印到屏幕上。然后,它会从原文中提取出一个你最有可能不认识的单词,将其加入到生词本中。

> 中文翻译:简单地描绘出一个超过一米宽的巨大面孔。

> The word AI has chosen is "depicted".

┏━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ 单词     ┃ 发音        ┃ 释义       ┃
┡━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ depicted │ /dɪˈpɪktɪd/ │ 描绘,描述 │
└──────────┴─────────────┴────────────┘
"depicted" was added to your vocabulary book (1 in total), well done!

重选生词

某些情况下,工具所挑选的生词可能并非你所想的那个。此时,通过输入 no 命令,你可以启动一次重选:

Enter text> no

上一次被添加到生词本的单词会被丢弃(加入到“已掌握”词库中),工具将尝试返回另外 3 个可能的生词,如下所示:

"depicted" was discarded, preparing other words...
⠦  Querying OpenAI API
? Choose the word you don't know (Use arrow keys)
   simply / ['sɪmpli] / 简单地,仅仅
 » enormous / [ɪˈnɔːməs] / 巨大的,庞大的
   metre / ['miːtə(r)] / 米,公尺
   None of above, skip for now.

请使用↑↓方向键选择你想要的词,按下回车确认。该单词会被添加到你的生词本中。

"enormous" was added to your vocabulary book (1 in total), well done!

假如你所想的单词仍然没有出现在选项中,请选择 None of above, skip for now.,跳过本次添加。

别气馁,祝你下次好运。😁

阅读故事来助记生词

为了快速并牢固掌握生词本里的单词,本工具提供了一个创新的故事模式。在交互式命令行模式下,输入 story 开始故事模式:

Enter text> story

工具将从生词本里挑选出 6 个单词,请求 AI 用这些词写一个小故事。输入如下所示:

Words for generating story: prudent, extraneous, serendipitously, onus, aphorisms, cater
⠼  Querying OpenAI API to write the story...
╭─────────────────────────────────────────── Enjoy your reading ────────────────────────────────────────────╮
│ Once there was a prudent young girl named Alice who always carried a small notebook with her. She wrote   │
│ down aphorisms and wise sayings that she heard from her elders or from books. It was an extraneous task,  │
│ but Alice believed that it helped her to be wise and joyful.                                              │
│                                                                                                           │
│ One day, Alice went for a walk in the park and serendipitously met an old man. He was reading a book, and │
│ Alice noticed that he had marked some phrases with a pencil. She greeted him and asked about the book.    │
│ They started to chat about literature, and the man shared some of his favorite aphorisms.                 │
│                                                                                                           │
│ Alice was delighted, and she wrote down the new sayings in her notebook. After their conversation, the    │
│ man thanked Alice and said that he felt as if a heavy onus had been lifted from his chest. Alice smiled   │
│ and said that it was her pleasure to cater to his needs.                                                  │
│                                                                                                           │
│ From then on, Alice and the old man often met in the park to exchange knowledge and wisdom. They learned  │
│ that serendipity could bring unexpected blessings to life.                                                │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────╯

阅读结束后,按下回车键,你可以继续查看在故事中出现的所有生词的详细信息。

其他功能

导出生词本

你可以使用 export 命令来导出你的生词本。以下是一些示例:

# 直接往屏幕输出文本格式
aivoc export
# 直接往屏幕输出 CSV 格式
aivoc export --format csv
# 往 ./voc.csv 写入 CSV 格式的生词本
aivoc export --format csv --file-path ./voc.csv

删除生词

如果你觉得你已经牢牢掌握了某个生词,你可以将它从生词本里删除。执行 remove 命令来完成这个任务:

# enormous  depicted 为需要删除的单词,多个单词使用空格分隔
aivoc remove enormous depicted

为什么开发这个工具?

学习一门语言,生词本是一个非常重要的工具。一个内容优秀的生词本,至少需要包含:生词、释义、例句、例句释义这些内容。但是,手动维护这些内容非常麻烦,因此大部分人都没有自己的生词本。阅读时碰见生词,常常查过词典,转头就忘。

“AI 生词本”尝试着使用 ChatGPT 的能力,将生词本的维护成本降到最低,让每人都可以拥有自己的生词本。

TODO

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_vocabulary_builder-0.2.0.tar.gz (21.0 kB view hashes)

Uploaded Source

Built Distribution

ai_vocabulary_builder-0.2.0-py3-none-any.whl (21.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page