Update QnA Maker Create and Update KB examples + Operation Id of Run…

…time APIs (#6383) * Update Create and Update KB schemas * Update operation Id of Runtime APIs
Azure · Jun 24, 2019 · 3d44282 · 3d44282
1 parent 915924c
commit 3d44282
Show file tree

Hide file tree

Showing 3 changed files with 131 additions and 39 deletions.
diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json
@@ -33,7 +33,7 @@
           "Knowledgebases"
         ],
         "summary": "GenerateAnswer call to query the knowledgebase.",
-        "operationId": "Knowledgebase_GenerateAnswer",
+        "operationId": "Runtime_GenerateAnswer",
         "parameters": [
           {
             "$ref": "#/parameters/KbId"
@@ -75,7 +75,7 @@
           "Knowledgebases"
         ],
         "summary": "Train call to add suggestions to the knowledgebase.",
-        "operationId": "Knowledgebase_Train",
+        "operationId": "Runtime_Train",
         "parameters": [
           {
             "$ref": "#/parameters/KbId"

diff --git a/...cation/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulCreateKb.json b/...cation/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulCreateKb.json
@@ -17,17 +17,53 @@
         },
         {
           "id": 0,
-          "answer": "You can use our REST apis to manage your KB. See here for details: https://westus.dev.cognitive.microsoft.com/docs/services/58994a073d9e04097c7ba6fe/operations/58994a073d9e041ad42d9baa",
+          "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
           "source": "Custom Editorial",
           "questions": [
-            "How do I programmatically update my KB?"
+            "How do I programmatically create a KB?"
           ],
           "metadata": [
             {
               "name": "category",
               "value": "api"
             }
-          ]
+          ],
+          "context": {
+            "isContextOnly": false,
+            "prompts": [
+              {
+                "displayOrder": 1,
+                "displayText": "Update KB",
+                "qna": {
+                  "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
+                  "questions": [
+                    "How do I programmatically update my KB?"
+                  ],
+                  "metadata": [
+                    {
+                      "name": "category",
+                      "value": "api"
+                    }
+                  ],
+                  "context": {
+                    "isContextOnly": false,
+                    "prompts": [
+                      {
+                      "displayOrder": 1,
+                      "displayText": "Refresh Endpoint Keys",
+                      "qna": {
+                        "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
+                        "questions": [
+                          "How do I programmatically refresh endpoint keys?"
+                          ]
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
         }
       ],
       "urls": [
@@ -54,4 +90,4 @@
       }
     }
   }
-}
+}
diff --git a/...ification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json b/...ification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json
@@ -15,24 +15,10 @@
               "How can I change the default message from QnA Maker?"
             ],
             "metadata": []
-          },
-          {
-            "id": 0,
-            "answer": "You can use our REST apis to manage your KB. See here for details: https://westus.dev.cognitive.microsoft.com/docs/services/58994a073d9e04097c7ba6fe/operations/58994a073d9e041ad42d9baa",
-            "source": "Custom Editorial",
-            "questions": [
-              "How do I programmatically update my KB?"
-            ],
-            "metadata": [
-              {
-                "name": "category",
-                "value": "api"
-              }
-            ]
           }
         ],
         "urls": [
-          "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ"
+            "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ"
         ],
         "files": [
           {
@@ -43,28 +29,86 @@
       },
       "delete": {
         "ids": [
-          4,
-          13,
-          35
-        ],
-        "sources": [
-          "Custom Editorial"
+            13,
+            35
         ]
       },
       "update": {
-        "name": "QnA Maker + Emotion API FAQ Bot",
+        "name": "QnA Maker FAQ Prompts Bot",
         "qnaList": [
           {
-            "id": 30,
-            "answer": "Yes, you can use our REST APIs to manage a KB. Please check our documentation for details.",
-            "source": "Custom Q&A",
+            "id": 2,
+            "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
+            "source": "Custom Editorial",
             "questions": {
-              "add": [
-                "can I programmatically manage a KB?"
+              "add": [],
+              "delete": []
+            },
+            "metadata": {
+              "add": [],
+              "delete": []
+            },
+            "alternateQuestionClusters": {
+              "delete": []
+            },
+            "context": {
+              "isContextOnly": false,
+              "promptsToAdd": [
+                {
+                  "displayText": "Add Prompts",
+                  "displayOrder": 0,
+                  "qna": {
+                    "id": 0,
+                    "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
+                    "source": "Editorial",
+                    "questions": [
+                      "How can I add prompts?"
+                    ],
+                    "metadata": [],
+                    "alternateQuestionClusters": [],
+                    "context": {
+                      "isContextOnly": false,
+                      "prompts": []
+                    }
+                  },
+                  "qnaId": 0
+                },
+                {
+                  "displayText": "Delete Prompts",
+                  "displayOrder": 0,
+                  "qna": {
+                    "id": 0,
+                    "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
+                    "source": "Editorial",
+                    "questions": [
+                      "How can I delete delete prompts?"
+                    ],
+                    "metadata": [],
+                    "alternateQuestionClusters": [],
+                    "context": {
+                      "isContextOnly": false,
+                      "prompts": []
+                    }
+                  },
+                  "qnaId": 0
+                },
+                {
+                  "displayText": "Update Knowledgebase",
+                  "displayOrder": 0,
+                  "qna": null,
+                  "qnaId": 3
+                }
               ],
-              "delete": [
-                "How do I programmatically update my KB?"
-              ]
+              "promptsToDelete": [ 3 ]
+            }
+          },
+          {
+            "id": 3,
+            "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
+            "source": "Custom Editorial",
+            "questions": {
+              "add": [],
+              "delete": []
             },
             "metadata": {
               "delete": [
@@ -79,11 +123,23 @@
                   "value": "programmatic"
                 }
               ]
+            },
+            "alternateQuestionClusters": {
+              "delete": []
+            },
+            "context": {
+              "isContextOnly": false,
+              "promptsToAdd": [
+                {
+                  "displayText": "Regenerate Endpoint keys",
+                  "displayOrder": 1,
+                  "qna": null,
+                  "qnaId": 4
+                }
+              ],
+              "promptsToDelete": [ 4 ]
             }
           }
-        ],
-        "urls": [
-          "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
         ]
       }
     }