Sentiment - Sentiment

L’API retourne une analyse détaillée des sentiments pour le texte d’entrée. L’analyse est effectuée à plusieurs niveaux de granularité, en commençant par le niveau du document, jusqu’à la phrase et les termes clés (cibles et évaluations).

POST {Endpoint}/text/analytics/v3.1-preview.4/sentiment
POST {Endpoint}/text/analytics/v3.1-preview.4/sentiment?model-version={model-version}&showStats={showStats}&opinionMining={opinionMining}&stringIndexType={stringIndexType}

Paramètres URI

Name In Required Type Description
Endpoint
path True
  • string

Points de terminaison de Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com) .

model-version
query
  • string

Facultatif Cette valeur indique le modèle qui sera utilisé pour le calcul de score. Si une version de modèle n’est pas spécifiée, l’API doit avoir comme valeur par défaut la version la plus récente, sans version préliminaire.

opinionMining
query
  • boolean

(Facultatif) si la valeur est true, la réponse contient non seulement la prédiction de sentiment, mais également les résultats de l’exploration de données d’opinion (analyse des sentiments basés sur l’aspect).

showStats
query
  • boolean

(Facultatif) si la valeur est true, la réponse contiendra les statistiques de demande et de niveau document.

stringIndexType
query

Facultatif Spécifie la méthode utilisée pour interpréter les offsets de chaîne. Par défaut, les éléments de texte (graphemes) sont conformes à la norme Unicode v 8.0.0. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets

En-tête de la demande

Media Types: "application/json", "text/json"

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Corps de la demande

Media Types: "application/json", "text/json"

Name Required Type Description
documents True

Ensemble de documents à traiter dans le cadre de ce traitement.

Réponses

Name Type Description
200 OK

Un appel réussi produit une prédiction de sentiment de document, ainsi que des scores de sentiment pour chaque classe de sentiment (positive, négative et neutre)

Media Types: "application/json", "text/json"

400 Bad Request

Demande incorrecte.

Media Types: "application/json", "text/json"

500 Internal Server Error

Réponse d’erreur interne

Media Types: "application/json", "text/json"

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful Sentiment request

Sample Request

POST {Endpoint}/text/analytics/v3.1-preview.4/sentiment
Ocp-Apim-Subscription-Key: {API key}
{
  "documents": [
    {
      "id": "1",
      "language": "en",
      "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
    }
  ]
}

Sample Response

{
  "documents": [
    {
      "confidenceScores": {
        "negative": 0,
        "neutral": 0,
        "positive": 1
      },
      "id": "1",
      "sentences": [
        {
          "targets": [
            {
              "confidenceScores": {
                "negative": 0,
                "positive": 1
              },
              "length": 10,
              "offset": 6,
              "relations": [
                {
                  "ref": "#/documents/0/sentences/0/assessments/0",
                  "relationType": "assessment"
                }
              ],
              "sentiment": "positive",
              "text": "atmosphere"
            }
          ],
          "confidenceScores": {
            "negative": 0,
            "neutral": 0,
            "positive": 1
          },
          "length": 17,
          "offset": 0,
          "assessments": [
            {
              "confidenceScores": {
                "negative": 0,
                "positive": 1
              },
              "isNegated": false,
              "length": 5,
              "offset": 0,
              "sentiment": "positive",
              "text": "great"
            }
          ],
          "sentiment": "positive",
          "text": "Great atmosphere."
        },
        {
          "targets": [
            {
              "confidenceScores": {
                "negative": 0.01,
                "positive": 0.99
              },
              "length": 11,
              "offset": 37,
              "relations": [
                {
                  "ref": "#/documents/0/sentences/1/assessments/0",
                  "relationType": "assessment"
                }
              ],
              "sentiment": "positive",
              "text": "restaurants"
            },
            {
              "confidenceScores": {
                "negative": 0.01,
                "positive": 0.99
              },
              "length": 6,
              "offset": 50,
              "relations": [
                {
                  "ref": "#/documents/0/sentences/1/assessments/0",
                  "relationType": "assessment"
                }
              ],
              "sentiment": "positive",
              "text": "hotels"
            }
          ],
          "confidenceScores": {
            "negative": 0.01,
            "neutral": 0.86,
            "positive": 0.13
          },
          "length": 52,
          "offset": 18,
          "assessments": [
            {
              "confidenceScores": {
                "negative": 0.01,
                "positive": 0.99
              },
              "isNegated": false,
              "length": 15,
              "offset": 18,
              "sentiment": "positive",
              "text": "Close to plenty"
            }
          ],
          "sentiment": "neutral",
          "text": "Close to plenty of restaurants, hotels, and transit!"
        }
      ],
      "sentiment": "positive",
      "warnings": []
    }
  ],
  "errors": [],
  "modelVersion": "2020-04-01"
}
{
  "error": {
    "code": "InvalidRequest",
    "message": "Invalid Request.",
    "innererror": {
      "code": "MissingInputRecords",
      "message": "Missing input records."
    }
  }
}
{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error"
  }
}

