diff --git a/docs/API_reference/zh/ailib/README.md b/docs/API_reference/zh/ailib/README.md index af8bebb661a5531da96566911f12f17a6e529886..7380542b417d52595008304895909c9b53867844 100644 --- a/docs/API_reference/zh/ailib/README.md +++ b/docs/API_reference/zh/ailib/README.md @@ -5,3 +5,4 @@ ## QuecPython AI 聊天机器人库列表 - [TiktokRTC - 豆包火山 RTC 平台](./TiktokRTC.md) +- [TiktokWS - 豆包火山 Websocket 平台](./TiktokWebsocket.md) \ No newline at end of file diff --git a/docs/API_reference/zh/ailib/TiktokWebsocket.md b/docs/API_reference/zh/ailib/TiktokWebsocket.md new file mode 100644 index 0000000000000000000000000000000000000000..74e8811a60a6e80282c86491de43c68eec03bcca --- /dev/null +++ b/docs/API_reference/zh/ailib/TiktokWebsocket.md @@ -0,0 +1,131 @@ +# TiktokWS - 火山 Websocket AI 对话 + +火山 Websocket AI 对话,在语音对话场景中,若你希望启动智能体提供语音聊天服务,可以通过调用此类实现。 + +> 支持模组型号:EC800MCN_LE + +## 构造函数 + +### `TiktokWS` + +```python +class TiktokWS() +``` + +初始化 TiktokWS,并返回 tiktok 火山大模型对话对象。 + +**示例:** + +```python +from usr.tiktokws import TiktokWS +tiktok = TiktokWS() +``` + +## 方法 + +### `TiktokWS.config` + +```python +tiktok.config('param') +tiktok.config(param=value) +``` + +火山大模型参数查询/配置。 + +当只传参关键字时,接口查询,每次只能查询一个值。 +当传参赋值时,接口设置,返回True/False表示成功/失败,可以同时设置多个值。 + +**参数描述:** + +- `ASR` - `str`类型,表示语音识别配置,格式({'Host': 'host', 'AppId': 'appid', 'AuthToken': 'authtoken', 'Cluster': 'cluster'})。 + - `Host` - `str`类型,表示ASR服务(语音识别)使用的域名。 + - `AppId` - `str`类型,表示ASR服务(语音识别)应用标识。 + - `AuthToken` - `str`类型,表示ASR服务(语音识别)应用令牌。 + - `Cluster` - `str`类型,表示ASR服务(语音识别)业务集群。 + +- `Chat` - `str`类型,表示对话配置,格式({'CompletionsPosrURL': 'completionsPosrURL', 'AppKey': 'appKey', 'ModelId': 'modelId'})。 + - `CompletionsPosrURL` - `str`类型,表示对话服务接口地址。 + - `AppKey` - `str`类型,表示对话服务API密钥。 + - `ModelId` - `str`类型,表示对话服务请求模型ID。 + +- `TTS` - `str`类型,表示语音合成配置,({'Host': 'host', 'AppId': 'appid', 'AuthToken': 'authtoken', 'Cluster': 'cluster'})。 + - `Host` - `str`类型,表示TTS服务(语音合成)使用的域名。 + - `AppId` - `str`类型,表示TTS服务(语音合成)应用标识。 + - `AuthToken` - `str`类型,表示TTS服务(语音合成)应用令牌。 + - `Cluster` - `str`类型,表示TTS服务(语音合成)业务集群。 + +- `volume` - `int`类型,表示音量配置(0~11)。 + +> 特别说明:用户如需使用 AI 对话功能,请确保使用前自行获取并更新上面各参数(除地址外),若直接使用,会导致AI对话功能无法正常使用。 + +**示例:** +配置信息查询: +```python +# 查询音量大小 +>>>tiktok.config('volume') +>>>8 +``` + +```python +# 查询ASR配置 +>>>tiktok.config('ASR') +>>>{'Host': 'a', 'AppId': 'b', 'AuthToken': 'c', 'Cluster': 'd'} +``` + +配置信息设置: +```python +# 配置音量大小 +>>>tiktok.config(volume=9) +>>>True +``` +```python +# 配置ASR +>>>tiktok.config(ASR={'AppId':'123'}) +>>>True +``` + +### `TiktokWS.start_media` + +```python +tiktok.start_media() +``` + +开始录制音频 + +### `TiktokWS.stop_media` + +```python +tiktok.stop_media() +``` + +停止录制音频 + +### `TiktokWS.asr` + +```python +tiktok.asr() +``` + +启动语音识别服务,与 ASR 服务器建立连接,读取已录制音频分批发送至 ASR 服务器,并接收识别文本结果。 + +### `TiktokWS.chat` + +```python +tiktok.chat(question_text) +``` + +启动对话服务,将携带的文本作为用户输入,大模型响应生成智能回复,返回文本内容。 + +**参数描述:** +- `question_text` - str 类型,表示提问文本内容(语音识别结果),例如:“说一个故事吧”。 + +### `TiktokWS.tts_play` + +```python +tiktok.tts_play(answer_text) +``` + +启动语音合成服务,与 TTS 服务器建立连接,将携带的文本发送至 TTS 服务器,接收对应文本生成的音频流。 + +**参数描述:** +- `question_text` - str 类型,表示需转换为语音的文本,例如:“当然!让我给您讲一个关于勇气的故事”。