From e0024dd0ed6de3f2dd8a8e3b4151319281319ee9 Mon Sep 17 00:00:00 2001
From: moqiyi <85303405@qq.com>
Date: Mon, 17 Mar 2025 12:58:41 +0000
Subject: [PATCH 1/6] =?UTF-8?q?=E6=8F=90=E4=BA=A4=E7=81=AB=E5=B1=B1websock?=
 =?UTF-8?q?et=5Fai=20api=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: moqiyi <85303405@qq.com>
---
 .../API_reference/zh/ailib/tiktokwebsocket.md | 148 ++++++++++++++++++
 1 file changed, 148 insertions(+)
 create mode 100644 docs/API_reference/zh/ailib/tiktokwebsocket.md

diff --git a/docs/API_reference/zh/ailib/tiktokwebsocket.md b/docs/API_reference/zh/ailib/tiktokwebsocket.md
new file mode 100644
index 00000000..8ab88774
--- /dev/null
+++ b/docs/API_reference/zh/ailib/tiktokwebsocket.md
@@ -0,0 +1,148 @@
+# 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 类型，表示需转换为语音的文本，例如：“当然！让我给您讲一个关于勇气的故事”。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-- 
Gitee


From b44af75edc2bbf2f4256ae9a04cebc2e8d6c031f Mon Sep 17 00:00:00 2001
From: moqiyi <85303405@qq.com>
Date: Mon, 17 Mar 2025 13:01:13 +0000
Subject: [PATCH 2/6] =?UTF-8?q?update=20docs/API=5Freference/zh/ailib/READ?=
 =?UTF-8?q?ME.md.=20=E6=9B=B4=E6=96=B0ai=E5=B9=B3=E5=8F=B0=E6=94=AF?=
 =?UTF-8?q?=E6=8C=81=E5=88=97=E8=A1=A8?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: moqiyi <85303405@qq.com>
---
 docs/API_reference/zh/ailib/README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/API_reference/zh/ailib/README.md b/docs/API_reference/zh/ailib/README.md
index af8bebb6..7380542b 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
-- 
Gitee


From 455fc77c9d0bbbdd730a93473b7903b5cfb36112 Mon Sep 17 00:00:00 2001
From: moqiyi <85303405@qq.com>
Date: Mon, 17 Mar 2025 13:02:07 +0000
Subject: [PATCH 3/6] =?UTF-8?q?Revert=20"=E6=8F=90=E4=BA=A4=E7=81=AB?=
 =?UTF-8?q?=E5=B1=B1websocket=5Fai=20api=E6=96=87=E6=A1=A3"?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This reverts commit e0024dd0ed6de3f2dd8a8e3b4151319281319ee9.
---
 .../API_reference/zh/ailib/tiktokwebsocket.md | 148 ------------------
 1 file changed, 148 deletions(-)
 delete mode 100644 docs/API_reference/zh/ailib/tiktokwebsocket.md

diff --git a/docs/API_reference/zh/ailib/tiktokwebsocket.md b/docs/API_reference/zh/ailib/tiktokwebsocket.md
deleted file mode 100644
index 8ab88774..00000000
--- a/docs/API_reference/zh/ailib/tiktokwebsocket.md
+++ /dev/null
@@ -1,148 +0,0 @@
-# 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 类型，表示需转换为语音的文本，例如：“当然！让我给您讲一个关于勇气的故事”。
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-- 
Gitee


From 385a2e848ddbeb2b0855db3c750df86bb2693354 Mon Sep 17 00:00:00 2001
From: moqiyi <85303405@qq.com>
Date: Mon, 17 Mar 2025 13:02:41 +0000
Subject: [PATCH 4/6] =?UTF-8?q?=E6=8F=90=E4=BA=A4=E7=81=AB=E5=B1=B1websock?=
 =?UTF-8?q?et=5Fai=20api=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: moqiyi <85303405@qq.com>
---
 .../API_reference/zh/ailib/TiktokWebsocket.md | 148 ++++++++++++++++++
 1 file changed, 148 insertions(+)
 create mode 100644 docs/API_reference/zh/ailib/TiktokWebsocket.md

diff --git a/docs/API_reference/zh/ailib/TiktokWebsocket.md b/docs/API_reference/zh/ailib/TiktokWebsocket.md
new file mode 100644
index 00000000..8ab88774
--- /dev/null
+++ b/docs/API_reference/zh/ailib/TiktokWebsocket.md
@@ -0,0 +1,148 @@
+# 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 类型，表示需转换为语音的文本，例如：“当然！让我给您讲一个关于勇气的故事”。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-- 
Gitee


From 1b2f8673bba9345d0c0c674d67561a0dc5267e90 Mon Sep 17 00:00:00 2001
From: moqiyi <85303405@qq.com>
Date: Mon, 17 Mar 2025 13:16:40 +0000
Subject: [PATCH 5/6] =?UTF-8?q?Revert=20"=E6=8F=90=E4=BA=A4=E7=81=AB?=
 =?UTF-8?q?=E5=B1=B1websocket=5Fai=20api=E6=96=87=E6=A1=A3"?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This reverts commit 385a2e848ddbeb2b0855db3c750df86bb2693354.
---
 .../API_reference/zh/ailib/TiktokWebsocket.md | 148 ------------------
 1 file changed, 148 deletions(-)
 delete mode 100644 docs/API_reference/zh/ailib/TiktokWebsocket.md

diff --git a/docs/API_reference/zh/ailib/TiktokWebsocket.md b/docs/API_reference/zh/ailib/TiktokWebsocket.md
deleted file mode 100644
index 8ab88774..00000000
--- a/docs/API_reference/zh/ailib/TiktokWebsocket.md
+++ /dev/null
@@ -1,148 +0,0 @@
-# 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 类型，表示需转换为语音的文本，例如：“当然！让我给您讲一个关于勇气的故事”。
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-- 
Gitee


From e507d7a5db4bc95428f27a08ab88e305d095bcf9 Mon Sep 17 00:00:00 2001
From: moqiyi <85303405@qq.com>
Date: Mon, 17 Mar 2025 13:17:03 +0000
Subject: [PATCH 6/6] =?UTF-8?q?=E6=8F=90=E4=BA=A4=E7=81=AB=E5=B1=B1websock?=
 =?UTF-8?q?et=5Fai=20api=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: moqiyi <85303405@qq.com>
---
 .../API_reference/zh/ailib/TiktokWebsocket.md | 131 ++++++++++++++++++
 1 file changed, 131 insertions(+)
 create mode 100644 docs/API_reference/zh/ailib/TiktokWebsocket.md

diff --git a/docs/API_reference/zh/ailib/TiktokWebsocket.md b/docs/API_reference/zh/ailib/TiktokWebsocket.md
new file mode 100644
index 00000000..74e8811a
--- /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 类型，表示需转换为语音的文本，例如：“当然！让我给您讲一个关于勇气的故事”。
-- 
Gitee