Pacote google.cloud.language.v1

Í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, saliência, referências a cada entidade e outras propriedades.

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.

AnalyzeEntitySentiment

rpc AnalyzeEntitySentiment(AnalyzeEntitySentimentRequest) returns (AnalyzeEntitySentimentResponse)

Encontra entidades de maneira semelhante a AnalyzeEntities no texto e analisa o sentimento associado a cada entidade e em referências a ela.

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.

AnalyzeSentiment

rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse)

Analisa o sentimento do texto fornecido.

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.

AnalyzeSyntax

rpc AnalyzeSyntax(AnalyzeSyntaxRequest) returns (AnalyzeSyntaxResponse)

Analisa a sintaxe do texto e fornece limites de frase e tokenização com tags de classe gramatical, árvores de dependência e outras propriedades.

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.

AnnotateText

rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse)

Um método de conveniência que fornece todos os recursos de analyzeSentiment, analyzeEntities e analyzeSyntax em uma chamada.

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.

ClassifyText

rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse)

Classifica um documento em categorias.

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.

AnalyzeEntitiesRequest

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

Campos
document

Document

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

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.

AnalyzeEntitySentimentRequest

A mensagem da solicitação de análise de sentimento no nível da entidade.

Campos
document

Document

Documento de entrada.

encoding_type

EncodingType

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

AnalyzeEntitySentimentResponse

A mensagem de resposta da análise de sentimento no nível da entidade.

Campos
entities[]

Entity

As entidades reconhecidas no documento de entrada com sentimentos associados.

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.

AnalyzeSentimentRequest

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

Campos
document

Document

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

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.

AnalyzeSyntaxRequest

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

Campos
document

Document

Documento de entrada.

encoding_type

EncodingType

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

AnalyzeSyntaxResponse

A mensagem de resposta da análise de sintaxe.

Campos
sentences[]

Sentence

Frases no documento de entrada.

tokens[]

Token

Tokens e suas informações sintáticas no documento de entrada.

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.

AnnotateTextRequest

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

Campos
document

Document

Documento de entrada.

features

Features

Os recursos ativados.

encoding_type

EncodingType

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

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.

Campos
extract_syntax

bool

Extrair informações de sintaxe.

extract_entities

bool

Extrair entidades.

extract_document_sentiment

bool

Extrair o sentimento no nível do documento.

extract_entity_sentiment

bool

Extrair entidades e os sentimentos associados.

classify_text

bool

Classificar o documento completo em categorias.

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

tokens[]

Token

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

entities[]

Entity

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

document_sentiment

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

ClassificationCategory

Categorias identificadas no documento de entrada.

ClassificationCategory

Representa uma categoria retornada do classificador de texto.

Campos
name

string

É o nome da categoria que representa o documento, a partir da taxonomia predefinida.

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.

ClassifyTextRequest

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

Campos
document

Document

Documento de entrada.

ClassifyTextResponse

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

Campos
categories[]

ClassificationCategory

Categorias que representam o documento de entrada.

DependencyEdge

Representa as informações da árvore de análise de dependência de um token. Para mais informações sobre rótulos de dependência, consulte http://www.aclweb.org/anthology/P13-2017 (conteúdo em inglês).

Campos
head_token_index

int32

Representa a parte superior do token na árvore de dependências. É o índice do token que tem um arco na direção dele. O índice é a posição do token na matriz de tokens retornados pelo método API. Se for um token de raiz, o head_token_index é seu próprio índice.

label

Label

O rótulo de análise do token.

Label

O enum de rótulo de análise do token.

