[Cognitive Services / Language] Dynamic classification class to classifications (Azure#21550)

omaremadeldin · kristapratico · kayousef · commit 143c46632b02 · 2022-12-21T13:51:56.000+02:00
* Dynamic classification `class` to `classifications`

* Update analyzetext.json

* Update analyzetext.json

* Update analyzetext.json

* update DynamicClassification x-ms-examples

Co-authored-by: Krista Pratico &lt;krpratic@microsoft.com&gt;
diff --git a/dev/cognitiveservices/data-plane/Language/analyzetext.json b/dev/cognitiveservices/data-plane/Language/analyzetext.json
@@ -768,6 +768,25 @@
         "class"
       ]
     },
+    "DynamicClassificationDocumentResult": {
+      "type": "object",
+      "properties": {
+        "classifications": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ClassificationResult"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/DocumentResult"
+        }
+      ],
+      "required": [
+        "classifications"
+      ]
+    },
     "HealthcareTaskParameters": {
       "type": "object",
       "description": "Supported parameters for a Healthcare task.",
@@ -3139,7 +3158,7 @@
           "items": {
             "allOf": [
               {
-                "$ref": "#/definitions/ClassificationDocumentResult"
+                "$ref": "#/definitions/DynamicClassificationDocumentResult"
               }
             ]
           }
diff --git a/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfuDynamicClassificationRequest.json b/dev/cognitiveservices/data-plane/Language/examples/text/SuccessfuDynamicClassificationRequest.json
@@ -40,7 +40,7 @@
           "documents": [
             {
               "id": "1",
-              "class": [
+              "classifications": [
                 {
                   "category": "Health",
                   "confidenceScore": 0.9
@@ -62,7 +62,7 @@
             },
             {
               "id": "2",
-              "class": [
+              "classifications": [
                 {
                   "category": "Health",
                   "confidenceScore": 0.9
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/analyzetext.json
@@ -768,6 +768,25 @@
         "class"
       ]
     },
+    "DynamicClassificationDocumentResult": {
+      "type": "object",
+      "properties": {
+        "classifications": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ClassificationResult"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/DocumentResult"
+        }
+      ],
+      "required": [
+        "classifications"
+      ]
+    },
     "HealthcareTaskParameters": {
       "type": "object",
       "description": "Supported parameters for a Healthcare task.",
@@ -3139,7 +3158,7 @@
           "items": {
             "allOf": [
               {
-                "$ref": "#/definitions/ClassificationDocumentResult"
+                "$ref": "#/definitions/DynamicClassificationDocumentResult"
               }
             ]
           }
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfuDynamicClassificationRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/text/SuccessfuDynamicClassificationRequest.json
@@ -40,7 +40,7 @@
           "documents": [
             {
               "id": "1",
-              "class": [
+              "classifications": [
                 {
                   "category": "Health",
                   "confidenceScore": 0.9
@@ -62,7 +62,7 @@
             },
             {
               "id": "2",
-              "class": [
+              "classifications": [
                 {
                   "category": "Health",
                   "confidenceScore": 0.9

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`"documents": [`
`41`	`41`	`{`
`42`	`42`	`"id": "1",`
`43`		`- "class": [`
	`43`	`+ "classifications": [`
`44`	`44`	`{`
`45`	`45`	`"category": "Health",`
`46`	`46`	`"confidenceScore": 0.9`
`@@ -62,7 +62,7 @@`
`62`	`62`	`},`
`63`	`63`	`{`
`64`	`64`	`"id": "2",`
`65`		`- "class": [`
	`65`	`+ "classifications": [`
`66`	`66`	`{`
`67`	`67`	`"category": "Health",`
`68`	`68`	`"confidenceScore": 0.9`