Method: documents.annotateText

Un metodo pratico che fornisce tutte le funzionalità in un'unica chiamata.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "document": {
    object (Document)
  },
  "features": {
    object (Features)
  },
  "encodingType": enum (EncodingType)
}
Campi
document

object (Document)

Obbligatorio. Inserisci il documento.

features

object (Features)

Obbligatorio. Le funzionalità abilitate.

encodingType

enum (EncodingType)

Il tipo di codifica utilizzato dall'API per calcolare gli offset.

Corpo della risposta

Il messaggio di risposta per le annotazioni di testo.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

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

object (Sentence)

Frasi nel documento di input. Viene compilato se l'utente attiva AnnotateTextRequest.Features.extract_document_sentiment.

entities[]

object (Entity)

Entità, insieme alle relative informazioni semantiche, nel documento di input. Viene compilato se l'utente attiva AnnotateTextRequest.Features.extract_entities o AnnotateTextRequest.Features.extract_entity_sentiment.

documentSentiment

object (Sentiment)

Il sentiment complessivo del documento. Viene compilato se l'utente attiva AnnotateTextRequest.Features.extract_document_sentiment.

languageCode

string

La lingua del testo, che corrisponderà alla lingua specificata nella richiesta o, se non specificata, alla lingua rilevata automaticamente. Per ulteriori dettagli, consulta il campo [Document.language][].

categories[]

object (ClassificationCategory)

Categorie identificate nel documento di input.

moderationCategories[]

object (ClassificationCategory)

Categorie dannose e sensibili identificate nel documento di input.

languageSupported

boolean

Indica se la lingua è supportata ufficialmente da tutte le funzionalità richieste. L'API potrebbe comunque restituire una risposta quando la lingua non è supportata, ma si tratta di un servizio secondo il criterio del "best effort".

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

Funzionalità

Tutte le funzionalità disponibili. Se imposti ciascuna su true, verrà attivata l'analisi specifica per l'input.

Rappresentazione JSON
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
Campi
extractEntities

boolean

Facoltativo. Estrarre le entità.

extractDocumentSentiment

boolean

Facoltativo. Estrai il sentiment a livello di documento.

classifyText

boolean

Facoltativo. Classifica l'intero documento in categorie.

moderateText

boolean

Facoltativo. Modera il documento per individuare contenuti dannosi e sensibili.