Enums
UNKNOWN Desconhecido
ABBREV Modificador de abreviatura
ACOMP Complemento adjetivo
ADVCL Modificador de oração adverbial
ADVMOD Modificador adverbial
AMOD Modificador adjetival de um sintagma nominal
APPOS Modificador apositivo de um sintagma nominal
ATTR Atributo dependente de um verbo de ligação
AUX Verbo auxiliar (não-principal)
AUXPASS Auxiliar passivo
CC Conjunção coordenativa
CCOMP Complemento oracional de um verbo ou adjetivo
CONJ Conjunção
CSUBJ Sujeito da oração
CSUBJPASS Sujeito passivo da oração
DEP Dependência (impossível determinar)
DET Determinante
DISCOURSE Discurso
DOBJ Objeto direto
EXPL Expletivo
GOESWITH Parte de (parte de uma palavra em um texto mal editado)
IOBJ Objeto indireto
MARK Marcador (palavra que introduz uma oração subordinada)
MWE Expressão de várias palavras
MWV Expressão verbal de várias palavras
NEG Modificador de negação
NN Modificador de substantivo composto
NPADVMOD Sintagma nominal usado como modificador adverbial
NSUBJ Sujeito nominal
NSUBJPASS Sujeito nominal passivo
NUM Modificador numérico de um substantivo
NUMBER Elemento de um número composto
P Sinal de pontuação
PARATAXIS Relação de parataxe
PARTMOD Modificador particípio
PCOMP O complemento de uma preposição é uma oração
POBJ Objeto de uma preposição
POSS Modificador de posse
POSTNEG Partícula negativa pós-verbal
PRECOMP Complemento do predicado
PRECONJ Preconjunção
PREDET Predeterminante
PREF Prefixo
PREP Modificador de preposição
PRONL A relação entre um verbo e um morfema verbal
PRT Partícula
PS Marcador associativo ou possessivo
QUANTMOD Modificador de oração quantificadora
RCMOD Modificador de oração relativa
RCMODREL Complementador em uma oração relativa
RDROP Elipse sem predicado anterior
REF Referente
REMNANT Remanescente
REPARANDUM Reparandum
ROOT Raiz
SNUM Sufixo especificando uma unidade de número
SUFF Sufixo
TMOD Modificador temporal
TOPIC Marcador de tópico
VMOD Oração iniciada por uma forma infinita do verbo que modifica um substantivo
VOCATIVE Vocativo
XCOMP Complemento da oração aberto
SUFFIX Sufixo do nome
TITLE Título do nome
ADVPHMOD Modificador de locução adverbial
AUXCAUS Auxiliar causativo
AUXVV Auxiliar
DTMOD Rentaishi (modificador prenominal)
FOREIGN Palavras estrangeiras
KW Palavra-chave
LIST Lista de cadeias de itens comparáveis
NOMC Oração nominal
NOMCSUBJ Sujeito da oração nominal
NOMCSUBJPASS Passivo da oração nominal
NUMC Composto de modificador numérico
COP Verbo de ligação
DISLOCATED Relação deslocada (para elementos topicalizados)
ASP Marcador de aspecto
GMOD Modificador genitivo
GOBJ Objeto genitivo
INFMOD Modificador de infinitivo
MES Medida
NCOMP Complemento nominal de um substantivo

Document

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

string

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 saliência e referências, a entidades.

Campos
name

string

O nome representativo da entidade.

type

Type

O tipo de entidade.

metadata

map<string, string>

Metadados associados à entidade.

Para a maioria dos tipos de entidade, os metadados são um URL da Wikipédia (wikipedia_url) e um MID do Mapa de informações (mid), se estiverem disponíveis. Para os metadados associados a outros tipos de entidade, consulte a tabela "Tipo" abaixo.

salience

float

A pontuação de saliência associada à entidade no intervalo [0, 1.0].

A pontuação de saliência de uma entidade fornece informações sobre a importância ou a centralidade dela para o texto completo do documento. As pontuações próximas a 0 são menos salientes, enquanto as pontuações mais próximas a 1,0 são altamente relevantes.

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 [AnalyzeEntitySentiment][] 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. Para a maioria dos tipos de entidade, os metadados associados são um URL da Wikipédia (wikipedia_url) e um MID do Mapa de informações (mid). 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 [AnalyzeEntitySentiment][] 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.

Tipo

Os tipos de referência compatíveis.

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

PartOfSpeech

Representa as informações de classe gramatical de um token, conforme definidas em http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf (conteúdo em inglês).

Campos
tag

Tag

A tag de classe gramatical.

aspect

Aspect

O aspecto gramatical.

case

Case

O caso gramatical.

form

Form

A classe gramatical.

gender

Gender

O gênero gramatical.

mood

Mood

O modo verbal.

number

Number

O número gramatical.

person

Person

A pessoa gramatical.

proper

Proper

A adequação gramatical.

reciprocity

Reciprocity

A reciprocidade gramatical.

tense

Tense

O tempo gramatical.

voice

Voice

A voz gramatical.

Aspect

A característica de um verbo que expressa fluxo de tempo durante um evento.

Enums
ASPECT_UNKNOWN O aspecto não é aplicável no idioma analisado ou não está previsto.
PERFECTIVE Perfeito
IMPERFECTIVE Imperfeito
PROGRESSIVE Progressivo

Case

A função gramatical executada por um substantivo ou pronome em uma locução, oração ou frase. Em alguns idiomas, outras classes gramaticais, como adjetivo e determinante, são conjugadas de acordo com o substantivo.

