Package google.cloud.translation.v3

Importante: para acessar o URL listado entre parênteses, é necessário se conectar à Internet. O URL é fornecido para acesso fora do ambiente isolado.

TranslationService

Fornece operações de tradução de idioma natural.

TranslateDocument
rpc TranslateDocument(TranslateDocumentRequest) returns (TranslateDocumentResponse) Traduz documentos no modo síncrono. Escopos de autorização Requer um dos seguintes escopos do OAuth: https://www.googleapis.com/auth/cloud-translation https://www.googleapis.com/auth/cloud-platform

TranslateDocumentRequest

Uma solicitação de tradução de documento.

Campos
parent	string Obrigatório. Local para fazer uma chamada regional. Formato: projects/{project-number-or-id}/locations/{location-id}. Para chamadas globais, use projects/{project-number-or-id}/locations/global ou projects/{project-number-or-id}. Um local não global é necessário para solicitações que usam modelos do AutoML ou glossários personalizados. Os modelos e glossários precisam estar na mesma região (ter o mesmo location-id). Caso contrário, um erro INVALID_ARGUMENT (400) será retornado.
source_language_code	string Opcional. O código de idioma ISO-639 do documento de entrada, se conhecido. Por exemplo, "en-US" ou "sr-Latn". Os códigos de idioma aceitos estão listados em "Suporte a idiomas". Se o idioma de origem não for especificado, a API tentará identificá-lo automaticamente e o retornará na resposta. O idioma de origem precisa ser especificado se a solicitação contiver um glossário ou um modelo personalizado.
target_language_code	string Obrigatório. O código de idioma ISO-639 a ser usado para tradução do documento de entrada, definido como um dos códigos de idioma listados em "Suporte a idiomas".
document_input_config	DocumentInputConfig Obrigatório. Configurações de entrada.
glossary_config	TranslateTextGlossaryConfig Opcional. Glossário a ser aplicado. O glossário precisa estar na mesma região (ter o mesmo location-id) que o modelo. Caso contrário, um erro INVALID_ARGUMENT (400) será retornado. A autorização requer a seguinte permissão do IAM no recurso especificado glossaryConfig: cloudtranslate.glossaries.docPredict

TranslateDocumentResponse

Uma mensagem de resposta de documento traduzido.

Campos
document_translation	DocumentTranslation Documento traduzido.
glossary_document_translation	DocumentTranslation A saída da tradução do documento, se um glossário for fornecido na solicitação. Pode ser o mesmo que [TranslateDocumentResponse.document_translation] se nenhum termo do glossário for aplicável.
glossary_config	TranslateTextGlossaryConfig O glossary_config usado para esta tradução.

CreateGlossary
rpc CreateGlossary(CreateGlossaryRequest) returns (Operation) Cria um glossário e retorna a operação de longa duração. Retorna NOT_FOUND se o projeto não existir.

DeleteGlossary
rpc DeleteGlossary(DeleteGlossaryRequest) returns (Operation) Exclui um glossário se ele não tiver sido criado. Retorna NOT_FOUND se o glossário não existir.

DetectLanguage
rpc DetectLanguage(DetectLanguageRequest) returns (DetectLanguageResponse) Detecta o idioma do texto em uma solicitação.

GetGlossary
rpc GetGlossary(GetGlossaryRequest) returns (Glossary) Recebe um glossário. Retorna NOT_FOUND se o glossário não existir.

GetSupportedLanguages
rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (SupportedLanguages) Retorna uma lista de idiomas aceitos para tradução.

ListGlossaries
rpc ListGlossaries(ListGlossariesRequest) returns (ListGlossariesResponse) Lista os glossários em um projeto. Retorna NOT_FOUND se o projeto não existir.

TranslateText
rpc TranslateText(TranslateTextRequest) returns (TranslateTextResponse) Traduz o texto de entrada e retorna o texto traduzido.

CreateGlossaryMetadata

