Package google.cloud.language.v2

Índice

LanguageService

Fornece operações de análise de texto, como análise de sentimento e reconhecimento de entidades.

AnalyzeEntities

rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse)

Encontra entidades nomeadas (atualmente, nomes próprios e substantivos comuns) no texto com tipos de entidade, probabilidade, referências a cada entidade e outras propriedades.

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

rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse)

Analisa o sentimento do texto fornecido.

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

rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse)

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

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

rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse)

Classifica um documento em categorias.

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

rpc ModerateText(ModerateTextRequest) returns (ModerateTextResponse)

Modera um documento em categorias nocivas e sensíveis.

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.

AnalyzeEntitiesRequest

A mensagem da solicitação de análise de entidade.

Campos
document

Document

Obrigatório. Documento de entrada.
encoding_type

EncodingType

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

AnalyzeEntitiesResponse

A mensagem de resposta da análise da entidade.

Campos
entities[]

Entity

As entidades reconhecidas no documento de entrada.
language_code

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

bool

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

AnalyzeSentimentRequest

A mensagem da solicitação de análise de sentimento.

Campos
document

Document

Obrigatório. Documento de entrada.
encoding_type

EncodingType

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

AnalyzeSentimentResponse

A mensagem de resposta da análise do sentimento.

Campos
document_sentiment

Sentiment

O sentimento geral do documento de entrada.
language_code

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

Sentence

O sentimento de todas as frases no documento.
language_supported

bool

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

AnnotateTextRequest

A mensagem de solicitação para a API de anotação de texto, que pode realizar vários tipos de análise em uma única chamada.

Campos
document

Document

Obrigatório. Documento de entrada.
features

Features

Obrigatório. Os recursos ativados.
encoding_type

EncodingType

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

Recursos

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

Campos
extract_entities

bool

Opcional. extrair entidades;
extract_document_sentiment

bool

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

bool

Opcional. Classificar o documento completo em categorias.
moderate_text

bool

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

AnnotateTextResponse

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

Campos
sentences[]

Sentence

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

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

Sentiment

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

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

ClassificationCategory

Categorias identificadas no documento de entrada.
moderation_categories[]

ClassificationCategory

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

bool

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.

ClassificationCategory

Representa uma categoria retornada do classificador de texto.

Campos
name

string

O nome da categoria que representa o documento.
confidence

float

A confiança do classificador da categoria. O número representa o nível de certeza do classificador de que a categoria representa o texto fornecido.
severity

float

Opcional. A gravidade da categoria no classificador. Isso só está presente quando a ModerateTextRequest.ModelVersion está definida como MODEL_VERSION_2 e a categoria correspondente tem uma pontuação de gravidade.

ClassifyTextRequest

A mensagem da solicitação de classificação de documento.

Campos
document

Document

Obrigatório. Documento de entrada.

ClassifyTextResponse

A mensagem de resposta da classificação de documentos.

Campos
categories[]

ClassificationCategory

Categorias que representam o documento de entrada.
language_code

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

bool

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

Documento

Representa a entrada para métodos da API.

Campos
type

Type

Obrigatório. Se o tipo não estiver definido ou for TYPE_UNSPECIFIED, retorna um erro INVALID_ARGUMENT.
language_code

string

Opcional. O idioma do documento (se não especificado, o idioma é automaticamente detectado). Os códigos de idioma ISO e BCP-47 são aceitos.Veja em
Suporte de idioma a lista de idiomas atualmente compatíveis para cada método de API. Se o idioma (especificado pelo autor da chamada ou detectado automaticamente) não for compatível com o método API chamado, um erro INVALID_ARGUMENT será retornado.
Campo de união source. A origem do documento: uma string com o conteúdo ou um URI do Google Cloud Storage. source pode ser apenas de um dos tipos a seguir:
content

string

O conteúdo da entrada em formato de string. Os registros de auditoria do Cloud estão isentos, porque são baseados nos dados do usuário.
gcs_content_uri

string

O URI do Google Cloud Storage, onde o conteúdo do arquivo está localizado. Esse URI precisa ter o formato: gs://bucket_name/object_name. Para saber mais, consulte https://cloud.google.com/storage/docs/reference-uris. OBSERVAÇÃO: o controle de versão de objeto do Cloud Storage não é aceito.

Tipo

O enum de tipos de documento.

Enums
TYPE_UNSPECIFIED O tipo de conteúdo não é especificado.
PLAIN_TEXT Texto simples
HTML HTML

EncodingType

Representa a codificação de texto que o autor da chamada usa para processar a saída. É recomendável fornecer um EncodingType porque a API fornece os deslocamentos iniciais para várias saídas, como tokens e referências, e as linguagens que usam diferentes codificações de texto nativamente podem acessá-los de forma diferente.

Enums
NONE Se EncodingType não for especificado, as informações dependentes de codificação (como begin_offset) serão definidas em -1.
UTF8 As informações dependentes de codificação (como begin_offset) são calculadas com base na codificação UTF-8 da entrada. C++ e Go são exemplos de linguagens que usam essa codificação nativamente.
UTF16 As informações dependentes de codificação (como begin_offset) são calculadas com base na codificação UTF-16 da entrada. Java e JavaScript são exemplos de linguagem que usam essa codificação nativamente.
UTF32 As informações dependentes de codificação (como begin_offset) são calculadas com base na codificação UTF-32 da entrada. O Python é um exemplo de linguagem que usa essa codificação nativamente.

