Google Cloud Translation v3 API - Class BatchTranslateDocumentRequest (3.10.0) 

public sealed class BatchTranslateDocumentRequest : IMessage<BatchTranslateDocumentRequest>, IEquatable<BatchTranslateDocumentRequest>, IDeepCloneable<BatchTranslateDocumentRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Translation v3 API class BatchTranslateDocumentRequest.

The BatchTranslateDocument request.

Inheritance

object > BatchTranslateDocumentRequest

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

BatchTranslateDocumentRequest()

public BatchTranslateDocumentRequest()

BatchTranslateDocumentRequest(BatchTranslateDocumentRequest)

public BatchTranslateDocumentRequest(BatchTranslateDocumentRequest other)
Parameter
Name Description
other BatchTranslateDocumentRequest

Properties

CustomizedAttribution

public string CustomizedAttribution { get; set; }

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

Property Value
Type Description
string

EnableRotationCorrection

public bool EnableRotationCorrection { get; set; }

Optional. If true, enable auto rotation correction in DVS.

Property Value
Type Description
bool

EnableShadowRemovalNativePdf

public bool EnableShadowRemovalNativePdf { get; set; }

Optional. If true, use the text removal server 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: false && pdf_native_only: false

Property Value
Type Description
bool

FormatConversions

public MapField<string, string> FormatConversions { get; }

Optional. The file format conversion map that is applied to all input files. The map key is the original mime_type. The map value is the target mime_type of translated documents.

Supported file format conversion includes:

  • application/pdf to application/vnd.openxmlformats-officedocument.wordprocessingml.document

If nothing specified, output files will be in the same format as the original file.

Property Value
Type Description
MapFieldstringstring

Glossaries

public MapField<string, TranslateTextGlossaryConfig> Glossaries { get; }

Optional. Glossaries to be applied. It's keyed by target language code.

Property Value
Type Description
MapFieldstringTranslateTextGlossaryConfig

InputConfigs

public RepeatedField<BatchDocumentInputConfig> InputConfigs { get; }

Required. Input configurations. The total number of files matched should be <= 100. The total content size to translate should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.

Property Value
Type Description
RepeatedFieldBatchDocumentInputConfig

Models

public MapField<string, string> Models { get; }

Optional. The models to use for translation. Map's key is target language code. Map's value is the 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.

Property Value
Type Description
MapFieldstringstring

OutputConfig

public BatchDocumentOutputConfig OutputConfig { get; set; }

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.

Property Value
Type Description
BatchDocumentOutputConfig

Parent

public string Parent { get; set; }

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.

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

SourceLanguageCode

public string SourceLanguageCode { get; set; }

Required. 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.

Property Value
Type Description
string

TargetLanguageCodes

public RepeatedField<string> TargetLanguageCodes { get; }

Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here. Supported language codes are listed in Language Support.

Property Value
Type Description
RepeatedFieldstring