Class: OCI::GenerativeAi::Models::ImportedModelSummary

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

Overview

Summary of the importedModel.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImportedModelSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :capabilities (Array<String>) —

    The value to assign to the #capabilities property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :vendor (String) —

    The value to assign to the #vendor property

  • :version (String) —

    The value to assign to the #version property

  • :data_source (OCI::GenerativeAi::Models::ModelDataSource) —

    The value to assign to the #data_source property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
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
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 177

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


48
49
50
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 48

def capabilities
  @capabilities
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 44

def compartment_id
  @compartment_id
end

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

This attribute is required.

Returns:



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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the imported model.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 40

def description
  @description
end

#display_name ⇒ String

A user-friendly name of the imported model.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 36

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


93
94
95
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 93

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 32

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) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of the imported model.

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_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>>) 


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

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) 


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

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) 


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

def time_updated
  @time_updated
end

#vendor ⇒ String

The provider of the imported model.

Returns:

  • (String) 


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

def vendor
  @vendor
end

#version ⇒ String

The version of the imported model.

Returns:

  • (String) 


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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 111

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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 134

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',
    '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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 281

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 325

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


305
306
307
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 305

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



314
315
316
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 314

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



358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 358

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



352
353
354
 
# File 'lib/oci/generative_ai/models/imported_model_summary.rb', line 352

def to_s
  to_hash.to_s
end