Class TranslateDocumentRequest (3.8.0)

Version 3.8.0

• 3.17.0 (latest)
• 3.15.5
• 3.14.0
• 3.13.0
• 3.12.1
• 3.11.3
• 3.10.1
• 3.9.0
• 3.8.4
• 3.7.4
• 3.6.1
• 3.5.0
• 3.4.1
• 3.3.2
• 3.2.1
• 3.1.0
• 3.0.2
• 2.0.4
• 1.7.2
• 1.6.0

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``. 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 BCP-47 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 BCP-47 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_v3beta1.types.DocumentInputConfig Required. Input configurations.
document_output_config	google.cloud.translate_v3beta1.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_v3beta1.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	Mapping[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.

Inheritance

builtins.object > proto.message.Message > TranslateDocumentRequest

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, `.Message`] 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 mapping is a mapping type or there are keyword parameters.