Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tts readme fix #125

Merged
merged 2 commits into from
Feb 20, 2024
Merged

tts readme fix #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63b3c70
tts readme fix
Feb 5, 2024
e264b50
tts readme fix
Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions appbuilder/core/components/tts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
短文本在线合成组件（TTS）提供高度拟人、流畅自然的语音合成服务，将文本朗读出来，基础音库性价比更高，精品音库听感更逼真。

### 功能介绍
提供高度拟人、流畅自然的语音合成服务
提供高度拟人、流畅自然的语音合成服务。

### 特色优势
将文本朗读出来，基础音库性价比更高，精品音库听感更逼真。
将文本朗读出来，基础音库性价比更高，精品音库听感更逼真。可实时生成语音输出，几乎没有延迟，更加自然流畅。

### 应用场景
文本朗读
Expand Down Expand Up @@ -57,32 +57,32 @@ os.environ["APPBUILDER_TOKEN"] = "..."

无

### 调用参数 （以表格形式展示）
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|------------|---------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| message | String | 是 | 待转成语音的文本 | |
| model | String | 否 | 默认是`baidu-tts`模型，可选值：`paddlespeech-tts`、`baidu-tts` | |
| speed | Integer | 否 | 语音语速，默认是5中等语速，取值范围在0~15之间，如果使用paddlespeech-tts模型，参数自动失效 | 10 |
| pitch | Integer | 否 | 语音音调，默认是5中等音调，取值范围在0~15之间，如果使用paddlespeech-tts模型，参数自动失效 | |
| volume | Integer | 否 | 语音音量，默认是5中等音量，取值范围在0~15之间，如果使用paddlespeech-tts模型，参数自动失效 | 10 |
| person | Integer | 否 | 语音人物特征，默认是0(度小美),可选值: 1(度小宇) 、0(度小美)、 3(度逍遥-基础)、 4(度丫丫)、 5003(度逍遥-精品)、 5118(度小鹿) 、106(度博文)、 110(度小童)、 111(度小萌)、 103(度米朵)、 5(度小娇), 如果选择模型为paddlespeech-tts，参数自动失效 | |
| audio_type | String | 否 | 音频文件格式，默认是`mp3`, 如果使用`paddlespeech-tts`模型非流式返回，参数只能设为`wav`，如果使用`paddlespeech-tts`模型流式返回，参数只能设为`pcm` | 10 |
| stream | Bool | 否 | 目前仅`paddlespeech-tts`模型支持流式返回 | 10 |
| retry | Integer | 否 | HTTP重试次数 | |
| timeout | Integer | 否 | HTTP超时时间 | 10 |
### 调用参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|------------|---------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
| message | String | 是 | 待转成语音的文本 | Message(content={"text": "需合成的文本"}) |
| model | String | 否 | 默认是`baidu-tts`模型，可选值：`paddlespeech-tts`、`baidu-tts` | paddlespeech-tts |
| speed | Integer | 否 | 语音语速，默认是5中等语速，取值范围在0~15之间，如果使用paddlespeech-tts模型，参数自动失效 | 5 |
| pitch | Integer | 否 | 语音音调，默认是5中等音调，取值范围在0~15之间，如果使用paddlespeech-tts模型，参数自动失效 | 5 |
| volume | Integer | 否 | 语音音量，默认是5中等音量，取值范围在0~15之间，如果使用paddlespeech-tts模型，参数自动失效 | 5 |
| person | Integer | 否 | 语音人物特征，默认是0(度小美),可选值: 1(度小宇) 、0(度小美)、 3(度逍遥-基础)、 4(度丫丫)、 5003(度逍遥-精品)、 5118(度小鹿) 、106(度博文)、 110(度小童)、 111(度小萌)、 103(度米朵)、 5(度小娇), 如果选择模型为paddlespeech-tts，参数自动失效 | 0 |
| audio_type | String | 否 | 音频文件格式，默认是`mp3`, 如果使用`paddlespeech-tts`模型非流式返回，参数只能设为`wav`，如果使用`paddlespeech-tts`模型流式返回，参数只能设为`pcm` | wav |
| stream | Bool | 否 | 目前仅`paddlespeech-tts`模型支持流式返回 | False |
| retry | Integer | 否 | HTTP重试次数 | 3 |
| timeout | Integer | 否 | HTTP超时时间 | 5 |

### 非流式语音响应参数
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---------------|--------|--------|---------|
| content | Dict | 消息内容 | |
| +audio_binary | Bytes | 音频二进制流 | |
| content | Dict | 消息内容 | 无 |
| +audio_binary | Bytes | 音频二进制流 | b'语音流' |
| +audio_type | String | 音频类型 | wav/mp3 |


### 非流式语音响应参数
### 流式语音响应参数
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---------|------------------|----------|-----|
| content | Python Generator | 可迭代的二进制流 | |
| content | Python Generator | 可迭代的二进制流 | 无 |


### 响应示例
Expand Down Expand Up @@ -161,4 +161,5 @@ for pcm in out.content:

## 更新记录和贡献
* 短文本在线合成 (2024-01)
* 增加流式能力 (2024-02)