Class: Google::Apis::TranslateV3::BatchTranslateDocumentRequest

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

Overview

The BatchTranslateDocument request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BatchTranslateDocumentRequest

Returns a new instance of BatchTranslateDocumentRequest.



130
131
132
 
# File 'lib/google/apis/translate_v3/classes.rb', line 130

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

Instance Attribute Details

#customized_attribution ⇒ String

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

Returns:

  • (String) 


73
74
75
 
# File 'lib/google/apis/translate_v3/classes.rb', line 73

def customized_attribution
  @customized_attribution
end

#enable_shadow_removal_native_pdf ⇒ Boolean Also known as: enable_shadow_removal_native_pdf?

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

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/google/apis/translate_v3/classes.rb', line 80

def enable_shadow_removal_native_pdf
  @enable_shadow_removal_native_pdf
end

#format_conversions ⇒ Hash<String,String>

Optional. Corresponds to the JSON property formatConversions

Returns:

  • (Hash<String,String>) 


86
87
88
 
# File 'lib/google/apis/translate_v3/classes.rb', line 86

def format_conversions
  @format_conversions
end

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

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

Returns:



91
92
93
 
# File 'lib/google/apis/translate_v3/classes.rb', line 91

def glossaries
  @glossaries
end

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

Required. Input configurations. The total number of files matched should be <=

  1. The total content size to translate should be <= 100M Unicode codepoints. The files must use UTF-8 encoding. Corresponds to the JSON property inputConfigs

Returns:



98
99
100
 
# File 'lib/google/apis/translate_v3/classes.rb', line 98

def input_configs
  @input_configs
end

#models ⇒ Hash<String,String>

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 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. Corresponds to the JSON propertymodels`

Returns:

  • (Hash<String,String>) 


110
111
112
 
# File 'lib/google/apis/translate_v3/classes.rb', line 110

def models
  @models
end

#output_config ⇒ Google::Apis::TranslateV3::BatchDocumentOutputConfig

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

Returns:



115
116
117
 
# File 'lib/google/apis/translate_v3/classes.rb', line 115

def output_config
  @output_config
end

#source_language_code ⇒ String

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

Returns:

  • (String) 


122
123
124
 
# File 'lib/google/apis/translate_v3/classes.rb', line 122

def source_language_code
  @source_language_code
end

#target_language_codes ⇒ Array<String>

Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here. Corresponds to the JSON property targetLanguageCodes

Returns:

  • (Array<String>) 


128
129
130
 
# File 'lib/google/apis/translate_v3/classes.rb', line 128

def target_language_codes
  @target_language_codes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/google/apis/translate_v3/classes.rb', line 135

def update!(**args)
  @customized_attribution = args[:customized_attribution] if args.key?(:customized_attribution)
  @enable_shadow_removal_native_pdf = args[:enable_shadow_removal_native_pdf] if args.key?(:enable_shadow_removal_native_pdf)
  @format_conversions = args[:format_conversions] if args.key?(:format_conversions)
  @glossaries = args[:glossaries] if args.key?(:glossaries)
  @input_configs = args[:input_configs] if args.key?(:input_configs)
  @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