Package google.cloud.translation.v3

Importante: para aceder ao URL indicado entre parênteses, tem de ter ligação à Internet. O URL é fornecido para acesso fora do seu ambiente isolado.

TranslationService

Oferece operações de tradução de linguagem natural.

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

TranslateDocumentRequest

Um pedido de tradução de documentos.

Campos
parent	string Obrigatório. Localização 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}. É necessária uma localização não global para pedidos que usem modelos do AutoML ou glossários personalizados. Os modelos e os glossários têm de estar na mesma região (ter o mesmo location-id). Caso contrário, é devolvido um erro INVALID_ARGUMENT (400).
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 suportados estão listados no artigo Suporte de idiomas. Se o idioma de origem não for especificado, a API tenta identificar o idioma de origem automaticamente e devolve o idioma de origem na resposta. O idioma de origem tem de ser especificado se o pedido contiver um glossário ou um modelo personalizado.
target_language_code	string Obrigatório. O código de idioma ISO-639 a usar para a tradução do documento de entrada, definido para um dos códigos de idioma indicados em Suporte de idiomas.
document_input_config	DocumentInputConfig Obrigatório. Configurações de entrada.
glossary_config	TranslateTextGlossaryConfig Opcional. Glossário a aplicar. O glossário tem de estar na mesma região (ter o mesmo location-id) que o modelo. Caso contrário, é devolvido um erro INVALID_ARGUMENT (400). A autorização requer a seguinte autorização de 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 O resultado da tradução do documento, se for fornecido um glossário no pedido. Este valor pode ser igual a [TranslateDocumentResponse.document_translation] se não se aplicar nenhum termo do glossário.
glossary_config	TranslateTextGlossaryConfig O glossary_config usado para esta tradução.

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

DeleteGlossary
rpc DeleteGlossary(DeleteGlossaryRequest) returns (Operation) Elimina um glossário se este não tiver sido criado. Devolve NOT_FOUND se o glossário não existir.

DetectLanguage
rpc DetectLanguage(DetectLanguageRequest) returns (DetectLanguageResponse) Deteta o idioma do texto num pedido.

GetGlossary
rpc GetGlossary(GetGlossaryRequest) returns (Glossary) Aceder a um glossário. Devolve NOT_FOUND se o glossário não existir.

GetSupportedLanguages
rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (SupportedLanguages) Devolve uma lista de idiomas compatíveis para tradução.

ListGlossaries
rpc ListGlossaries(ListGlossariesRequest) returns (ListGlossariesResponse) Apresenta glossários num projeto. Devolve NOT_FOUND se o projeto não existir.

TranslateText
rpc TranslateText(TranslateTextRequest) returns (TranslateTextResponse) Traduz o texto introduzido e devolve o texto traduzido.

CreateGlossaryMetadata

Armazenado no campo google.longrunning.Operation.metadata devolvido por CreateGlossary.

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

Estado

Enumera os estados possíveis em que o pedido de criação pode estar.

Enumerações
STATE_UNSPECIFIED	Inválido.
RUNNING	O pedido está a ser processado.
SUCCEEDED	O glossário foi criado com êxito.
FAILED	Falha ao criar o glossário.

CreateGlossaryRequest

Mensagem de pedido para CreateGlossary.

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

DeleteGlossaryMetadata

Armazenado no campo google.longrunning.Operation.metadata devolvido por DeleteGlossary.

Campos
name	string O nome do glossário que está a ser eliminado.
state	State O estado atual da operação de eliminação do glossário.
submit_time	Timestamp A hora em que a operação foi enviada para o servidor.

Estado

Enumera os estados possíveis em que o pedido de criação pode estar.

Enumerações
STATE_UNSPECIFIED	Inválido.
RUNNING	O pedido está a ser processado.
SUCCEEDED	O glossário foi eliminado com êxito.
FAILED	Não foi possível eliminar o glossário.

DeleteGlossaryRequest