Armazenado no campo google.longrunning.Operation.metadata retornado por "CreateGlossary".

Campos
name	string O nome do glossário que está sendo criado.
state	State O estado atual da operação de criação de glossário.
submit_time	Timestamp O horário em que a operação foi enviada ao servidor.

Estado

Enumera os possíveis estados da solicitação de criação.

Enums
STATE_UNSPECIFIED	Inválido.
RUNNING	A solicitação está sendo processada.
SUCCEEDED	O glossário foi criado.
FAILED	Não foi possível criar o glossário.

CreateGlossaryRequest

Mensagem de solicitação para "CreateGlossary".

Campos
parent	string Obrigatório. O nome do projeto.
glossary	Glossary Obrigatório. O glossário a ser criado.

DeleteGlossaryMetadata

Armazenado no campo google.longrunning.Operation.metadata retornado por "DeleteGlossary".

Campos
name	string O nome do glossário que está sendo excluído.
state	State O estado atual da operação de exclusão do glossário.
submit_time	Timestamp O horário em que a operação foi enviada ao servidor.

Estado

Enumera os possíveis estados da solicitação de criação.

Enums
STATE_UNSPECIFIED	Inválido.
RUNNING	A solicitação está sendo processada.
SUCCEEDED	O glossário foi excluído.
FAILED	Não foi possível excluir o glossário.

DeleteGlossaryRequest

Mensagem de solicitação para DeleteGlossary.

Campos
name	string Obrigatório. O nome do glossário a ser excluído.

DeleteGlossaryResponse

Armazenado no campo google.longrunning.Operation.response retornado por "DeleteGlossary".

Campos
name	string O nome do glossário excluído.
submit_time	Timestamp O horário em que a operação foi enviada ao servidor.
end_time	Timestamp O momento em que a exclusão do glossário é concluída e google.longrunning.Operation.done é definido como verdadeiro.

DetectLanguageRequest

A mensagem de solicitação para detecção do idioma.

Campos
parent	string Obrigatório. Projeto para fazer uma chamada. Precisa se referir ao projeto de um autor da chamada. Formato: projects/{project-id}.
mime_type	string Opcional. O formato do texto de origem, por exemplo, "text/html", "text/plain". Se for deixado em branco, o tipo MIME será "text/html" por padrão.
content	string O conteúdo da entrada armazenado como uma string.

DetectLanguageResponse

A mensagem de resposta para detecção do idioma.

Campos
languages[]	DetectedLanguage O idioma mais provável detectado pela API Translation. Para cada solicitação, a API Translation sempre retorna apenas um resultado.

DetectedLanguage

A mensagem de resposta para detecção do idioma.

Campos
language_code	string O código do idioma BCP-47 do conteúdo de origem na solicitação, detectado automaticamente.
confidence	float A confiança do resultado de detecção para este idioma.

S3Source

O local de armazenamento do conteúdo de entrada.

Campos
input_uri	string Obrigatório. URI dos dados de origem. Por exemplo, s3://my_bucket/my_object

GetGlossaryRequest

Mensagem de solicitação para GetGlossary.

Campos
name	string Obrigatório. O nome do glossário a ser recuperado.

GetSupportedLanguagesRequest

A mensagem de solicitação para descobrir idiomas aceitos.

Campos
parent	string Obrigatório. Projeto para fazer uma chamada. Precisa se referir ao projeto de um autor da chamada. Formato: projects/{project-id}.
display_language_code	string Opcional. O idioma usado para retornar nomes localizados e legíveis de idiomas compatíveis. Se estiver faltando, os nomes de exibição não serão retornados em uma resposta.

Glossário

Representa um glossário criado com base em dados fornecidos pelo usuário.

