## **接口說明**
API V2.0是基于圖靈機器人平臺語義理解、深度學習等核心技術，為廣大開發者和企業提供的在線服務和開發接口。
目前API接口可調用聊天對話、語料庫、技能三大模塊的語料：
聊天對話是指平臺免費提供的近10億條公有對話語料，滿足用戶對話娛樂需求；
語料庫是指用戶在平臺上傳的私有語料，僅供個人查看使用，幫助用戶最便捷的搭建專業領域次的語料。
技能服務是指平臺打包的26種實用服務技能。涵蓋生活、出行、購物等多個領域，一站式滿足用戶需求。
## **使用說明**
#### ****編碼方式****
UTF-8（調用圖靈API的各個環節的編碼方式均為UTF-8）
#### ****接口地址****
http://openapi.turingapi.com/openapi/api/v2
#### ****請求方式****
HTTP POST
#### ****請求參數****
請求參數格式為 json
請求示例：
~~~
{
"reqType":0,
"perception": {
"inputText": {
"text": "附近的酒店"
},
"inputImage": {
"url": "imageUrl"
},
"selfInfo": {
"location": {
"city": "北京",
"province": "北京",
"street": "信息路"
}
}
},
"userInfo": {
"apiKey": "",
"userId": ""
}
}
~~~
>**參數說明**
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| reqType | ?int | N | ?- | 輸入類型:0-文本(默認)、1-圖片、2-音頻 |
| perception | ?- | Y | ?- | 輸入信息 |
| userInfo | ?- | Y | ?- | 用戶參數 |
**perception**
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| inputText | ?- | N | ?- | 文本信息 |
| inputImage | ?- | N | ?- | 圖片信息 |
| inputMedia | ?- | N | ?- | 音頻信息 |
| selfInfo | ?- | N| ?- | 客戶端屬性 |
注意：輸入參數必須包含inputText或inputImage或inputMedia！
***inputText***
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| text | String | Y | 1-128字符 | 直接輸入文本 |
***inputImage***
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| url | String | Y | | 圖片地址 |
***inputMedia***
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| url | String | Y | | 音頻地址 |
***selfInfo***
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| location | ?- | N | ?- | 地理位置信息 |
*****location*****
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| city | String | Y | ?- | 所在城市 |
| province | String | N | ?- | 省份 |
| street | String | N | ?- | 街道 |
**userInfo**
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| apiKey | String | Y | 32位 | 機器人標識 |
| userId | String | Y | 長度小于等于32位 | 用戶唯一標識? |
| groupId | String | N| 長度小于等于64位 | 群聊唯一標識? |
| userIdName | String | N | 長度小于等于64位 | 群內用戶昵稱 |
#### ****輸出參數****
輸出示例：
~~~
{
"intent": {
"code": 10005,
"intentName": "",
"actionName": "",
"parameters": {
"nearby_place": "酒店"
}
},
"results": [
{
"groupType": 1,
"resultType": "url",
"values": {
"url": "http://m.elong.com/hotel/0101/nlist/#indate=2016-12-10&outdate=2016-12-11&keywords=%E4%BF%A1%E6%81%AF%E8%B7%AF"
}
},
{
"groupType": 1,
"resultType": "text",
"values": {
"text": "親，已幫你找到相關酒店信息"
}
}
]
}
~~~
>****參數說明****
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| intent | - | Y | ?- | 請求意圖 |
| results | - | N | ?- | 輸出結果集 |
**intent**
| 參數 | 類型 | 是否包含 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| code | int | Y | ?- | 輸出功能code |ap
| intentName | String | N | ?- | 意圖名稱 |
| actionName | String | N | ?- | 意圖動作名稱 |
| parameters | Map | N | ?- | 功能相關參數 |
**results**
| 參數 | 類型 | 是否包含 | 取值范圍 | 說明 |
| --- | --- | --- | --- | --- |
| resultType | String | Y | ?文本(text);連接(url);音頻(voice);視頻(video);圖片(image);圖文(news)| 輸出類型 |
| values | ?- | Y | ?- | 輸出值 |
| groupType | ?int | Y | ?- | ‘組’編號:0為獨立輸出，大于0時可能包含同組相關內容 (如：音頻與文本為一組時說明內容一致)|
### ****異常返回碼****
###### 異常返回格式
~~~
{
'intent':
{
'code':5000
}
}
~~~
###### 異常返回說明
| 異常碼 | 說明 |
| --- | --- |
| 5000 | 無解析結果 |
| 6000 | 暫不支持該功能 |
| 4000 | 請求參數格式錯誤 |
| 4001 | 加密方式錯誤 |
| 4002 | 無功能權限 |
| 4003 | 該apikey沒有可用請求次數 |
| 4005 | 無功能權限 |
| 4007 | apikey不合法 |
| 4100 | userid獲取失敗 |
| 4200 | 上傳格式錯誤 |
| 4300 | 批量操作超過限制 |
| 4400 | 沒有上傳合法userid |
| 4500 | userid申請個數超過限制 |
| 4600 | 輸入內容為空 |
| 4602 | 輸入文本內容超長(上限150)|
| 7002 | 上傳信息失敗 |
| 8008 | 服務器錯誤 |
| 0 | 上傳成功 |
