Method: documents.annotateText

Méthode pratique fournissant toutes les fonctionnalités en un seul appel.

Requête HTTP

POST https://language.googleapis.com/v2/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)

Obligatoire. Document d'entrée.
features

object (Features)

Obligatoire. Caractéristiques activées.
encodingType

enum (EncodingType)

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

Corps de la réponse

Message de réponse des annotations textuelles.

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

Représentation JSON 
{
  "sentences": [
    {
      object (Sentence)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "languageCode": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageSupported": boolean
}
Champs
sentences[]

object (Sentence)

Phrases identifiées dans le document d'entrée. Champ renseigné si l'utilisateur active AnnotateTextRequest.Features.extract_document_sentiment.
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 ou AnnotateTextRequest.Features.extract_entity_sentiment.
documentSentiment

object (Sentiment)

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

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 le champ [Document.language][].
categories[]

object (ClassificationCategory)

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

object (ClassificationCategory)

Catégories nuisibles et sensibles identifiées dans le document d'entrée.
languageSupported

boolean

Indique si la langue est officiellement prise en charge par toutes les fonctionnalités demandées. L'API peut toujours renvoyer une réponse lorsque la langue n'est pas prise en charge, mais dans la mesure du possible.

Champs d'application 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 fonctionnalités disponibles Définir l'une de ces valeurs sur "true" active l'analyse associée sur l'entrée.

Représentation JSON 
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
Champs
extractEntities

boolean

Facultatif. extraire des entités textuelles ;
extractDocumentSentiment

boolean

Facultatif. Extraire les sentiments au niveau du document.
classifyText

boolean

Facultatif. Classer l'intégralité du document en catégories.
moderateText

boolean

Facultatif. Modérer le document pour les catégories nuisibles et sensibles.