Package google.cloud.language.v2

Índice

LanguageService

Proporciona operaciones de análisis de texto, como el análisis de opiniones y el reconocimiento de entidades.

AnalyzeEntities

rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse)

Encuentra entidades nombradas (actualmente, nombres propios y sustantivos comunes) en el texto, junto con los tipos de entidades, la probabilidad, las menciones de cada entidad y otras propiedades.

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.
AnalyzeSentiment

rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse)

Analiza el sentimiento del texto proporcionado.

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.
AnnotateText

rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse)

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

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.
ClassifyText

rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse)

Clasifica un documento en categorías.

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.
ModerateText

rpc ModerateText(ModerateTextRequest) returns (ModerateTextResponse)

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

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.

AnalyzeEntitiesRequest

El mensaje de solicitud de análisis de entidades.

Campos
document

Document

Obligatorio. Documento de entrada
encoding_type

EncodingType

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

AnalyzeEntitiesResponse

El mensaje de respuesta del análisis de entidades.

Campos
entities[]

Entity

Las entidades reconocidas en el documento de entrada.
language_code

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.
language_supported

bool

Indica si el idioma es compatible oficialmente. 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.

AnalyzeSentimentRequest

El mensaje de solicitud de análisis de opiniones

Campos
document

Document

Obligatorio. Documento de entrada
encoding_type

EncodingType

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

AnalyzeSentimentResponse

El mensaje de respuesta del análisis de opiniones.

Campos
document_sentiment

Sentiment

Es la opinión general del documento de entrada.
language_code

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.
sentences[]

Sentence

Es la opinión de todas las oraciones del documento.
language_supported

bool

Indica si el idioma es compatible oficialmente. 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.

AnnotateTextRequest

Es el mensaje de solicitud de la API de TextAnnotation, que puede realizar varios tipos de análisis en una sola llamada.

Campos
document

Document

Obligatorio. Documento de entrada
features

Features

Obligatorio. Las funciones habilitadas
encoding_type

EncodingType

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

Funciones

Todas las funciones disponibles Si estableces cada uno como verdadero, se habilitará ese análisis específico para la entrada.

Campos
extract_entities

bool

Opcional. Extraer entidades
extract_document_sentiment

bool

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

bool

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

bool

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

AnnotateTextResponse

El mensaje de respuesta de las anotaciones de texto.

Campos
sentences[]

Sentence

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

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.
document_sentiment

Sentiment

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

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[]

ClassificationCategory

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

ClassificationCategory

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

bool

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.

ClassificationCategory

Representa una categoría que muestra el clasificador de texto.

Campos
name

string

Es el nombre de la categoría que representa el documento.
confidence

float

Es la confianza del clasificador en la categoría. El número representa qué tan seguro está el clasificador de que esta categoría representa el texto determinado.
severity

float

Opcional. La gravedad de la categoría del clasificador Solo está presente cuando ModerateTextRequest.ModelVersion se establece en MODEL_VERSION_2 y la categoría correspondiente tiene una puntuación de gravedad.

ClassifyTextRequest

El mensaje de solicitud de clasificación de documentos

Campos
document

Document

Obligatorio. Documento de entrada

ClassifyTextResponse

El mensaje de respuesta de la clasificación de documentos.

Campos
categories[]

ClassificationCategory

Categorías que representan el documento de entrada.
language_code

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.
language_supported

bool

Indica si el idioma es compatible oficialmente. 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.

Documento

Representa la entrada a los métodos de la API.

Campos
type

Type

Obligatorio. Si el tipo no está configurado o es TYPE_UNSPECIFIED, se muestra un error INVALID_ARGUMENT.
language_code

string