Mensagem de pedido para DeleteGlossary.

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

DeleteGlossaryResponse

Armazenado no campo google.longrunning.Operation.response devolvido por DeleteGlossary.

Campos
name	string O nome do glossário eliminado.
submit_time	Timestamp A hora em que a operação foi enviada para o servidor.
end_time	Timestamp A hora em que a eliminação do glossário é concluída e google.longrunning.Operation.done é definida como verdadeira.

DetectLanguageRequest

A mensagem de pedido para a deteção de idioma.

Campos
parent	string Obrigatório. Projetar para fazer uma chamada. Tem de referir-se 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" ou "text/plain". Se for deixado em branco, o tipo MIME usa como predefinição "text/html".
content	string O conteúdo da entrada armazenado como uma string.

DetectLanguageResponse

A mensagem de resposta para a deteção de idioma.

Campos
languages[]	DetectedLanguage O idioma mais provável detetado pela API Translation. Para cada pedido, a API Translation devolve sempre apenas um resultado.

DetectedLanguage

A mensagem de resposta para a deteção de idioma.

Campos
language_code	string O código de idioma BCP-47 do conteúdo de origem no pedido, detetado automaticamente.
confidence	float A confiança do resultado da deteção para este idioma.

S3Source

A localização 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 pedido para GetGlossary.

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

GetSupportedLanguagesRequest

A mensagem de pedido para descobrir idiomas suportados.

Campos
parent	string Obrigatório. Projetar para fazer uma chamada. Tem de referir-se ao projeto de um autor da chamada. Formato: projects/{project-id}.
display_language_code	string Opcional. O idioma a usar para devolver nomes legíveis de idiomas compatíveis. Se estiver em falta, os nomes a apresentar não são devolvidos numa resposta.

Glossário

Representa um glossário criado a partir de dados fornecidos pelos utilizadores.

Campos
name	string Obrigatório. O nome do recurso do glossário. Os nomes dos glossários têm o formato projects/{project-id}/glossaries/{glossary-id}.
input_config	GlossaryInputConfig Obrigatório. Fornece exemplos a partir dos quais o glossário é criado. 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 a apresentar do glossário.
Campo de união languages. Idiomas suportados pelo glossário. languages só pode ser uma das seguintes opções:
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 que seja uma correspondência exata de GlossaryTerm.language_code.
target_language_code	string Obrigatório. O código de idioma BCP-47 para o resultado da tradução, por exemplo, "zh-CN". É esperado que seja 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 os termos definidos no glossário. Todas as entradas são únicas. A lista contém, pelo menos, duas entradas. É esperado que seja 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 ficheiro é determinado com base na extensão do nome do ficheiro. A API devolve google.rpc.Code.INVALID_ARGUMENT para URIs e formatos de ficheiros não suportados. Não são permitidos carateres universais. Tem de ser um único ficheiro num dos seguintes formatos: Para glossários unidirecionais: TSV/CSV (.tsv/.csv): ficheiro de 2 colunas, separado por tabulações ou vírgulas. A primeira coluna é o texto de origem. A segunda coluna é o texto de destino. O ficheiro não pode conter cabeçalhos. Ou seja, a primeira linha contém dados e não nomes de colunas. TMX (.tmx): ficheiro TMX com dados paralelos que definem pares de termos de origem/destino. Para glossários de conjuntos de termos equivalentes: CSV (.csv): ficheiro CSV de várias colunas que define termos do glossário equivalentes em vários idiomas. Consulte a documentação para mais informações: glossários.

ListGlossariesRequest

Mensagem de pedido para ListGlossaries.

