### 3.2.13 國學大會
#### (1)功能說明
國學大會目前主要包括兩本典籍內容,分別是弟子規、三字經。該技能主要是通過學與練相結合的方式,強化對學習內容的認知和記憶,逐步達到學會、掌握的目的。
#### (2)接口說明
**請求方法**
* POST
**請求地址**
* http://api.ruyi.ai/v1/message
**請求參數說明**
|參數名 |參數類型 | 是否必須 |參數說明
| :-----| :---| :---:|:-----
|q |String| 是| 自然語言表達,例如“國學大會”等
|app_key| String|是 |應用開發者秘鑰,注冊開發者后臺賬號,建立虛擬助理后獲得
|user_id |String| 是 |用戶唯一標識,便于支持個性化語義解析。建議開發者使用 UUID 字符,且不同用戶必須用不同的 user_id,防止意圖串。
#### (3)返回說明
**返回參數說明**
|名稱 |類型| 說明
|:---|:---|:---
|code |Integer | 返回代碼
|msg | String |返回代碼描述
|parameters|JSON Object |解析到的實體以及服務說明
|action|String|服務的接口名稱
|name| String|匹配的意圖名稱
|result | JSON Object| 接口返回內容
|outputs| Array| 服務輸出結果,微信端使用 type 類型為 wechat 開頭的內容;硬件端收到所有內容,依據需求解析使用
**返回代碼說明**
|返回代碼 |錯誤類型|說明
|:---|:---|:---
|0/200 |成功 |請求成功
|400 |無效請求 |某些必需參數缺失或參數值錯誤,詳見msg字段
|401 |未授權 |授權失敗,app_key缺失或錯誤
|403 |請求被禁止|有效請求,但服務拒絕響應,請聯系contact@ruyi.ai
|408 |請求超時 |請求響應超時,一般響應時間設置為2000ms以內
|429 |短時間內大量訪問 |短時間內請求數過多
|500 |內部錯誤 |服務處理異常
|503 |服務不可用|服務異常或正在維護
#### (4)請求示例
**請求范例**
打開國學大會
游戲規則
弟子規
從頭開始
弟子規圣人訓首孝悌次謹信(正確跟讀)
鞏固練習
第一項(回答錯誤)
退出
**請求示例正確**
http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=從頭開始
(那個頭開始)
返回結果
```json
{"code": 0,
"msg": "ok",
"result"{
"_text": "從頭開始",
"msg_id": "d1eb1bbd-c317-4242-b70e-31dfa36751ad",
"intents": [
{
"parameters": {
"startFromBegining": "false",
"chapterNumber": "1"
},
"action": "開始接口",
"name": "【適配js】開始游戲(弟子規內容總敘)",
"result": {
"finish": false,
"content": {
"words": [
"弟子規",
"圣人訓",
"首孝悌",
"次謹信"
],
"explain": "弟子規,是圣人的教誨。首先要孝敬父母、友愛兄弟姊妹,其次要謹言慎行、講求信用。",
"picUrl": "http://on9d0c18z.bkt.clouddn.com/第一章1.jpg",
"audioUrl": "http://ruyi-xiaodu.bj.bcebos.com/dizigui/弟子規1.wav"
}
"text": "{\"type\":\"baidu.display.directive\",\"payload\":{\"type\":\"Display.RenderTemplate\",\"template\":{\"type\":\"BodyTemplate5\",\"token\":\"com.haizhi.baidu.dizigui.diyizhangzongxu\",\"backgroundImage\":{\"url\":\"http://on9d0c18z.bkt.clouddn.com/第一章1.jpg\",\"widthPixels\":1280,\"heightPixels\":720},\"images\":[{\"url\":\"http://on9d0c18z.bkt.clouddn.com/第一章1.jpg\",\"widthPixels\":450,\"heightPixels\":600}],\"title\":\"\"},\"hint\":{\"type\":\"Hint\",\"hints\":[{\"type\":\"PlainText\",\"text\":\"\"},{\"type\":\"PlainText\",\"text\":\"\"}]},\"text\":\"<speak> <audio src=\\\"http://ruyi-xiaodu.bj.bcebos.com/dizigui/弟子規1.wav\\\"></audio> </speak>\"}}",
"type": "dialog"
},
"outputs": [
{
"type": "wechat.text",
"property": {
"text": "{\"type\":\"baidu.display.directive\",\"payload\":{\"type\":\"Display.RenderTemplate\",\"template\":{\"type\":\"BodyTemplate5\",\"token\":\"com.haizhi.baidu.dizigui.diyizhangzongxu\",\"backgroundImage\":{\"url\":\"http://on9d0c18z.bkt.clouddn.com/第一章1.jpg\",\"widthPixels\":1280,\"heightPixels\":720},\"images\":[{\"url\":\"http://on9d0c18z.bkt.clouddn.com/第一章1.jpg\",\"widthPixels\":450,\"heightPixels\":600}],\"title\":\"\"},\"hint\":{\"type\":\"Hint\",\"hints\":[{\"type\":\"PlainText\",\"text\":\"\"},{\"type\":\"PlainText\",\"text\":\"\"}]},\"text\":\"<speak> <audio src=\\\"http://ruyi-xiaodu.bj.bcebos.com/dizigui/弟子規1.wav\\\"></audio> </speak>\"}}"
}
},
{
"type": "dialog",
"property": {
"text": "請跟我讀http://ruyi-xiaodu.bj.bcebos.com/dizigui/弟子規1.wav",
"emotion": "calm"
}
},
"score": "1.0",
"scoreColor": "c4",
"is_match": 1,
"skill_id": "4107891e-63da-47f5-86e9-3f8db56d9c96",
"id": "111a056e-0eeb-4f2a-ba06-4cd5075005b9"
}
],
"meta_process_milliseconds": 281
}
```
**請求示例正確**
http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=弟子規圣人訓首孝悌次謹信
(正確跟讀)
返回結果
```json
{"code": 0,
"msg": "ok",
"result"{
"_text": "弟子規圣人訓首孝悌次謹信",
"msg_id": "7535af4e-f266-4234-afa0-3b47503dd07d",
"intents": [
{
"parameters": {
"any": "弟子規圣人訓首孝悌次謹信"
},
"action": "下一句接口",
"name": "【適配js】跟讀弟子規(弟子規內容)",
"result": {
"sectionEnd": false,
"finish": false,
"content": {
"words": [
"泛愛眾",
"而親仁",
"有余力",
"則學文"
],
"explain": "博愛大眾,親近有仁德的人。 有多余的時間和精力,學習有益的學問。",
"picUrl": "http://on9d0c18z.bkt.clouddn.com/第一章2.jpg",
"audioUrl": "http://ruyi-xiaodu.bj.bcebos.com/dizigui/弟子規2.wav"
}
"text": "請跟我讀http://ruyi-xiaodu.bj.bcebos.com/dizigui/弟子規2.wav",
"type": "dialog"
},
"outputs": [
{
"type": "dialog",
"property": {
"text": "請跟我讀http://ruyi-xiaodu.bj.bcebos.com/dizigui/弟子規2.wav",
"emotion": "calm"
}
},
"score": "1.0",
"scoreColor": "c4",
"is_match": 1,
"skill_id": "4107891e-63da-47f5-86e9-3f8db56d9c96",
"id": "f520db85-e4d1-4f56-9c55-d45bf76bac34"
}
],
"meta_process_milliseconds": 146
}
```
**請求示例正確**
http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=第一項
(鞏固練習錯誤回答)
返回結果
```json
{"code": 0,
"msg": "ok",
"result"{
"_text": "第一項",
"msg_id": "b23e9415-9438-4168-9437-1eb6f54bcd27",
"intents": [
{
"parameters": {
"choiceAnswer": "選項一"
},
"action": "回答接口",
"name": "【適配js】回答題目(弟子規題目)",
"result": {
"correctAnswer": "選項二",
"isCorrect": false,
"lastQuestion": false,
"questionAndAnswer": {
"question": "短句“圣人訓”中“訓”的意思是?",
"choices": [
"選項1:訓練",
"選項2:教導、教誨",
"選項3:解釋"
],
"answer": "選項二"
},
"questionType": "XUANZETI"
"type": "undefined"
},
"outputs": [
{
"type": "dialog",
"property": {
"text": "很遺憾,回答錯誤。正確答案是選項二。請聽下一題:短句“圣人訓”中“訓”的意思是?選項1:訓練。選項2:教導、教誨。選項3:解釋",
"emotion": "calm"
}
},
"score": "1.0",
"scoreColor": "c4",
"is_match": 1,
"skill_id": "4107891e-63da-47f5-86e9-3f8db56d9c96",
"id": "58e2d728-0deb-4499-b0f0-b36afa45c8a0"
}
],
"meta_process_milliseconds": 311
}
```
**請求示例退出**
http://api.ruyi.ai/ruyi-api/v1/message?app_key=APP_KEY&user_id=user0&q=退出
(退出游戲)
返回結果
```json
{"code": 0,
"msg": "ok",
"result"{
"_text": "退出",
"msg_id": "01f2bf62-ac76-491b-9974-c1754ec709a8",
"intents": [
{
"parameters": {
"退出": "結束"
},
"action": "退出接口",
"name": "【適配js】退出",
"result": {
"title": "第一章:總敘",
"sentence": [
"泛愛眾",
"而親仁",
"有余力",
"則學文"
]
}
},
"text": "好的,已為您退出。您已學習到第一章:總敘。泛愛眾,而親仁,有余力,則學文",
"type": "dialog"
},
"outputs": [
{
"type": "dialog",
"property": {
"text": "好的,已為您退出。您已學習到第一章:總敘。泛愛眾,而親仁,有余力,則學文",
"emotion": "positive"
}
},
"score": "1.0",
"scoreColor": "c4",
"is_match": 1,
"skill_id": "4107891e-63da-47f5-86e9-3f8db56d9c96",
"id": "6ce19dd5-cee9-4b77-8583-df22f4782bc7"
}
],
"meta_process_milliseconds": 153
}
```
**詳細參數說明**
|名稱|類型|說明|
|:---|:---|:---
|service | String |服務名稱
|startFromBegining|bool|是否重新開始
|chapterNumber | int | 選擇章數
|choiceAnswer | String |選擇題回答(優先匹配選擇題回答,如果選擇題回答為空,則匹配文字題回答)
|textAnswer|String|文字題回答
|sectionEnd | String |4句小節結束
|finish|String|書籍內容結束
|content | String |學習內容(詞句、解釋、圖片、音頻)
|correctAnswer|String|正確答案
|isCorrect| String |是否正確
|lastQuestion|String|是否最后一個問題
|question | String |問題
|answer|String|答案
|questionType | String |問題類型
|choices | String |選項
**指令清單**
|指令名稱|范例|
|:---|:---
|喚醒 | 打開國學大會
|游戲規則 | 了解游戲規則
|繼續上次內容還是從頭開始 | 從頭開始
|鞏固練習 | 鞏固練習
|退出 | 退出
- 1. 海知智能第三方技能插件開放平臺概述
- 2. 快速接入API
- 2.1 硬件接口調用
- 2.2 快速接入微信
- 2.3 API接入常見問題
- 3. 技能插件
- 3.1 基礎能力類
- 頂級過濾器
- 用戶知識圖譜
- 機器人檔案
- 通用閑聊
- 兒童閑聊
- Smart Reply
- 輕量閑聊
- 3.2 語音游戲類
- 成語接龍
- 詞匯樂園
- 詞語接龍
- 鸚鵡學舌
- 動腦猜猜
- 挑戰單詞
- 冒險世界
- 猜猜我是誰
- 阿拉丁學詩詞
- 貓貓托管所
- 漂流瓶
- 詩詞大會
- 國學大會
- 我愛猜歌名
- 我在看著你
- 燈謎猜猜
- 3.3 休閑娛樂類
- 星座運勢
- 悅耳聲音
- 幸運簽
- 調教機器人
- 娛樂推送
- 3.4 生活服務類
- 黃歷
- 計算器
- 古詩詞
- 時間詢問
- 翻譯類技能
- 天氣資訊
- 日程創建
- 日程創建指令
- 鬧鐘
- 食材知識
- 冥想音樂
- 格言
- 每日英語
- 漢語詞典
- 豆果菜譜
- 古文翻譯
- 3.5 音頻點播類
- 喜馬拉雅FM
- 新聞廣播
- 音樂點播
- Smart Music
- 兒童聽聽
- Smart Audio
- 兒童笑話
- 點播控制指令
- 3.6 視頻點播類
- 影視點播
- 3.7 百科知識類
- 人物百科
- 百科問答
- 實時百科
- 3.8 體育健康類
- 五分鐘健身
- 4. 開發者初級教程
- 4.1 開通服務
- 4.2 創建機器人
- 4.3 設置機器人
- 4.4 獲取技能插件
- 4.5 讓機器人學會聊天
- 4.6 導入知識庫
- 4.7 多種問答形式
- 4.8 數據統計
- 4.9 粉絲管理
- 5. 開發者中級教程
- 5.1 詞典運用
- 5.2 意圖處理
- 5.3 暗號使用
- 5.4 事件觸發
- 5.5 優先級
- 5.6 觸發器
- 5.7 快捷鍵
- 5.8 意圖報錯
- 6. 開發者高級教程
- 6.1 handlebars模版語言
- 6.2 JavaScript簡單介紹
- 6.3 JavaScript使用說明
- 6.4 JavaScript使用案例
- 6.5 JavaScript常見問題
- 7. 快速發布技能
- 8. 幫助中心
- 8.1 常見概念
- 8.2 幫助視頻
- 8.3 聯系我們