Método: documents.annotateText

Um método de conveniência que fornece todos os recursos de sintaxe, sentimento, entidade e classificação em uma chamada.

Solicitação HTTP

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

Documento de entrada.

features

object(Features)

Os recursos ativados.

encodingType

enum(EncodingType)

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

Corpo da resposta

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

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

Representação JSON

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

object(Sentence)

Frases no documento de entrada. Preenchido se o usuário ativar AnnotateTextRequest.Features.extract_syntax.

tokens[]

object(Token)

Tokens e suas informações sintáticas no documento de entrada. Preenchido se o usuário ativar AnnotateTextRequest.Features.extract_syntax.

entities[]

object(Entity)

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

documentSentiment

object(Sentiment)

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

language

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.

Escopos de autorização

Requer um dos seguintes escopos do 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 de análise sintática, semântica e de sentimento. Defina cada um como verdadeiro para permitir a análise específica da entrada. Próximo código: 4

Representação JSON

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

boolean

Extrair informações de sintaxe.

extractEntities

boolean

Extrair entidades.

extractDocumentSentiment

boolean

Extrair o sentimento no nível do documento.

extractEntitySentiment

boolean

Extrair entidades e os sentimentos associados.

classifyText

boolean

Classificar o documento completo em categorias. Se for definido como verdadeiro, a API usará o modelo padrão que se classifica como uma taxonomia predefinida.