As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Cloud Translation API Client¶

class google.cloud.translate_v3beta1.types.Any¶

type_url¶: Field google.protobuf.Any.type_url

value¶: Field google.protobuf.Any.value

class google.cloud.translate_v3beta1.types.BatchTranslateMetadata¶

State metadata for the batch translation operation.

state¶: The state of the operation.

translated_characters¶: Number of successfully translated characters so far (Unicode codepoints).

failed_characters¶: Number of characters that have failed to process so far (Unicode codepoints).

total_characters¶: Total number of characters (Unicode codepoints). This is the total number of codepoints from input files times the number of target languages and appears here shortly after the call is submitted.

submit_time¶: Time when the operation was submitted.

failed_characters: Field google.cloud.translation.v3beta1.BatchTranslateMetadata.failed_characters

state: Field google.cloud.translation.v3beta1.BatchTranslateMetadata.state

submit_time: Field google.cloud.translation.v3beta1.BatchTranslateMetadata.submit_time

total_characters: Field google.cloud.translation.v3beta1.BatchTranslateMetadata.total_characters

translated_characters: Field google.cloud.translation.v3beta1.BatchTranslateMetadata.translated_characters

class google.cloud.translate_v3beta1.types.BatchTranslateResponse¶

Stored in the [google.longrunning.Operation.response][google.longrunni ng.Operation.response] field returned by BatchTranslateText if at least one sentence is translated successfully.

total_characters¶: Total number of characters (Unicode codepoints).

translated_characters¶: Number of successfully translated characters (Unicode codepoints).

failed_characters¶: Number of characters that have failed to process (Unicode codepoints).

submit_time¶: Time when the operation was submitted.

end_time¶: The time when the operation is finished and [google.longrunnin g.Operation.done][google.longrunning.Operation.done] is set to true.

end_time: Field google.cloud.translation.v3beta1.BatchTranslateResponse.end_time

failed_characters: Field google.cloud.translation.v3beta1.BatchTranslateResponse.failed_characters

submit_time: Field google.cloud.translation.v3beta1.BatchTranslateResponse.submit_time

total_characters: Field google.cloud.translation.v3beta1.BatchTranslateResponse.total_characters

translated_characters: Field google.cloud.translation.v3beta1.BatchTranslateResponse.translated_characters

class google.cloud.translate_v3beta1.types.BatchTranslateTextRequest¶

The batch translation request.

parent¶: Required. Location to make a call. Must refer to a caller’s project. Format: projects/{project-id}/locations/{location- id}. The global location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

source_language_code¶: Required. Source language code.

target_language_codes¶: Required. Specify up to 10 language codes here.

models¶: Optional. The models to use for translation. Map’s key is target language code. Map’s value is model name. Value can be a built-in general model, or an AutoML Translation model. The value format depends on model type: - AutoML Translation models: projects/{project-id}/locations/{location- id}/models/{model-id} - General (built-in) models: projects/{project-id}/locations/{location- id}/models/general/nmt, projects/{project- id}/locations/{location-id}/models/general/base If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.

input_configs¶: Required. Input configurations. The total number of files matched should be <= 1000. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.

output_config¶: Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don’t generate output for duplicate inputs.

glossaries¶: Optional. Glossaries to be applied for translation. It’s keyed by target language code.

labels¶: Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/labels for more information.

class GlossariesEntry¶

key¶: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.GlossariesEntry.key

value¶: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.GlossariesEntry.value

class LabelsEntry¶

key¶: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.LabelsEntry.key

value¶: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.LabelsEntry.value

class ModelsEntry¶

key¶: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.ModelsEntry.key

value¶: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.ModelsEntry.value

glossaries: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.glossaries

input_configs: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.input_configs

labels: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.labels

models: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.models

output_config: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.output_config

parent: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.parent

source_language_code: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.source_language_code

target_language_codes: Field google.cloud.translation.v3beta1.BatchTranslateTextRequest.target_language_codes

class google.cloud.translate_v3beta1.types.CancelOperationRequest¶

name¶: Field google.longrunning.CancelOperationRequest.name

class google.cloud.translate_v3beta1.types.CreateGlossaryMetadata¶

Stored in the [google.longrunning.Operation.metadata][google.longrunni ng.Operation.metadata] field returned by CreateGlossary.

