Class TranslateDocumentRequest

A document translation request.

Attributes
NameDescription
strparent
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.
strsource_language_code
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.
strtarget_language_code
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.
google.cloud.translate_v3.types.DocumentInputConfigdocument_input_config
Required. Input configurations.
google.cloud.translate_v3.types.DocumentOutputConfigdocument_output_config
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.
strmodel
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.
google.cloud.translate_v3.types.TranslateTextGlossaryConfigglossary_config
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.
Sequence[google.cloud.translate_v3.types.TranslateDocumentRequest.LabelsEntry]labels
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)

API documentation for translate_v3.types.TranslateDocumentRequest.LabelsEntry class.