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 more...

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.

[View source]

2346
2347
2348
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2346

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

2289
2290
2291
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2289

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:


2295
2296
2297
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2295

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

2305
2306
2307
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2305

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) 

2311
2312
2313
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2311

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, - Translation LLM models:projects/project-number-or-id/locations/location- id/models/general/translation-llm, 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) 

2324
2325
2326
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2324

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) 

2333
2334
2335
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2333

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) 

2339
2340
2341
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2339

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:


2344
2345
2346
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2344

def transliteration_config
  @transliteration_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
 
# File 'lib/google/apis/translate_v3/classes.rb', line 2351

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