Méthode : documents.annotateText

Méthode pratique fournissant toutes les caractéristiques de syntaxe, de sentiment, d'entité et de classification dans un même appel.

Requête HTTP

POST https://language.googleapis.com/v1beta2/documents:annotateText

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 

{
  "document": {
    object(Document)
  },
  "features": {
    object(Features)
  },
  "encodingType": enum(EncodingType)
}
Champs
document

object(Document)

Document d'entrée.

features

object(Features)

Caractéristiques activées.

encodingType

enum(EncodingType)

Type d'encodage utilisé par l'API pour calculer les décalages.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Message de réponse des annotations textuelles.

Représentation JSON 

{
  "sentences": [
    {
      object(Sentence)
    }
  ],
  "tokens": [
    {
      object(Token)
    }
  ],
  "entities": [
    {
      object(Entity)
    }
  ],
  "documentSentiment": {
    object(Sentiment)
  },
  "language": string,
  "categories": [
    {
      object(ClassificationCategory)
    }
  ]
}
Champs
sentences[]

object(Sentence)

Phrases identifiées dans le document d'entrée. Champ renseigné si l'utilisateur active AnnotateTextRequest.Features.extract_syntax.

tokens[]

object(Token)

Jetons, accompagnés des informations syntaxiques correspondantes, identifiés dans le document d'entrée. Champ renseigné si l'utilisateur active AnnotateTextRequest.Features.extract_syntax.

entities[]

object(Entity)

Entités, accompagnées des informations sémantiques correspondantes, identifiées dans le document d'entrée. Champ renseigné si l'utilisateur active AnnotateTextRequest.Features.extract_entities.

documentSentiment

object(Sentiment)

Sentiment général du document. Champ renseigné si l'utilisateur active AnnotateTextRequest.Features.extract_document_sentiment.

language

string

Langue du texte, qui correspond à celle spécifiée dans la requête ou, si celle-ci est omise, à la langue détectée automatiquement. Pour en savoir plus, consultez les informations sur le champ Document.language.

categories[]

object(ClassificationCategory)

Catégories identifiées dans le document d'entrée.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Présentation de l'authentification.

Fonctionnalités

Toutes les caractéristiques disponibles pour les sentiments, la syntaxe et l'analyse sémantique. Définir l'une de ces valeurs sur "true" active l'analyse associée sur l'entrée. ID suivant : 10.

Représentation JSON 

{
  "extractSyntax": boolean,
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "extractEntitySentiment": boolean,
  "classifyText": boolean
}
Champs
extractSyntax

boolean

Extraire les informations de syntaxe.

extractEntities

boolean

Extraire les entités.

extractDocumentSentiment

boolean

Extraire les sentiments au niveau du document.

extractEntitySentiment

boolean

Extraire les entités et les sentiments associés.

classifyText

boolean

Classer l'intégralité du document en catégories. Si cette option vaut "vrai", l'API utilise le modèle par défaut, qui classe le document dans une classification prédéfinie.