docs: update settings

This commit is contained in:
an-lee
2024-07-24 10:09:22 +08:00
parent c5fc1a6b90
commit c2d35159df
2 changed files with 134 additions and 78 deletions

View File

@@ -4,11 +4,11 @@
如果登录时报 `Network Error`,发音评估或者使用其他功能时报 `connect ETIMEDOUT` 错误,可以打开浏览器(不要在微信里打开),尝试打开 [https://enjoy.bot](https://enjoy.bot)。
如果无法打开,或者跳转到了其他不相关页面,说明因为您当前的网络无法连接上 Enjoy 的服务。
如果无法打开,或者跳转到了其他不相关页面,说明您当前的网络无法连接上 Enjoy 的服务。
可以按照以下步骤解决:
1. 升级 Enjoy App 至 v0.3.2 以上;
1. [升级 Enjoy App](./index.md) 至 v0.3.2 以上;
2. 在登录页面,点 `高级设置`(如果已登录,点 `软件设置`/`高级设置`),修改 API 设置,填入 `https://api.getenjoyapp.com`,点保存。
软件自动重载后即可。

View File

@@ -4,7 +4,125 @@ Enjoy 只需要登录后即可直接使用,**无需其他设置**。但是,
打开 Enjoy 软件,点击左侧栏最下面的齿轮按钮,即可打开 `软件设置`
## 资源库保存路径
## 基本设置
### 母语
请选择您的母语,默认为`简体中文`
请注意,此设定关系到学习过程中的翻译内容、分析等,并不影响软件的界面语言。
### 学习语言
请选择您要学习的语言,默认为 `English(United States)`
### 语音转文本服务
::: info 设置路径
软件设置 -> 基本设置 -> 语音转文本服务
:::
语音转文本(即 STTSpeech to Text服务是 Enjoy 提供的核心功能之一,也是 [跟读训练](./audios.md#跟读音频) 的前提条件。
此处设置为默认值,在语音转文本时仍可选择不同服务。
<details>
<summary>
本地(whisper)
</summary>
该设置默认项为 `本地`,即利用 Enjoy 集成的 whisper 组件,完全利用本地计算机的算力提供 STT 服务,该服务完全免费。
Enjoy 软件集成了最小的 whisper 模型 `tiny.en`,如果电脑配置较高,可以选用更大的模型以提高语音转文本的准确度。点击 `模型` 按钮,在弹窗中选择相应的模型即可自动下载并选中。
::: tip 关于 whisper 模型的选择
下载的 whisper 模型会保存在 `/EnjoyLibrary/whisper/models/` 文件夹下。如果自动下载失败,也可以到 [这里](https://hf-mirror.com/ggerganov/whisper.cpp) 手动下载,放置在该文件夹下,在 Enjoy 中即可以选中。
理论上,模型越大,识别的准确度也更高,但是运行得越慢,甚至在一些配置不高的电脑中无法运行。
凡是以 `.en` 结尾的模型均只支持英文,识别英文准确性也更高,例如 `base.en`;而不以 `.en` 结尾的模型则可以支持多种语言,例如 `base`
:::
::: warning 检查本地 whisper 服务
有些电脑或者系统(例如 macOS 11可能会因为兼容性问题或其他未知问题无法使用本地的 whisper 服务。点击 `检查` 按钮即可检查 whisper 服务在本地计算机是否工作正常。如果提示无法正常工作,可以选用其他服务。
:::
</details>
<details>
<summary>
Azure AI STT
</summary>
利用微软 Azure AI 的语音识别 API 服务提供的 STT该服务为**收费服务**,每次使用均会在 Enjoy 账户余额中扣费,,余额不足则需要 [充值](#充值) 后才可继续使用。
</details>
<details>
<summary>
Cloudflare AI STT
</summary>
利用 Cloudflare 提供的 whisper 云服务,该服务目前免费。经实测,对于一些时长较短的音频,识别会有较大误差。
</details>
<details>
<summary>
OpenAI STT
</summary>
利用 OpenAI 提供的 whipser 云服务,该服务需要[配置自己的 OpenAI 密钥](#openai-配置)。
</details>
### 默认 AI 引擎
::: info 设置路径
软件设置 -> 基本设置 -> 默认 AI 引擎
:::
Enjoy 中提供了很多方便的功能,例如 [提取关键词汇](./webpage#提取关键词汇)、 [查单词](./webpage#查单词)、标注音标 等,均是利用 AI 服务来实现。
默认值为 `Enjoy AI`,由 Enjoy 提供该服务,每次使用均会在账户余额中扣费,余额不足则需要 [充值](#充值) 后才可继续使用。EnjoyAI 提供了除 OpenAI 以外,目前流行的热门模型,用户可以灵活选用。
如果您配备了可用的 [OpenAI 密钥](#openai-配置),也可以将 **默认 AI 引擎** 选为 `OpenAI`
在默认模型,您还可以对不同的服务选用不同的模型。
### OpenAI 配置
::: info 设置路径
软件设置 -> 基本设置 -> OpenAI
:::
配置 OpenAI API 密钥,可以在 [官网](https://platform.openai.com/api-keys) 申请。配置好的 OpenAI 服务可以在 [智能助手](./ai-assistant.md)、 [提取关键词汇](./webpage#提取关键词汇)、 [查单词](./webpage#查单词)、标注音标 等服务中使用。
- 密钥OpenAI API 密钥
- 模型:默认使用的模型
- 接口地址:如果使用的是官方申请的密钥,则不需要填;否则请根据密钥提供方的信息填写。
::: warning 接口地址
由于 OpenAI 在某些地区不提供服务,有些用户会使用第三方提供的中转服务。请务必根据服务提供方的信息填写好 **接口地址**。如果使用时出现报错,可能需要在接口地址结尾加上 `/v1`
:::
## 高级设置
### API 设置
设置 Enjoy 服务的 API 地址。默认为 `https://enjoy.bot`
### 代理设置
为 Enjoy App 设置代理服务。
### 重置设置选项
退出登录并将 Enjoy App 的所有设置重置为默认值。
### 重置所有
将退出登录,并删除所有个人数据。
## 账户设置
### 资源库保存路径
::: info 设置路径
软件设置 -> 基本设置 -> 资源库保存路径
@@ -70,81 +188,7 @@ Enjoy 采用 **本地优先** 的设计原则,大部分数据均保存在本
如前文所说Enjoy 采用本地优先的设计原则,绝大部分数据并没有上传云服务器,请妥善保管好自己的个人数据。
:::
## OpenAI 配置
::: info 设置路径
软件设置 -> 基本设置 -> OpenAi
:::
配置 OpenAI API 密钥,可以在 [官网](https://platform.openai.com/api-keys) 申请。配置好的 OpenAI 服务可以在 [智能助手](./ai-assistant.md)、 [提取关键词汇](./webpage#提取关键词汇)、 [查单词](./webpage#查单词)、标注音标 等服务中使用。
- 密钥OpenAI API 密钥
- 模型:默认使用的模型
- 接口地址:如果使用的是官方申请的密钥,则不需要填;否则请根据密钥提供方的信息填写。
::: warning 接口地址
由于 OpenAI 在某些地区不提供服务,有些用户会使用第三方提供的中转服务。请务必根据服务提供方的信息填写好 **接口地址**。如果使用时出现报错,可能需要在接口地址结尾加上 `/v1`
:::
## Google Generative AI 配置
::: info 设置路径
软件设置 -> 基本设置 -> Google Generative AI
:::
配置 Google Generative AI 的密钥,可以在 [官网](https://ai.google.dev/) 申请 。配置后可以在 [智能助手](./ai-assistant.md) 中选用 Google Generative AI 作为 AI 引擎。
## 语音转文本服务
::: info 设置路径
软件设置 -> 基本设置 -> 语音转文本服务
:::
语音转文本(即 STTSpeech to Text服务是 Enjoy 提供的核心功能之一,也是 [跟读训练](./audios.md#跟读音频) 的前提条件。
### 本地(whisper)
该设置默认项为 `本地`,即利用 Enjoy 集成的 whisper 组件,完全利用本地计算机的算力提供 STT 服务,该服务完全免费。
Enjoy 软件集成了最小的 whisper 模型 `tiny.en`,如果电脑配置较高,可以选用更大的模型以提高语音转文本的准确度。点击 `模型` 按钮,在弹窗中选择相应的模型即可自动下载并选中。
::: tip 关于 whisper 模型的选择
下载的 whisper 模型会保存在 `/EnjoyLibrary/whisper/models/` 文件夹下。如果自动下载失败,也可以到 [这里](https://hf-mirror.com/ggerganov/whisper.cpp) 手动下载,放置在该文件夹下,在 Enjoy 中即可以选中。
理论上,模型越大,识别的准确度也更高,但是运行得越慢,甚至在一些配置不高的电脑中无法运行。
凡是以 `.en` 结尾的模型均只支持英文,识别英文准确性也更高,例如 `base.en`;而不以 `.en` 结尾的模型则可以支持多种语言,例如 `base`
:::
::: warning 检查本地 whisper 服务
有些电脑或者系统(例如 macOS 11可能会因为兼容性问题或其他未知问题无法使用本地的 whisper 服务。点击 `检查` 按钮即可检查 whisper 服务在本地计算机是否工作正常。如果提示无法正常工作,可以选用其他服务。
:::
### Azure AI STT
利用微软 Azure AI 的语音识别 API 服务提供的 STT该服务为**收费服务**,每次使用均会在 Enjoy 账户余额中扣费,,余额不足则需要 [充值](#充值) 后才可继续使用。
### Cloudflare AI STT
利用 Cloudflare 提供的 whisper 云服务,该服务目前免费。经实测,对于一些时长较短的音频,识别会有较大误差。
### OpenAI STT
利用 OpenAI 提供的 whipser 云服务,该服务需要[配置自己的 OpenAI 密钥](#openai-配置)。
## 默认 AI 引擎
::: info 设置路径
软件设置 -> 基本设置 -> 默认 AI 引擎
:::
Enjoy 中提供了很多方便的功能,例如 [提取关键词汇](./webpage#提取关键词汇)、 [查单词](./webpage#查单词)、标注音标 等,均是利用 AI 服务来实现。
如果你有自己的 [OpenAI 密钥](#openai-配置),建议将 **默认 AI 引擎** 选为 `OpenAI`
否则,可以选 `Enjoy AI`,由 Enjoy 提供该服务,每次使用均会在账户余额中扣费,余额不足则需要 [充值](#充值) 后才可继续使用。
## 充值
### 充值
::: info 设置路径
软件设置 -> 账户设置 -> 余额
@@ -159,3 +203,15 @@ Enjoy 提供了部分收费的 AI 服务,均为 **按使用量收费**,每
请谨慎考虑,按需充值。
:::
## 快捷键
Enjoy App 可用的快捷键,点击键位可以修改。
## 外观
可修改主题和界面语言。
## 关于
当前版本和更新链接。