Method: documents.annotateText

Um método de conveniência que fornece todos os recursos em uma chamada.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "document": {
    object (Document)
  },
  "features": {
    object (Features)
  },
  "encodingType": enum (EncodingType)
}
Campos
document

object (Document)

Obrigatório. Documento de entrada.
features

object (Features)

Obrigatório. Os recursos ativados.
encodingType

enum (EncodingType)

O tipo de codificação usado pela API para calcular os deslocamentos.

Corpo da resposta

A mensagem de resposta de anotações de texto.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "sentences": [
    {
      object (Sentence)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "languageCode": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageSupported": boolean
}
Campos
sentences[]

object (Sentence)

Frases no documento de entrada. Preenchido se o usuário ativar AnnotateTextRequest.Features.extract_document_sentiment.
entities[]

object (Entity)

Entidades e suas informações semânticas no documento de entrada. Preenchido se o usuário ativar AnnotateTextRequest.Features.extract_entities ou AnnotateTextRequest.Features.extract_entity_sentiment.
documentSentiment

object (Sentiment)

O sentimento geral do documento. Preenchido se o usuário ativar AnnotateTextRequest.Features.extract_document_sentiment.
languageCode

string

O idioma do texto, que será o mesmo especificado na solicitação ou, se não especificado, detectado automaticamente. Consulte o campo [Document.language][] para mais detalhes.
categories[]

object (ClassificationCategory)

Categorias identificadas no documento de entrada.
moderationCategories[]

object (ClassificationCategory)

Categorias nocivas e sensíveis identificadas no documento de entrada.
languageSupported

boolean

Se o idioma tem suporte oficial de todos os recursos solicitados. A API ainda pode retornar uma resposta quando o idioma não tiver suporte, mas isso vai depender da disponibilidade.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

Recursos

Todos os recursos disponíveis. Defina cada um como verdadeiro para permitir a análise específica da entrada.

Representação JSON 
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
Campos
extractEntities

boolean

Opcional. extrair entidades;
extractDocumentSentiment

boolean

Opcional. Extrair o sentimento no nível do documento.
classifyText

boolean

Opcional. Classificar o documento completo em categorias.
moderateText

boolean

Opcional. Moderar o documento para categorias nocivas e sensíveis.