Types overview

BatchTranslateTextRequest

The batch translation request.

Fields
`glossaries`	`map (key: string, value: object (TranslateTextGlossaryConfig))` Optional. Glossaries to be applied for translation. It's keyed by target language code.
`inputConfigs[]`	`object (InputConfig)` Required. Input configurations. The total number of files matched should be <= 100. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.
`labels`	`map (key: string, value: string)` 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/advanced/labels for more information.
`models`	`map (key: string, value: string)` 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`, If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.
`outputConfig`	`object (OutputConfig)` 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.
`sourceLanguageCode`	`string` Required. Source language code.
`targetLanguageCodes[]`	`string` Required. Specify up to 10 language codes here.

DetectLanguageRequest

The request message for language detection.

Fields
`content`	`string` The content of the input stored as a string.
`labels`	`map (key: string, value: string)` 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/advanced/labels for more information.
`mimeType`	`string` Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".
`model`	`string` 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.

DetectLanguageResponse

The response message for language detection.

Fields

Fields
`languages[]`	`object (DetectedLanguage)` The most probable language detected by the Translation API. For each request, the Translation API will always return only one result.

languages[]

object (DetectedLanguage)

The most probable language detected by the Translation API. For each request, the Translation API will always return only one result.

DetectedLanguage

The response message for language detection.

Fields

Fields
`confidence`	`number (float format)` The confidence of the detection result for this language.
`languageCode`	`string` The BCP-47 language code of source content in the request, detected automatically.

confidence

number (float format)

The confidence of the detection result for this language.

languageCode

string

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

GcsDestination

The Google Cloud Storage location for the output content.

Fields

Fields
`outputUriPrefix`	`string` Required. The bucket used in 'output_uri_prefix' must exist and there must be no files under 'output_uri_prefix'. 'output_uri_prefix' must end with "/" and start with "gs://". One 'output_uri_prefix' can only be used by one batch translation job at a time. Otherwise an INVALID_ARGUMENT (400) error is returned.

outputUriPrefix

string

Required. The bucket used in 'output_uri_prefix' must exist and there must be no files under 'output_uri_prefix'. 'output_uri_prefix' must end with "/" and start with "gs://". One 'output_uri_prefix' can only be used by one batch translation job at a time. Otherwise an INVALID_ARGUMENT (400) error is returned.

GcsSource

The Google Cloud Storage location for the input content.

Fields

Fields
`inputUri`	`string` Required. Source data URI. For example, `gs://my_bucket/my_object`.

inputUri

string

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

Glossary

Represents a glossary built from user provided data.

Fields
`endTime`	`string (Timestamp format)` Output only. When the glossary creation was finished.
`entryCount`	`integer (int32 format)` Output only. The number of entries defined in the glossary.
`inputConfig`	`object (GlossaryInputConfig)` Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
`languageCodesSet`	`object (LanguageCodesSet)` Used with equivalent term set glossaries.
`languagePair`	`object (LanguageCodePair)` Used with unidirectional glossaries.
`name`	`string` Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`.
`submitTime`	`string (Timestamp format)` Output only. When CreateGlossary was called.

GlossaryInputConfig

Input configuration for glossaries.

Fields

Fields
`gcsSource`	`object (GcsSource)` 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. See documentation for more information - glossaries.

gcsSource

object (GcsSource)

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. See documentation for more information - glossaries.

InputConfig

Input configuration for BatchTranslateText request.

Fields

Fields
`gcsSource`	`object (GcsSource)` 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.
`mimeType`	`string` 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.

gcsSource

object (GcsSource)

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.

mimeType

string

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.

LanguageCodePair

Used with unidirectional glossaries.

Fields

Fields
`sourceLanguageCode`	`string` Required. The BCP-47 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code.
`targetLanguageCode`	`string` Required. The BCP-47 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.

sourceLanguageCode

string

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

targetLanguageCode

string

Required. The BCP-47 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.

LanguageCodesSet

Used with equivalent term set glossaries.

Fields

Fields
`languageCodes[]`	`string` 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.

languageCodes[]

string

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.

ListGlossariesResponse

Response message for ListGlossaries.

Fields

Fields
`glossaries[]`	`object (Glossary)` The list of glossaries for a project.
`nextPageToken`	`string` 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[]

object (Glossary)

The list of glossaries for a project.

nextPageToken

string

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.

ListLocationsResponse

The response message for Locations.ListLocations.

Fields

Fields
`locations[]`	`object (Location)` A list of locations that matches the specified filter in the request.
`nextPageToken`	`string` The standard List next-page token.

locations[]

object (Location)

A list of locations that matches the specified filter in the request.

nextPageToken

string

The standard List next-page token.

ListOperationsResponse

The response message for Operations.ListOperations.

Fields

Fields
`nextPageToken`	`string` The standard List next-page token.
`operations[]`	`object (Operation)` A list of operations that matches the specified filter in the request.

nextPageToken

string

The standard List next-page token.

operations[]

object (Operation)

A list of operations that matches the specified filter in the request.

Location

A resource that represents Google Cloud Platform location.

Fields
`displayName`	`string` The friendly name for this location, typically a nearby city name. For example, "Tokyo".
`labels`	`map (key: string, value: string)` Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
`locationId`	`string` The canonical id for this location. For example: `"us-east1"`.
`metadata`	`map (key: string, value: any)` Service-specific metadata. For example the available capacity at the given location.
`name`	`string` Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`

