Merge pull request Azure#6 from josuhazure/josuh_aspect

Adding sentence text + changing documentScores to confidenceScores

Author: laramume

specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json

@@ -565,7 +565,7 @@
       "required": [
         "id",
         "sentiment",
-        "documentScores",
+        "confidenceScores",
         "sentences"
       ],
       "properties": {
@@ -590,7 +590,7 @@
         "statistics": {
           "$ref": "#/definitions/DocumentStatistics"
         },
-        "documentScores": {
+        "confidenceScores": {
           "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.",
           "$ref": "#/definitions/SentimentConfidenceScorePerLabel"
         },
@@ -681,12 +681,17 @@
     "SentenceSentiment": {
       "type": "object",
       "required": [
+        "text",
         "sentiment",
-        "sentenceScores",
+        "confidenceScores",
         "offset",
         "length"
       ],
       "properties": {
+        "text": {
+          "type": "string",
+          "description": "The sentence text."
+        },
         "sentiment": {
           "type": "string",
           "description": "The predicted Sentiment for the sentence.",
@@ -700,7 +705,7 @@
             "modelAsString": false
           }
         },
-        "sentenceScores": {
+        "confidenceScores": {
           "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.",
           "$ref": "#/definitions/SentimentConfidenceScorePerLabel"
         },
@@ -1119,4 +1124,4 @@
       "x-ms-skip-url-encoding": true
     }
   }
-}
+}

specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulSentimentRequest.json

@@ -37,6 +37,7 @@
             },
             "sentences": [
               {
+                "text": "Hello world.",
                 "sentiment": "neutral",
                 "sentenceScores": {
                   "positive": 0.070910170674324,
@@ -47,6 +48,7 @@
                 "length": 12
               },
               {
+                "text": "This is some input text that I love.",
                 "sentiment": "positive",
                 "sentenceScores": {
                   "positive": 0.998519241809845,
@@ -68,6 +70,7 @@
             },
             "sentences": [
               {
+                "text": "It's incredibly sunny outside!",
                 "sentiment": "neutral",
                 "sentenceScores": {
                   "positive": 0.0499138832092285,
@@ -78,6 +81,7 @@
                 "length": 30
               },
               {
+                "text": "I'm so happy.",
                 "sentiment": "positive",
                 "sentenceScores": {
                   "positive": 0.9954571723937988,
@@ -99,6 +103,7 @@
             },
             "sentences": [
               {
+                "text": "Pike place market is my favorite Seattle attraction.",
                 "sentiment": "positive",
                 "sentenceScores": {
                   "positive": 0.9965128302574158,

specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json

@@ -724,6 +724,7 @@
     "SentenceSentiment": {
       "type": "object",
       "required": [
+        "text",
         "sentiment",
         "confidenceScores",
         "offset",
@@ -732,6 +733,10 @@
         "opinions"
       ],
       "properties": {
+        "text": {
+          "type": "string",
+          "description": "The sentence text."
+        },
         "sentiment": {
           "type": "string",
           "description": "The predicted Sentiment for the sentence.",

specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/examples/SuccessfulSentimentRequest.json

@@ -32,6 +32,7 @@
             },
             "sentences": [
               {
+                "text": "Great atmosphere.",
                 "sentiment": "positive",
                 "confidenceScores": {
                   "positive": 1.0,
@@ -73,6 +74,7 @@
                 ]
               },
               {
+                "text": "Close to plenty of restaurants, hotels, and transit!",
                 "sentiment": "neutral",
                 "confidenceScores": {
                   "positive": 0.13,
@@ -130,6 +132,7 @@
                 ]
               },
               {
+                "text": "Staff are friendly and helpful.",
                 "sentiment": "positive",
                 "confidenceScores": {
                   "positive": 1.0,
@@ -183,6 +186,7 @@
             },
             "sentences": [
               {
+                "text": "Bad atmosphere.",
                 "sentiment": "negative",
                 "confidenceScores": {
                   "positive": 0.0,
@@ -225,6 +229,7 @@
                 "warnings": []
               },
               {
+                "text": "Not close to plenty of restaurants, hotels, and transit!",
                 "sentiment": "negative",
                 "confidenceScores": {
                   "positive": 0.02,
@@ -267,6 +272,7 @@
                 "warnings": []
               },
               {
+                "text": "Staff are not friendly and helpful.",
                 "sentiment": "negative",
                 "confidenceScores": {
                   "positive": 0.0,
@@ -317,4 +323,4 @@
       }
     }
   }
-}
+}