Class: OCI::AiLanguage::Models::ModelMetadataDetails

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

Overview

training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelMetadataDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 108

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.model_type = attributes[:'modelType'] if attributes[:'modelType']

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

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

  self.model_id = attributes[:'modelId'] if attributes[:'modelId']

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

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

  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.language_code = attributes[:'languageCode'] if attributes[:'languageCode']

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

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

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

Instance Attribute Details

#configuration ⇒ Hash<String, OCI::AiLanguage::Models::ConfigurationDetails>

model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails}

Returns:



69
70
71
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 69

def configuration
  @configuration
end

#endpoint_id ⇒ String

Unique identifier endpoint OCID that should be used for inference

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 32

def endpoint_id
  @endpoint_id
end

#language_code ⇒ String

Language code supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew

Returns:

  • (String) 


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

def language_code
  @language_code
end

#model_id ⇒ String

Unique identifier model OCID that should be used for inference

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 28

def model_id
  @model_id
end

#model_type ⇒ String

model type to used for inference allowed values are - LANGUAGE_SENTIMENT_ANALYSIS - LANGUAGE_DETECTION - TEXT_CLASSIFICATION - NAMED_ENTITY_RECOGNITION - KEY_PHRASE_EXTRACTION - LANGUAGE_PII_ENTITIES - LANGUAGE_TRANSLATION

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 24

def model_type
  @model_type
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'model_id': :'modelId',
    'endpoint_id': :'endpointId',
    'language_code': :'languageCode',
    'configuration': :'configuration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'model_id': :'String',
    'endpoint_id': :'String',
    'language_code': :'String',
    'configuration': :'Hash<String, OCI::AiLanguage::Models::ConfigurationDetails>'
    # 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



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 148

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

  self.class == other.class &&
    model_type == other.model_type &&
    model_id == other.model_id &&
    endpoint_id == other.endpoint_id &&
    language_code == other.language_code &&
    configuration == other.configuration
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 182

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


162
163
164
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 162

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 171

def hash
  [model_type, model_id, endpoint_id, language_code, configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 215

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



209
210
211
 
# File 'lib/oci/ai_language/models/model_metadata_details.rb', line 209

def to_s
  to_hash.to_s
end