From 651737380b2be42ae5182a777abb0938a36aedc1 Mon Sep 17 00:00:00 2001
From: jmwang66 <wangjiaming.wjm@alibaba-inc.com>
Date: 星期三, 09 八月 2023 16:48:02 +0800
Subject: [PATCH] Merge branch 'main' into dev_wjm_modelscope
---
funasr/runtime/docs/websocket_protocol_zh.md | 89 ++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 89 insertions(+), 0 deletions(-)
diff --git a/funasr/runtime/docs/websocket_protocol_zh.md b/funasr/runtime/docs/websocket_protocol_zh.md
new file mode 100644
index 0000000..b8e68a4
--- /dev/null
+++ b/funasr/runtime/docs/websocket_protocol_zh.md
@@ -0,0 +1,89 @@
+(绠�浣撲腑鏂噟[English](./websocket_protocol.md))
+# websocket/grpc閫氫俊鍗忚
+
+鏈崗璁负FunASR杞欢鍖呴�氫俊鍗忚锛屽垎涓虹绾挎枃浠惰浆鍐欙紙[閮ㄧ讲鏂囨。](./SDK_tutorial_zh.md)锛夛紝瀹炴椂璇煶璇嗗埆锛圼閮ㄧ讲鏂囨。](./SDK_tutorial_online_zh.md)锛�
+
+## 绂荤嚎鏂囦欢杞啓
+### 浠庡鎴风寰�鏈嶅姟绔彂閫佹暟鎹�
+#### 娑堟伅鏍煎紡
+閰嶇疆鍙傛暟涓巑eta淇℃伅鐢╦son锛岄煶棰戞暟鎹噰鐢╞ytes
+#### 棣栨閫氫俊
+message涓猴紙闇�瑕佺敤json搴忓垪鍖栵級锛�
+```text
+{"mode": "offline", "wav_name": "wav_name", "is_speaking": True,"wav_format":"pcm"}
+```
+鍙傛暟浠嬬粛锛�
+```text
+`mode`锛歚offline`锛岃〃绀烘帹鐞嗘ā寮忎负绂荤嚎鏂囦欢杞啓
+`wav_name`锛氳〃绀洪渶瑕佹帹鐞嗛煶棰戞枃浠跺悕
+`wav_format`锛氳〃绀洪煶瑙嗛鏂囦欢鍚庣紑鍚嶏紝鍙�塸cm銆乵p3銆乵p4绛�
+`is_speaking`锛欶alse 琛ㄧず鏂彞灏剧偣锛屼緥濡傦紝vad鍒囧壊鐐癸紝鎴栬�呬竴鏉av缁撴潫
+`audio_fs`锛氬綋杈撳叆闊抽涓簆cm鏁版嵁鏄紝闇�瑕佸姞涓婇煶棰戦噰鏍风巼鍙傛暟
+```
+
+#### 鍙戦�侀煶棰戞暟鎹�
+pcm鐩存帴灏嗛煶棰戞暟鎹紝鍏朵粬鏍煎紡闊抽鏁版嵁锛岃繛鍚屽ご閮ㄤ俊鎭笌闊宠棰慴ytes鏁版嵁鍙戦�侊紝鏀寔澶氱閲囨牱鐜囦笌闊宠棰戞牸寮�
+
+#### 鍙戦�侀煶棰戠粨鏉熸爣蹇�
+闊抽鏁版嵁鍙戦�佺粨鏉熷悗锛岄渶瑕佸彂閫佺粨鏉熸爣蹇楋紙闇�瑕佺敤json搴忓垪鍖栵級锛�
+```text
+{"is_speaking": False}
+```
+
+### 浠庢湇鍔＄寰�瀹㈡埛绔彂鏁版嵁
+#### 鍙戦�佽瘑鍒粨鏋�
+message涓猴紙閲囩敤json搴忓垪鍖栵級
+```text
+{"mode": "offline", "wav_name": "wav_name", "text": "asr ouputs", "is_final": True}
+```
+鍙傛暟浠嬬粛锛�
+```text
+`mode`锛歚offline`锛岃〃绀烘帹鐞嗘ā寮忎负绂荤嚎鏂囦欢杞啓
+`wav_name`锛氳〃绀洪渶瑕佹帹鐞嗛煶棰戞枃浠跺悕
+`text`锛氳〃绀鸿闊宠瘑鍒緭鍑烘枃鏈�
+`is_final`锛氳〃绀鸿瘑鍒粨鏉�
+```
+
+## 瀹炴椂璇煶璇嗗埆
+### 绯荤粺鏋舵瀯鍥�
+
+<div align="left"><img src="images/2pass.jpg" width="600"/></div>
+
+### 浠庡鎴风寰�鏈嶅姟绔彂閫佹暟鎹�
+#### 娑堟伅鏍煎紡
+閰嶇疆鍙傛暟涓巑eta淇℃伅鐢╦son锛岄煶棰戞暟鎹噰鐢╞ytes
+
+#### 棣栨閫氫俊
+message涓猴紙闇�瑕佺敤json搴忓垪鍖栵級锛�
+```text
+{"mode": "2pass", "wav_name": "wav_name", "is_speaking": True, "wav_format":"pcm", "chunk_size":[5,10,5]
+```
+鍙傛暟浠嬬粛锛�
+```text
+`mode`锛歚offline`锛岃〃绀烘帹鐞嗘ā寮忎负涓�鍙ヨ瘽璇嗗埆锛沗online`锛岃〃绀烘帹鐞嗘ā寮忎负瀹炴椂璇煶璇嗗埆锛沗2pass`锛氳〃绀轰负瀹炴椂璇煶璇嗗埆锛屽苟涓旇璇濆彞灏鹃噰鐢ㄧ绾挎ā鍨嬭繘琛岀籂閿欍��
+`wav_name`锛氳〃绀洪渶瑕佹帹鐞嗛煶棰戞枃浠跺悕
+`wav_format`锛氳〃绀洪煶瑙嗛鏂囦欢鍚庣紑鍚嶏紝鍙�塸cm銆乵p3銆乵p4绛夛紙澶囨敞锛�1.0鐗堟湰鍙敮鎸乸cm闊抽娴侊級
+`is_speaking`锛氳〃绀烘柇鍙ュ熬鐐癸紝渚嬪锛寁ad鍒囧壊鐐癸紝鎴栬�呬竴鏉av缁撴潫
+`chunk_size`锛氳〃绀烘祦寮忔ā鍨媗atency閰嶇疆锛宍[5,10,5]`锛岃〃绀哄綋鍓嶉煶棰戜负600ms锛屽苟涓斿洖鐪�300ms锛屽張鐪�300ms銆�
+`audio_fs`锛氬綋杈撳叆闊抽涓簆cm鏁版嵁鏄紝闇�瑕佸姞涓婇煶棰戦噰鏍风巼鍙傛暟
+```
+#### 鍙戦�侀煶棰戞暟鎹�
+鐩存帴灏嗛煶棰戞暟鎹紝绉婚櫎澶撮儴淇℃伅鍚庣殑bytes鏁版嵁鍙戦�侊紝鏀寔闊抽閲囨牱鐜囦负8000锛坄message`涓渶瑕佹寚瀹歚audio_fs`涓�8000锛夛紝16000
+#### 鍙戦�佺粨鏉熸爣蹇�
+闊抽鏁版嵁鍙戦�佺粨鏉熷悗锛岄渶瑕佸彂閫佺粨鏉熸爣蹇楋紙闇�瑕佺敤json搴忓垪鍖栵級锛�
+```text
+{"is_speaking": False}
+```
+### 浠庢湇鍔＄寰�瀹㈡埛绔彂鏁版嵁
+#### 鍙戦�佽瘑鍒粨鏋�
+message涓猴紙閲囩敤json搴忓垪鍖栵級
+```text
+{"mode": "2pass-online", "wav_name": "wav_name", "text": "asr ouputs", "is_final": True}
+```
+鍙傛暟浠嬬粛锛�
+```text
+`mode`锛氳〃绀烘帹鐞嗘ā寮忥紝鍒嗕负`2pass-online`锛岃〃绀哄疄鏃惰瘑鍒粨鏋滐紱`2pass-offline`锛岃〃绀�2閬嶄慨姝ｈ瘑鍒粨鏋�
+`wav_name`锛氳〃绀洪渶瑕佹帹鐞嗛煶棰戞枃浠跺悕
+`text`锛氳〃绀鸿闊宠瘑鍒緭鍑烘枃鏈�
+`is_final`锛氳〃绀鸿瘑鍒粨鏉�
+```
\ No newline at end of file
--
Gitblit v1.9.1