rhasspy/wyoming-speech-to-phrase

rhasspy/wyoming-speech-to-phrase 镜像文档

1. 镜像概述和主要用途

rhasspy/wyoming-speech-to-phrase 是一个基于 Wyoming 协议的本地语音转文本服务镜像，提供快速、个性化的语音识别能力。该镜像专注于本地环境运行，支持模型个性化训练，适用于需要隐私保护、低延迟且无需依赖云端服务的语音交互场景。

2. 核心功能和特性

• 本地处理：语音数据全程在本地设备处理，无需上传云端，确保数据隐私与安全。
• 个性化训练：支持通过外部数据目录导入自定义训练数据，生成符合特定场景（如方言、专业术语）的定制化识别模型。
• Home Assistant 集成：可通过 WebSocket 协议与 Home Assistant 联动，支持智能家居语音控制场景。
• 轻量高效：优化资源占用，适用于嵌入式设备及低配置服务器，实现快速语音识别响应。

3. 使用场景和适用范围

• 智能家居语音控制：与 Home Assistant 集成，实现本地化语音指令解析，控制灯光、家电等设备。
• 本地服务器语音交互：部署于私有服务器，提供无云端依赖的语音命令识别（如服务器管理、日志查询）。
• 隐私敏感场景：***、家庭数据处理等需严格保护用户语音数据的场景。
• 嵌入式设备应用：在树莓派等嵌入式平台运行，满足资源受限环境下的高效语音识别需求。

4. 使用方法和配置说明

4.1 环境要求

• 已安装 Docker 引擎（20.10+ 版本推荐）。
• 模型文件：需提前下载兼容的语音模型（参考 https://github.com/OHF-voice/speech-to-phrase%EF%BC%89%EF%BC%8C%E5%B9%B6%E9%80%9A%E8%BF%87%E5%8D%B7%E6%8C%82%E8%BD%BD%E8%87%B3%E5%AE%B9%E5%99%A8%E3%80%82

4.2 Docker 快速启动（docker run）

bash
docker run -it -p 10300:10300 \
  -v /path/to/local/models:/models \  # 本地模型目录挂载至容器/models（必填）
  -v /path/to/local/train:/train \    # 本地训练数据目录挂载至容器/train（可选，用于个性化训练）
  rhasspy/wyoming-speech-to-phrase \
  --hass-websocket-uri 'ws://homeassistant.local:8123/api/websocket' \  # Home Assistant WebSocket地址（可选，用于集成）
  --hass-token '<LONG_LIVED_ACCESS_TOKEN>' \  # Home Assistant 长期访问令牌（可选，与--hass-websocket-uri配合使用）
  --retrain-on-start  # 启动时使用/train目录数据重新训练模型（可选，默认不启用）

参数说明：

• -it：以交互模式运行容器，支持实时日志查看与控制。
• -p 10300:10300：映射容器服务端口（***）至主机，用于外部访问。

4.3 Docker Compose 部署（推荐）

创建 docker-compose.yml 文件，配置如下：

yaml
version: '3.8'
services:
  wyoming-speech-to-phrase:
    image: docker.xuanyuan.run/rhasspy/wyoming-speech-to-phrase
    container_name: wyoming-speech-to-phrase
    restart: unless-stopped  # 服务异常时自动重启
    ports:
      - "10300:10300"  # 端口映射
    volumes:
      - /path/to/local/models:/models  # 模型目录（替换为本地实际路径）
      - /path/to/local/train:/train    # 训练数据目录（可选，按需挂载）
    command: >
      --hass-websocket-uri 'ws://homeassistant.local:8123/api/websocket'  # Home Assistant集成（可选）
      --hass-token '<LONG_LIVED_ACCESS_TOKEN>'  # Home Assistant令牌（可选）
      --retrain-on-start  # 启动时重新训练（可选）

启动服务：

bash
docker-compose up -d

5. 配置参数详解

5.1 命令行参数

5.2 卷挂载说明

6. 环境变量

当前版本镜像主要通过命令行参数进行配置，暂无需额外环境变量。如有更新，可参考 https://github.com/OHF-voice/speech-to-phrase 获取最新环境变量说明。