Enums
CASE_UNKNOWN O caso não é aplicável no idioma analisado ou não está previsto.
ACCUSATIVE Acusativo
ADVERBIAL Adverbial
COMPLEMENTIVE Complementar
DATIVE Dativo
GENITIVE Genitivo
INSTRUMENTAL Instrumental
LOCATIVE Locativo
NOMINATIVE Nominativo
OBLIQUE Oblíquo
PARTITIVE Partitivo
PREPOSITIONAL Preposicional
REFLEXIVE_CASE Reflexivo
RELATIVE_CASE Relativo
VOCATIVE Vocativo

Form

Dependendo do idioma, a classe gramatical pode classificar diferentes formas de verbos, adjetivos, advérbios etc. Por exemplo, ela pode categorizar os sufixos de verbos e adjetivos flexionados ou distinguir entre formas curtas e longas de adjetivos e particípios.

Enums
FORM_UNKNOWN A classe não é aplicável no idioma analisado ou não está prevista.
ADNOMIAL Adnominal
AUXILIARY Auxiliar
COMPLEMENTIZER Complemento
FINAL_ENDING Sufixo
GERUND Gerúndio
REALIS Indicativo
IRREALIS Subjuntivo
SHORT Forma abreviada
LONG Forma longa
ORDER Forma de ordem
SPECIFIC Forma específica

Gender

Classes de gênero de substantivos refletidos no comportamento de palavras associadas.

Enums
GENDER_UNKNOWN O gênero não é aplicável no idioma analisado ou não está previsto.
FEMININE Feminino
MASCULINE Masculino
NEUTER Neutro

Mood

A característica gramatical dos verbos, usada para demonstrar modalidade e atitude.

Enums
MOOD_UNKNOWN O modo não é aplicável no idioma analisado ou não está previsto.
CONDITIONAL_MOOD Condicional
IMPERATIVE Imperativo
INDICATIVE Indicativo
INTERROGATIVE Interrogativo
JUSSIVE Jussivo
SUBJUNCTIVE Subjuntivo

Number

Distinções de número.

Enums
NUMBER_UNKNOWN O número não é aplicável no idioma analisado ou não está previsto.
SINGULAR Singular
PLURAL Plural
DUAL Duplo

Person

A distinção entre falante, segunda pessoa, terceira pessoa etc.

Enums
PERSON_UNKNOWN A pessoa não é aplicável no idioma analisado ou não está prevista.
FIRST Primeira pessoa
SECOND Segunda pessoa
THIRD Terceira pessoa
REFLEXIVE_PERSON Reflexivo

Proper

Essa categoria indica se o token faz parte de um nome próprio.

Enums
PROPER_UNKNOWN O nome próprio não é aplicável no idioma analisado ou não está previsto.
PROPER Nome próprio
NOT_PROPER Substantivo comum

Reciprocity

Características recíprocas de um pronome.

Enums
RECIPROCITY_UNKNOWN A reciprocidade não é aplicável no idioma analisado ou não está prevista.
RECIPROCAL Recíproco
NON_RECIPROCAL Não recíproco

Tag

O enum das tags de classe gramatical.

Enums
UNKNOWN Desconhecido
ADJ Adjetivo
ADP Adposição (preposição e posposição)
ADV Advérbio
CONJ Conjunção
DET Determinante
NOUN Substantivo (comum e próprio)
NUM Número cardinal
PRON Pronome
PRT Partícula ou outra palavra funcional
PUNCT Pontuação
VERB Verbo (todos os tempos e modos)
X Outros: palavras estrangeiras, erros de digitação, abreviaturas
AFFIX Afixo

Tense

Referência de tempo.

Enums
TENSE_UNKNOWN O tempo não é aplicável no idioma analisado ou não está previsto.
CONDITIONAL_TENSE Condicional
FUTURE Futuro
PAST Pretérito
PRESENT Presente
IMPERFECT Imperfeito
PLUPERFECT Mais-que-perfeito

Voice

A relação entre a ação que um verbo expressa e os participantes identificados por seus argumentos.

Enums
VOICE_UNKNOWN A voz não é aplicável no idioma analisado ou não está prevista.
ACTIVE Ativa
CAUSATIVE Causativa
PASSIVE Passiva

Sentence

Representa uma frase no documento de entrada.

Campos
text

TextSpan

O texto da frase.

sentiment

Sentiment

Em chamadas para [AnalyzeSentiment][] 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 trecho de texto de saída.

Campos
content

string

O conteúdo do texto de saída.

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.

Token

Representa o menor elemento básico sintático do texto.

Campos
text

TextSpan

O texto do token.

part_of_speech

PartOfSpeech

Tag de classe gramatical para o token.

dependency_edge

DependencyEdge

A análise da árvore de dependências do token.

lemma

string

Lema do token.