Method: documents.annotateText

Es un método conveniente que proporciona todas las funciones en una sola llamada.

Solicitud HTTP

POST https://language.googleapis.com/v2/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)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "languageCode": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageSupported": boolean
}
Campos
sentences[]

object (Sentence)

Son las oraciones del documento de entrada. Se propaga si el usuario habilita AnnotateTextRequest.Features.extract_document_sentiment.
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 o AnnotateTextRequest.Features.extract_entity_sentiment.
documentSentiment

object (Sentiment)

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

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 detalles.
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
languageSupported

boolean

Indica si el idioma es compatible oficialmente con todas las funciones solicitadas. Es posible que la API aún muestre una respuesta cuando el idioma no sea compatible, pero se hará según el criterio del mejor esfuerzo.

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 Si estableces cada uno como verdadero, se habilitará ese análisis específico para la entrada.

Representación JSON 
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
Campos
extractEntities

boolean

Opcional. Extraer entidades
extractDocumentSentiment

boolean

Opcional. Extrae la opinión a nivel del documento.
classifyText

boolean

Opcional. Clasifica el documento completo en categorías.
moderateText

boolean

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