Class: Google::Apis::TranslateV3::TranslateTextRequest
- Inherits:
-
Object
- Object
- Google::Apis::TranslateV3::TranslateTextRequest
- 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
-
#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.
Constructor Details
#initialize(**args) ⇒ TranslateTextRequest
Returns a new instance of TranslateTextRequest.
1130 1131 1132 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1130 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. The max length of this field is 1024. Use
BatchTranslateText for larger text.
Corresponds to the JSON property contents
1080 1081 1082 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1080 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
1086 1087 1088 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1086 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
1096 1097 1098 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1096 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
1102 1103 1104 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1102 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, use
location-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 property
model`
1113 1114 1115 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1113 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
1122 1123 1124 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1122 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
1128 1129 1130 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1128 def target_language_code @target_language_code end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1135 1136 1137 1138 1139 1140 1141 1142 1143 |
# File 'lib/google/apis/translate_v3/classes.rb', line 1135 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 |