phonexia/spe

Phonexia Speech Engine Docker镜像文档

快速参考

• 开发方：Phonexia
• 获取帮助：SPE API参考文档、Phonexia合作伙伴门户
• 提交问题：可通过Phonexia服务台在"Speech Platform: Speech Engine"产品下提交
• 获取许可证：联系Phonexia支持团队 ***

什么是Phonexia Speech Engine

Phonexia Speech Engine (SPE)是一个提供REST API的HTTP服务器，专为希望集成Phonexia语音技术的开发者设计。

如何使用此镜像

注意：拉取镜像需使用特定标签，不支持latest标签。详见标签命名章节。

启动带VAD技术的Phonexia Speech Engine 3.61版本

shell
$ docker run --detach --name some-spe --publish 8600:8600 --volume /license.dat:/opt/spe/license.dat phonexia/spe:3.61-vad

或：

shell
$ docker network create some-network
$ docker run --detach --name some-spe --network some-network --volume /license.dat:/opt/spe/license.dat phonexia/spe:3.61-vad

其中：

• some-network 是新创建的网络
• some-spe 是您为容器分配的名称
• /license.dat 是Phonexia许可证文件路径。联系***获取许可证。

容器启动时，入口脚本会自动配置SPE，初始化1个技术实例（若存在流式技术变体，也会初始化1个实例，将额外消耗许可证槽位）。详见技术配置章节。

连接到Speech Engine服务器

通过浏览器访问API文档：http://localhost:8600/doc%EF%BC%88%E9%9C%80%E4%BD%BF%E7%94%A8%60--publish 8600:8600`运行SPE）

或使用curl获取SPE状态（需使用--publish 8600:8600运行SPE）：

shell
$ curl localhost:8600/status

或使用镜像中的phxclient（SPE需连接到some-network网络）：

shell
$ docker run --rm --network some-network phonexia/spe:3.61-vad phxclient -m GET -u some-spe:8600/status

技术配置

容器启动时，入口脚本会自动配置SPE，初始化每个技术的1个实例（若存在流式技术变体，也会初始化1个实例，额外消耗许可证槽位）。要初始化多个技术实例，可使用环境变量SPE_N_INSTANCES。也可通过SPE_N_WORKERS和SPE_N_REALTIME_WORKERS设置工作进程数（自SPE 3.55起，工作进程数默认自动配置为-1，根据CPU数量和技术配置动态调整）。

示例：启动4个实例

shell
$ docker run --detach --name some-spe -e SPE_N_INSTANCES=4 --publish 8600:8600 --volume /license.dat:/opt/spe/license.dat phonexia/spe:3.61-vad

示例：使用SPE_ENABLE_TECHNOLOGIES配置技术实例

该变量会作为phxadmin2 technology enable ${SPE_ENABLE_TECHNOLOGIES}命令的参数执行。例如，配置3个VAD技术实例和1个VAD_STREAM技术实例：

shell
$ docker run --detach --name some-spe -e SPE_ENABLE_TECHNOLOGIES="vad:*=3 vad_stream:*=1" --publish 8600:8600 --volume /license.dat:/opt/spe/license.dat phonexia/spe:3.61-vad

自定义配置文件

可将自定义配置文件挂载到容器内/opt/spe/settings/technologies.xml路径。若该文件已存在，入口脚本将不会自动配置SPE。详见数据持久化章节。

环境变量

入口脚本变量

SPE配置变量

变量语义补充说明

• SPE_OUTPUT_STREAM_RTP_TIMEOUT：若输出流超过指定时间未发送数据，将被关闭。防止客户端忘记关闭流导致的流阻塞。
• SPE_TECHNOLOGIES_TTS_CONNECTORS：启用外部文本转语音技术。每个连接器需通过其文件夹中的配置文件进行配置，模板文件为connectors.properties.template。

查看默认值

可通过以下命令查看环境变量默认值：

shell
$ docker inspect phonexia/spe:3.61-vad

数据持久化

配置文件

SPE配置存储在/opt/spe/settings文件夹中。容器启动时，若phxspe.properties和technologies.xml文件不存在，将自动生成。可通过挂载settings文件夹使用自定义配置：

shell
docker run --detach --name some-spe --publish 8600:8600 --volume /license.dat:/opt/spe/license.dat --volume /spe/my_settings:/opt/spe/settings docker.xuanyuan.run/phonexia/spe:3.61-vad

可手动编辑配置文件，或使用phxadmin/phxadmin2工具修改technologies.xml。修改后需重启SPE。

查看已配置技术

shell
$ docker run --rm --volume /spe/my_settings:/opt/spe/settings phonexia/spe:3.61-vad phxadmin2 technology

启用/禁用VAD技术

shell
$ docker run --rm --volume /spe/my_settings:/opt/spe/settings phonexia/spe:3.61-vad phxadmin2 technology enable vad
$ docker run --rm --volume /spe/my_settings:/opt/spe/settings phonexia/spe:3.61-vad phxadmin2 technology disable vad

