[TOC]
## 語音識別結果說明
|JSON字段 |英文全稱 |類型 | 說明 |
| :---: | :---: | :---: | :---: |
|sn |sentence |int | 第幾句 |
|ls | last sentence |boolean | 是否最后一句 |
| bg |begin |int | 開始 |
| ed | end | int | 結束 |
| ws |words | array | 詞 |
| cw | chinese word | array |中文分詞 |
| w | word | string |單字 |
| sc | score |int |分數 |
語音聽寫結果示例：
~~~
{
"sn": 1,
"ls": true,
"bg": 0,
"ed": 0,
"ws": [
{
"bg": 0,
"cw": [
{
"w": " 今天 ",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": " 的",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": " 天氣 ",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": " 怎么樣 ",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": " 。",
"sc": 0
}
]
}
]
}
~~~
多候選結果示例：
~~~
{
"sn": 1,
"ls": false,
"bg": 0,
"ed": 0,
"ws": [
{
"bg": 0,
"cw": [
{
"w": "我想聽",
"sc": 0
}
]
},
{
"bg": 0,
"cw": [
{
"w": "拉德斯基進行曲",
"sc": 0
},
{
"w": "拉得斯進行曲",
"sc": 0
}
]
}
]
}
~~~
語法識別結果示例：
~~~
{
"sn": 1,
"ls": true,
"bg": 0,
"ed": 0,
"ws": [
{
"bg": 0,
"cw": [
{
"sc": "70",
"gm": "0",
"w": "北京到上海"
},
{
"sc": "69",
"gm": "0",
"w": "天京到上海"
},
{
"sc": "58",
"gm": "0",
"w": "東京到上海"
}
]
}
]
}
~~~
## 聲紋業務
文本密碼JSON示例：
~~~
{
"txt_pwd": [
"我的地盤我做主",
"移動改變生活",
"芝麻開門"
]
}
~~~
數字密碼JSON示例：
~~~
{
"num_pwd": [
"03285469",
"09734658",
"53894276",
"57392804",
"68294073"
]
}
~~~
聲紋業務結果（VerifierResult）成員說明：
| 成員 |說明 |
| :---: | --- |
| sst |業務類型，取值為train或verify |
| ret |返回值，0為成功，-1為失敗 |
| vid |注冊成功的聲紋模型id |
| score | 當前聲紋相似度 |
|suc | 本次注冊已成功的訓練次數 |
|rgn |本次注冊需要的訓練次數 |
| trs | 注冊完成描述信息 |
|err |注冊/驗證返回的錯誤碼 |
| dcs | 描述信息 |
## 人臉識別結果說明
|JSON字段 |類型 | 說明 |
| :---: | :---: | --- |
|sst| string |指定本路會話是屬于何種性質|
|rst |bool| 結果|
|sid |string| 會話id|
|ret |int |錯誤碼|
|uid |string |用戶id|
|score| float| 打分|
|pose |dictionary |面部朝向|
|confidence |float| 置信度|
|position| dictionary |面部的矩形區域|
|landmark| dictionary| 關鍵點數組|
人臉檢測時響應結果返回json格式串：
~~~
{
"face": [
{
"attribute": {
"pose": {
"pitch": 1
}
},
"confidence": "10.412",
"position": {
"bottom": 447,
"left": 140,
"right": 419,
"top": 168
},
"tag": ""
}
],
"ret": "0",
"rst": "success",
"sid": "wfr278422e9@ch47fc0817c22e477000",
"sst": "detect",
"uid": "a1644276827"
}
~~~
關鍵點檢測時響應結果返回json格式串：
~~~
{
"result": [
{
"landmark": {
"left_eye_center": {
"x": "209.739",
"y": "229.428"
},
"left_eye_left_corner": {
"x": "177.219",
"y": "230.914"
},
"left_eye_right_corner": {
"x": "235.839",
"y": "236.793"
},
"left_eyebrow_left_corner": {
"x": "155.253",
"y": "187.392"
},
"left_eyebrow_middle": {
"x": "199.240",
"y": "182.701"
},
"left_eyebrow_right_corner": {
"x": "246.582",
"y": "192.358"
},
"mouth_left_corner": {
"x": "204.203",
"y": "386.777"
},
"mouth_lower_lip_bottom": {
"x": "262.768",
"y": "416.832"
},
"mouth_middle": {
"x": "263.705",
"y": "390.507"
},
"mouth_right_corner": {
"x": "317.841",
"y": "390.864"
},
"mouth_upper_lip_top": {
"x": "264.736",
"y": "367.996"
},
"nose_bottom": {
"x": "267.811",
"y": "339.358"
},
"nose_left": {
"x": "225.449",
"y": "319.586"
},
"nose_right": {
"x": "308.086",
"y": "323.936"
},
"nose_top": {
"x": "271.755",
"y": "310.934"
},
"right_eye_center": {
"x": "335.608",
"y": "234.335"
},
"right_eye_left_corner": {
"x": "306.995",
"y": "238.703"
},
"right_eye_right_corner": {
"x": "364.231",
"y": "240.307"
},
"right_eyebrow_left_corner": {
"x": "300.652",
"y": "194.243"
},
"right_eyebrow_middle": {
"x": "347.711",
"y": "188.787"
},
"right_eyebrow_right_corner": {
"x": "391.572",
"y": "197.455"
}
}
}
],
"ret": "0",
"rst": "success",
"sid": "wfr278522e9@ch47fc0817c255477600",
"sst": "align",
"uid": "a1644276827"
}
~~~
## 身份驗證結果說明
### 人臉注冊字段
|JSON字段| 類型| 說明|
| :---: | :---: | --- |
|ssub| String| 業務類型，人臉業務為ifr（人臉驗證）|
|sst |String |子業務類型，注冊業務為enroll|
|ret |int |返回值，0為請求成功，其他為請求失敗|
|suc |int| 本次注冊已成功的訓練次數|
|rgn |int| 本次注冊需要的訓練次數|
|fid |String |人臉模型id (當前無需關注)|
人臉注冊結果示例：
~~~
{
"ret": 0,
"suc": 1,
"rgn": 1,
"sst": "enroll",
"ssub": "ifr",
"fid": "90f821fa7381ee297a80ed9570dea635"
}
~~~
### 聲紋注冊字段
|JSON字段 |類型 |說明|
|:---:|:---:|---|
|ssub |String| 業務類型，聲紋業務為ivp |
|sst |String |子業務類型，注冊業務為enroll|
|ret |int |返回值，0為請求成功，其他為請求失敗|
|rgn| int |本次注冊需要的訓練次數|
|suc| int |本次注冊已成功的訓練次數|
|vid| String |聲紋模型id (當前無需關注)|
聲紋注冊結果示例：
~~~
{
"vid": "16eb6a9f24c96405647347f8458e4cea",
"suc": 5,
"rgn": 5,
"sst": "enroll",
"ssub": "ivp",
"ret": 0
}
~~~
### 人臉、聲紋和融合驗證字段
|JSON字段| 類型| 說明|
|:---:|:---:|---|
|ssub |String| 業務類型，取值：<br>ivp：聲紋驗證；<br>ifr：人臉驗證； <br>ivp \| ifr：融合驗證；|
|sst |String| 子業務類型，驗證業務為verify|
|ret |int |返回值，0為請求成功，其他為請求失敗|
|decision |String |accepted：驗證成功，rejected：驗證失敗|
|fusion _score |double| 相似度得分，僅驗證業務返回|
|face _score |double |人臉驗證得分，僅驗證業務返回|
|voice _score| double |聲紋驗證得分，僅驗證業務返回|
驗證結果示例：
~~~
{
"ret": 0,
"face_score": 99.732,
"voice_score": 86.874,
"ssub": "ivp|ifr",
"decision": "accepted",
"fusion_score": 99.823,
"sst": "verify"
}
~~~
### 人臉、聲紋鑒別字段
|JSON字段 |類型| 說明|
|:---:|:---:|---|
|sst| String| 業務類型，鑒別業務為identify|
|ssub |String |子業務類型，取值：<br>ivp：聲紋；<br>ifr：人臉；|
|ret |int |返回值，0為請求成功，其他為請求失敗|
|group_id| String| 本次鑒別的成員組id|
|group_name |String |本次鑒別的成員組id對應的組名稱|
|topc |int |本次鑒別返回的結果數|
|model_id |String| 模型id|
|decision |String |accepted：匹配成功，rejected：匹配失敗|
|score |double |匹配相似度|
|user_name| String |該模型對應用戶名|
鑒別結果示例：
~~~
{
"ret": 0,
"group_id": "xxxxxx",
"group_name": "xxxxxx",
"ifv_result": {
"candidates": [
{
"model_id": "xxxxxxxx",
"decision": "accepted",
"score": 88.888888,
"user": "user_name"
}
]
},
"sst": "identify",
"ssub": "ivp",
"topc": 1
}
~~~
### 查詢/刪除模型字段
|JSON字段| 類型| 說明|
|:---:|:---:|---|
|ssub |String| 業務類型，取值：<br>ivp：聲紋業務；<br>ifr：人臉業務（暫無查詢業務）；|
|ret |int |返回值，0為請求成功，其他為請求失敗|
|sst |String |子業務類型，取值：<br>query：查詢模型；<br>delete：刪除模型；|
查詢結果示例 ：
~~~
{
"ssub": "ivp",
"sst": "query",
"ret": 0
}
~~~
刪除結果示例：
~~~
{
"ssub": "ivp",
"sst": "delete",
"ret": 0
}
~~~
### 組管理字段
|JSON字段| 類型| 說明|
|:---:|:---:|---|
|ssub |String |ipt：組管理|
|ret| int| 返回值，0為請求成功，其他為請求失敗|
|group_name |String| 組名稱|
|group_id |String |組id|
|person |array |組內成員集|
|user |String |用戶名|
創建組結果示例：
~~~
{
"ssub": "ipt",
"group_name": " xxxxxxxx ",
"sst": "add",
"ret": 0,
"group_id": "xxxxxxxx"
}
~~~
刪除組結果示例：
~~~
{
"ssub": "ipt",
"group_name": " xxxxxxxx ",
"sst": "delete",
"ret": 0,
"group_id": " xxxxxxxx "
}
~~~
查詢組中人員結果示例：
~~~
{
"ssub": "ipt",
"person": [
{
"user": " xxxxxxxx "
}
],
"group_name": " xxxxxxxx ",
"sst": "query",
"ret": 0,
"group_id": " xxxxxxxx "
}
~~~
用戶加入組結果示例：
~~~
{
"ssub": "ipt",
"group_name": " xxxxxxxx ",
"ret": 0,
"sst": "add",
"user": " xxxxxxxx ",
"group_id": " xxxxxxxx "
}
~~~
用戶退出組結果示例：
~~~
{
"ssub": "ipt",
"group_name": " xxxxxxxx ",
"ret": 0,
"sst": "delete",
"user": " xxxxxxxx ",
"group_id": " xxxxxxxx "
}
~~~
## 合成發音人列表
1、 語言為中英文的發音人可以支持中英文的混合朗讀。
2、 英文發音人只能朗讀英文，中文無法朗讀。
3、 漢語發音人只能朗讀中文，遇到英文會以單個字母的方式進行朗讀。
4、 使用**新引擎參數**會獲得更好的合成效果。
|名稱|屬性|語言|參數名稱|新引擎參數|備注|
|:---:|:---:|:---:|:---:|:---:|:---:|
|小燕|青年<br>女聲|中英文<br>（普通話）|xiaoyan| |默認|
|小宇|青年<br>男聲|中英文<br>（普通話）|xiaoyu| | |
|凱瑟琳|青年<br>女聲|英文|catherine| | |
|亨利|青年<br>男聲|英文|henry| | |
|瑪麗|青年<br>女聲|英文|vimary| | |
|小研|青年<br>女聲|中英文<br>（普通話）|vixy| | |
|小琪|青年<br>女聲|中英文<br>（普通話）|vixq|xiaoqi| |
|小峰|青年<br>男聲|中英文<br>（普通話）|vixf| | |
|小梅|青年<br>女聲|中英文<br>（粵語）|vixm|xiaomei| |
|小莉|青年<br>女聲|中英文<br>（臺灣普通話）|vixl|xiaolin| |
|小蓉|青年<br>女聲|漢語<br>（四川話）|vixr|xiaorong| |
|小蕓|青年<br>女聲|漢語<br>（東北話）|vixyun|xiaoqian| |
|小坤|青年<br>男聲|漢語<br>（河南話）|vixk|xiaokun| |
|小強|青年<br>男聲|漢語<br>（湖南話）|vixqa|xiaoqiang| |
|小瑩|青年<br>女聲|漢語<br>（陜西話）|vixying| | |
|小新|童年<br>男聲|漢語<br>（普通話）|vixx|xiaoxin| |
|楠楠|童年<br>女聲|漢語<br>（普通話）|vinn|nannan| |
|老孫|老年<br>男聲|漢語<br>（普通話）|vils| | |
|Mariane| |法語|Mariane| | |
|Allabent| |俄語|Allabent| | |
|Gabriela| |西班牙語|Gabriela| | |
|Abha| |印地語|Abha| | |
|XiaoYun| |越南語|XiaoYun| | |
## 錯誤碼列表
10000~19999的錯誤碼參見[MSC錯誤碼](http://www.xfyun.cn/index.php/default/doccenter/doccenterInner?itemTitle=ZmFx&anchor=Y29udGl0bGU2Ng==)。
其它錯誤碼參見下表：
|錯誤碼|數值|含義|
|:---:|:---:|:---:|
|ERROR_NO_NETWORK|20001|無有效的網絡連接|
|ERROR_NETWORK_TIMEOUT|20002|網絡連接超時|
|ERROR_NET_EXPECTION|20003|網絡連接發生異常|
|ERROR_INVALID_RESULT|20004|無有效的結果|
|ERROR_NO_MATCH|20005|無匹配結果|
|ERROR_AUDIO_RECORD|20006|錄音失敗|
|ERROR_NO_SPPECH|20007|未檢測到語音|
|ERROR_SPEECH_TIMEOUT|20008|音頻輸入超時|
|ERROR_EMPTY_UTTERANCE|20009|無效的文本輸入|
|ERROR_FILE_ACCESS|20010|文件讀寫失敗|
|ERROR_PLAY_MEDIA|20011|音頻播放失敗|
|ERROR_INVALID_PARAM|20012|無效的參數|
|ERROR_TEXT_OVERFLOW|20013|文本溢出|
|ERROR_INVALID_DATA|20014|無效數據|
|ERROR_LOGIN|20015|用戶未登錄|
|ERROR_PERMISSION_DENIED|20016|無效授權|
|ERROR_INTERRUPT|20017|被異常打斷|
|ERROR_VERSION_LOWER|20018|版本過低|
## 集成幫助文檔
打開終端（termainl或iterm），cd 到壓縮包的doc 目錄，執行以下命令：
~~~
cp -R -f -a com.iflytek.IFlyMSC.docset ~/Library/Developer/Shared/Documentation/DocSets/
~~~
然后執行命令：
~~~
open ~/Library/Developer/Shared/Documentation/DocSets/
~~~
**注意**：*不同的Xcode版本，對應的docset路徑可能有變化，需要根據實際路徑來操作。（例如：/Applications/Xcode.app/Contents/Developer/Documentation/DocSets/）*
請核對文檔的版本為最新下載的版本：
打開Xcode的幫助文檔就可以看到已經集成的文檔：