Opcional. Es el idioma del documento (si no se especifica, el idioma se detecta automáticamente). Se aceptan los códigos de idioma ISO y BCP-47.
En Idiomas compatibles, se enumeran los idiomas admitidos actualmente para cada método de la API. Si el método de la API llamado no admite el idioma (especificado por el emisor o detectado automáticamente), se muestra un error INVALID_ARGUMENT.
Campo de unión source. Es la fuente del documento: una cadena que contiene el contenido o un URI de Google Cloud Storage. source puede ser solo uno de los siguientes:
content

string

Es el contenido de la entrada en formato de cadena. Los registros de auditoría de Cloud están exentos, ya que se basan en datos del usuario.
gcs_content_uri

string

Es el URI de Google Cloud Storage donde se encuentra el contenido del archivo. Este URI debe tener el formato gs://bucket_name/object_name. Para obtener más detalles, consulta https://cloud.google.com/storage/docs/reference-uris. NOTA: No se admite el control de versiones de objetos de Cloud Storage.

Tipo

La enumeración de tipos de documentos.

Enums
TYPE_UNSPECIFIED No se especificó el tipo de contenido.
PLAIN_TEXT Texto sin formato
HTML HTML

EncodingType

Representa la codificación de texto que usa el llamador para procesar el resultado. Se recomienda proporcionar un EncodingType porque la API proporciona los desplazamientos iniciales para varias salidas, como tokens y menciones, y los idiomas que usan de forma nativa diferentes codificaciones de texto pueden acceder a los desplazamientos de manera diferente.

Enums
NONE Si no se especifica EncodingType, la información dependiente de la codificación (como begin_offset) se establecerá en -1.
UTF8 La información dependiente de la codificación (como begin_offset) se calcula en función de la codificación UTF-8 de la entrada. C++ y Go son ejemplos de lenguajes que usan esta codificación de forma nativa.
UTF16 La información dependiente de la codificación (como begin_offset) se calcula en función de la codificación UTF-16 de la entrada. Java y JavaScript son ejemplos de lenguajes que usan esta codificación de forma nativa.
UTF32 La información dependiente de la codificación (como begin_offset) se calcula en función de la codificación UTF-32 de la entrada. Python es un ejemplo de un lenguaje que usa esta codificación de forma nativa.

Entidad

Representa una frase en el texto que es una entidad conocida, como una persona, una organización o una ubicación. La API asocia información, como la probabilidad y las menciones, con las entidades.

Campos
name

string

Es el nombre del representante de la entidad.
type

Type

Es el tipo de entidad.
metadata

map<string, string>

Son los metadatos asociados con la entidad.

Para ver los metadatos asociados con otros tipos de entidades, consulta la tabla de tipos que aparece a continuación.
mentions[]

EntityMention

Las menciones de esta entidad en el documento de entrada. Actualmente, la API admite menciones de nombres propios.
sentiment

Sentiment

En el caso de las llamadas a AnalyzeEntitySentimentRequest o si AnnotateTextRequest.Features.extract_entity_sentiment se establece como verdadero, este campo contendrá el sentimiento agregado expresado para esta entidad en el documento proporcionado.

Tipo

Es el tipo de entidad. En la siguiente tabla, se enumeran los campos asociados para las entidades que tienen metadatos diferentes.

Enums
UNKNOWN Desconocido
PERSON Persona
LOCATION Ubicación
ORGANIZATION Organización
EVENT Evento
WORK_OF_ART Obra de arte
CONSUMER_GOOD Producto para usuarios finales
OTHER Otros tipos de entidades
PHONE_NUMBER

Número de teléfono

En los metadatos, se indica el número de teléfono, con el formato que corresponda según la convención local, además de los elementos adicionales que aparezcan en el texto:

  • number: Es el número real, desglosado en secciones según la convención local.
  • national_prefix: Código de país, si se detecta
  • area_code: Código de región o área, si se detecta
  • extension: Extensión telefónica (para marcar después de la conexión), si se detecta
ADDRESS

Dirección

