Class: OCI::GoldenGate::Models::AiModelSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/golden_gate/models/ai_model_summary.rb

Overview

Summary details of an AI model supported by a provider.

Constant Summary collapse

PROVIDER_TYPE_ENUM = 
[
  PROVIDER_TYPE_OCI_GENERATIVE_AI = 'OCI_GENERATIVE_AI'.freeze,
  PROVIDER_TYPE_GEMINI = 'GEMINI'.freeze,
  PROVIDER_TYPE_OPEN_AI = 'OPEN_AI'.freeze,
  PROVIDER_TYPE_VOYAGE_AI = 'VOYAGE_AI'.freeze,
  PROVIDER_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 = {}) ⇒ AiModelSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :provider_type (String) —

    The value to assign to the #provider_type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 75

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

  self.provider_type = attributes[:'providerType'] if attributes[:'providerType']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

Instance Attribute Details

#description ⇒ String

[Required] Metadata about this specific object.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 39

def description
  @description
end

#display_name ⇒ String

[Required] An object's Display Name.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 34

def display_name
  @display_name
end

#key ⇒ String

[Required] The identifier of the AI model offered by a provider.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 24

def key
  @key
end

#provider_type ⇒ String

[Required] AI Provider type used by the AI Model Connection.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 29

def provider_type
  @provider_type
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'provider_type': :'providerType',
    'display_name': :'displayName',
    'description': :'description'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'provider_type': :'String',
    'display_name': :'String',
    'description': :'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



118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 118

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

  self.class == other.class &&
    key == other.key &&
    provider_type == other.provider_type &&
    display_name == other.display_name &&
    description == other.description
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 151

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


131
132
133
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 140

def hash
  [key, provider_type, display_name, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 184

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



178
179
180
 
# File 'lib/oci/golden_gate/models/ai_model_summary.rb', line 178

def to_s
  to_hash.to_s
end