Class: Google::Apis::TranslateV3::TranslateTextRequest

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 request message for synchronous translation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TranslateTextRequest

Returns a new instance of TranslateTextRequest.



1825
1826
1827
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1825

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

Instance Attribute Details

#contents ⇒ Array<String>

Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text. Corresponds to the JSON property contents

Returns:

  • (Array<String>) 


1770
1771
1772
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1770

def contents
  @contents
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:



1776
1777
1778
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1776

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


1786
1787
1788
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1786

def labels
  @labels
end

#mime_type ⇒ String

Optional. The format of the source text, for example, "text/html", "text/plain" . If left blank, the MIME type defaults to "text/html". Corresponds to the JSON property mimeType

Returns:

  • (String) 


1792
1793
1794
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1792

def mime_type
  @mime_type
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, For global (non-regionalized) requests, uselocation-idglobal. For example,projects/project-number-or-id/locations/global/models/general/nmt. If not provided, the default Google model (NMT) will be used Corresponds to the JSON propertymodel`

Returns:

  • (String) 


1803
1804
1805
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1803

def model
  @model
end

#source_language_code ⇒ String

Optional. The ISO-639 language code of the input text 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. Corresponds to the JSON property sourceLanguageCode

Returns:

  • (String) 


1812
1813
1814
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1812

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 text, set to one of the language codes listed in Language Support. Corresponds to the JSON property targetLanguageCode

Returns:

  • (String) 


1818
1819
1820
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1818

def target_language_code
  @target_language_code
end

#transliteration_config ⇒ Google::Apis::TranslateV3::TransliterationConfig

Configures transliteration feature on top of translation. Corresponds to the JSON property transliterationConfig

Returns:



1823
1824
1825
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1823

def transliteration_config
  @transliteration_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1830

def update!(**args)
  @contents = args[:contents] if args.key?(:contents)
  @glossary_config = args[:glossary_config] if args.key?(:glossary_config)
  @labels = args[:labels] if args.key?(:labels)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @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)
  @transliteration_config = args[:transliteration_config] if args.key?(:transliteration_config)
end