Campos
name	string Obrigatório. O nome do recurso do glossário. Os nomes de glossários têm o formato projects/{project-id}/glossaries/{glossary-id}.
input_config	GlossaryInputConfig Obrigatório. Fornece exemplos para criar o glossário. O glossário total não pode exceder 10 milhões de pontos de código Unicode.
entry_count	int32 Apenas saída. O número de entradas definidas no glossário.
submit_time	Timestamp Apenas saída. Quando "CreateGlossary" foi chamado.
end_time	Timestamp Apenas saída. Quando a criação do glossário foi concluída.
display_name	string Opcional. O nome de exibição do glossário.
Campo de união languages. Idiomas compatíveis com o glossário. languages pode ser apenas de um dos tipos a seguir:
language_pair	LanguageCodePair Usado com glossários unidirecionais.
language_codes_set	LanguageCodesSet Usado com glossários de conjuntos de termos equivalentes.

LanguageCodePair

Usado com glossários unidirecionais.

Campos
source_language_code	string Obrigatório. O código de idioma BCP-47 do texto de entrada, por exemplo, "en-US". Esperado para ser uma correspondência exata de GlossaryTerm.language_code.
target_language_code	string Obrigatório. O código de idioma BCP-47 para a saída da tradução, por exemplo, "zh-CN". Esperado para ser uma correspondência exata de GlossaryTerm.language_code.

LanguageCodesSet

Usado com glossários de conjuntos de termos equivalentes.

Campos
language_codes[]	string Os códigos de idioma BCP-47 para termos definidos no glossário. Todas as entradas são exclusivas. A lista tem pelo menos duas entradas. Esperado para ser uma correspondência exata de GlossaryTerm.language_code.

GlossaryInputConfig

Configuração de entrada para glossários.

Campos

s3_source

S3Source Obrigatório. Local de armazenamento dos dados do glossário. O formato do arquivo é determinado com base na extensão do nome. A API retorna google.rpc.Code.INVALID_ARGUMENT para URIs e formatos de arquivo não compatíveis. Caracteres curinga não são permitidos. Ele precisa ser um único arquivo em um dos seguintes formatos: Para glossários unidirecionais: TSV/CSV (.tsv/.csv): arquivo de duas colunas, separado por tabulação ou vírgula. A primeira coluna é o texto de origem. A segunda coluna é o texto de destino. O arquivo não pode ter cabeçalhos. Ou seja, a primeira linha é de dados, não de nomes de colunas. TMX (.tmx): arquivo TMX com dados paralelos que definem pares de termos de origem/destino. Para glossários de conjuntos de termos equivalentes: CSV (.csv): arquivo CSV de várias colunas que define termos equivalentes do glossário em vários idiomas. Consulte a documentação para mais informações: glossários.

ListGlossariesRequest

Mensagem de solicitação para ListGlossaries.

Campos
parent	string Obrigatório. O nome do projeto em que todos os glossários serão listados.
page_size	int32 Opcional. Tamanho da página solicitada. O servidor pode retornar menos glossários do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.
page_token	string Opcional. Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de [ListGlossariesResponse.next_page_token] retornado da chamada anterior ao método ListGlossaries. A primeira página será retornada se page_token estiver vazia ou ausente.
filter	string Opcional. Filtro que especifica restrições de uma operação de lista. Especifique a restrição no formato "chave=valor", em que a chave precisa ser "src" ou "tgt", e o valor precisa ser um código de idioma válido. Para várias restrições, concatene-as com "AND" (somente maiúsculas), como: "src=en-US AND tgt=zh-CN". Observe que a correspondência exata é usada aqui, o que significa que usar "en-US" e "en" pode levar a resultados diferentes, dependendo do código de idioma usado ao criar o glossário. Para os glossários unidirecionais, "src" e "tgt" adicionam restrições separadamente ao código do idioma de origem e de destino. Para os glossários de conjuntos de termos equivalentes, "src" e/ou "tgt" adicionam restrições ao conjunto de termos. Por exemplo, "src=en-US AND tgt=zh-CN" só vai escolher os glossários unidirecionais que correspondem exatamente ao código do idioma de origem "en-US" e ao código do idioma de destino "zh-CN", mas todos os glossários de conjuntos de termos equivalentes que contêm "en-US" e "zh-CN" no conjunto de idiomas serão escolhidos. Se estiver faltando, nenhuma filtragem será realizada.

