Add the missing description to summarization parameter (#20809)

wangyuantao · yuantao-wang · web-flow · commit dad16c71bfaa · 2022-09-30T11:21:07.000+08:00
* add the missing description

* fix wording

* fix prettier

* remove endpoint format uri

* fix lintdiff

* add format uri back

* x-ms-parameterized-host hostTemplate consistent

* fix prettier

* fix typo

* fix model validation

* remove dup Language

* prettier more

* add more custom words like Telangana

* fix typo of documentKind

* remove dup def of Endpoint in QnA gen

* GeneratedQAs is [] not [][]

* revert custom words

* remove format uri again

* add custom words back

* fix documentKind in QnA examples

* test security check

* fix QnA sample

* test security

* revert security

* consistent security

* delete QnA generate

* azure-sdk-for-net-track2

* fix more validation errors

* revert authoring

* fix authoring

* fix authoring

* add 200 back to export qna authoring

* revert endpoint to Endpoint

* fix example of qna authoring

* prettier revert

* fix api version

* revert authoring

Co-authored-by: Yuantao Wang &lt;yuantw@microsoft.com&gt;
diff --git a/dev/cognitiveservices/data-plane/Language/analyzeconversations-authoring.json b/dev/cognitiveservices/data-plane/Language/analyzeconversations-authoring.json
@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring",
-    "version": "2022-07-01-preview",
+    "version": "2022-10-01-preview",
     "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>."
   },
   "securityDefinitions": {
diff --git a/dev/cognitiveservices/data-plane/Language/analyzeconversations.json b/dev/cognitiveservices/data-plane/Language/analyzeconversations.json
@@ -1651,6 +1651,7 @@
       ]
     },
     "ConversationSentimentResult": {
+      "type": "object",
       "description": "The result from sentiment analysis operation for each conversation item.",
       "required": [
         "conversationItems"
@@ -1721,19 +1722,23 @@
           "properties": {
             "completed": {
               "description": "Count of tasks completed successfully.",
-              "type": "integer"
+              "type": "integer",
+              "format": "int32"
             },
             "failed": {
               "description": "Count of tasks that failed.",
-              "type": "integer"
+              "type": "integer",
+              "format": "int32"
             },
             "inProgress": {
               "description": "Count of tasks in progress currently.",
-              "type": "integer"
+              "type": "integer",
+              "format": "int32"
             },
             "total": {
               "description": "Total count of tasks submitted as part of the job.",
-              "type": "integer"
+              "type": "integer",
+              "format": "int32"
             },
             "items": {
               "description": "List of results from tasks (if available).",
diff --git a/dev/cognitiveservices/data-plane/Language/analyzetext-authoring.json b/dev/cognitiveservices/data-plane/Language/analyzetext-authoring.json
@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "title": "Microsoft Cognitive Language Service - Analyze Text Authoring",
-    "version": "2022-07-01-preview",
+    "version": "2022-10-01-preview",
     "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>."
   },
   "securityDefinitions": {
diff --git a/dev/cognitiveservices/data-plane/Language/analyzetext.json b/dev/cognitiveservices/data-plane/Language/analyzetext.json
@@ -505,6 +505,7 @@
       "x-ms-discriminator-value": "SentimentAnalysis"
     },
     "AnalyzeTextDynamicClassificationInput": {
+      "type": "object",
       "properties": {
         "analysisInput": {
           "$ref": "#/definitions/MultiLanguageAnalysisInput"
@@ -916,7 +917,7 @@
             "HealthcareProfession",
             "Diagnosis",
             "SymptomOrSign",
-            "ConditionalQualifier",
+            "ConditionQualifier",
             "MedicationClass",
             "MedicationName",
             "Dosage",
diff --git a/dev/cognitiveservices/data-plane/Language/common.json b/dev/cognitiveservices/data-plane/Language/common.json
@@ -16,10 +16,7 @@
           "description": "The error object.",
           "$ref": "#/definitions/Error"
         }
-      },
-      "required": [
-        "error"
-      ]
+      }
     },
     "Error": {
       "type": "object",
@@ -805,7 +802,8 @@
       "properties": {
         "sentenceCount": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "description": "It controls the approximate number of sentences in the output summaries."
         },
         "stringIndexType": {
           "$ref": "#/definitions/StringIndexType"
@@ -1545,7 +1543,6 @@
       "x-ms-parameter-location": "client",
       "required": true,
       "type": "string",
-      "format": "uri",
       "in": "path",
       "x-ms-skip-url-encoding": true
     },
diff --git a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSentimentSubmit.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSentimentSubmit.json
@@ -17,7 +17,9 @@
                 "participantId": "1",
                 "id": "1",
                 "text": "I like the service. I do not like the food",
-                "lexical": "i like the service i do not like the food"
+                "lexical": "i like the service i do not like the food",
+                "itn": "",
+                "maskedItn": ""
               }
             ]
           }
