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.
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
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.
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.
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 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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis documentation pertains to the \u003ccode\u003eBatchTranslateDocumentRequest\u003c/code\u003e class within the Google Cloud Translation v3 API, used for batch document translation requests.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003eBatchTranslateDocumentRequest\u003c/code\u003e documentation available is version 3.9.0, with historical versions listed back to 2.2.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBatchTranslateDocumentRequest\u003c/code\u003e class implements multiple interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e and inherits from the \u003ccode\u003eobject\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the \u003ccode\u003eBatchTranslateDocumentRequest\u003c/code\u003e class include configurable options for \u003ccode\u003eCustomizedAttribution\u003c/code\u003e, \u003ccode\u003eEnableRotationCorrection\u003c/code\u003e, \u003ccode\u003eEnableShadowRemovalNativePdf\u003c/code\u003e, file \u003ccode\u003eFormatConversions\u003c/code\u003e, \u003ccode\u003eGlossaries\u003c/code\u003e, \u003ccode\u003eInputConfigs\u003c/code\u003e, \u003ccode\u003eModels\u003c/code\u003e, and \u003ccode\u003eOutputConfig\u003c/code\u003e to be used in the translation process.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBatchTranslateDocumentRequest\u003c/code\u003e requires users to specify \u003ccode\u003eParent\u003c/code\u003e, \u003ccode\u003eSourceLanguageCode\u003c/code\u003e, and \u003ccode\u003eTargetLanguageCodes\u003c/code\u003e, which are vital to perform the batch translation; you can only use AutoML translation models or glossaries within the same region as the project.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Translation v3 API - Class BatchTranslateDocumentRequest (3.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.Translate.V3/latest/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.8.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.7.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.6.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.5.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.4.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.3.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.2.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.1.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/3.0.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/2.4.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/2.3.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Translate.V3/2.2.0/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest) \n\n public sealed class BatchTranslateDocumentRequest : IMessage\u003cBatchTranslateDocumentRequest\u003e, IEquatable\u003cBatchTranslateDocumentRequest\u003e, IDeepCloneable\u003cBatchTranslateDocumentRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Translation v3 API class BatchTranslateDocumentRequest.\n\nThe BatchTranslateDocument request. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e BatchTranslateDocumentRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[BatchTranslateDocumentRequest](/dotnet/docs/reference/Google.Cloud.Translate.V3/latest/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[BatchTranslateDocumentRequest](/dotnet/docs/reference/Google.Cloud.Translate.V3/latest/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[BatchTranslateDocumentRequest](/dotnet/docs/reference/Google.Cloud.Translate.V3/latest/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Translate.V3](/dotnet/docs/reference/Google.Cloud.Translate.V3/latest/Google.Cloud.Translate.V3)\n\nAssembly\n--------\n\nGoogle.Cloud.Translate.V3.dll\n\nConstructors\n------------\n\n### BatchTranslateDocumentRequest()\n\n public BatchTranslateDocumentRequest()\n\n### BatchTranslateDocumentRequest(BatchTranslateDocumentRequest)\n\n public BatchTranslateDocumentRequest(BatchTranslateDocumentRequest other)\n\nProperties\n----------\n\n### CustomizedAttribution\n\n public string CustomizedAttribution { get; set; }\n\nOptional. This flag is to support user customized attribution.\nIf not provided, the default is `Machine Translated by Google`.\nCustomized attribution should follow rules in\n\u003chttps://cloud.google.com/translate/attribution#attribution_and_logos\u003e\n\n### EnableRotationCorrection\n\n public bool EnableRotationCorrection { get; set; }\n\nOptional. If true, enable auto rotation correction in DVS.\n\n### EnableShadowRemovalNativePdf\n\n public bool EnableShadowRemovalNativePdf { get; set; }\n\nOptional. If true, use the text removal server to remove the shadow text on\nbackground image for native pdf translation.\nShadow removal feature can only be enabled when\nis_translate_native_pdf_only: false \\&\\& pdf_native_only: false\n\n### FormatConversions\n\n public MapField\u003cstring, string\u003e FormatConversions { get; }\n\nOptional. The file format conversion map that is applied to all input\nfiles. The map key is the original mime_type. The map value is the target\nmime_type of translated documents.\n\nSupported file format conversion includes:\n\n- `application/pdf` to `application/vnd.openxmlformats-officedocument.wordprocessingml.document`\n\nIf nothing specified, output files will be in the same format as the\noriginal file.\n\n### Glossaries\n\n public MapField\u003cstring, TranslateTextGlossaryConfig\u003e Glossaries { get; }\n\nOptional. Glossaries to be applied. It's keyed by target language code.\n\n### InputConfigs\n\n public RepeatedField\u003cBatchDocumentInputConfig\u003e InputConfigs { get; }\n\nRequired. Input configurations.\nThe total number of files matched should be \\\u003c= 100.\nThe total content size to translate should be \\\u003c= 100M Unicode codepoints.\nThe files must use UTF-8 encoding.\n\n### Models\n\n public MapField\u003cstring, string\u003e Models { get; }\n\nOptional. The models to use for translation. Map's key is target language\ncode. Map's value is the model name. Value can be a built-in general model,\nor an AutoML Translation model.\n\nThe value format depends on model type:\n\n- AutoML Translation models:\n `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`\n\n- General (built-in) models:\n `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,\n\nIf the map is empty or a specific model is\nnot requested for a language pair, then default google model (nmt) is used.\n\n### OutputConfig\n\n public BatchDocumentOutputConfig OutputConfig { get; set; }\n\nRequired. Output configuration.\nIf 2 input configs match to the same file (that is, same input path),\nwe don't generate output for duplicate inputs.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. Location to make a regional call.\n\nFormat: `projects/{project-number-or-id}/locations/{location-id}`.\n\nThe `global` location is not supported for batch translation.\n\nOnly AutoML Translation models or glossaries within the same region (have\nthe same location-id) can be used, otherwise an INVALID_ARGUMENT (400)\nerror is returned.\n\n### ParentAsLocationName\n\n public LocationName ParentAsLocationName { get; set; }\n\n[LocationName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.LocationName.html)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.Translate.V3/latest/Google.Cloud.Translate.V3.BatchTranslateDocumentRequest#Google_Cloud_Translate_V3_BatchTranslateDocumentRequest_Parent) resource name property.\n\n### SourceLanguageCode\n\n public string SourceLanguageCode { get; set; }\n\nRequired. The ISO-639 language code of the input document if known, for\nexample, \"en-US\" or \"sr-Latn\". Supported language codes are listed in\n[Language Support](https://cloud.google.com/translate/docs/languages).\n\n### TargetLanguageCodes\n\n public RepeatedField\u003cstring\u003e TargetLanguageCodes { get; }\n\nRequired. The ISO-639 language code to use for translation of the input\ndocument. Specify up to 10 language codes here."]]
