Class: OCI::AiLanguage::Models::BatchLanguageTranslationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/batch_language_translation_details.rb

Overview

The documents details for translation call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchLanguageTranslationDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 107

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self._alias = attributes[:'alias'] if attributes[:'alias']

  raise 'You cannot provide both :alias and :_alias' if attributes.key?(:'alias') && attributes.key?(:'_alias')

  self._alias = attributes[:'_alias'] if attributes[:'_alias']

  self.endpoint_id = attributes[:'endpointId'] if attributes[:'endpointId']

  raise 'You cannot provide both :endpointId and :endpoint_id' if attributes.key?(:'endpointId') && attributes.key?(:'endpoint_id')

  self.endpoint_id = attributes[:'endpoint_id'] if attributes[:'endpoint_id']

  self.no_translate = attributes[:'noTranslate'] if attributes[:'noTranslate']

  raise 'You cannot provide both :noTranslate and :no_translate' if attributes.key?(:'noTranslate') && attributes.key?(:'no_translate')

  self.no_translate = attributes[:'no_translate'] if attributes[:'no_translate']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.target_language_code = attributes[:'targetLanguageCode'] if attributes[:'targetLanguageCode']

  raise 'You cannot provide both :targetLanguageCode and :target_language_code' if attributes.key?(:'targetLanguageCode') && attributes.key?(:'target_language_code')

  self.target_language_code = attributes[:'target_language_code'] if attributes[:'target_language_code']

  self.documents = attributes[:'documents'] if attributes[:'documents']
end

Instance Attribute Details

#_alias ⇒ String

Unique name to identify an endpoint to be used for inferencing

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 13

def _alias
  @_alias
end

#compartment_id ⇒ String

The OCID of the compartment that calls the API, inference will be served from pre trained model

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 25

def compartment_id
  @compartment_id
end

#documents ⇒ Array<OCI::AiLanguage::Models::TextDocument>

[Required] List of documents for translation.

Returns:



65
66
67
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 65

def documents
  @documents
end

#endpoint_id ⇒ String

The endpoint that has to be used for inferencing.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 17

def endpoint_id
  @endpoint_id
end

#no_translate ⇒ Array<String>

List of words not to be translated

Returns:

  • (Array<String>) 


21
22
23
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 21

def no_translate
  @no_translate
end

#target_language_code ⇒ String

Language code supported Arabic - ar Brazilian Portuguese - pt-BR Canadian French - fr-CA Croatian - hr Czech - cs Danish - da Dutch - nl English - en Finnish - fi French - fr German - de Greek - el Hebrew - he Hungarian - hu Italian - it Japanese - ja Korean - ko Norwegian - no Polish - pl Portuguese - pt Romanian - ro Russian - ru Simplified Chinese - zh-CN Slovak - sk Slovenian - sl Spanish - es Swedish - sv Thai - th Traditional Chinese - zh-TW Turkish - tr Vietnamese - vi

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 61

def target_language_code
  @target_language_code
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 68

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '_alias': :'alias',
    'endpoint_id': :'endpointId',
    'no_translate': :'noTranslate',
    'compartment_id': :'compartmentId',
    'target_language_code': :'targetLanguageCode',
    'documents': :'documents'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 82

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '_alias': :'String',
    'endpoint_id': :'String',
    'no_translate': :'Array<String>',
    'compartment_id': :'String',
    'target_language_code': :'String',
    'documents': :'Array<OCI::AiLanguage::Models::TextDocument>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 153

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    _alias == other._alias &&
    endpoint_id == other.endpoint_id &&
    no_translate == other.no_translate &&
    compartment_id == other.compartment_id &&
    target_language_code == other.target_language_code &&
    documents == other.documents
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 188

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 168

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



177
178
179
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 177

def hash
  [_alias, endpoint_id, no_translate, compartment_id, target_language_code, documents].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 221

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



215
216
217
 
# File 'lib/oci/ai_language/models/batch_language_translation_details.rb', line 215

def to_s
  to_hash.to_s
end