Class: OCI::GenerativeAi::Models::CreateModelDetails

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

Overview

The data to create a custom model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateModelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 104

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

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

#base_model_idString

[Required] The OCID of the base model that's used for fine-tuning.

Returns:

  • (String)


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

def base_model_id
  @base_model_id
end

#compartment_idString

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

Returns:

  • (String)


17
18
19
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 17

def compartment_id
  @compartment_id
end

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


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

def defined_tags
  @defined_tags
end

#descriptionString

An optional description of the model.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

A user-friendly name.

Returns:

  • (String)


13
14
15
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 13

def display_name
  @display_name
end

#fine_tune_detailsOCI::GenerativeAi::Models::FineTuneDetails

This attribute is required.



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

def fine_tune_details
  @fine_tune_details
end

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


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

def freeform_tags
  @freeform_tags
end

#vendorString

The provider of the model.

Returns:

  • (String)


21
22
23
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 21

def vendor
  @vendor
end

#versionString

The version of the model.

Returns:

  • (String)


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

def version
  @version
end

Class Method Details

.attribute_mapObject

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 56

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

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'vendor': :'String',
    'version': :'String',
    'description': :'String',
    'base_model_id': :'String',
    'fine_tune_details': :'OCI::GenerativeAi::Models::FineTuneDetails',
    '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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 160

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    vendor == other.vendor &&
    version == other.version &&
    description == other.description &&
    base_model_id == other.base_model_id &&
    fine_tune_details == other.fine_tune_details &&
    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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 198

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


178
179
180
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 178

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



187
188
189
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 187

def hash
  [display_name, compartment_id, vendor, version, description, base_model_id, fine_tune_details, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
240
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 231

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



225
226
227
# File 'lib/oci/generative_ai/models/create_model_details.rb', line 225

def to_s
  to_hash.to_s
end