Class: OCI::GenerativeAi::Models::ImportedModel

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

Overview

Represents a model imported into the system based on an external data source, such as Hugging Face or Object Storage.

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_TO_TEXT = 'TEXT_TO_TEXT'.freeze,
  CAPABILITIES_IMAGE_TEXT_TO_TEXT = 'IMAGE_TEXT_TO_TEXT'.freeze,
  CAPABILITIES_EMBEDDING = 'EMBEDDING'.freeze,
  CAPABILITIES_RERANK = 'RERANK'.freeze,
  CAPABILITIES_TEXT_TO_IMAGE = 'TEXT_TO_IMAGE'.freeze,
  CAPABILITIES_IMAGE_TEXT_TO_IMAGE = 'IMAGE_TEXT_TO_IMAGE'.freeze,
  CAPABILITIES_IMAGE_TEXT_TO_VIDEO = 'IMAGE_TEXT_TO_VIDEO'.freeze,
  CAPABILITIES_IMAGE_TO_IMAGE = 'IMAGE_TO_IMAGE'.freeze,
  CAPABILITIES_REALTIME = 'REALTIME'.freeze,
  CAPABILITIES_AUDIO_TO_AUDIO = 'AUDIO_TO_AUDIO'.freeze,
  CAPABILITIES_AUDIO_TO_TEXT = 'AUDIO_TO_TEXT'.freeze,
  CAPABILITIES_TEXT_TO_AUDIO = 'TEXT_TO_AUDIO'.freeze,
  CAPABILITIES_TEXT_TO_VIDEO = 'TEXT_TO_VIDEO'.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_UPDATING = 'UPDATING'.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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImportedModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 187

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

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

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

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

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

#capabilities ⇒ Array<String>

Specifies the intended use or supported capabilities of the imported model.

Returns:

  • (Array<String>) 


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

def capabilities
  @capabilities
end

#compartment_id ⇒ String

[Required] The compartment OCID from which the model is imported.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#data_source ⇒ OCI::GenerativeAi::Models::ModelDataSource

This attribute is required.

Returns:



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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the imported model.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

A user-friendly name.

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] An OCID that uniquely identifies an imported model.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current state of the imported model, providing more detailed and actionable context.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the imported model.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#previous_state ⇒ OCI::GenerativeAi::Models::ImportedModel

Returns:



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

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


115
116
117
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 115

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


85
86
87
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 85

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 89

def time_updated
  @time_updated
end

#vendor ⇒ String

The provider of the imported model.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 73

def vendor
  @vendor
end

#version ⇒ String

The version of the imported model.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 77

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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/generative_ai/models/imported_model.rb', line 118

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

.swagger_types ⇒ Object

Attribute type mapping.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 142

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 310

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    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 &&
    data_source == other.data_source &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 355

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


335
336
337
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 335

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



344
345
346
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 344

def hash
  [id, display_name, description, compartment_id, capabilities, lifecycle_state, lifecycle_details, vendor, version, data_source, time_created, time_updated, 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



388
389
390
391
392
393
394
395
396
397
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 388

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



382
383
384
 
# File 'lib/oci/generative_ai/models/imported_model.rb', line 382

def to_s
  to_hash.to_s
end