Show / Hide Table of Contents

Class TranslateDocumentRequest

A document translation request.

Inheritance
System.Object
TranslateDocumentRequest
Implements
IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Translate.v3.Data
Assembly: Google.Apis.Translate.v3.dll
Syntax
public class TranslateDocumentRequest : IDirectResponseSchema

Properties

CustomizedAttribution

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

Declaration
[JsonProperty("customizedAttribution")]
public virtual string CustomizedAttribution { get; set; }
Property Value
Type Description
System.String

DocumentInputConfig

Required. Input configurations.

Declaration
[JsonProperty("documentInputConfig")]
public virtual DocumentInputConfig DocumentInputConfig { get; set; }
Property Value
Type Description
DocumentInputConfig

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.

Declaration
[JsonProperty("documentOutputConfig")]
public virtual DocumentOutputConfig DocumentOutputConfig { get; set; }
Property Value
Type Description
DocumentOutputConfig

EnableShadowRemovalNativePdf

Optional. If true, use the text removal server to remove the shadow text on background image for native pdf translation.

Declaration
[JsonProperty("enableShadowRemovalNativePdf")]
public virtual bool? EnableShadowRemovalNativePdf { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

GlossaryConfig

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.

Declaration
[JsonProperty("glossaryConfig")]
public virtual TranslateTextGlossaryConfig GlossaryConfig { get; set; }
Property Value
Type Description
TranslateTextGlossaryConfig

IsTranslateNativePdfOnly

Optional. is_translate_native_pdf_only field for external customers. If true, the page limit of online native pdf translation is 300 and only native pdf pages will be translated.

Declaration
[JsonProperty("isTranslateNativePdfOnly")]
public virtual bool? IsTranslateNativePdfOnly { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>

Model

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.

Declaration
[JsonProperty("model")]
public virtual string Model { get; set; }
Property Value
Type Description
System.String

SourceLanguageCode

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.

Declaration
[JsonProperty("sourceLanguageCode")]
public virtual string SourceLanguageCode { get; set; }
Property Value
Type Description
System.String

TargetLanguageCode

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.

Declaration
[JsonProperty("targetLanguageCode")]
public virtual string TargetLanguageCode { get; set; }
Property Value
Type Description
System.String

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX