Class: Google::Apis::TranslateV3::TranslateTextRequest
- Inherits:
-
Object
- Object
- Google::Apis::TranslateV3::TranslateTextRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/translate_v3/classes.rb,
generated/google/apis/translate_v3/representations.rb,
generated/google/apis/translate_v3/representations.rb
Overview
The request message for synchronous translation.
Instance Attribute Summary collapse
-
#contents ⇒ Array<String>
Required.
-
#glossary_config ⇒ Google::Apis::TranslateV3::TranslateTextGlossaryConfig
Configures which glossary should be used for a specific target language, and defines options for applying that glossary.
-
#labels ⇒ Hash<String,String>
Optional.
-
#mime_type ⇒ String
Optional.
-
#model ⇒ String
Optional.
-
#source_language_code ⇒ String
Optional.
-
#target_language_code ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TranslateTextRequest
constructor
A new instance of TranslateTextRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ TranslateTextRequest
Returns a new instance of TranslateTextRequest.
827 828 829 |
# File 'generated/google/apis/translate_v3/classes.rb', line 827 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 30k codepoints.
Use BatchTranslateText for larger text.
Corresponds to the JSON property contents
772 773 774 |
# File 'generated/google/apis/translate_v3/classes.rb', line 772 def contents @contents end |
#glossary_config ⇒ Google::Apis::TranslateV3::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
778 779 780 |
# File 'generated/google/apis/translate_v3/classes.rb', line 778 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
789 790 791 |
# File 'generated/google/apis/translate_v3/classes.rb', line 789 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
795 796 797 |
# File 'generated/google/apis/translate_v3/classes.rb', line 795 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
,projects/
project-number-or-id/locations/
location-id/models/general/base
For global (non-regionalized) requests, uselocation-id
global
. For example,projects/
project-number-or-id/locations/global/models/general/nmt
. If missing, the system decides which google base model to use. Corresponds to the JSON propertymodel
810 811 812 |
# File 'generated/google/apis/translate_v3/classes.rb', line 810 def model @model end |
#source_language_code ⇒ String
Optional. The BCP-47 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
819 820 821 |
# File 'generated/google/apis/translate_v3/classes.rb', line 819 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
text, set to one of the language codes listed in Language Support.
Corresponds to the JSON property targetLanguageCode
825 826 827 |
# File 'generated/google/apis/translate_v3/classes.rb', line 825 def target_language_code @target_language_code end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
832 833 834 835 836 837 838 839 840 |
# File 'generated/google/apis/translate_v3/classes.rb', line 832 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 |