Class: OCI::GenerativeAi::Models::CreateImportedModelDetails

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

Overview

The data to import a model.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateImportedModelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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

  • :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

  • :capabilities (Array<String>) —

    The value to assign to the #capabilities 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



120
121
122
123
124
125
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
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 120

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

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

Instance Attribute Details

#capabilities ⇒ Array<String>

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

Returns:

  • (Array<String>) 


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

def capabilities
  @capabilities
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 37

def compartment_id
  @compartment_id
end

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

This attribute is required.

Returns:



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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the imported model.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

A user-friendly name for the imported model.

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#vendor ⇒ String

The provider of the imported model.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 41

def vendor
  @vendor
end

#version ⇒ String

The version of the imported model.

Returns:

  • (String) 


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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'vendor': :'vendor',
    'version': :'version',
    'data_source': :'dataSource',
    'capabilities': :'capabilities',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'vendor': :'String',
    'version': :'String',
    'data_source': :'OCI::GenerativeAi::Models::ModelDataSource',
    'capabilities': :'Array<String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 187

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    vendor == other.vendor &&
    version == other.version &&
    data_source == other.data_source &&
    capabilities == other.capabilities &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 225

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


205
206
207
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 205

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



214
215
216
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 214

def hash
  [display_name, description, compartment_id, vendor, version, data_source, capabilities, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 258

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



252
253
254
 
# File 'lib/oci/generative_ai/models/create_imported_model_details.rb', line 252

def to_s
  to_hash.to_s
end