name¶: The name of the glossary that is being created.

state¶: The current state of the glossary creation operation.

submit_time¶: The time when the operation was submitted to the server.

name: Field google.cloud.translation.v3beta1.CreateGlossaryMetadata.name

state: Field google.cloud.translation.v3beta1.CreateGlossaryMetadata.state

submit_time: Field google.cloud.translation.v3beta1.CreateGlossaryMetadata.submit_time

class google.cloud.translate_v3beta1.types.CreateGlossaryRequest¶

Request message for CreateGlossary.

parent¶: Required. The project name.

glossary¶: Required. The glossary to create.

glossary: Field google.cloud.translation.v3beta1.CreateGlossaryRequest.glossary

parent: Field google.cloud.translation.v3beta1.CreateGlossaryRequest.parent

class google.cloud.translate_v3beta1.types.DeleteGlossaryMetadata¶

Stored in the [google.longrunning.Operation.metadata][google.longrunni ng.Operation.metadata] field returned by DeleteGlossary.

name¶: The name of the glossary that is being deleted.

state¶: The current state of the glossary deletion operation.

submit_time¶: The time when the operation was submitted to the server.

name: Field google.cloud.translation.v3beta1.DeleteGlossaryMetadata.name

state: Field google.cloud.translation.v3beta1.DeleteGlossaryMetadata.state

submit_time: Field google.cloud.translation.v3beta1.DeleteGlossaryMetadata.submit_time

class google.cloud.translate_v3beta1.types.DeleteGlossaryRequest¶

Request message for DeleteGlossary.

name¶: Required. The name of the glossary to delete.

name: Field google.cloud.translation.v3beta1.DeleteGlossaryRequest.name

class google.cloud.translate_v3beta1.types.DeleteGlossaryResponse¶

Stored in the [google.longrunning.Operation.response][google.longrunni ng.Operation.response] field returned by DeleteGlossary.

name¶: The name of the deleted glossary.

submit_time¶: The time when the operation was submitted to the server.

end_time¶: The time when the glossary deletion is finished and [google.lo ngrunning.Operation.done][google.longrunning.Operation.done] is set to true.

end_time: Field google.cloud.translation.v3beta1.DeleteGlossaryResponse.end_time

name: Field google.cloud.translation.v3beta1.DeleteGlossaryResponse.name

submit_time: Field google.cloud.translation.v3beta1.DeleteGlossaryResponse.submit_time

class google.cloud.translate_v3beta1.types.DeleteOperationRequest¶

name¶: Field google.longrunning.DeleteOperationRequest.name

class google.cloud.translate_v3beta1.types.DetectLanguageRequest¶

The request message for language detection.

parent¶: Required. Project or location to make a call. Must refer to a caller’s project. Format: projects/{project- id}/locations/{location-id} or projects/{project-id}. For global calls, use projects/{project- id}/locations/global or projects/{project-id}. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.

model¶: Optional. The language detection model to be used. Format: projects/{project-id}/locations/{location- id}/models/language-detection/{model-id} Only one language detection model is currently supported: projects/{project- id}/locations/{location-id}/models/language- detection/default. If not specified, the default model is used.

source¶: Required. The source of the document from which to detect the language.

content¶: The content of the input stored as a string.

mime_type¶: Optional. The format of the source text, for example, “text/html”, “text/plain”. If left blank, the MIME type defaults to “text/html”.

labels¶: Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/labels for more information.

class LabelsEntry¶

key¶: Field google.cloud.translation.v3beta1.DetectLanguageRequest.LabelsEntry.key

value¶: Field google.cloud.translation.v3beta1.DetectLanguageRequest.LabelsEntry.value

content: Field google.cloud.translation.v3beta1.DetectLanguageRequest.content

labels: Field google.cloud.translation.v3beta1.DetectLanguageRequest.labels

mime_type: Field google.cloud.translation.v3beta1.DetectLanguageRequest.mime_type

model: Field google.cloud.translation.v3beta1.DetectLanguageRequest.model

parent: Field google.cloud.translation.v3beta1.DetectLanguageRequest.parent

class google.cloud.translate_v3beta1.types.DetectLanguageResponse¶

The response message for language detection.