Entity

Representa uma frase no texto que é uma entidade conhecida, como uma pessoa, uma organização ou um local. A API associa informações, como probabilidade e menções, a entidades.

Campos
name

string

O nome representativo da entidade.
type

Type

O tipo de entidade.
metadata

map<string, string>

Metadados associados à entidade.

Para os metadados associados a outros tipos de entidade, consulte a tabela "Tipo" abaixo.
mentions[]

EntityMention

As referências à entidade no documento de entrada. Atualmente, a API é compatível com referências a nomes próprios.
sentiment

Sentiment

Em chamadas para AnalyzeEntitySentimentRequest ou se AnnotateTextRequest.Features.extract_entity_sentiment estiver definido como verdadeiro, esse campo conterá o sentimento agregado expresso para a entidade no documento fornecido.

Tipo

O tipo de entidade. A tabela abaixo lista os campos associados a entidades com metadados diferentes.

Enums
UNKNOWN Desconhecido
PERSON Pessoa
LOCATION Local
ORGANIZATION Organização
EVENT Evento
WORK_OF_ART Obra de arte
CONSUMER_GOOD Produto de consumo
OTHER Outros tipos de entidades
PHONE_NUMBER

Número de telefone

Os metadados listam o número de telefone, formatado de acordo com a convenção local, além de outros elementos que aparecem no texto:

  • number: o número real, dividido em seções de acordo com a convenção local
  • national_prefix: código de país, se detectado
  • area_code: código de região ou área, se detectado
  • extension: extensão de telefone (a ser discada após a conexão), se detectada
ADDRESS

Endereço

Os metadados identificam o número da rua e a localidade, além dos outros elementos exibidos no texto:

  • street_number - Número do endereço
  • locality - Cidade ou município
  • street_name: nome da rua/rota, se detectado
  • postal_code: CEP, se detectado
  • country: país, se detectado
  • broad_region: área administrativa, como o estado, se detectado
  • narrow_region: área administrativa menor, como condado, se detectada
  • sublocality - usado em endereços asiáticos para marcar um distrito dentro de uma cidade, se detectado
DATE

Data

Os metadados identificam os componentes da data:

  • year: ano de quatro dígitos, se detectado
  • month - número de dois dígitos, se detectado
  • day: número de dois dígitos, se detectado
NUMBER

Número

Os metadados são os números em si.
PRICE

Preço

Os metadados identificam value e currency.

EntityMention

Representa uma referência a uma entidade no texto. Atualmente, as referências a nomes próprios são compatíveis.

Campos
text

TextSpan

O texto da referência.
type

Type

O tipo de referência à entidade.
sentiment

Sentiment

Em chamadas para AnalyzeEntitySentimentRequest ou se AnnotateTextRequest.Features.extract_entity_sentiment estiver definido como verdadeiro, esse campo conterá o sentimento expresso para a referência da entidade no documento fornecido.
probability

float

Pontuação de probabilidade associada à entidade.

A pontuação mostra a probabilidade de a menção de entidade ser o tipo de entidade. A pontuação está no intervalo (0, 1].

Tipo

Os tipos de referência compatíveis.

Enums
TYPE_UNKNOWN Desconhecido
PROPER Nome próprio
COMMON Substantivo comum (ou composto)

ModerateTextRequest

A mensagem da solicitação de moderação de documentos.

Campos
document

Document

Obrigatório. Documento de entrada.
model_version

ModelVersion

Opcional. A versão do modelo a ser usada para ModerateText.

ModelVersion

A versão do modelo a ser usada para ModerateText.

Enums
MODEL_VERSION_UNSPECIFIED A versão padrão do modelo.
MODEL_VERSION_1 Use o modelo v1, que é usado por padrão quando não é fornecido. O modelo v1 só retorna a pontuação de probabilidade (confiança) para cada categoria.
MODEL_VERSION_2 Use o modelo v2. O modelo v2 só retorna a pontuação de probabilidade (confiança) para cada categoria e a pontuação de gravidade para um subconjunto das categorias.

ModerateTextResponse

A mensagem de resposta da moderação de documentos.

Campos
moderation_categories[]

ClassificationCategory

Categorias nocivas e sensíveis que representam o documento de entrada.
language_code

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

bool

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

Frase

Representa uma frase no documento de entrada.

Campos
text

TextSpan

O texto da frase.
sentiment

Sentiment

Em chamadas para AnalyzeSentimentRequest ou se AnnotateTextRequest.Features.extract_document_sentiment estiver definido como verdadeiro, esse campo conterá o sentimento da frase.

Sentimento

Representa o sentimento associado a todo o texto ou a entidades no texto.

Campos
magnitude

float

Um número não negativo no intervalo [0, +inf] que representa a magnitude absoluta do sentimento independentemente da pontuação (positiva ou negativa).
score

float

Sentimento entre -1,0 (sentimento negativo) e 1,0 (sentimento positivo).

TextSpan

Representa um intervalo de texto no documento de entrada.

Campos
content

string

O conteúdo do intervalo de texto, que é uma substring do documento.
begin_offset

int32

A API calcula o deslocamento inicial do conteúdo no documento original de acordo com o EncodingType especificado na solicitação da API.