Class: Google::Apis::TranslateV3::TranslateDocumentRequest

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 more...

Overview

A document translation request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TranslateDocumentRequest

Returns a new instance of TranslateDocumentRequest.

[View source]

2181
2182
2183
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2181

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) 

2106
2107
2108
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2106

def customized_attribution
  @customized_attribution
end

#document_input_config ⇒ Google::Apis::TranslateV3::DocumentInputConfig

A document translation request input config. Corresponds to the JSON property documentInputConfig

Returns:


2111
2112
2113
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2111

def document_input_config
  @document_input_config
end

#document_output_config ⇒ Google::Apis::TranslateV3::DocumentOutputConfig

A document translation request output config. Corresponds to the JSON property documentOutputConfig

Returns:


2116
2117
2118
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2116

def document_output_config
  @document_output_config
end

#enable_rotation_correction ⇒ Boolean Also known as: enable_rotation_correction?

Optional. If true, enable auto rotation correction in DVS. Corresponds to the JSON property enableRotationCorrection

Returns:

  • (Boolean) 

2121
2122
2123
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2121

def enable_rotation_correction
  @enable_rotation_correction
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) 

2129
2130
2131
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2129

def enable_shadow_removal_native_pdf
  @enable_shadow_removal_native_pdf
end

#glossary_config ⇒ Google::Apis::TranslateV3::TranslateTextGlossaryConfig

Configures which glossary is used for a specific target language and defines options for applying that glossary. Corresponds to the JSON property glossaryConfig

Returns:


2136
2137
2138
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2136

def glossary_config
  @glossary_config
end

#is_translate_native_pdf_only ⇒ Boolean Also known as: is_translate_native_pdf_only?

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

Returns:

  • (Boolean) 

2143
2144
2145
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2143

def is_translate_native_pdf_only
  @is_translate_native_pdf_only
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>) 

2154
2155
2156
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2154

def labels
  @labels
end

#model ⇒ String

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

Returns:

  • (String) 

2163
2164
2165
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2163

def model
  @model
end

#source_language_code ⇒ String

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

Returns:

  • (String) 

2173
2174
2175
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2173

def source_language_code
  @source_language_code
end

#target_language_code ⇒ String

Required. The ISO-639 language code to use for translation of the input document, set to one of the language codes listed in Language Support. Corresponds to the JSON property targetLanguageCode

Returns:

  • (String) 

2179
2180
2181
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2179

def target_language_code
  @target_language_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2186

def update!(**args)
  @customized_attribution = args[:customized_attribution] if args.key?(:customized_attribution)
  @document_input_config = args[:document_input_config] if args.key?(:document_input_config)
  @document_output_config = args[:document_output_config] if args.key?(:document_output_config)
  @enable_rotation_correction = args[:enable_rotation_correction] if args.key?(:enable_rotation_correction)
  @enable_shadow_removal_native_pdf = args[:enable_shadow_removal_native_pdf] if args.key?(:enable_shadow_removal_native_pdf)
  @glossary_config = args[:glossary_config] if args.key?(:glossary_config)
  @is_translate_native_pdf_only = args[:is_translate_native_pdf_only] if args.key?(:is_translate_native_pdf_only)
  @labels = args[:labels] if args.key?(:labels)
  @model = args[:model] if args.key?(:model)
  @source_language_code = args[:source_language_code] if args.key?(:source_language_code)
  @target_language_code = args[:target_language_code] if args.key?(:target_language_code)
end