系统范围内的离线语音命令或文本，可插拔系统

SL5 Aura 服务 - 功能和操作系统兼容性

欢迎来到 SL5 Aura 服务！本文档快速概述了我们的主要功能及其操作系统兼容性。

Aura 不仅仅是一个转录器；它也是一个转录器。它是一个强大的离线处理引擎，可以将您的声音转换为精确的动作和文本。

X空格符X X空格符X 翻译：该文档也存在于other languages中。

SL5 Aura (v0.7.0.2): A Deep Dive Under the Hood – Live Coding & Core Concepts （https://skipvids.com/?v=tEijy8WRFCI）

主要特点

  • 离线和私人： 100% 本地。任何数据都不会离开您的机器。

  • 动态脚本引擎： 超越文本替换。 Rules can execute custom Python scripts (on_match_exec) to perform advanced actions like calling APIs (e.g., search Wikipedia), interacting with files (e.g., manage a to-do list), or generating dynamic content (e.g., a context-aware email greeting).

  • 高控制转换引擎： 实现配置驱动、高度可定制的处理管道。 Rule priority, command detection, and text transformations are determined purely by the sequential order of rules in the Fuzzy Maps, requiring configuration, not coding.

  • 保守的 RAM 使用： 智能管理内存，仅在有足够的可用 RAM 时才预加载模型，确保其他应用程序（例如您的 PC 游戏）始终具有优先权。

  • 跨平台： 适用于 Linux、macOS 和 Windows。

文档

如需完整的技术参考，包括所有模块和脚本，请访问我们的官方文档页面。它是自动生成的并且始终是最新的。

Go to Documentation >>

构建状态

Linux Manjaro Linux Ubuntu Linux Suse macOS Windows 11

Documentation

阅读其他语言版本：

🇬🇧 English | 🇸🇦 العربية | 🇩🇪 Deutsch | 🇪🇸 Español | 🇫🇷 Français | 🇮🇳 हिन्दी | 🇯🇵 日本語 | 🇰🇷 한국어 | 🇵🇱 Polski | 🇵🇹 Português | 🇧🇷 Português Brasil | 🇨🇳 简体中文

＃＃ 安装

设置过程分为两步：

  1. 将此存储库克隆到您的计算机。

  2. 运行适用于您的操作系统的一次性安装脚本。

安装脚本处理一切：系统依赖项、Python 环境，以及直接从我们的 GitHub 版本下载必要的模型和工具（~4GB）以获得最大速度。

适用于 Linux、macOS 和 Windows

在项目根目录中打开终端并运行适用于您的系统的脚本： 代码_块_0

对于 Windows

使用管理员权限运行安装脚本 “使用 PowerShell 运行”。

安装一个用于读取和运行的工具，例如CopyQ 或 AutoHotkey v2。这是文本输入观察者所必需的。

＃＃ 用法

一个脚本可以处理所有事情。 It starts the main dictation service and the file watcher automatically in the background. 代码_块_1

在 Windows 上

2. 配置您的热键

要触发听写，您需要一个创建特定文件的全局热键。我们强烈推荐跨平台工具CopyQ。

使用全局快捷方式在 CopyQ 中创建新命令。

代码_块_3

代码_块_4

3. 开始听写！

单击任何文本字段，按热键，将出现“正在收听…”通知。说清楚，然后停顿。系统将为您输入更正后的文本。

高级配置（可选）

  1. 导航到“config/”目录。

  2. 编辑 settings_local.py 以覆盖主 config/settings.py 文件中的任何设置。

插件结构和逻辑

系统的模块化允许通过plugins/目录进行强大的扩展。

处理引擎严格遵守分层优先级链：

X空格符X

X空格符X

Windows 用户的关键脚本

设置和更新

  • setup/setup.bat：环境的初始一次性设置的主脚本。

  • or 运行 powershell -Command "Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; .\setup\windows11_setup.ps1"

运行应用程序

  • start_dictation_v2.0.bat：启动听写服务的主要脚本。

核心和帮助脚本

  • dictation_service.py：核心 Python 服务（通常由上述脚本之一启动）。

  • get_suggestions.py：用于特定功能的帮助程序脚本。

🚀 主要功能和操作系统兼容性

操作系统兼容性图例：

  • 🐧 Linux（例如 Arch、Ubuntu）

  • 🍏 macOS

  • 🪟 Windows

  • 📱 Android（针对移动设备特定功能）

核心语音转文本 (Aura) 引擎

我们用于离线语音识别和音频处理的主要引擎。

