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.



1737
1738
1739
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1737

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


1687
1688
1689
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1687

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:



1693
1694
1695
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1693

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


1703
1704
1705
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1703

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) 


1709
1710
1711
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1709

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) 


1720
1721
1722
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1720

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) 


1729
1730
1731
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1729

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) 


1735
1736
1737
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1735

def target_language_code
  @target_language_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1742
1743
1744
1745
1746
1747
1748
1749
1750
 
# File 'lib/google/apis/translate_v3/classes.rb', line 1742

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