Class: OCI::AiLanguage::Models::ModelDetails

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

Overview

Possible model types This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_NAMED_ENTITY_RECOGNITION = 'NAMED_ENTITY_RECOGNITION'.freeze,
  MODEL_TYPE_TEXT_CLASSIFICATION = 'TEXT_CLASSIFICATION'.freeze,
  MODEL_TYPE_PRE_TRAINED_NAMED_ENTITY_RECOGNITION = 'PRE_TRAINED_NAMED_ENTITY_RECOGNITION'.freeze,
  MODEL_TYPE_PRE_TRAINED_TEXT_CLASSIFICATION = 'PRE_TRAINED_TEXT_CLASSIFICATION'.freeze,
  MODEL_TYPE_PRE_TRAINED_SENTIMENT_ANALYSIS = 'PRE_TRAINED_SENTIMENT_ANALYSIS'.freeze,
  MODEL_TYPE_PRE_TRAINED_KEYPHRASE_EXTRACTION = 'PRE_TRAINED_KEYPHRASE_EXTRACTION'.freeze,
  MODEL_TYPE_PRE_TRAINED_LANGUAGE_DETECTION = 'PRE_TRAINED_LANGUAGE_DETECTION'.freeze,
  MODEL_TYPE_PRE_TRAINED_PII = 'PRE_TRAINED_PII'.freeze,
  MODEL_TYPE_PRE_TRAINED_TRANSLATION = 'PRE_TRAINED_TRANSLATION'.freeze,
  MODEL_TYPE_PRE_TRAINED_HEALTH_NLU = 'PRE_TRAINED_HEALTH_NLU'.freeze,
  MODEL_TYPE_PRE_TRAINED_SUMMARIZATION = 'PRE_TRAINED_SUMMARIZATION'.freeze,
  MODEL_TYPE_PRE_TRAINED_UNIVERSAL = 'PRE_TRAINED_UNIVERSAL'.freeze,
  MODEL_TYPE_PII = 'PII'.freeze,
  MODEL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :language_code (String) —

    The value to assign to the #language_code property

  • :model_type (String) —

    The value to assign to the #model_type property



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/ai_language/models/model_details.rb', line 92

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.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.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']
end

Instance Attribute Details

#language_code ⇒ String

supported language default value is en

Returns:

  • (String) 


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

def language_code
  @language_code
end

#model_type ⇒ String

[Required] Model type

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/ai_language/models/model_details.rb', line 36

def model_type
  @model_type
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
 
# File 'lib/oci/ai_language/models/model_details.rb', line 39

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

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/ai_language/models/model_details.rb', line 63

def self.get_subtype(object_hash)
  type = object_hash[:'modelType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::AiLanguage::Models::PreTrainedKeyPhraseExtractionModelDetails' if type == 'PRE_TRAINED_KEYPHRASE_EXTRACTION'
  return 'OCI::AiLanguage::Models::PreTrainedHealthNluModelDetails' if type == 'PRE_TRAINED_HEALTH_NLU'
  return 'OCI::AiLanguage::Models::PreTrainedUniversalModel' if type == 'PRE_TRAINED_UNIVERSAL'
  return 'OCI::AiLanguage::Models::NamedEntityRecognitionModelDetails' if type == 'NAMED_ENTITY_RECOGNITION'
  return 'OCI::AiLanguage::Models::PiiModelDetails' if type == 'PII'
  return 'OCI::AiLanguage::Models::PreTrainedLanguageDetectionModelDetails' if type == 'PRE_TRAINED_LANGUAGE_DETECTION'
  return 'OCI::AiLanguage::Models::PreTrainedNamedEntityRecognitionModelDetails' if type == 'PRE_TRAINED_NAMED_ENTITY_RECOGNITION'
  return 'OCI::AiLanguage::Models::PreTrainedSentimentAnalysisModelDetails' if type == 'PRE_TRAINED_SENTIMENT_ANALYSIS'
  return 'OCI::AiLanguage::Models::PreTrainedTextClassificationModelDetails' if type == 'PRE_TRAINED_TEXT_CLASSIFICATION'
  return 'OCI::AiLanguage::Models::TextClassificationModelDetails' if type == 'TEXT_CLASSIFICATION'
  return 'OCI::AiLanguage::Models::PreTrainedSummarization' if type == 'PRE_TRAINED_SUMMARIZATION'
  return 'OCI::AiLanguage::Models::PreTrainedPiiModelDetails' if type == 'PRE_TRAINED_PII'

  # TODO: Log a warning when the subtype is not found.
  'OCI::AiLanguage::Models::ModelDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
 
# File 'lib/oci/ai_language/models/model_details.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'language_code': :'String',
    'model_type': :'String'
    # 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



131
132
133
134
135
136
137
 
# File 'lib/oci/ai_language/models/model_details.rb', line 131

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

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/ai_language/models/model_details.rb', line 162

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


142
143
144
 
# File 'lib/oci/ai_language/models/model_details.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/oci/ai_language/models/model_details.rb', line 151

def hash
  [language_code, model_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/ai_language/models/model_details.rb', line 195

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



189
190
191
 
# File 'lib/oci/ai_language/models/model_details.rb', line 189

def to_s
  to_hash.to_s
end