[Question Answering] Language 2022-07-01-preview (#19865)

sush2218 · Sushvanth Akkireddy · web-flow · commit cb969a7b7c92 · 2022-07-28T10:20:41.000-07:00
* [Question Answering] Language 2022-07-01-preview

* Add paths without /authoring

* Typo in file name

* Add AAD

* Adding /authoring at top.

Co-authored-by: Sushvanth Akkireddy &lt;sakkireddy@microsoft.com&gt;
diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json
@@ -17,7 +17,7 @@
         "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
         "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
         "status": "succeeded",
-        "resultUrl": "https://<resource-endpoint>/language/proj1/export/job1/result"
+        "resultUrl": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2022-07-01-preview"
       }
     }
   }
diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json
@@ -11,7 +11,7 @@
     "202": {
       "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
       "headers": {
-        "Operation-Location": "job1"
+        "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/deployments/production/jobs/job1?api-version=2022-07-01-preview"
       }
     }
   }
diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
@@ -16,7 +16,7 @@
     "202": {
       "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
       "headers": {
-        "Operation-Location": "job1"
+        "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2022-07-01-preview"
       }
     }
   }
diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json
@@ -42,13 +42,8 @@
               "prompts": [
                 {
                   "displayOrder": 1,
-                  "qnaId": 11,
+                  "qnaId": 2,
                   "displayText": "prompt 1.1"
-                },
-                {
-                  "displayOrder": 2,
-                  "qnaId": 21,
-                  "displayText": "prompt 1.2"
                 }
               ]
             }
@@ -71,7 +66,7 @@
     "202": {
       "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
       "headers": {
-        "Operation-Location": "job1"
+        "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2022-07-01-preview"
       }
     }
   }
diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateQnas.json
@@ -67,7 +67,7 @@
     "202": {
       "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
       "headers": {
-        "Operation-Location": "job1"
+        "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2022-07-01-preview"
       }
     }
   }
diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulUpdateSources.json
@@ -37,7 +37,7 @@
     "202": {
       "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
       "headers": {
-        "Operation-Location": "job1"
+        "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2022-07-01-preview"
       }
     }
   }
diff --git a/dev/cognitiveservices/data-plane/Language/questionanswering-authoring.json b/dev/cognitiveservices/data-plane/Language/questionanswering-authoring.json
@@ -6,19 +6,33 @@
     "version": "2022-07-01-preview"
   },
   "securityDefinitions": {
+    "AADToken": {
+      "type": "oauth2",
+      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+      "flow": "implicit",
+      "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a  built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
+      "scopes": {
+        "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default"
+      }
+    },
     "apim_key": {
       "type": "apiKey",
       "name": "Ocp-Apim-Subscription-Key",
       "in": "header"
     }
   },
   "security": [
+    {
+      "AADToken": [
+        "https://cognitiveservices.azure.com/.default"
+      ]
+    },
     {
       "apim_key": []
     }
   ],
   "x-ms-parameterized-host": {
-    "hostTemplate": "{Endpoint}/language",
+    "hostTemplate": "{Endpoint}/language/authoring",
     "useSchemePrefix": false,
     "parameters": [
       {
diff --git a/dev/cognitiveservices/data-plane/Language/questionanswering.json b/dev/cognitiveservices/data-plane/Language/questionanswering.json
@@ -6,13 +6,27 @@
     "version": "2022-07-01-preview"
   },
   "securityDefinitions": {
+    "AADToken": {
+      "type": "oauth2",
+      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+      "flow": "implicit",
+      "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a  built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.",
+      "scopes": {
+        "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default"
+      }
+    },
     "apim_key": {
       "type": "apiKey",
       "name": "Ocp-Apim-Subscription-Key",
       "in": "header"
     }
   },
   "security": [
+    {
+      "AADToken": [
+        "https://cognitiveservices.azure.com/.default"
+      ]
+    },
     {
       "apim_key": []
     }

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`"jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",`
`18`	`18`	`"lastUpdatedDateTime": "2021-05-01T17:21:14Z",`
`19`	`19`	`"status": "succeeded",`
`20`		`- "resultUrl": "https://<resource-endpoint>/language/proj1/export/job1/result"`
	`20`	`+ "resultUrl": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2022-07-01-preview"`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`"202": {`
`12`	`12`	`"description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",`
`13`	`13`	`"headers": {`
`14`		`- "Operation-Location": "job1"`
	`14`	`+ "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/deployments/production/jobs/job1?api-version=2022-07-01-preview"`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`"202": {`
`17`	`17`	`"description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",`
`18`	`18`	`"headers": {`
`19`		`- "Operation-Location": "job1"`
	`19`	`+ "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2022-07-01-preview"`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,13 +42,8 @@`
`42`	`42`	`"prompts": [`
`43`	`43`	`{`
`44`	`44`	`"displayOrder": 1,`
`45`		`- "qnaId": 11,`
	`45`	`+ "qnaId": 2,`
`46`	`46`	`"displayText": "prompt 1.1"`
`47`		`- },`
`48`		`- {`
`49`		`- "displayOrder": 2,`
`50`		`- "qnaId": 21,`
`51`		`- "displayText": "prompt 1.2"`
`52`	`47`	`}`
`53`	`48`	`]`
`54`	`49`	`}`
`@@ -71,7 +66,7 @@`
`71`	`66`	`"202": {`
`72`	`67`	`"description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",`
`73`	`68`	`"headers": {`
`74`		`- "Operation-Location": "job1"`
	`69`	`+ "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2022-07-01-preview"`
`75`	`70`	`}`
`76`	`71`	`}`
`77`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@`
`67`	`67`	`"202": {`
`68`	`68`	`"description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",`
`69`	`69`	`"headers": {`
`70`		`- "Operation-Location": "job1"`
	`70`	`+ "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2022-07-01-preview"`
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`"202": {`
`38`	`38`	`"description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",`
`39`	`39`	`"headers": {`
`40`		`- "Operation-Location": "job1"`
	`40`	`+ "Operation-Location": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2022-07-01-preview"`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`	`}`