diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json index 6ef1657fa0c3..2c826b9ba1c4 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json @@ -565,7 +565,7 @@ "required": [ "id", "sentiment", - "confidenceScores", + "documentScores", "sentences" ], "properties": { @@ -590,7 +590,7 @@ "statistics": { "$ref": "#/definitions/DocumentStatistics" }, - "confidenceScores": { + "documentScores": { "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", "$ref": "#/definitions/SentimentConfidenceScorePerLabel" }, @@ -681,17 +681,12 @@ "SentenceSentiment": { "type": "object", "required": [ - "text", "sentiment", - "confidenceScores", + "sentenceScores", "offset", "length" ], "properties": { - "text": { - "type": "string", - "description": "The sentence text." - }, "sentiment": { "type": "string", "description": "The predicted Sentiment for the sentence.", @@ -705,7 +700,7 @@ "modelAsString": false } }, - "confidenceScores": { + "sentenceScores": { "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", "$ref": "#/definitions/SentimentConfidenceScorePerLabel" }, @@ -1124,4 +1119,4 @@ "x-ms-skip-url-encoding": true } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulSentimentRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulSentimentRequest.json index 5f5979a2a601..a61d236644d0 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulSentimentRequest.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/examples/SuccessfulSentimentRequest.json @@ -37,7 +37,6 @@ }, "sentences": [ { - "text": "Hello world.", "sentiment": "neutral", "sentenceScores": { "positive": 0.070910170674324, @@ -48,7 +47,6 @@ "length": 12 }, { - "text": "This is some input text that I love.", "sentiment": "positive", "sentenceScores": { "positive": 0.998519241809845, @@ -70,7 +68,6 @@ }, "sentences": [ { - "text": "It's incredibly sunny outside!", "sentiment": "neutral", "sentenceScores": { "positive": 0.0499138832092285, @@ -81,7 +78,6 @@ "length": 30 }, { - "text": "I'm so happy.", "sentiment": "positive", "sentenceScores": { "positive": 0.9954571723937988, @@ -103,7 +99,6 @@ }, "sentences": [ { - "text": "Pike place market is my favorite Seattle attraction.", "sentiment": "positive", "sentenceScores": { "positive": 0.9965128302574158, diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json index 4169bcd06553..513e60b9721e 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json @@ -333,7 +333,7 @@ "/sentiment": { "post": { "summary": "Sentiment", - "description": "The API returns a sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral) for the document and each sentence within it. See the Supported languages in Text Analytics API for the list of enabled languages.", + "description": "The API returns a detailed sentiment analysis for the input text. The analysis is done in multiple levels of granularity, start from the a document level, down to sentence and key terms (aspects) and opinions.", "operationId": "Sentiment", "consumes": [ "application/json", @@ -513,7 +513,7 @@ }, "targetRef": { "type": "string", - "description": "The JSON pointer indicating the linked object." + "description": "A JSON pointer reference indicating the target object." } } }, @@ -762,7 +762,7 @@ "length": { "type": "integer", "format": "int32", - "description": "The length of the sentence by Unicode standard." + "description": "The length of the sentence." }, "aspects": { "type": "array", @@ -812,7 +812,7 @@ "length": { "type": "integer", "format": "int32", - "description": "The length of the aspect by Unicode standard." + "description": "The length of the aspect." }, "text": { "type": "string", @@ -859,7 +859,7 @@ "length": { "type": "integer", "format": "int32", - "description": "The length of the opinion by Unicode standard." + "description": "The length of the opinion." }, "text": { "type": "string", @@ -1003,12 +1003,12 @@ "offset": { "type": "integer", "format": "int32", - "description": "Start position (in Unicode characters) for the entity text." + "description": "Start position for the entity text." }, "length": { "type": "integer", "format": "int32", - "description": "Length (in Unicode characters) for the entity text." + "description": "Length for the entity text." }, "confidenceScore": { "type": "number", @@ -1140,12 +1140,12 @@ "offset": { "type": "integer", "format": "int32", - "description": "Start position (in Unicode characters) for the entity match text." + "description": "Start position for the entity match text." }, "length": { "type": "integer", "format": "int32", - "description": "Length (in Unicode characters) for the entity match text." + "description": "Length for the entity match text." } } }, diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/examples/SuccessfulSentimentRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/examples/SuccessfulSentimentRequest.json index 4e666eb03f7a..8cd32cf7db23 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/examples/SuccessfulSentimentRequest.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/examples/SuccessfulSentimentRequest.json @@ -45,8 +45,8 @@ { "sentiment": "positive", "confidenceScores": { - "positive": 1, - "negative": 0 + "positive": 1.0, + "negative": 0.0 }, "offset": 6, "length": 10, @@ -63,8 +63,8 @@ { "sentiment": "positive", "confidenceScores": { - "positive": 1, - "negative": 0 + "positive": 1.0, + "negative": 0.0 }, "offset": 0, "length": 5, @@ -145,8 +145,8 @@ { "sentiment": "positive", "confidenceScores": { - "positive": 1, - "negative": 0 + "positive": 1.0, + "negative": 0.0 }, "offset": 71, "length": 5, @@ -163,8 +163,8 @@ { "sentiment": "positive", "confidenceScores": { - "positive": 1, - "negative": 0 + "positive": 1.0, + "negative": 0.0 }, "offset": 81, "length": 8, @@ -285,8 +285,8 @@ { "sentiment": "negative", "confidenceScores": { - "positive": 0, - "negative": 1 + "positive": 0.0, + "negative": 1.0 }, "offset": 73, "length": 5, @@ -303,8 +303,8 @@ { "sentiment": "negative", "confidenceScores": { - "positive": 0, - "negative": 1 + "positive": 0.0, + "negative": 1.0 }, "offset": 87, "length": 8,