API documentation for translate_v3.types package.
Classes
BatchDocumentInputConfig
Input configuration for BatchTranslateDocument request. .. attribute:: gcs_source
Google Cloud Storage location for the source input. This can
be a single file (for example,
gs://translation-test/input.docx) or a wildcard (for
example, gs://translation-test/*).
File mime type is determined based on extension. Supported mime type includes:
pdf, application/pdfdocx, application/vnd.openxmlformats-officedocument.wordprocessingml.documentpptx, application/vnd.openxmlformats-officedocument.presentationml.presentationxlsx, application/vnd.openxmlformats-officedocument.spreadsheetml.sheetThe max file size to support for
.docx,.pptxand.xlsxis 100MB. The max file size to support for.pdfis 1GB and the max page limit is 1000 pages. The max file size to support for all input documents is 1GB.
BatchDocumentOutputConfig
Output configuration for BatchTranslateDocument request. .. attribute:: gcs_destination
Google Cloud Storage destination for output content. For every single input document (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateDocumentRequest).
While the input documents are being processed, we
write/update an index file index.csv under
gcs_destination.output_uri_prefix (for example,
gs://translation_output/index.csv) The index file is
generated/updated as new files are being translated. The
format is:
input_document,target_language_code,translation_output,error_output, glossary_translation_output,glossary_error_output
input_document is one file we matched using
gcs_source.input_uri. target_language_code is provided
in the request. translation_output contains the
translations. (details provided below) error_output
contains the error message during processing of the file.
Both translations_file and errors_file could be empty
strings if we have no content to output.
glossary_translation_output and
glossary_error_output are the translated output/error
when we apply glossaries. 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 naming format of translation output files follows (for
target language code [trg]): translation_output:
gs://translation_output/a_b_c_[trg]\ translation.[extension]
glossary_translation_output:
gs://translation_test/a_b_c\ [trg]_glossary_translation.[extension]
The output document will maintain the same file format as
the input document.
The naming format of error output files follows (for target
language code [trg]): error_output:
gs://translation_test/a_b_c_[trg]\ errors.txt
glossary_error_output:
gs://translation_test/a_b_c\ [trg]_glossary_translation.txt
The error output is a txt file containing error details.
BatchTranslateDocumentMetadata
State metadata for the batch translation operation. .. attribute:: state
The state of the operation.
:type: google.cloud.translate_v3.types.BatchTranslateDocumentMetadata.State
BatchTranslateDocumentRequest
The BatchTranslateDocument request. .. attribute:: parent
Required. Location to make a regional call.
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.
:type: str
BatchTranslateDocumentResponse
Stored in the
google.longrunning.Operation.response][google.longrunning.Operation.response]
field returned by BatchTranslateDocument if at least one document is
translated successfully.
BatchTranslateMetadata
State metadata for the batch translation operation. .. attribute:: state
The state of the operation.
:type: google.cloud.translate_v3.types.BatchTranslateMetadata.State
BatchTranslateResponse
Stored in the
google.longrunning.Operation.response][google.longrunning.Operation.response]
field returned by BatchTranslateText if at least one sentence is
translated successfully.
BatchTranslateTextRequest
The batch translation request. .. attribute:: parent
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.
:type: str
CreateGlossaryMetadata
Stored in the
google.longrunning.Operation.metadata][google.longrunning.Operation.metadata]
field returned by CreateGlossary.
CreateGlossaryRequest
Request message for CreateGlossary. .. attribute:: parent
Required. The project name.
:type: str
DeleteGlossaryMetadata
Stored in the
google.longrunning.Operation.metadata][google.longrunning.Operation.metadata]
field returned by DeleteGlossary.
DeleteGlossaryRequest
Request message for DeleteGlossary. .. attribute:: name
Required. The name of the glossary to delete.
:type: str
DeleteGlossaryResponse
Stored in the
google.longrunning.Operation.response][google.longrunning.Operation.response]
field returned by DeleteGlossary.
DetectLanguageRequest
The request message for language detection. .. attribute:: parent
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.
:type: str
DetectLanguageResponse
The response message for language detection. .. attribute:: languages
The most probable language detected by the Translation API. For each request, the Translation API will always return only one result.
:type: Sequence[google.cloud.translate_v3.types.DetectedLanguage]
DetectedLanguage
The response message for language detection. .. attribute:: language_code
The BCP-47 language code of source content in the request, detected automatically.
:type: str
DocumentInputConfig
A document translation request input config. .. attribute:: content
Document's content represented as a stream of bytes.
:type: bytes
DocumentOutputConfig
A document translation request output config. .. attribute:: gcs_destination
Optional. Google Cloud Storage destination for the
translation output, e.g., gs://my_bucket/my_directory/.
The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.
For a DocumentInputConfig.contents provided document, the output file will have the name "output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the output file will have a name according to its URI. For example: an input file with URI: "gs://a/b/c.[extension]" stored in a gcs_destination bucket with name "my_bucket" will have an output URI: "gs://my_bucket/a_b_c_[trg]_translations.[ext]", where
[trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If the document was directly provided through the request, then the output document will have the format: "gs://my_bucket/translated_document_[trg]_translations.[ext], where
[trg] corresponds to the translated file's language code,
[ext] corresponds to the translated file's extension according to its mime type.
If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have
glossary_translationsinstead oftranslations. For the previous example, its glossary URI would be: "gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]".Thus the max number of output files will be 2 (Translated document, Glossary translated document).
Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.
DocumentTranslation
A translated document message. .. attribute:: byte_stream_outputs
The array of translated documents. It is expected to be size 1 for now. We may produce multiple translated documents in the future for other type of file formats.
:type: Sequence[bytes]
GcsDestination
The Google Cloud Storage location for the output content. .. attribute:: output_uri_prefix
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.
:type: str
GcsSource
The Google Cloud Storage location for the input content. .. attribute:: input_uri
Required. Source data URI. For example,
gs://my_bucket/my_object.
:type: str
GetGlossaryRequest
Request message for GetGlossary. .. attribute:: name
Required. The name of the glossary to retrieve.
:type: str
GetSupportedLanguagesRequest
The request message for discovering supported languages. .. attribute:: parent
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.
:type: str
Glossary
Represents a glossary built from user provided data. .. attribute:: name
Required. The resource name of the glossary. Glossary names
have the form
projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.
:type: str
GlossaryInputConfig
Input configuration for glossaries. .. attribute:: 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. See documentation for more information -glossaries <https://cloud.google.com/translate/docs/advanced/glossary>__.
InputConfig
Input configuration for BatchTranslateText request. .. attribute:: 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.
:type: str
ListGlossariesRequest
Request message for ListGlossaries. .. attribute:: parent
Required. The name of the project from which to list all of the glossaries.
:type: str
ListGlossariesResponse
Response message for ListGlossaries. .. attribute:: glossaries
The list of glossaries for a project.
:type: Sequence[google.cloud.translate_v3.types.Glossary]
OutputConfig
Output configuration for BatchTranslateText request. .. attribute:: 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).
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]
SupportedLanguage
A single supported language response corresponds to information related to one supported language.
SupportedLanguages
The response message for discovering supported languages. .. attribute:: languages
A list of supported language responses. This list contains an entry for each language the Translation API supports.
:type: Sequence[google.cloud.translate_v3.types.SupportedLanguage]
TranslateDocumentRequest
A document translation request. .. attribute:: parent
Required. Location to make a regional call.
Format:
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 the same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
:type: str
TranslateDocumentResponse
A translated document response message. .. attribute:: document_translation
Translated document.
TranslateTextGlossaryConfig
Configures which glossary should be used for a specific target language, and defines options for applying that glossary.
TranslateTextRequest
The request message for synchronous translation. .. attribute:: contents
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.
:type: Sequence[str]
TranslateTextResponse
Translation
A single translation response. .. attribute:: translated_text
Text translated into the target language. If an error occurs during translation, this field might be excluded from the response.
:type: str