Google Cloud Translation v3 API - Class BatchTranslateTextRequest (3.6.0)

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

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

The batch translation request.

Inheritance

object > BatchTranslateTextRequest

Namespace

Google.Cloud.Translate.V3

Assembly

Google.Cloud.Translate.V3.dll

Constructors

BatchTranslateTextRequest()

public BatchTranslateTextRequest()

BatchTranslateTextRequest(BatchTranslateTextRequest)

public BatchTranslateTextRequest(BatchTranslateTextRequest other)
Parameter
NameDescription
otherBatchTranslateTextRequest

Properties

Glossaries

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

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

Property Value
TypeDescription
MapFieldstringTranslateTextGlossaryConfig

InputConfigs

public RepeatedField<InputConfig> InputConfigs { get; }

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

Property Value
TypeDescription
RepeatedFieldInputConfig

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
TypeDescription
MapFieldstringstring

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 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
TypeDescription
MapFieldstringstring

OutputConfig

public OutputConfig 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
TypeDescription
OutputConfig

Parent

public string Parent { get; set; }

Required. Location to make a call. Must refer to a caller's project.

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
TypeDescription
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
TypeDescription
LocationName

SourceLanguageCode

public string SourceLanguageCode { get; set; }

Required. Source language code.

Property Value
TypeDescription
string

TargetLanguageCodes

public RepeatedField<string> TargetLanguageCodes { get; }

Required. Specify up to 10 language codes here.

Property Value
TypeDescription
RepeatedFieldstring