From b9bcf1f093c3053fdc4e2cf4a1d38e27bbf429fb Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 19 十月 2023 14:03:48 +0800
Subject: [PATCH] docs
---
funasr/runtime/docs/websocket_protocol_zh.md | 23 ++++++++++++++++-------
1 files changed, 16 insertions(+), 7 deletions(-)
diff --git a/funasr/runtime/docs/websocket_protocol_zh.md b/funasr/runtime/docs/websocket_protocol_zh.md
index 38ab3c4..8d5888e 100644
--- a/funasr/runtime/docs/websocket_protocol_zh.md
+++ b/funasr/runtime/docs/websocket_protocol_zh.md
@@ -1,5 +1,8 @@
(绠�浣撲腑鏂噟[English](./websocket_protocol.md))
# websocket/grpc閫氫俊鍗忚
+
+鏈崗璁负FunASR杞欢鍖呴�氫俊鍗忚锛屽垎涓虹绾挎枃浠惰浆鍐欙紙[閮ㄧ讲鏂囨。](./SDK_tutorial_zh.md)锛夛紝瀹炴椂璇煶璇嗗埆锛圼閮ㄧ讲鏂囨。](./SDK_tutorial_online_zh.md)锛�
+
## 绂荤嚎鏂囦欢杞啓
### 浠庡鎴风寰�鏈嶅姟绔彂閫佹暟鎹�
#### 娑堟伅鏍煎紡
@@ -7,7 +10,7 @@
#### 棣栨閫氫俊
message涓猴紙闇�瑕佺敤json搴忓垪鍖栵級锛�
```text
-{"mode": "offline", "wav_name": "wav_name", "is_speaking": True,"wav_format":"pcm"}
+{"mode": "offline", "wav_name": "wav_name","wav_format":"pcm","is_speaking": True,"hotwords":"闃块噷宸村反 杈炬懇闄� 闃块噷浜�","itn":True}
```
鍙傛暟浠嬬粛锛�
```text
@@ -15,7 +18,9 @@
`wav_name`锛氳〃绀洪渶瑕佹帹鐞嗛煶棰戞枃浠跺悕
`wav_format`锛氳〃绀洪煶瑙嗛鏂囦欢鍚庣紑鍚嶏紝鍙�塸cm銆乵p3銆乵p4绛�
`is_speaking`锛欶alse 琛ㄧず鏂彞灏剧偣锛屼緥濡傦紝vad鍒囧壊鐐癸紝鎴栬�呬竴鏉av缁撴潫
-`audio_fs`锛氬綋杈撳叆闊抽涓簆cm鏁版嵁鏄紝闇�瑕佸姞涓婇煶棰戦噰鏍风巼鍙傛暟
+`audio_fs`锛氬綋杈撳叆闊抽涓簆cm鏁版嵁鏃讹紝闇�瑕佸姞涓婇煶棰戦噰鏍风巼鍙傛暟
+`hotwords`锛氬鏋淎M涓虹儹璇嶆ā鍨嬶紝闇�瑕佸悜鏈嶅姟绔彂閫佺儹璇嶆暟鎹紝鏍煎紡涓哄瓧绗︿覆锛岀儹璇嶄箣闂寸敤" "鍒嗛殧锛屼緥濡� "闃块噷宸村反 杈炬懇闄� 闃块噷浜�"
+`itn`: 璁剧疆鏄惁浣跨敤itn锛岄粯璁rue
```
#### 鍙戦�侀煶棰戞暟鎹�
@@ -31,7 +36,7 @@
#### 鍙戦�佽瘑鍒粨鏋�
message涓猴紙閲囩敤json搴忓垪鍖栵級
```text
-{"mode": "offline", "wav_name": "wav_name", "text": "asr ouputs", "is_final": True}
+{"mode": "offline", "wav_name": "wav_name", "text": "asr ouputs", "is_final": True,"timestamp":"[[100,200], [200,500]]"}
```
鍙傛暟浠嬬粛锛�
```text
@@ -39,12 +44,13 @@
`wav_name`锛氳〃绀洪渶瑕佹帹鐞嗛煶棰戞枃浠跺悕
`text`锛氳〃绀鸿闊宠瘑鍒緭鍑烘枃鏈�
`is_final`锛氳〃绀鸿瘑鍒粨鏉�
+`timestamp`锛氬鏋淎M涓烘椂闂存埑妯″瀷锛屼細杩斿洖姝ゅ瓧娈碉紝琛ㄧず鏃堕棿鎴筹紝鏍煎紡涓� "[[100,200], [200,500]]"(ms)
```
## 瀹炴椂璇煶璇嗗埆
### 绯荤粺鏋舵瀯鍥�
-<div align="left"><img src="images/2pass.jpg" width="400"/></div>
+<div align="left"><img src="images/2pass.jpg" width="600"/></div>
### 浠庡鎴风寰�鏈嶅姟绔彂閫佹暟鎹�
#### 娑堟伅鏍煎紡
@@ -53,7 +59,7 @@
#### 棣栨閫氫俊
message涓猴紙闇�瑕佺敤json搴忓垪鍖栵級锛�
```text
-{"mode": "2pass", "wav_name": "wav_name", "is_speaking": True, "wav_format":"pcm", "chunk_size":[5,10,5]
+{"mode": "2pass", "wav_name": "wav_name", "is_speaking": True, "wav_format":"pcm", "chunk_size":[5,10,5], "hotwords":"闃块噷宸村反 杈炬懇闄� 闃块噷浜�","itn":True}
```
鍙傛暟浠嬬粛锛�
```text
@@ -63,6 +69,8 @@
`is_speaking`锛氳〃绀烘柇鍙ュ熬鐐癸紝渚嬪锛寁ad鍒囧壊鐐癸紝鎴栬�呬竴鏉av缁撴潫
`chunk_size`锛氳〃绀烘祦寮忔ā鍨媗atency閰嶇疆锛宍[5,10,5]`锛岃〃绀哄綋鍓嶉煶棰戜负600ms锛屽苟涓斿洖鐪�300ms锛屽張鐪�300ms銆�
`audio_fs`锛氬綋杈撳叆闊抽涓簆cm鏁版嵁鏄紝闇�瑕佸姞涓婇煶棰戦噰鏍风巼鍙傛暟
+`hotwords`锛氬鏋淎M涓虹儹璇嶆ā鍨嬶紝闇�瑕佸悜鏈嶅姟绔彂閫佺儹璇嶆暟鎹紝鏍煎紡涓哄瓧绗︿覆锛岀儹璇嶄箣闂寸敤" "鍒嗛殧锛屼緥濡� "闃块噷宸村反 杈炬懇闄� 闃块噷浜�"
+`itn`: 璁剧疆鏄惁浣跨敤itn锛岄粯璁rue
```
#### 鍙戦�侀煶棰戞暟鎹�
鐩存帴灏嗛煶棰戞暟鎹紝绉婚櫎澶撮儴淇℃伅鍚庣殑bytes鏁版嵁鍙戦�侊紝鏀寔闊抽閲囨牱鐜囦负8000锛坄message`涓渶瑕佹寚瀹歚audio_fs`涓�8000锛夛紝16000
@@ -75,7 +83,7 @@
#### 鍙戦�佽瘑鍒粨鏋�
message涓猴紙閲囩敤json搴忓垪鍖栵級
```text
-{"mode": "2pass-online", "wav_name": "wav_name", "text": "asr ouputs", "is_final": True}
+{"mode": "2pass-online", "wav_name": "wav_name", "text": "asr ouputs", "is_final": True, "timestamp":"[[100,200], [200,500]]"}
```
鍙傛暟浠嬬粛锛�
```text
@@ -83,4 +91,5 @@
`wav_name`锛氳〃绀洪渶瑕佹帹鐞嗛煶棰戞枃浠跺悕
`text`锛氳〃绀鸿闊宠瘑鍒緭鍑烘枃鏈�
`is_final`锛氳〃绀鸿瘑鍒粨鏉�
-```
\ No newline at end of file
+`timestamp`锛氬鏋淎M涓烘椂闂存埑妯″瀷锛屼細杩斿洖姝ゅ瓧娈碉紝琛ㄧず鏃堕棿鎴筹紝鏍煎紡涓� "[[100,200], [200,500]]"(ms)
+```
--
Gitblit v1.9.1