RubySpeech 项目技术文档

1. 安装指南

在安装RubySpeech之前，您需要确保系统中已安装了以下依赖：

• pcre：根据您的操作系统安装对应的pcre库。
  • 在OSX系统中，使用Homebrew安装：

    brew install pcre
    

  • 在Ubuntu/Debian系统中，使用apt-get安装：

    sudo apt-get install libpcre3 libpcre3-dev
    

  • 在CentOS系统中，使用yum安装：

    sudo yum install pcre-devel
    

安装完依赖后，使用以下命令通过gem安装RubySpeech：

gem install ruby_speech

2. 项目的使用说明

RubySpeech库用于构建和解析文本到语音（TTS）和自动语音识别（ASR）文档，如SSML、GRXML和NLSML。以下是使用该库的基本示例：

SSML示例

require 'ruby_speech'

speak = RubySpeech::SSML.draw do
  voice gender: :male, name: 'fred' do
    string "Hi, I'm Fred. The time is currently "
    say_as interpret_as: 'date', format: 'dmy' do
      "01/02/1960"
    end
  end
end

puts speak.to_s

GRXML示例

require 'ruby_speech'

grammy = RubySpeech::GRXML.draw mode: :dtmf, root: 'pin' do
  rule id: 'digit' do
    one_of do
      ('0'..'9').map { |d| item { d } }
    end
  end

  rule id: 'pin', scope: 'public' do
    one_of do
      item do
        item repeat: '4' do
          ruleref uri: '#digit'
        end
        "#"
      end
      item do
        "* 9"
      end
    end
  end
end

puts grammy.to_s

NLSML示例

require 'ruby_speech'

nlsml = RubySpeech::NLSML.draw grammar: 'http://flight' do
  interpretation confidence: 0.6 do
    input "I want to go to Pittsburgh", mode: :voice

    instance do
      airline do
        to_city 'Pittsburgh'
      end
    end
  end
end

puts nlsml.to_s

3. 项目API使用文档

RubySpeech提供了丰富的API来构建和解析TTS和ASR文档。以下是API的简要概述：

SSML API

• RubySpeech::SSML.draw：构建SSML文档。
• voice：定义语音的性别和名称。
• string：添加普通文本。
• say_as：定义如何输出文本。
• break：在文本中添加停顿。
• audio：添加音频文件。
• p 和 s：文本段落和句子。

GRXML API

• RubySpeech::GRXML.draw：构建GRXML文档。
• rule：定义语法规则。
• one_of：定义一组可能的输入。
• item：定义具体的输入项。
• ruleref：引用另一个规则。

NLSML API

• RubySpeech::NLSML.draw：构建NLSML文档。
• interpretation：定义解释和置信度。
• input：添加输入文本。
• instance：定义实例数据。

4. 项目安装方式

项目的安装方式已在“安装指南”部分说明，简要概括如下：

• 安装依赖库pcre。
• 使用gem命令安装RubySpeech库：

  gem install ruby_speech