Merge pull request Azure#3 from josuhazure/josuh_aspect

Adding ABSA description
tasharm-0412 · Mar 5, 2020 · 9a28376 · 9a28376
2 parents 3befe3f + 83462c7
commit 9a28376
Showing 1 changed file with 27 additions and 16 deletions.
diff --git a/...tion/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json b/...tion/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json
@@ -730,14 +730,14 @@
         },
         "aspects": {
           "type": "array",
-          "description": "an array of aspects per sentence",
+          "description": "The array of aspect object for the sentence.",
           "items": {
             "$ref": "#/definitions/SentenceAspect"
           }
         },
         "opinions": {
           "type": "array",
-          "description": "an array of opinions per sentence",
+          "description": "The array of opinion object for the sentence.",
           "items": {
             "$ref": "#/definitions/SentenceOpinion"
           }
@@ -761,26 +761,30 @@
         },
         "sentiment": {
           "type": "string",
-          "enum": [ "positive", "mixed", "negative" ]
+          "enum": [ "positive", "mixed", "negative" ],
+          "description": "Aspect level sentiment for the aspect in the sentence."
         },
         "confidenceScores": {
-          "description": "Aspect level sentiment confidence scores for each sentiment class.",
+          "description": "Aspect level sentiment confidence scores for the aspect in the sentence.",
           "$ref": "#/definitions/AspectConfidenceScoreLabel"
         },
         "offset": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "description": "The aspect offset from the start of the sentence."
         },
         "length": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "description": "The length of the aspect by Unicode standard."
         },
         "text": {
-          "type": "string"
+          "type": "string",
+          "description": "The aspect text detected."
         },
         "relations": {
           "type": "array",
-          "description": "Aspect-based sentiment analysis.",
+          "description": "The array of either opinion or aspect object which is related to the aspect.",
           "items": {
             "$ref": "#/definitions/AspectRelation"
           }
@@ -804,25 +808,30 @@
         },
         "sentiment": {
           "type": "string",
-          "enum": [ "positive", "mixed", "negative" ]
+          "enum": [ "positive", "mixed", "negative" ],
+          "description": "Opinion level sentiment for the aspect in the sentence."
         },
         "confidenceScores": {
-          "description": "Opinion level sentiment confidence scores for each sentiment class.",
+          "description": "Opinion level sentiment confidence scores for the aspect in the sentence.",
           "$ref": "#/definitions/AspectConfidenceScoreLabel"
         },
         "offset": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "description": "The opinion offset from the start of the sentence."
         },
         "length": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "description": "The length of the opinion by Unicode standard."
         },
         "text": {
-          "type": "string"
+          "type": "string",
+          "description": "The aspect text detected."
         },
         "isNegated": {
-          "type": "boolean"
+          "type": "boolean",
+          "description": "The indicator representing if the opinion is negated."
         },
         "warnings": {
           "type": "array",
@@ -839,10 +848,12 @@
       "properties": {
         "relationType": {
           "type": "string",
-          "enum": [ "opinion", "aspect" ]
+          "enum": [ "opinion", "aspect" ],
+          "description": "The type related to the aspect."
         },
         "links": {
-          "type": "string"
+          "type": "string",
+          "description": "The JSON pointer indicating the linked object."
         },
         "warnings": {
           "type": "array",