查看帮助：

shell
$ docker run --rm phonexia/spe:3.61-vad phxadmin2 --help

SPE数据

SPE数据存储在home和shared文件夹中。默认SQLite数据库文件位于home文件夹。可通过挂载这些文件夹实现数据持久化：

shell
$ docker run --detach --name some-spe --publish 8600:8600 --volume /license.dat:/opt/spe/license.dat --volume /spe/my_home:/opt/spe/home --volume /spe/my_shared:/opt/spe/shared phonexia/spe:3.61-vad

使用Phonexia RLS服务器

通过环境变量SPE_REPORTING_URLS配置RLS地址：

shell
$ docker run --detach --name some-spe --publish 8600:8600 --volume /license.dat:/opt/spe/license.dat -e SPE_REPORTING_URLS="server1.com:8777, 192.168.0.10:8777" phonexia/spe:3.61-vad

使用MariaDB数据库

启动MariaDB（带持久化存储）

shell
$ docker run -d --network some-network --name mariadb --volume /mariadb-data:/var/lib/mysql -e MARIADB_ROOT_PASSWORD=secret -e MARIADB_DATABASE=phxspe mariadb:latest

其中secret是MariaDB的root密码，phxspe是SPE数据库名称。

运行使用MariaDB的SPE

shell
docker run --detach --name some-spe --network some-network --volume /license.dat:/opt/spe/license.dat -e SPE_DB_ENGINE=MariaDB -e SPE_DB_MARIADB_HOST=mariadb -e SPE_DB_MARIADB_USER=root -e SPE_DB_MARIADB_PASSWORD=secret -e SPE_DB_MARIADB_DB=phxspe docker.xuanyuan.run/phonexia/spe:3.61-vad

使用docker-compose

示例docker-compose.yml文件：

yaml
version: '3'
services:
  mariadb:
    image: docker.xuanyuan.run/mariadb:latest
    container_name: mariadb
    environment:
      MARIADB_ROOT_USER: root
      MARIADB_ROOT_PASSWORD: secret
      MARIADB_USER: phonexia
      MARIADB_DATABASE: phxspe
    volumes:
      - dbdata:/var/lib/mysql
    healthcheck:
      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
      timeout: 20s
      retries: 10

  spe:
    image: docker.xuanyuan.run/phonexia/spe:3.61-vad
    container_name: spe
    links:
      - mariadb
    environment:
      SPE_DB_ENGINE: MariaDB
      SPE_DB_MARIADB_HOST: mariadb
      SPE_DB_MARIADB_USER: root
      SPE_DB_MARIADB_PASSWORD: secret
      SPE_DB_MARIADB_DB: phxspe
    ports:
      - 8600:8600
    volumes:
      - home:/opt/spe/home
      - shared:/opt/spe/shared
      - settings:/opt/spe/settings
      - /spe/license.dat:/opt/spe/license.dat
    depends_on:
      mariadb:
        condition: service_healthy
    healthcheck:
      test: ["CMD", "curl" ,"-f", "http://localhost:8600/status"]
      timeout: 30s
      retries: 10

volumes:
  dbdata:
  home:
  shared:
  settings:

其中/spe/license.dat是许可证文件路径。在docker-compose.yml文件所在目录运行：

shell
$ docker-compose up -d

组合多种技术

示例spe-vad-sqe-sid4.Dockerfile（组合VAD、SQE和SID4技术）：

dockerfile
FROM docker.xuanyuan.run/phonexia/spe:3.61-vad as VAD
FROM docker.xuanyuan.run/phonexia/spe:3.61-sqe as SQE
FROM docker.xuanyuan.run/phonexia/spe:3.61-sid4 as SID4
FROM docker.xuanyuan.run/phonexia/spe:3.61

COPY --from=VAD /opt/spe/bsapi ./bsapi
COPY --from=SQE /opt/spe/bsapi ./bsapi
COPY --from=SID4 /opt/spe/bsapi ./bsapi

在spe-vad-sqe-sid4.Dockerfile文件所在目录构建镜像：

shell
$ docker build -t spe-vad-sqe-sid4:3.61 -f spe-vad-sqe-sid4.Dockerfile .

标签命名

SPE镜像标签命名规则如下，便于选择版本和技术：

例如标签3.61.0-vad-generic_3中：

• 3.61.0：SPE版本。若需跟踪最新bug修复版本，可使用3.61（指向最新bug修复版本）
• vad：技术名称。支持的技术包括：age、denoise、diar、gid、kws、lid、sid、sid4、sqe、stt、tanalysis和vad
• generic_3：技术模型名称。部分技术可省略模型名使用默认模型，例如VAD技术默认模型为generic_3，可使用标签3.61.0-vad

此外，提供不含任何技术的基础镜像，标签仅包含版本（如3.61.0或3.61）。该镜像因缺少技术无法启动，主要用于组合多种技术（详见组合多种技术章节）。