languages¶: A list of detected languages sorted by detection confidence in descending order. The most probable language first.

languages: Field google.cloud.translation.v3beta1.DetectLanguageResponse.languages

class google.cloud.translate_v3beta1.types.DetectedLanguage¶

The response message for language detection.

language_code¶: The BCP-47 language code of source content in the request, detected automatically.

confidence¶: The confidence of the detection result for this language.

confidence: Field google.cloud.translation.v3beta1.DetectedLanguage.confidence

language_code: Field google.cloud.translation.v3beta1.DetectedLanguage.language_code

class google.cloud.translate_v3beta1.types.GcsDestination¶

The Google Cloud Storage location for the output content.

output_uri_prefix¶: Required. There must be no files under ‘output_uri_prefix’. ‘output_uri_prefix’ must end with “/” and start with “gs://”, otherwise an INVALID_ARGUMENT (400) error is returned.

output_uri_prefix: Field google.cloud.translation.v3beta1.GcsDestination.output_uri_prefix

class google.cloud.translate_v3beta1.types.GcsSource¶

The Google Cloud Storage location for the input content.

input_uri¶: Required. Source data URI. For example, gs://my_bucket/my_object.

input_uri: Field google.cloud.translation.v3beta1.GcsSource.input_uri

class google.cloud.translate_v3beta1.types.GetGlossaryRequest¶

Request message for GetGlossary.

name¶: Required. The name of the glossary to retrieve.

name: Field google.cloud.translation.v3beta1.GetGlossaryRequest.name

class google.cloud.translate_v3beta1.types.GetOperationRequest¶

name¶: Field google.longrunning.GetOperationRequest.name

class google.cloud.translate_v3beta1.types.GetSupportedLanguagesRequest¶

The request message for discovering supported languages.

parent¶: Required. Project or location to make a call. Must refer to a caller’s project. Format: projects/{project-id} or projects/{project-id}/locations/{location-id}. For global calls, use projects/{project-id}/locations/global or projects/{project-id}. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

display_language_code¶: Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.

model¶: Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: projects/{project-id}/locations/{location-id}/models/{model- id} - General (built-in) models: projects/{project- id}/locations/{location-id}/models/general/nmt, projects/{project-id}/locations/{location- id}/models/general/base Returns languages supported by the specified model. If missing, we get supported languages of Google general base (PBMT) model.

display_language_code: Field google.cloud.translation.v3beta1.GetSupportedLanguagesRequest.display_language_code

model: Field google.cloud.translation.v3beta1.GetSupportedLanguagesRequest.model

parent: Field google.cloud.translation.v3beta1.GetSupportedLanguagesRequest.parent

class google.cloud.translate_v3beta1.types.Glossary¶

Represents a glossary built from user provided data.

name¶: Required. The resource name of the glossary. Glossary names have the form projects/{project-id}/locations/{location- id}/glossaries/{glossary-id}.

languages¶: Languages supported by the glossary.

language_pair¶: Used with unidirectional glossaries.

language_codes_set¶: Used with equivalent term set glossaries.

input_config¶: Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.

entry_count¶: Output only. The number of entries defined in the glossary.

submit_time¶: Output only. When CreateGlossary was called.

end_time¶: Output only. When the glossary creation was finished.

class LanguageCodePair¶

Used with unidirectional glossaries.

source_language_code¶: Required. The BCP-47 language code of the input text, for example, “en-US”. Expected to be an exact match for GlossaryTerm.language_code.

target_language_code¶: Required. The BCP-47 language code for translation output, for example, “zh-CN”. Expected to be an exact match for GlossaryTerm.language_code.

source_language_code: Field google.cloud.translation.v3beta1.Glossary.LanguageCodePair.source_language_code

target_language_code: Field google.cloud.translation.v3beta1.Glossary.LanguageCodePair.target_language_code

class LanguageCodesSet¶

Used with equivalent term set glossaries.

language_codes¶: The BCP-47 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code.

language_codes: Field google.cloud.translation.v3beta1.Glossary.LanguageCodesSet.language_codes

end_time: Field google.cloud.translation.v3beta1.Glossary.end_time

entry_count: Field google.cloud.translation.v3beta1.Glossary.entry_count

input_config: Field google.cloud.translation.v3beta1.Glossary.input_config

language_codes_set: Field google.cloud.translation.v3beta1.Glossary.language_codes_set

language_pair: Field google.cloud.translation.v3beta1.Glossary.language_pair

name: Field google.cloud.translation.v3beta1.Glossary.name

submit_time: Field google.cloud.translation.v3beta1.Glossary.submit_time

class google.cloud.translate_v3beta1.types.GlossaryInputConfig¶

Input configuration for glossaries.

source¶: Required. Specify the input.

gcs_source¶: Required. Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (.tsv/.csv): 2 column file, tab- or comma-separated. The first column is source text. The second column is target text. The file must not contain headers. That is, the first row is data, not column names. - TMX (.tmx): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (.csv): Multi-column CSV file defining equivalent glossary terms in multiple languages. The format is defined for Google Translation Toolkit and documented in Use a glossary.

gcs_source: Field google.cloud.translation.v3beta1.GlossaryInputConfig.gcs_source

class google.cloud.translate_v3beta1.types.InputConfig¶

Input configuration for BatchTranslateText request.

mime_type¶: Optional. Can be “text/plain” or “text/html”. For .tsv, “text/html” is used if mime_type is missing. For .html, this field must be “text/html” or empty. For .txt, this field must be “text/plain” or empty.

source¶: Required. Specify the input.

gcs_source¶: Required. Google Cloud Storage location for the source input. This can be a single file (for example, gs://translation- test/input.tsv) or a wildcard (for example, gs://translation-test/*). If a file extension is .tsv, it can contain either one or two columns. The first column (optional) is the id of the text request. If the first column is missing, we use the row number (0-based) from the input file as the ID in the output file. The second column is the actual text to be translated. We recommend each row be <= 10K Unicode codepoints, otherwise an error might be returned. Note that the input tsv must be RFC 4180 compliant. You could use https://github.com/Clever/csvlint to check potential formatting errors in your tsv file. csvlint –delimiter=‘:raw- latex:` ’ your_input_file.tsv The other supported file extensions are `.txt`` or .html, which is treated as a single large chunk of text.

gcs_source: Field google.cloud.translation.v3beta1.InputConfig.gcs_source

mime_type: Field google.cloud.translation.v3beta1.InputConfig.mime_type

class google.cloud.translate_v3beta1.types.ListGlossariesRequest¶

Request message for ListGlossaries.

parent¶: Required. The name of the project from which to list all of the glossaries.

page_size¶: Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.

page_token¶: Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to ListGlossaries method. The first page is returned if page_tokenis empty or missing.

filter¶: Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed.

filter: Field google.cloud.translation.v3beta1.ListGlossariesRequest.filter

page_size: Field google.cloud.translation.v3beta1.ListGlossariesRequest.page_size

page_token: Field google.cloud.translation.v3beta1.ListGlossariesRequest.page_token

parent: Field google.cloud.translation.v3beta1.ListGlossariesRequest.parent

class google.cloud.translate_v3beta1.types.ListGlossariesResponse¶

Response message for ListGlossaries.

glossaries¶: The list of glossaries for a project.

next_page_token¶: A token to retrieve a page of results. Pass this value in the [ListGlossariesRequest.page_token] field in the subsequent call to ListGlossaries method to retrieve the next page of results.

glossaries: Field google.cloud.translation.v3beta1.ListGlossariesResponse.glossaries

next_page_token: Field google.cloud.translation.v3beta1.ListGlossariesResponse.next_page_token

class google.cloud.translate_v3beta1.types.ListOperationsRequest¶

filter¶: Field google.longrunning.ListOperationsRequest.filter

name¶: Field google.longrunning.ListOperationsRequest.name

page_size¶: Field google.longrunning.ListOperationsRequest.page_size

page_token¶: Field google.longrunning.ListOperationsRequest.page_token

class google.cloud.translate_v3beta1.types.ListOperationsResponse¶

next_page_token¶: Field google.longrunning.ListOperationsResponse.next_page_token

operations¶: Field google.longrunning.ListOperationsResponse.operations

class google.cloud.translate_v3beta1.types.Operation¶

done¶: Field google.longrunning.Operation.done

error¶: Field google.longrunning.Operation.error

metadata¶: Field google.longrunning.Operation.metadata

name¶: Field google.longrunning.Operation.name

response¶: Field google.longrunning.Operation.response

class google.cloud.translate_v3beta1.types.OperationInfo¶

metadata_type¶: Field google.longrunning.OperationInfo.metadata_type

response_type¶: Field google.longrunning.OperationInfo.response_type

class google.cloud.translate_v3beta1.types.OutputConfig¶

Output configuration for BatchTranslateText request.

destination¶: Required. The destination of output.

gcs_destination¶: Google Cloud Storage destination for output content. For every single input file (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateTextRequest). Output files (tsv) generated are compliant with RFC 4180 except that record delimiters are \\n instead of \\r\\n. We don’t provide any way to change record delimiters. While the input files are being processed, we write/update an index file ‘index.csv’ under ‘output_uri_prefix’ (for example, gs://translation- test/index.csv) The index file is generated/updated as new files are being translated. The format is: input_file,target_language_code,translations_file,errors_file, glossary_translations_file,glossary_errors_file input_file is one file we matched using gcs_source.input_uri. target_language_code is provided in the request. translations_file contains the translations. (details provided below) errors_file contains the errors during processing of the file. (details below). Both translations_file and errors_file could be empty strings if we have no content to output. glossary_translations_file and glossary_errors_file are always empty strings if the input_file is tsv. They could also be empty if we have no content to output. Once a row is present in index.csv, the input/output matching never changes. Callers should also expect all the content in input_file are processed and ready to be consumed (that is, no partial output file is written). The format of translations_file (for target language code ‘trg’) is: gs://translation_test/a_b_c_‘trg’_translations.[extension] If the input file extension is tsv, the output has the following columns: Column 1: ID of the request provided in the input, if it’s not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: translation without applying a glossary. Empty string if there is an error. Column 4 (only present if a glossary is provided in the request): translation after applying the glossary. Empty string if there is an error applying the glossary. Could be same string as column 3 if there is no glossary applied. If input file extension is a txt or html, the translation is directly written to the output file. If glossary is requested, a separate glossary_translations_file has format of gs://trans lation_test/a_b_c_‘trg’_glossary_translations.[extension] The format of errors file (for target language code ‘trg’) is: gs://translation_test/a_b_c_‘trg’_errors.[extension] If the input file extension is tsv, errors_file contains the following: Column 1: ID of the request provided in the input, if it’s not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: Error detail for the translation. Could be empty. Column 4 (only present if a glossary is provided in the request): Error when applying the glossary. If the input file extension is txt or html, glossary_error_file will be generated that contains error details. glossary_error_file has format of gs://translat ion_test/a_b_c_‘trg’_glossary_errors.[extension]

gcs_destination: Field google.cloud.translation.v3beta1.OutputConfig.gcs_destination

class google.cloud.translate_v3beta1.types.Status¶

code¶: Field google.rpc.Status.code

details¶: Field google.rpc.Status.details

message¶: Field google.rpc.Status.message

class google.cloud.translate_v3beta1.types.SupportedLanguage¶

A single supported language response corresponds to information related to one supported language.

language_code¶: Supported language code, generally consisting of its ISO 639-1 identifier, for example, ‘en’, ‘ja’. In certain cases, BCP-47 codes including language and region identifiers are returned (for example, ‘zh-TW’ and ‘zh-CN’)

display_name¶: Human readable name of the language localized in the display language specified in the request.

support_source¶: Can be used as source language.

support_target¶: Can be used as target language.

display_name: Field google.cloud.translation.v3beta1.SupportedLanguage.display_name

language_code: Field google.cloud.translation.v3beta1.SupportedLanguage.language_code

support_source: Field google.cloud.translation.v3beta1.SupportedLanguage.support_source

support_target: Field google.cloud.translation.v3beta1.SupportedLanguage.support_target

class google.cloud.translate_v3beta1.types.SupportedLanguages¶

The response message for discovering supported languages.

languages¶: A list of supported language responses. This list contains an entry for each language the Translation API supports.

languages: Field google.cloud.translation.v3beta1.SupportedLanguages.languages

class google.cloud.translate_v3beta1.types.Timestamp¶

nanos¶: Field google.protobuf.Timestamp.nanos

seconds¶: Field google.protobuf.Timestamp.seconds

class google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig¶

Configures which glossary should be used for a specific target language, and defines options for applying that glossary.

glossary¶: Required. Specifies the glossary used for this translation. Use this format: projects//locations//glossaries/*

ignore_case¶: Optional. Indicates match is case-insensitive. Default value is false if missing.

glossary: Field google.cloud.translation.v3beta1.TranslateTextGlossaryConfig.glossary

ignore_case: Field google.cloud.translation.v3beta1.TranslateTextGlossaryConfig.ignore_case

class google.cloud.translate_v3beta1.types.TranslateTextRequest¶

The request message for synchronous translation.

contents¶: Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. Use BatchTranslateText for larger text.

mime_type¶: Optional. The format of the source text, for example, “text/html”, “text/plain”. If left blank, the MIME type defaults to “text/html”.

source_language_code¶: Optional. The BCP-47 language code of the input text if known, for example, “en-US” or “sr-Latn”. Supported language codes are listed in Language Support. If the source language isn’t specified, the API attempts to identify the source language automatically and returns the source language within the response.

target_language_code¶: Required. The BCP-47 language code to use for translation of the input text, set to one of the language codes listed in Language Support.

parent¶: Required. Project or location to make a call. Must refer to a caller’s project. Format: projects/{project-id} or projects/{project-id}/locations/{location-id}. For global calls, use projects/{project-id}/locations/global or projects/{project-id}. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.

model¶: Optional. The model type requested for this translation. The format depends on model type: - AutoML Translation models: projects/{project-id}/locations/{location- id}/models/{model-id} - General (built-in) models: projects/{project-id}/locations/{location- id}/models/general/nmt, projects/{project- id}/locations/{location-id}/models/general/base For global (non-regionalized) requests, use location-id global. For example, projects/{project- id}/locations/global/models/general/nmt. If missing, the system decides which google base model to use.

glossary_config¶: Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.

labels¶: Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/labels for more information.

class LabelsEntry¶

key¶: Field google.cloud.translation.v3beta1.TranslateTextRequest.LabelsEntry.key

value¶: Field google.cloud.translation.v3beta1.TranslateTextRequest.LabelsEntry.value

contents: Field google.cloud.translation.v3beta1.TranslateTextRequest.contents

glossary_config: Field google.cloud.translation.v3beta1.TranslateTextRequest.glossary_config

labels: Field google.cloud.translation.v3beta1.TranslateTextRequest.labels

mime_type: Field google.cloud.translation.v3beta1.TranslateTextRequest.mime_type

model: Field google.cloud.translation.v3beta1.TranslateTextRequest.model

parent: Field google.cloud.translation.v3beta1.TranslateTextRequest.parent

source_language_code: Field google.cloud.translation.v3beta1.TranslateTextRequest.source_language_code

target_language_code: Field google.cloud.translation.v3beta1.TranslateTextRequest.target_language_code

class google.cloud.translate_v3beta1.types.TranslateTextResponse¶

translations¶: Text translation responses with no glossary applied. This field has the same length as [contents][google.cloud.trans lation.v3beta1.TranslateTextRequest.contents].

glossary_translations¶: Text translation responses if a glossary is provided in the request. This can be the same as [translations][google.clo ud.translation.v3beta1.TranslateTextResponse.translations] if no terms apply. This field has the same length as [contents][google.cloud.translation.v3beta1.TranslateTextRequest.contents].

glossary_translations: Field google.cloud.translation.v3beta1.TranslateTextResponse.glossary_translations

translations: Field google.cloud.translation.v3beta1.TranslateTextResponse.translations

class google.cloud.translate_v3beta1.types.Translation¶

A single translation response.

translated_text¶: Text translated into the target language.

model¶: Only present when model is present in the request. This is same as model provided in the request.

detected_language_code¶: The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.

glossary_config¶: The glossary_config used for this translation.

detected_language_code: Field google.cloud.translation.v3beta1.Translation.detected_language_code

glossary_config: Field google.cloud.translation.v3beta1.Translation.glossary_config

model: Field google.cloud.translation.v3beta1.Translation.model

translated_text: Field google.cloud.translation.v3beta1.Translation.translated_text

Types for Cloud Translation API Client¶

google-cloud-translate

Navigation

Related Topics