ListGlossariesResponse

Mensagem de resposta para "ListGlossaries".

Campos
glossaries[]	Glossary A lista de glossários de um projeto.
next_page_token	string Um token para recuperar uma página de resultados. Transmita esse valor no campo [ListGlossariesRequest.page_token] na chamada subsequente ao método ListGlossaries para recuperar a próxima página de resultados.

SupportedLanguage

Uma única resposta de idioma aceito corresponde às informações relacionadas a um idioma aceito.

Campos
language_code	string Código de idioma compatível, geralmente consistindo no identificador ISO 639-1, por exemplo, "en", "ja". Em alguns casos, são retornados códigos BCP-47, incluindo identificadores de idioma e região (por exemplo, "zh-TW" e "zh-CN").
display_name	string Nome legível do idioma localizado no idioma de exibição especificado na solicitação.
support_source	bool Pode ser usado como idioma de origem.
support_target	bool Pode ser usado como idioma de destino.

SupportedLanguages

A mensagem de resposta para descobrir idiomas aceitos.

Campos
languages[]	SupportedLanguage Uma lista de respostas de idiomas aceitos. Essa lista contém uma entrada para cada idioma compatível com a API Translation.

TranslateTextGlossaryConfig

Configura qual glossário deve ser usado para um idioma de destino específico e define opções para aplicar esse glossário.

Campos
glossary	string Obrigatório. O glossary a ser aplicado para esta tradução. O formato depende do glossário: Glossário personalizado fornecido pelo usuário: projects/{project-id}/glossaries/{glossary-id}
ignore_case	bool Opcional. Indica que a correspondência não diferencia maiúsculas de minúsculas. O valor padrão é "false" se estiver ausente.

TranslateTextRequest

A mensagem de solicitação para tradução síncrona.

Campos
contents[]	string Obrigatório. O conteúdo da entrada em formato de string. Recomendamos que o conteúdo total tenha menos de 30 mil pontos de código. O tamanho máximo desse campo é 1024. Use BatchTranslateText para textos maiores.
mime_type	string Opcional. O formato do texto de origem, por exemplo, "text/html", "text/plain". Se for deixado em branco, o tipo MIME será "text/html" por padrão.
source_language_code	string O código de idioma BCP-47 do texto de entrada, se conhecido. Por exemplo, en-US ou sr-Latn. Os códigos de idioma aceitos estão listados em "Suporte a idiomas".
target_language_code	string Obrigatório. O código de idioma BCP-47 a ser usado para tradução do texto de entrada, definido como um dos códigos de idioma listados em "Suporte a idiomas".
parent	string Obrigatório. Projeto para fazer uma chamada. Precisa se referir ao projeto de um autor da chamada. Formato: projects/{project-id}
glossary_config	TranslateTextGlossaryConfig Opcional. Glossário a ser aplicado.

TranslateTextResponse

Campos
translations[]	Translation Respostas de tradução de texto sem glossário aplicado. Esse campo tem o mesmo comprimento de contents.
glossary_translations[]	Translation Respostas de tradução de texto se um glossário for fornecido na solicitação. Pode ser o mesmo que translations se nenhum termo for aplicável. Esse campo tem o mesmo comprimento de contents.

Tradução

Uma única resposta de tradução.

Campos
translated_text	string Texto traduzido para o idioma de chegada. Se ocorrer um erro durante a tradução, esse campo poderá ser excluído da resposta.
detected_language_code	string Se o idioma de origem foi transmitido, a detecção automática não ocorre e esse campo fica vazio.
glossary_config	TranslateTextGlossaryConfig O glossary_config usado para esta tradução.