diff --git a/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json b/dev/cognitiveservices/data-plane/Language/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json
@@ -9,11 +9,11 @@
     "200": {
       "headers": {},
       "body": {
-        "createdDateTime": "2022-10-01T8:00:25Z",
+        "createdDateTime": "2022-04-01T15:00:45Z",
         "displayName": "Sentiment Analysis from a call center conversation",
-        "expirationDateTime": "2022-10-03T8:0:25Z",
+        "expirationDateTime": "2022-04-01T15:00:45Z",
         "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
-        "lastUpdatedDateTime": "2022-10-01T8:00:50Z",
+        "lastUpdatedDateTime": "2022-04-01T15:00:45Z",
         "status": "succeeded",
         "tasks": {
           "completed": 1,
@@ -24,7 +24,7 @@
             {
               "kind": "ConversationalSentimentResults",
               "taskName": "Conversation Sentiment",
-              "lastUpdateDateTime": "2022-10-01T8:00:50Z",
+              "lastUpdateDateTime": "2022-04-01T15:00:45Z",
               "status": "succeeded",
               "results": {
                 "conversations": [
diff --git a/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/dev/cognitiveservices/data-plane/Language/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
@@ -3,7 +3,7 @@
     "Endpoint": "{Endpoint}",
     "Ocp-Apim-Subscription-Key": "{API key}",
     "Content-Type": "application/json",
-    "api-version": "2022-07-01-preview",
+    "api-version": "2022-10-01-preview",
     "projectName": "proj1",
     "body": {
       "exportAssetTypes": [
@@ -13,6 +13,18 @@
     }
   },
   "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "errors": [],
+        "createdDateTime": "2021-05-01T17:21:14Z",
+        "expirationDateTime": "2021-05-01T17:21:14Z",
+        "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
+        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
+        "status": "succeeded",
+        "resultUrl": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2022-10-01-preview"
+      }
+    },
     "202": {
       "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
       "headers": {
diff --git a/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfulEntityRecognitionRequest.json b/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfulEntityRecognitionRequest.json
@@ -63,7 +63,7 @@
                   "confidenceScore": 0.99,
                   "resolutions": [
                     {
-                      "resolutionKind": "DateTime",
+                      "resolutionKind": "DateTimeResolution",
                       "dateTimeSubKind": "Date",
                       "timex": "1975-04-04",
                       "value": "1975-04-04"
diff --git a/dev/cognitiveservices/data-plane/Language/questionanswering-authoring.json b/dev/cognitiveservices/data-plane/Language/questionanswering-authoring.json
@@ -3,7 +3,7 @@
   "info": {
     "title": "Microsoft Cognitive Language Service - Question Answering - Authoring",
     "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms.  The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview</a>.",
-    "version": "2022-07-01-preview"
+    "version": "2022-10-01-preview"
   },
   "securityDefinitions": {
     "AADToken": {
diff --git a/dev/cognitiveservices/data-plane/Language/questionanswering.json b/dev/cognitiveservices/data-plane/Language/questionanswering.json
@@ -3,7 +3,7 @@
   "info": {
     "title": "Microsoft Cognitive Language Service - Question Answering",
     "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms.  The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview</a>.",
-    "version": "2022-07-01-preview"
+    "version": "2022-10-01-preview"
   },
   "securityDefinitions": {
     "AADToken": {

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,9 @@`
`17`	`17`	`"participantId": "1",`
`18`	`18`	`"id": "1",`
`19`	`19`	`"text": "I like the service. I do not like the food",`
`20`		`- "lexical": "i like the service i do not like the food"`
	`20`	`+ "lexical": "i like the service i do not like the food",`
	`21`	`+ "itn": "",`
	`22`	`+ "maskedItn": ""`
`21`	`23`	`}`
`22`	`24`	`]`
`23`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@`
`63`	`63`	`"confidenceScore": 0.99,`
`64`	`64`	`"resolutions": [`
`65`	`65`	`{`
`66`		`- "resolutionKind": "DateTime",`
	`66`	`+ "resolutionKind": "DateTimeResolution",`
`67`	`67`	`"dateTimeSubKind": "Date",`
`68`	`68`	`"timex": "1975-04-04",`
`69`	`69`	`"value": "1975-04-04"`