Los metadatos identifican el número de calle y la localidad, además de los elementos adicionales que aparecen en el texto:

  • street_number: Número de la calle
  • locality: Ciudad o pueblo
  • street_name: Nombre de la calle o ruta, si se detecta
  • postal_code: Código postal, si se detecta
  • country: País, si se detecta
  • broad_region: Área administrativa, como el estado, si se detecta
  • narrow_region: Área administrativa más pequeña, como un condado, si se detecta
  • sublocality: Se usa en direcciones asiáticas para demarcar un distrito dentro de una ciudad, si se detecta.
DATE

Fecha

Los metadatos identifican los componentes de la fecha:

  • year: Año de cuatro dígitos, si se detecta
  • month: Número de mes de dos dígitos, si se detecta
  • day: Número de día de dos dígitos, si se detecta
NUMBER

Número

Los metadatos son el número en sí.
PRICE

Precio

Los metadatos identifican value y currency.

EntityMention

Representa una mención de una entidad en el texto. Actualmente, se admiten menciones de nombres propios.

Campos
text

TextSpan

El texto de la mención.
type

Type

Es el tipo de mención de entidad.
sentiment

Sentiment

En el caso de las llamadas a AnalyzeEntitySentimentRequest o si AnnotateTextRequest.Features.extract_entity_sentiment se establece como verdadero, este campo contendrá el sentimiento expresado para esta mención de la entidad en el documento proporcionado.
probability

float

Puntuación de probabilidad asociada con la entidad.

La puntuación muestra la probabilidad de que la mención de la entidad sea el tipo de entidad. La puntuación está en el rango [0, 1].

Tipo

Los tipos de menciones admitidos

Enums
TYPE_UNKNOWN Desconocido
PROPER Nombre propio
COMMON Sustantivo común (o compuesto)

ModerateTextRequest

El mensaje de solicitud de moderación de documentos.

Campos
document

Document

Obligatorio. Ingresa el documento.
model_version

ModelVersion

Opcional. Es la versión del modelo que se usará para ModerateText.

ModelVersion

Es la versión del modelo que se usará para ModerateText.

Enums
MODEL_VERSION_UNSPECIFIED Es la versión predeterminada del modelo.
MODEL_VERSION_1 Usa el modelo v1, que se usa de forma predeterminada cuando no se proporciona. El modelo v1 solo muestra una puntuación de probabilidad (confianza) para cada categoría.
MODEL_VERSION_2 Usa el modelo v2. El modelo v2 solo muestra una puntuación de probabilidad (confianza) para cada categoría y una puntuación de gravedad para un subconjunto de las categorías.

ModerateTextResponse

El mensaje de respuesta de moderación de documentos.

Campos
moderation_categories[]

ClassificationCategory

Categorías dañinas y sensibles que representan el documento de entrada
language_code

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.
language_supported

bool

Indica si el idioma es compatible oficialmente. Es posible que la API devuelva una respuesta cuando el idioma no sea compatible, pero se hará según el criterio del mejor esfuerzo.

Oración

Representa una oración en el documento de entrada.

Campos
text

TextSpan

Es el texto de la oración.
sentiment

Sentiment

En el caso de las llamadas a AnalyzeSentimentRequest o si AnnotateTextRequest.Features.extract_document_sentiment está configurado como verdadero, este campo contendrá el sentimiento de la oración.

Opinión

Representa el sentimiento asociado con todo el texto o las entidades en el texto.

Campos
magnitude

float

Es un número no negativo en el rango [0, +inf], que representa la magnitud absoluta del sentimiento, independientemente de la puntuación (positiva o negativa).
score

float

Puntuación de opinión entre -1.0 (opinión negativa) y 1.0 (opinión positiva).

TextSpan

Representa un intervalo de texto en el documento de entrada.

Campos
content

string

Es el contenido del intervalo de texto, que es una subcadena del documento.
begin_offset

int32

La API calcula el desplazamiento inicial del contenido en el documento original según el EncodingType especificado en la solicitud a la API.