Campos
parent	string Obrigatório. O nome do projeto a partir do qual listar todos os glossários.
page_size	int32 Opcional. Tamanho da página solicitado. O servidor pode devolver menos glossários do que o pedido. Se não for especificado, o servidor escolhe uma predefinição adequada.
page_token	string Opcional. Um token que identifica uma página de resultados que o servidor deve devolver. Normalmente, este é o valor de [ListGlossariesResponse.next_page_token] devolvido pela chamada anterior ao método ListGlossaries. A primeira página é devolvida se page_token estiver vazio ou em falta.
filter	string Opcional. Filtro que especifica restrições de uma operação de lista. Especifique a restrição pelo formato de "key=value", em que a chave tem de ser "src" ou "tgt", e o valor tem de ser um código de idioma válido. Para várias restrições, concatene-as com "AND" (apenas em maiúsculas), como: "src=en-US AND tgt=zh-CN". Tenha em atenção que aqui é usada a correspondência exata, o que significa que a utilização de "en-US" e "en" pode gerar resultados diferentes, o que depende do código de idioma que usou quando criou o glossário. Para os glossários unidirecionais, os elementos "src" e "tgt" adicionam restrições ao código do idioma de origem e de destino separadamente. Para os glossários de conjuntos de termos equivalentes, os elementos "src" e/ou "tgt" adicionam restrições ao conjunto de termos. Por exemplo: "src=en-US AND tgt=zh-CN" só seleciona 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 respetivo conjunto de idiomas são selecionados. Se estiver em falta, não é aplicado nenhum filtro.

ListGlossariesResponse

Mensagem de resposta para ListGlossaries.

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

SupportedLanguage

Uma resposta de idioma suportado único corresponde a informações relacionadas com um idioma suportado.

Campos
language_code	string Código de idioma suportado, geralmente composto pelo respetivo identificador ISO 639-1, por exemplo, "en", "ja". Em determinados casos, são devolvidos 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 apresentação especificado no pedido.
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 compatíveis.

Campos
languages[]	SupportedLanguage Uma lista de respostas de idiomas compatíveis. Esta lista contém uma entrada para cada idioma suportado pela API Translation.

TranslateTextGlossaryConfig

Configura o glossário que 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 aplicar a esta tradução. O formato depende do glossário: Glossário personalizado fornecido pelo utilizador: projects/{project-id}/glossaries/{glossary-id}
ignore_case	bool Opcional. Indica que a correspondência não é sensível a maiúsculas e minúsculas. O valor predefinido é false se estiver em falta.

TranslateTextRequest

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

Campos
contents[]	string Obrigatório. O conteúdo da entrada no formato de string. Recomendamos que o conteúdo total tenha menos de 30 mil pontos de código. O comprimento máximo deste campo é de 1024 carateres. Use BatchTranslateText para texto maior.
mime_type	string Opcional. O formato do texto de origem, por exemplo, "text/html" ou "text/plain". Se for deixado em branco, o tipo MIME usa como predefinição "text/html".
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 suportados estão listados no artigo Suporte de idiomas.
target_language_code	string Obrigatório. O código de idioma BCP-47 a usar para a tradução do texto de entrada, definido para um dos códigos de idioma indicados em Suporte de idiomas.
parent	string Obrigatório. Projetar para fazer uma chamada. Tem de referir-se ao projeto de um autor da chamada. Formato: projects/{project-id}
glossary_config	TranslateTextGlossaryConfig Opcional. Glossário a aplicar.

TranslateTextResponse

Campos
translations[]	Translation Respostas de tradução de texto sem glossário aplicado. Este campo tem o mesmo comprimento que contents.
glossary_translations[]	Translation Respostas de tradução de texto se for fornecido um glossário no pedido. Pode ser igual a translations se não se aplicarem termos. Este campo tem o mesmo comprimento que contents.

Tradução

Uma única resposta de tradução.

Campos
translated_text	string Texto traduzido para o idioma de destino. Se ocorrer um erro durante a tradução, este campo pode ser excluído da resposta.
detected_language_code	string Se o idioma de origem tiver sido transmitido, a deteção automática do idioma não ocorre e este campo fica vazio.
glossary_config	TranslateTextGlossaryConfig O glossary_config usado para esta tradução.