Définitions

DocumentError
DocumentSentiment
DocumentSentimentValue

Sentiment prédit pour le document (négatif, neutre, positif ou mixte).

DocumentStatistics

Si showStats = true a été spécifié dans la demande, ce champ contient des informations sur la charge utile de document.

ErrorCodeValue

Code d’erreur.

ErrorResponse
InnerError
InnerErrorCodeValue

Code d’erreur.

MultiLanguageBatchInput

Contient un ensemble de documents d’entrée à analyser par le service.

MultiLanguageInput

Contient un document d’entrée à analyser par le service.

RequestStatistics

Si showStats = true a été spécifié dans la demande, ce champ contient des informations sur la charge utile de la demande.

SentenceAssessment
SentenceSentiment
SentenceSentimentValue

Sentiment prédit pour la phrase.

SentenceTarget
SentimentConfidenceScorePerLabel

Représente les scores de confiance entre 0 et 1 dans toutes les classes de sentiments : positif, neutre, négatif.

SentimentResponse
StringIndexType
TargetConfidenceScoreLabel

Représente les scores de confiance dans toutes les classes de sentiment : positif, neutre, négatif.

TargetRelation
TargetRelationType

Type associé à la cible.

TextAnalyticsError
TextAnalyticsWarning
TokenSentimentValue

Sentiment ciblé dans la phrase.

WarningCodeValue

Code d’erreur.

DocumentError

Name Type Description
error

Erreur de document.

id
  • string

ID du document.

DocumentSentiment

Name Type Description
confidenceScores

Les scores de confiance au niveau du document sont compris entre 0 et 1 pour chaque classe de sentiment.

id
  • string

Identificateur de document unique et non vide.

sentences

Analyse des sentiments au niveau des phrases.

sentiment

Sentiment prédit pour le document (négatif, neutre, positif ou mixte).

statistics

Si showStats = true a été spécifié dans la demande, ce champ contient des informations sur la charge utile de document.

warnings

Avertissements rencontrés lors du traitement du document.

DocumentSentimentValue

Sentiment prédit pour le document (négatif, neutre, positif ou mixte).

Name Type Description
mixed
  • string
negative
  • string
neutral
  • string
positive
  • string

DocumentStatistics

Si showStats = true a été spécifié dans la demande, ce champ contient des informations sur la charge utile de document.

Name Type Description
charactersCount
  • integer

Nombre d’éléments de texte reconnus dans le document.

transactionsCount
  • integer

Nombre de transactions pour le document.

ErrorCodeValue

Code d’erreur.

Name Type Description
InternalServerError
  • string
InvalidArgument
  • string
InvalidRequest
  • string
NotFound
  • string
ServiceUnavailable
  • string

ErrorResponse

Name Type Description
error

Erreur de document.

InnerError

Name Type Description
code

Code d’erreur.

details
  • object

Détails de l’erreur.

innererror

L’erreur interne contient des informations plus spécifiques.

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur.

InnerErrorCodeValue

Code d’erreur.

Name Type Description
EmptyRequest
  • string
InvalidCountryHint
  • string
InvalidDocument
  • string
InvalidDocumentBatch
  • string
InvalidParameterValue
  • string
InvalidRequestBodyFormat
  • string
MissingInputRecords
  • string
ModelVersionIncorrect
  • string
UnsupportedLanguageCode
  • string

MultiLanguageBatchInput

Contient un ensemble de documents d’entrée à analyser par le service.

Name Type Description
documents

Ensemble de documents à traiter dans le cadre de ce traitement.

MultiLanguageInput

Contient un document d’entrée à analyser par le service.

Name Type Description
id
  • string

Identificateur de document unique et non vide.

language
  • string

Facultatif Il s’agit de la représentation ISO 639-1 d’une langue à deux lettres. Par exemple, utilisez « fr » pour l’anglais ; « es » pour l’espagnol, etc. Si ce paramètre n’est pas défini, utilisez « en » pour l’anglais comme valeur par défaut.

