Google Cloud Translation v3 API - Class TranslateDocumentRequest (3.1.0)

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

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

A document translation request.

Inheritance

Object > TranslateDocumentRequest

Implements

IMessage<TranslateDocumentRequest>, IEquatable<TranslateDocumentRequest>, IDeepCloneable<TranslateDocumentRequest>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

TranslateDocumentRequest()

public TranslateDocumentRequest()

TranslateDocumentRequest(TranslateDocumentRequest)

public TranslateDocumentRequest(TranslateDocumentRequest other)

Parameter
Name	Description
`other`	`TranslateDocumentRequest`

Properties

DocumentInputConfig

public DocumentInputConfig DocumentInputConfig { get; set; }

Required. Input configurations.

Property Value
Type	Description
`DocumentInputConfig`

DocumentOutputConfig

public DocumentOutputConfig DocumentOutputConfig { get; set; }

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.

Property Value
Type	Description
`DocumentOutputConfig`

GlossaryConfig

public TranslateTextGlossaryConfig GlossaryConfig { get; set; }

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.

Property Value
Type	Description
`TranslateTextGlossaryConfig`

Labels

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

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.

Property Value
Type	Description
`MapField<String, String>`

Model

public string Model { get; set; }

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.

Property Value
Type	Description
`String`

Parent

public string Parent { get; set; }

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.

Property Value
Type	Description
`String`

SourceLanguageCode

public string SourceLanguageCode { get; set; }

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.

Property Value
Type	Description
`String`

TargetLanguageCode

public string TargetLanguageCode { get; set; }

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.

Property Value
Type	Description
`String`