package google.cloud.translation.v3
Get desktop application:
View/edit binary Protocol Buffers messages
Provides natural language translation operations.
Translates input text and returns translated text.
message
translation_service.proto:165The request message for synchronous translation.
repeated string contents = 1
Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. Use BatchTranslateText for larger text.
string mime_type = 3
Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".
string source_language_code = 4
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.
string target_language_code = 5
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.
string parent = 8
Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-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.
string model = 6
Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If missing, the system decides which google base model to use.
optional glossary_config = 7
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.
map<string, string> labels = 10
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.
message
translation_service.proto:243repeated translations = 1
Text translation responses with no glossary applied. This field has the same length as [`contents`][google.cloud.translation.v3.TranslateTextRequest.contents].
repeated glossary_translations = 3
Text translation responses if a glossary is provided in the request. This can be the same as [`translations`][google.cloud.translation.v3.TranslateTextResponse.translations] if no terms apply. This field has the same length as [`contents`][google.cloud.translation.v3.TranslateTextRequest.contents].
Detects the language of text within a request.
message
translation_service.proto:283The request message for language detection.
string parent = 5
Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
string model = 4
Optional. The language detection model to be used. Format: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}` Only one language detection model is currently supported: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`. If not specified, the default model is used.
oneof source
Required. The source of the document from which to detect the language.
string content = 1
The content of the input stored as a string.
string mime_type = 3
Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".
map<string, string> labels = 6
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.
message
translation_service.proto:345The response message for language detection.
repeated languages = 1
A list of detected languages sorted by detection confidence in descending order. The most probable language first.
Returns a list of supported languages for translation.
message
translation_service.proto:352The request message for discovering supported languages.
string parent = 3
Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-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.
string display_language_code = 1
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.
string model = 2
Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-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.
message
translation_service.proto:396The response message for discovering supported languages.
repeated languages = 1
A list of supported language responses. This list contains an entry for each language the Translation API supports.
Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.
message
translation_service.proto:543The batch translation request.
string parent = 1
Required. Location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-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.
string source_language_code = 2
Required. Source language code.
repeated string target_language_codes = 3
Required. Specify up to 10 language codes here.
map<string, string> models = 4
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-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-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.
repeated input_configs = 5
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.
optional output_config = 6
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.
map<string, > glossaries = 7
Optional. Glossaries to be applied for translation. It's keyed by target language code.
map<string, string> labels = 9
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.
Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.
message
translation_service.proto:768Request message for CreateGlossary.
string parent = 1
Required. The project name.
optional glossary = 2
Required. The glossary to create.
Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.
message
translation_service.proto:804Request message for ListGlossaries.
string parent = 1
Required. The name of the project from which to list all of the glossaries.
int32 page_size = 2
Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.
string page_token = 3
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_token`is empty or missing.
string filter = 4
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.
message
translation_service.proto:830Response message for ListGlossaries.
repeated glossaries = 1
The list of glossaries for a project.
string next_page_token = 2
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.
Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.
message
translation_service.proto:782Request message for GetGlossary.
string name = 1
Required. The name of the glossary to retrieve.
Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.
message
translation_service.proto:793Request message for DeleteGlossary.
string name = 1
Required. The name of the glossary to delete.
message
translation_service.proto:614State metadata for the batch translation operation.
BatchTranslateMetadata.State state = 1
The state of the operation.
int64 translated_characters = 2
Number of successfully translated characters so far (Unicode codepoints).
int64 failed_characters = 3
Number of characters that have failed to process so far (Unicode codepoints).
int64 total_characters = 4
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.
optional submit_time = 5
Time when the operation was submitted.
State of the job.
Used in:
STATE_UNSPECIFIED = 0
Invalid.
RUNNING = 1
Request is being processed.
SUCCEEDED = 2
The batch is processed, and at least one item was successfully processed.
FAILED = 3
The batch is done and no item was successfully processed.
CANCELLING = 4
Request is in the process of being canceled after caller invoked longrunning.Operations.CancelOperation on the request id.
CANCELLED = 5
The batch is done after the user has called the longrunning.Operations.CancelOperation. Any records processed before the cancel command are output as specified in the request.
message
translation_service.proto:663Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateText if at least one sentence is translated successfully.
int64 total_characters = 1
Total number of characters (Unicode codepoints).
int64 translated_characters = 2
Number of successfully translated characters (Unicode codepoints).
int64 failed_characters = 3
Number of characters that have failed to process (Unicode codepoints).
optional submit_time = 4
Time when the operation was submitted.
optional end_time = 5
The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.
message
translation_service.proto:843Stored in the [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by CreateGlossary.
string name = 1
The name of the glossary that is being created.
CreateGlossaryMetadata.State state = 2
The current state of the glossary creation operation.
optional submit_time = 3
The time when the operation was submitted to the server.
Enumerates the possible states that the creation request can be in.
Used in:
STATE_UNSPECIFIED = 0
Invalid.
RUNNING = 1
Request is being processed.
SUCCEEDED = 2
The glossary was successfully created.
FAILED = 3
Failed to create the glossary.
CANCELLING = 4
Request is in the process of being canceled after caller invoked longrunning.Operations.CancelOperation on the request id.
CANCELLED = 5
The glossary creation request was successfully canceled.
message
translation_service.proto:879Stored in the [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by DeleteGlossary.
string name = 1
The name of the glossary that is being deleted.
DeleteGlossaryMetadata.State state = 2
The current state of the glossary deletion operation.
optional submit_time = 3
The time when the operation was submitted to the server.
Enumerates the possible states that the creation request can be in.
Used in:
STATE_UNSPECIFIED = 0
Invalid.
RUNNING = 1
Request is being processed.
SUCCEEDED = 2
The glossary was successfully deleted.
FAILED = 3
Failed to delete the glossary.
CANCELLING = 4
Request is in the process of being canceled after caller invoked longrunning.Operations.CancelOperation on the request id.
CANCELLED = 5
The glossary deletion request was successfully canceled.
message
translation_service.proto:915Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by DeleteGlossary.
string name = 1
The name of the deleted glossary.
optional submit_time = 2
The time when the operation was submitted to the server.
optional end_time = 3
The time when the glossary deletion is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.
message
translation_service.proto:335The response message for language detection.
Used in:
string language_code = 1
The BCP-47 language code of source content in the request, detected automatically.
float confidence = 2
The confidence of the detection result for this language.
message
translation_service.proto:461The Google Cloud Storage location for the output content.
Used in:
string output_uri_prefix = 1
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.
message
translation_service.proto:423The Google Cloud Storage location for the input content.
Used in: ,
string input_uri = 1
Required. Source data URI. For example, `gs://my_bucket/my_object`.
message
translation_service.proto:713Represents a glossary built from user provided data.
Used as response type in: TranslationService.GetGlossary
Used as field type in: ,
string name = 1
Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`.
oneof languages
Languages supported by the glossary.
language_pair = 3
Used with unidirectional glossaries.
language_codes_set = 4
Used with equivalent term set glossaries.
optional input_config = 5
Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
int32 entry_count = 6
Output only. The number of entries defined in the glossary.
optional submit_time = 7
Output only. When CreateGlossary was called.
optional end_time = 8
Output only. When the glossary creation was finished.
message
translation_service.proto:720Used with unidirectional glossaries.
Used in:
string source_language_code = 1
Required. The BCP-47 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code.
string target_language_code = 2
Required. The BCP-47 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
message
translation_service.proto:731Used with equivalent term set glossaries.
Used in:
repeated string language_codes = 1
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.
message
translation_service.proto:683Input configuration for glossaries.
Used in:
oneof source
Required. Specify the input.
gcs_source = 1
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](https://support.google.com/translatortoolkit/answer/6306379?hl=en).
message
translation_service.proto:429Input configuration for BatchTranslateText request.
Used in:
string mime_type = 1
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.
oneof source
Required. Specify the input.
gcs_source = 2
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='\t' your_input_file.tsv The other supported file extensions are `.txt` or `.html`, which is treated as a single large chunk of text.
message
translation_service.proto:469Output configuration for BatchTranslateText request.
Used in:
oneof destination
Required. The destination of output.
gcs_destination = 1
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://translation_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://translation_test/a_b_c_'trg'_glossary_errors.[extension]
message
translation_service.proto:404A single supported language response corresponds to information related to one supported language.
Used in:
string language_code = 1
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')
string display_name = 2
Human readable name of the language localized in the display language specified in the request.
bool support_source = 3
Can be used as source language.
bool support_target = 4
Can be used as target language.
message
translation_service.proto:154Configures which glossary should be used for a specific target language, and defines options for applying that glossary.
Used in: , ,
string glossary = 1
Required. Specifies the glossary used for this translation. Use this format: projects/*/locations/*/glossaries/*
bool ignore_case = 2
Optional. Indicates match is case-insensitive. Default value is false if missing.
message
translation_service.proto:258A single translation response.
Used in:
string translated_text = 1
Text translated into the target language.
string model = 2
Only present when `model` is present in the request. `model` here is normalized to have project number. For example: If the `model` requested in TranslationTextRequest is `projects/{project-id}/locations/{location-id}/models/general/nmt` then `model` here would be normalized to `projects/{project-number}/locations/{location-id}/models/general/nmt`.
string detected_language_code = 4
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.
optional glossary_config = 3
The `glossary_config` used for this translation.