X空格符X 光环核心/ 🐧 🍏 🪟
├─ dictation_service.py （主要 Python 服务编排 Aura） 🐧 🍏 🪟
├┬ 实时热重载（配置和地图）🐧🍏🪟
│├ 文本处理和更正/ 按语言分组（例如 de-DE、en-US、…）
│├ 1. normalize_punctuation.py（转录后标点符号标准化）🐧 🍏 🪟
│├ 2. 智能预校正 (FuzzyMap Pre - The Primary Command Layer) 🐧 🍏 🪟
│ │ * 动态脚本执行：规则可以触发自定义Python脚本（on_match_exec）来执行高级操作，例如API调用、文件I/O或生成动态响应。
│ │ * 级联执行：规则按顺序处理，其效果累积。后面的规则适用于前面的规则修改的文本。
│ │ * 最高优先级停止标准： 如果规则实现 完全匹配 (^…$)，则该令牌的整个处理管道将立即停止。这种机制对于实现可靠的语音命令至关重要。
│├ 3. Correct_text_by_languagetool.py (集成LanguageTool用于语法/风格校正) 🐧 🍏 🪟
│└ 4. 智能后期校正 (FuzzyMap)– LT后细化 🐧 🍏 🪟
│ │ * 在 LanguageTool 之后应用以纠正 LT 特定的输出。遵循与预校正层相同的严格级联优先级逻辑。
││ * **动态脚本执行：**规则可以触发自定义Python脚本（on_match_exec）来执行高级操作，例如API调用、文件I/O或生成动态响应。
││ * 模糊回退： 模糊相似性检查（由阈值控制，例如 85%）充当最低优先级的纠错层。仅当前面的整个确定性/级联规则运行未能找到匹配项（current_rule_matched 为 False）时才会执行它，通过尽可能避免缓慢的模糊检查来优化性能。
├┬ 模型管理/
│├─ prioritize_model.py (根据使用情况优化模型加载/卸载) 🐧 🍏 🪟
│└─ setup_initial_model.py (配置首次模型设置) 🐧 🍏 🪟
├─ 自适应 VAD 超时 🐧 🍏 🪟
├─ 自适应热键（开始/停止） 🐧 🍏 🪟
└─ 即时语言切换（通过模型预加载进行实验）🐧 🍏

系统实用程序/
├┬ LanguageTool 服务器管理/
│├─ start_languagetool_server.py (初始化本地 LanguageTool 服务器) 🐧 🍏 🪟
│└─ stop_languagetool_server.py (关闭 LanguageTool 服务器) 🐧 🍏 ├─ monitor_mic.sh （例如，与耳机一起使用，而不使用键盘和显示器） 🐧 🍏 🪟

模型和包管理

用于稳健处理大型语言模型的工具。

模型管理/ 🐧 🍏 🪟
├─ 强大的模型下载器（GitHub 发布块）🐧 🍏 🪟
├─ split_and_hash.py （仓库所有者分割大文件并生成校验和的实用程序）🐧 🍏 🪟
└─ download_all_packages.py （供最终用户下载、验证和重新组装多部分文件的工具） 🐧 🍏 🪟

开发和部署助手

用于环境设置、测试和服务执行的脚本。

DevHelpers/
├┬ 虚拟环境管理/
│├ scripts/restart_venv_and_run-server.sh (Linux/macOS) 🐧 🍏
│└ scripts/restart_venv_and_run-server.ahk (Windows) 🪟
├┬ 全系统听写集成/
│├ Vosk-系统-监听器集成 🐧 🍏 🪟
│├ scripts/monitor_mic.sh (Linux 专用麦克风监控) 🐧
│└ scripts/type_watcher.ahk （AutoHotkey 侦听已识别的文本并在系统范围内将其输入）🪟
└─ CI/CD 自动化/
└─ 扩展的 GitHub 工作流程（安装、测试、文档部署）🐧 🍏 🪟 （在 GitHub 操作上运行）

即将推出/实验性功能

目前正在开发或处于草稿状态的功能。

实验功能/
├─ ENTER_AFTER_DICTATION_REGEX 激活规则示例“(ExampleAplicationThatNotExist|Pi，您的个人 AI)” 🐧
├┬插件
│╰┬ 实时延迟重新加载 (*) 🐧 🍏 🪟
（对插件激活/停用及其配置的更改将应用于下一次处理运行，无需重新启动服务。）
│ ├ git 命令（发送 git 命令的语音控制）🐧 🍏 🪟
│ ├ 万韦尔（德国-万韦尔位置地图）🐧 🍏 🪟
│ ├ 扑克插件（草案）（扑克应用程序的语音控制）🐧 🍏 🪟
│ └ 0 A.D. 插件（草稿）（0 A.D. 游戏的语音控制）🐧
├─ 开始或结束会话时的声音输出（描述待定）🐧
├─ 针对视障人士的语音输出（描述待定）🐧 🍏 🪟
└─ SL5 Aura Android 原型（尚未完全离线）📱

（注意：通用 Linux 🐧 符号涵盖了特定的 Linux 发行版，例如 Arch (ARL) 或 Ubuntu (UBT)。安装指南中可能会介绍详细的区别。）

<详情>

点击查看生成此脚本列表所使用的命令

代码_块_5 </详情>

以图形方式查看后面的内容：

yappi_call_graph

X空格符X pydeps -v -o dependencies.svg scripts/py/func/main.py

使用的型号：

建议：使用 Mirror https://github.com/sl5net/SL5-aura-service/releases/tag/v0.2.0.1 中的模型（可能更快）

此Ziped模型必须保存到“models/”文件夹中

mv vosk-model-*.zip 模型/

型号

尺寸

字错误率/速度

笔记

许可证

vosk-model-en-us-0.22

1.8G

5.69（librispeech 测试清理）
6.05（tedlium）
29.78（呼叫中心）

精准通用美式英语模型

阿帕奇2.0

vosk-model-de-0.21

1.9G

9.83（Tuda-de 测试）
24.00（播客）
12.82（cv-测试）
12.42（mls）
33.26（mtedx）

德国大型电话和服务器模型

阿帕奇2.0

此表提供了不同 Vosk 型号的概述，包括其大小、字错误率或速度、注释和许可证信息。

LanguageTool许可证： GNU Lesser General Public License (LGPL) v2.1 or later

支持该项目

如果您觉得这个工具有用，请考虑给我们买杯咖啡！您的支持有助于推动未来的改进。

ko-fi

Stripe-Buy Now