text
  • string

Texte d’entrée à traiter.

RequestStatistics

Si showStats = true a été spécifié dans la demande, ce champ contient des informations sur la charge utile de la demande.

Name Type Description
documentsCount
  • integer

Nombre de documents envoyés dans la demande.

erroneousDocumentsCount
  • integer

Nombre de documents non valides. Cela comprend des documents vides, des limites de taille supérieure ou des langues non prises en charge.

transactionsCount
  • integer

Nombre de transactions pour la demande.

validDocumentsCount
  • integer

Nombre de documents valides. Cela exclut les documents vides, les limites de taille supérieure ou les langues non prises en charge.

SentenceAssessment

Name Type Description
confidenceScores

Scores de confiance des sentiments d’évaluation dans la phrase.

isNegated
  • boolean

Indicateur représentant si l’évaluation est négative.

length
  • integer

Durée de l’évaluation.

offset
  • integer

Offset d’évaluation à partir du début de la phrase.

sentiment

Sentiment de l’évaluation dans la phrase.

text
  • string

Texte d’évaluation détecté.

SentenceSentiment

Name Type Description
assessments

Tableau d’évaluations pour la phrase.

confidenceScores

Le score de confiance de sentiment entre 0 et 1 pour la phrase pour toutes les classes.

length
  • integer

Longueur de la phrase.

offset
  • integer

Décalage de phrase à partir du début du document.

sentiment

Sentiment prédit pour la phrase.

targets

Tableau de cibles de phrase pour la phrase.

text
  • string

Texte de la phrase.

SentenceSentimentValue

Sentiment prédit pour la phrase.

Name Type Description
negative
  • string
neutral
  • string
positive
  • string

SentenceTarget

Name Type Description
confidenceScores

Cibler les scores de confiance de la cible dans la phrase.

length
  • integer

Longueur de la cible.

offset
  • integer

Offset cible à partir du début de la phrase.

relations

Tableau des objets d’évaluation ou cibles associés à la cible.

sentiment

Sentiment ciblé dans la phrase.

text
  • string

Texte cible détecté.

SentimentConfidenceScorePerLabel

Représente les scores de confiance entre 0 et 1 dans toutes les classes de sentiments : positif, neutre, négatif.

Name Type Description
negative
  • number
neutral
  • number
positive
  • number

SentimentResponse

Name Type Description
documents

Analyse des sentiments par document.

errors

Erreurs par ID de document.

modelVersion
  • string

Ce champ indique quel modèle est utilisé pour le calcul de score.

statistics

Si showStats = true a été spécifié dans la demande, ce champ contient des informations sur la charge utile de la demande.

StringIndexType

Name Type Description
TextElements_v8
  • string

Les valeurs de décalage et de longueur retournées correspondent aux TextElement (clusters graphemes et graphèmes) qui confirment la norme Unicode 8.0.0. Utilisez cette option si votre application est écrite dans .NET Framework ou .Net Core et que vous utiliserez StringInfo.

UnicodeCodePoint
  • string

Les valeurs de décalage et de longueur retournées correspondent aux points de code Unicode. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple Python.

Utf16CodeUnit
  • string

Les valeurs de décalage et de longueur retournées correspondent aux unités de code UTF-16. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple Java, JavaScript.

TargetConfidenceScoreLabel

Représente les scores de confiance dans toutes les classes de sentiment : positif, neutre, négatif.

Name Type Description
negative
  • number
positive
  • number

TargetRelation

Name Type Description
ref
  • string

Pointeur JSON indiquant l’objet lié.

relationType

Type associé à la cible.

TargetRelationType

Type associé à la cible.

Name Type Description
assessment
  • string
target
  • string

TextAnalyticsError

Name Type Description
code

Code d’erreur.

details

Détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.

innererror

L’erreur interne contient des informations plus spécifiques.

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur.

TextAnalyticsWarning

Name Type Description
code

Code d’erreur.

message
  • string

Message d'avertissement.

targetRef
  • string

Référence de pointeur JSON indiquant l’objet cible.

TokenSentimentValue

Sentiment ciblé dans la phrase.

Name Type Description
mixed
  • string
negative
  • string
positive
  • string

WarningCodeValue

Code d’erreur.

Name Type Description
DocumentTruncated
  • string
LongWordsInDocument
  • string