Class: Google::Apis::TranslateV3::BatchTranslateTextRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/translate_v3/classes.rb,
generated/google/apis/translate_v3/representations.rb,
generated/google/apis/translate_v3/representations.rb

Overview

The batch translation request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BatchTranslateTextRequest

Returns a new instance of BatchTranslateTextRequest.



84
85
86
 
# File 'generated/google/apis/translate_v3/classes.rb', line 84

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#glossaries ⇒ Hash<String,Google::Apis::TranslateV3::TranslateTextGlossaryConfig>

Optional. Glossaries to be applied for translation. It's keyed by target language code. Corresponds to the JSON property glossaries

Returns:



33
34
35
 
# File 'generated/google/apis/translate_v3/classes.rb', line 33

def glossaries
  @glossaries
end

#input_configs ⇒ Array<Google::Apis::TranslateV3::InputConfig>

Required. Input configurations. The total number of files matched should be <= 1000. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding. Corresponds to the JSON property inputConfigs

Returns:



41
42
43
 
# File 'generated/google/apis/translate_v3/classes.rb', line 41

def input_configs
  @input_configs
end

#labels ⇒ Hash<String,String>

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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


52
53
54
 
# File 'generated/google/apis/translate_v3/classes.rb', line 52

def labels
  @labels
end

#models ⇒ Hash<String,String>

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, projects/project-number-or-id/locations/location-id/models/general/base If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used. Corresponds to the JSON property models

Returns:

  • (Hash<String,String>) 


67
68
69
 
# File 'generated/google/apis/translate_v3/classes.rb', line 67

def models
  @models
end

#output_config ⇒ Google::Apis::TranslateV3::OutputConfig

Output configuration for BatchTranslateText request. Corresponds to the JSON property outputConfig

Returns:



72
73
74
 
# File 'generated/google/apis/translate_v3/classes.rb', line 72

def output_config
  @output_config
end

#source_language_code ⇒ String

Required. Source language code. Corresponds to the JSON property sourceLanguageCode

Returns:

  • (String) 


77
78
79
 
# File 'generated/google/apis/translate_v3/classes.rb', line 77

def source_language_code
  @source_language_code
end

#target_language_codes ⇒ Array<String>

Required. Specify up to 10 language codes here. Corresponds to the JSON property targetLanguageCodes

Returns:

  • (Array<String>) 


82
83
84
 
# File 'generated/google/apis/translate_v3/classes.rb', line 82

def target_language_codes
  @target_language_codes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



89
90
91
92
93
94
95
96
97
 
# File 'generated/google/apis/translate_v3/classes.rb', line 89

def update!(**args)
  @glossaries = args[:glossaries] if args.key?(:glossaries)
  @input_configs = args[:input_configs] if args.key?(:input_configs)
  @labels = args[:labels] if args.key?(:labels)
  @models = args[:models] if args.key?(:models)
  @output_config = args[:output_config] if args.key?(:output_config)
  @source_language_code = args[:source_language_code] if args.key?(:source_language_code)
  @target_language_codes = args[:target_language_codes] if args.key?(:target_language_codes)
end