TranslateDocumentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)A document translation request.
Attributes | |
|---|---|
| Name | Description |
parent |
str
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.
|
source_language_code |
str
Optional. The ISO-639 language code of the input document 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. Source language must be specified if the request contains a glossary or a custom model. |
target_language_code |
str
Required. The ISO-639 language code to use for translation of the input document, set to one of the language codes listed in Language Support. |
document_input_config |
google.cloud.translate_v3.types.DocumentInputConfig
Required. Input configurations. |
document_output_config |
google.cloud.translate_v3.types.DocumentOutputConfig
Optional. Output configurations. Defines if the output file should be stored within Cloud Storage as well as the desired output format. If not provided the translated file will only be returned through a byte-stream and its output mime type will be the same as the input file's mime type. |
model |
str
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,
If not provided, the default Google model (NMT) will be used
for translation.
|
glossary_config |
google.cloud.translate_v3.types.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 |
MutableMapping[str, str]
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. |
customized_attribution |
str
Optional. This flag is to support user customized attribution. If not provided, the default is Machine Translated by Google. Customized attribution
should follow rules in
https://cloud.google.com/translate/attribution#attribution_and_logos
|
is_translate_native_pdf_only |
bool
Optional. If true, the page limit of online native pdf translation is 300 and only native pdf pages will be translated. |
enable_shadow_removal_native_pdf |
bool
Optional. If true, use the text removal to remove the shadow text on background image for native pdf translation. Shadow removal feature can only be enabled when is_translate_native_pdf_only is false |
Classes
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |