Class: OCI::GenerativeAi::Models::Model

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

Overview

You can create a custom model by using your dataset to fine-tune an out-of-the-box text generation base model. Have your dataset ready before you create a custom model. See Training Data Requirements.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resources.

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
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_BASE = 'BASE'.freeze,
  TYPE_CUSTOM = 'CUSTOM'.freeze,
  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 = {}) ⇒ Model

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/generative_ai/models/model.rb', line 232

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

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

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

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

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

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

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

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

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

  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) 


87
88
89
 
# File 'lib/oci/generative_ai/models/model.rb', line 87

def base_model_id
  @base_model_id
end

#capabilities ⇒ Array<String>

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

Returns:

  • (Array<String>) 


55
56
57
 
# File 'lib/oci/generative_ai/models/model.rb', line 55

def capabilities
  @capabilities
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/generative_ai/models/model.rb', line 51

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>>) 


132
133
134
 
# File 'lib/oci/generative_ai/models/model.rb', line 132

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the model.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/generative_ai/models/model.rb', line 47

def description
  @description
end

#display_name ⇒ String

A user-friendly name.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/generative_ai/models/model.rb', line 75

def display_name
  @display_name
end

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

Returns:



94
95
96
 
# File 'lib/oci/generative_ai/models/model.rb', line 94

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>) 


124
125
126
 
# File 'lib/oci/generative_ai/models/model.rb', line 124

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/generative_ai/models/model.rb', line 43

def id
  @id
end

#is_long_term_supported ⇒ BOOLEAN

Whether a model is supported long-term. Only applicable to base models.

Returns:

  • (BOOLEAN) 


101
102
103
 
# File 'lib/oci/generative_ai/models/model.rb', line 101

def is_long_term_supported
  @is_long_term_supported
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/generative_ai/models/model.rb', line 63

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the model.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/generative_ai/models/model.rb', line 59

def lifecycle_state
  @lifecycle_state
end

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

Returns:



97
98
99
 
# File 'lib/oci/generative_ai/models/model.rb', line 97

def model_metrics
  @model_metrics
end

#previous_state ⇒ OCI::GenerativeAi::Models::Model

Returns:



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

def previous_state
  @previous_state
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>>) 


139
140
141
 
# File 'lib/oci/generative_ai/models/model.rb', line 139

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) 


79
80
81
 
# File 'lib/oci/generative_ai/models/model.rb', line 79

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) 


113
114
115
 
# File 'lib/oci/generative_ai/models/model.rb', line 113

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) 


105
106
107
 
# File 'lib/oci/generative_ai/models/model.rb', line 105

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) 


109
110
111
 
# File 'lib/oci/generative_ai/models/model.rb', line 109

def time_on_demand_retired
  @time_on_demand_retired
end

#time_updated ⇒ DateTime

The date and time that the model was updated in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/generative_ai/models/model.rb', line 83

def time_updated
  @time_updated
end

#type ⇒ String

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

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/generative_ai/models/model.rb', line 91

def type
  @type
end

#vendor ⇒ String

The provider of the base model.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/generative_ai/models/model.rb', line 67

def vendor
  @vendor
end

#version ⇒ String

The version of the model.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/generative_ai/models/model.rb', line 71

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/generative_ai/models/model.rb', line 142

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'capabilities': :'capabilities',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'vendor': :'vendor',
    'version': :'version',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    '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',
    'previous_state': :'previousState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/generative_ai/models/model.rb', line 173

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'capabilities': :'Array<String>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'vendor': :'String',
    'version': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'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',
    'previous_state': :'OCI::GenerativeAi::Models::Model',
    '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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/oci/generative_ai/models/model.rb', line 406

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

  self.class == other.class &&
    id == other.id &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    capabilities == other.capabilities &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    vendor == other.vendor &&
    version == other.version &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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 &&
    previous_state == other.previous_state &&
    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



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/oci/generative_ai/models/model.rb', line 458

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


438
439
440
 
# File 'lib/oci/generative_ai/models/model.rb', line 438

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



447
448
449
 
# File 'lib/oci/generative_ai/models/model.rb', line 447

def hash
  [id, description, compartment_id, capabilities, lifecycle_state, lifecycle_details, vendor, version, display_name, time_created, time_updated, base_model_id, type, fine_tune_details, model_metrics, is_long_term_supported, time_deprecated, time_on_demand_retired, time_dedicated_retired, previous_state, 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



491
492
493
494
495
496
497
498
499
500
 
# File 'lib/oci/generative_ai/models/model.rb', line 491

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



485
486
487
 
# File 'lib/oci/generative_ai/models/model.rb', line 485

def to_s
  to_hash.to_s
end