Method: documents.annotateText

Es un método conveniente que proporciona todas las funciones de análisis sintáctico, opiniones, entidades y clasificación en una sola llamada.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "document": {
    object (Document)
  },
  "features": {
    object (Features)
  },
  "encodingType": enum (EncodingType)
}
Campos
document

object (Document)

Obligatorio. Documento de entrada
features

object (Features)

Obligatorio. Las funciones habilitadas
encodingType

enum (EncodingType)

Es el tipo de codificación que usa la API para calcular los desplazamientos.

Cuerpo de la respuesta

El mensaje de respuesta de las anotaciones de texto.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

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

object (Sentence)

Son las oraciones del documento de entrada. Se propaga si el usuario habilita AnnotateTextRequest.Features.extract_syntax.
tokens[]

object (Token)

Los tokens, junto con su información sintáctica, en el documento de entrada Se propaga si el usuario habilita AnnotateTextRequest.Features.extract_syntax.
entities[]

object (Entity)

Las entidades, junto con su información semántica, en el documento de entrada Se propaga si el usuario habilita AnnotateTextRequest.Features.extract_entities.
documentSentiment

object (Sentiment)

Es la opinión general del documento. Se propaga si el usuario habilita AnnotateTextRequest.Features.extract_document_sentiment.
language

string

Es el idioma del texto, que será el mismo que el idioma especificado en la solicitud o, si no se especifica, el idioma detectado automáticamente. Consulta el campo Document.language para obtener más información.
categories[]

object (ClassificationCategory)

Son las categorías identificadas en el documento de entrada.
moderationCategories[]

object (ClassificationCategory)

Categorías dañinas y sensibles identificadas en el documento de entrada

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Funciones

Todas las funciones disponibles para el análisis de opiniones, sintaxis y semántica. Si estableces cada uno como verdadero, se habilitará ese análisis específico para la entrada.

Representación JSON 
{
  "extractSyntax": boolean,
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "extractEntitySentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean,
  "classificationModelOptions": {
    object (ClassificationModelOptions)
  }
}
Campos
extractSyntax

boolean

Extrae información de sintaxis.
extractEntities

boolean

Extraer entidades
extractDocumentSentiment

boolean

Extrae la opinión a nivel del documento.
extractEntitySentiment

boolean

Extrae entidades y su opinión asociada.
classifyText

boolean

Clasifica el documento completo en categorías. Si es así, la API usará el modelo predeterminado que clasifica en una taxonomía predefinida.
moderateText

boolean

Modera el documento en busca de categorías dañinas y sensibles.
classificationModelOptions

object (ClassificationModelOptions)

Opcional. Las opciones de modelos que se usarán para la clasificación Si no se especifican, se usan las opciones de la versión 1 de forma predeterminada. Solo se usa si classifyText se establece como verdadero.