Class: OCI::GenerativeAi::Models::ModelSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/models/model_summary.rb

Overview

Summary of the model.

Constant Summary collapse

CAPABILITIES_ENUM = 
[
  CAPABILITIES_TEXT_GENERATION = 'TEXT_GENERATION'.freeze,
  CAPABILITIES_TEXT_SUMMARIZATION = 'TEXT_SUMMARIZATION'.freeze,
  CAPABILITIES_TEXT_EMBEDDINGS = 'TEXT_EMBEDDINGS'.freeze,
  CAPABILITIES_FINE_TUNE = 'FINE_TUNE'.freeze,
  CAPABILITIES_CHAT = 'CHAT'.freeze,
  CAPABILITIES_TEXT_RERANK = 'TEXT_RERANK'.freeze,
  CAPABILITIES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 207

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.base_model_id = attributes[:'baseModelId'] if attributes[:'baseModelId']

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

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

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

  self.fine_tune_details = attributes[:'fineTuneDetails'] if attributes[:'fineTuneDetails']

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

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

  self.model_metrics = attributes[:'modelMetrics'] if attributes[:'modelMetrics']

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

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

  self.is_long_term_supported = attributes[:'isLongTermSupported'] unless attributes[:'isLongTermSupported'].nil?

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

  self.is_long_term_supported = attributes[:'is_long_term_supported'] unless attributes[:'is_long_term_supported'].nil?

  self.time_deprecated = attributes[:'timeDeprecated'] if attributes[:'timeDeprecated']

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

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

  self.time_on_demand_retired = attributes[:'timeOnDemandRetired'] if attributes[:'timeOnDemandRetired']

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

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

  self.time_dedicated_retired = attributes[:'timeDedicatedRetired'] if attributes[:'timeDedicatedRetired']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#base_model_id ⇒ String

The OCID of the base model that's used for fine-tuning. For pretrained models, the value is null.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 69

def base_model_id
  @base_model_id
end

#capabilities ⇒ Array<String>

[Required] Describes what this model can be used for.

Returns:

  • (Array<String>) 


33
34
35
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 33

def capabilities
  @capabilities
end

#compartment_id ⇒ String

[Required] The compartment OCID for fine-tuned models. For pretrained models, this value is null.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 29

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


116
117
118
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 116

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 53

def display_name
  @display_name
end

#fine_tune_details ⇒ OCI::GenerativeAi::Models::FineTuneDetails

Returns:



81
82
83
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 81

def fine_tune_details
  @fine_tune_details
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


108
109
110
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 108

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] An ID that uniquely identifies a pretrained or a fine-tuned model.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 25

def id
  @id
end

#is_long_term_supported ⇒ BOOLEAN

Whether a model is supported long-term. Applies only to base models.

Returns:

  • (BOOLEAN) 


88
89
90
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 88

def is_long_term_supported
  @is_long_term_supported
end

#lifecycle_details ⇒ String

A message describing the current state of the model with detail that can provide actionable information.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 49

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the model.

Allowed values are: - ACTIVE - CREATING - DELETING - DELETED - FAILED

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 45

def lifecycle_state
  @lifecycle_state
end

#model_metrics ⇒ OCI::GenerativeAi::Models::ModelMetrics

Returns:



84
85
86
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 84

def model_metrics
  @model_metrics
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


123
124
125
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 123

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time that the model was created in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 65

def time_created
  @time_created
end

#time_dedicated_retired ⇒ DateTime

The timestamp indicating when the custom model and its associated foundation model will be fully retired.

Returns:

  • (DateTime) 


100
101
102
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 100

def time_dedicated_retired
  @time_dedicated_retired
end

#time_deprecated ⇒ DateTime

Corresponds to the time when the custom model and its associated foundation model will be deprecated.

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 92

def time_deprecated
  @time_deprecated
end

#time_on_demand_retired ⇒ DateTime

The timestamp indicating when the base model will no longer be available for on-demand usage.

Returns:

  • (DateTime) 


96
97
98
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 96

def time_on_demand_retired
  @time_on_demand_retired
end

#type ⇒ String

[Required] The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.

Allowed values are: - BASE - CUSTOM

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 78

def type
  @type
end

#vendor ⇒ String

The provider of the model.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 57

def vendor
  @vendor
end

#version ⇒ String

The version of the model.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 61

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 126

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'capabilities': :'capabilities',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'display_name': :'displayName',
    'vendor': :'vendor',
    'version': :'version',
    'time_created': :'timeCreated',
    'base_model_id': :'baseModelId',
    'type': :'type',
    'fine_tune_details': :'fineTuneDetails',
    'model_metrics': :'modelMetrics',
    'is_long_term_supported': :'isLongTermSupported',
    'time_deprecated': :'timeDeprecated',
    'time_on_demand_retired': :'timeOnDemandRetired',
    'time_dedicated_retired': :'timeDedicatedRetired',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 154

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'capabilities': :'Array<String>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'display_name': :'String',
    'vendor': :'String',
    'version': :'String',
    'time_created': :'DateTime',
    'base_model_id': :'String',
    'type': :'String',
    'fine_tune_details': :'OCI::GenerativeAi::Models::FineTuneDetails',
    'model_metrics': :'OCI::GenerativeAi::Models::ModelMetrics',
    'is_long_term_supported': :'BOOLEAN',
    'time_deprecated': :'DateTime',
    'time_on_demand_retired': :'DateTime',
    'time_dedicated_retired': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 341

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    capabilities == other.capabilities &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    display_name == other.display_name &&
    vendor == other.vendor &&
    version == other.version &&
    time_created == other.time_created &&
    base_model_id == other.base_model_id &&
    type == other.type &&
    fine_tune_details == other.fine_tune_details &&
    model_metrics == other.model_metrics &&
    is_long_term_supported == other.is_long_term_supported &&
    time_deprecated == other.time_deprecated &&
    time_on_demand_retired == other.time_on_demand_retired &&
    time_dedicated_retired == other.time_dedicated_retired &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 390

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


370
371
372
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 370

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



379
380
381
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 379

def hash
  [id, compartment_id, capabilities, lifecycle_state, lifecycle_details, display_name, vendor, version, time_created, base_model_id, type, fine_tune_details, model_metrics, is_long_term_supported, time_deprecated, time_on_demand_retired, time_dedicated_retired, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



423
424
425
426
427
428
429
430
431
432
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 423

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



417
418
419
 
# File 'lib/oci/generative_ai/models/model_summary.rb', line 417

def to_s
  to_hash.to_s
end