Operation

This resource represents a long-running operation that is the result of a network API call.

Fields
`done`	`boolean` If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
`error`	`object (Status)` The error result of the operation in case of failure or cancellation.
`metadata`	`map (key: string, value: any)` Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
`name`	`string` The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
`response`	`map (key: string, value: any)` The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

OutputConfig

Output configuration for BatchTranslateText request.

Fields

Fields
`gcsDestination`	`object (GcsDestination)` 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). Since index.csv will be keeping updated during the process, please make sure there is no custom retention policy applied on the output bucket that may avoid file updating. (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy) 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]

gcsDestination

object (GcsDestination)

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). Since index.csv will be keeping updated during the process, please make sure there is no custom retention policy applied on the output bucket that may avoid file updating. (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy) 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]

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Fields

Fields
`code`	`integer (int32 format)` The status code, which should be an enum value of google.rpc.Code.
`details[]`	`object` A list of messages that carry the error details. There is a common set of message types for APIs to use.
`message`	`string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code

integer (int32 format)

The status code, which should be an enum value of google.rpc.Code.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

SupportedLanguage

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

Fields
`displayName`	`string` Human readable name of the language localized in the display language specified in the request.
`languageCode`	`string` 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')
`supportSource`	`boolean` Can be used as source language.
`supportTarget`	`boolean` Can be used as target language.

SupportedLanguages

The response message for discovering supported languages.

Fields

Fields
`languages[]`	`object (SupportedLanguage)` A list of supported language responses. This list contains an entry for each language the Translation API supports.

languages[]

object (SupportedLanguage)

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

TranslateTextGlossaryConfig

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

Fields

Fields
`glossary`	`string` Required. The `glossary` to be applied for this translation. The format depends on glossary: - User provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`
`ignoreCase`	`boolean` Optional. Indicates match is case-insensitive. Default value is false if missing.

glossary

string

Required. The glossary to be applied for this translation. The format depends on glossary: - User provided custom glossary: projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}

ignoreCase

boolean

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

TranslateTextRequest

The request message for synchronous translation.

Fields
`contents[]`	`string` Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.
`glossaryConfig`	`object (TranslateTextGlossaryConfig)` 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`	`map (key: string, value: string)` 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/advanced/labels for more information.
`mimeType`	`string` Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".
`model`	`string` 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`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used
`sourceLanguageCode`	`string` 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.
`targetLanguageCode`	`string` 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.

TranslateTextResponse

(No description provided)

Fields

Fields
`glossaryTranslations[]`	`object (Translation)` Text translation responses if a glossary is provided in the request. This can be the same as `translations` if no terms apply. This field has the same length as `contents`.
`translations[]`	`object (Translation)` Text translation responses with no glossary applied. This field has the same length as `contents`.

glossaryTranslations[]

object (Translation)

Text translation responses if a glossary is provided in the request. This can be the same as translations if no terms apply. This field has the same length as contents.

translations[]

object (Translation)

Text translation responses with no glossary applied. This field has the same length as contents.

Translation

A single translation response.

Fields
`detectedLanguageCode`	`string` 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.
`glossaryConfig`	`object (TranslateTextGlossaryConfig)` The `glossary_config` used for this translation.
`model`	`string` 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`.
`translatedText`	`string` Text translated into the target language. If an error occurs during translation, this field might be excluded from the response.

WaitOperationRequest

The request message for Operations.WaitOperation.

Fields

Fields
`timeout`	`string (Duration format)` The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

timeout

string (Duration format)

The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.