Class: Google::Apis::TranslateV3beta1::TranslateDocumentRequest

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

Overview

A document translation request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TranslateDocumentRequest

Returns a new instance of TranslateDocumentRequest.



1012
1013
1014
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 1012

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) 


944
945
946
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 944

def customized_attribution
  @customized_attribution
end

#document_input_config ⇒ Google::Apis::TranslateV3beta1::DocumentInputConfig

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

Returns:



949
950
951
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 949

def document_input_config
  @document_input_config
end

#document_output_config ⇒ Google::Apis::TranslateV3beta1::DocumentOutputConfig

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

Returns:



954
955
956
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 954

def document_output_config
  @document_output_config
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. Corresponds to the JSON property enableShadowRemovalNativePdf

Returns:

  • (Boolean) 


960
961
962
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 960

def enable_shadow_removal_native_pdf
  @enable_shadow_removal_native_pdf
end

#glossary_config ⇒ Google::Apis::TranslateV3beta1::TranslateTextGlossaryConfig

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

Returns:



967
968
969
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 967

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) 


974
975
976
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 974

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>) 


985
986
987
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 985

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) 


994
995
996
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 994

def model
  @model
end

#source_language_code ⇒ String

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

Returns:

  • (String) 


1004
1005
1006
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 1004

def source_language_code
  @source_language_code
end

#target_language_code ⇒ String

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

Returns:

  • (String) 


1010
1011
1012
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 1010

def target_language_code
  @target_language_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/google/apis/translate_v3beta1/classes.rb', line 1017

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_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