Class: OCI::GenerativeAi::Models::Model
- Inherits:
-
Object
- Object
- OCI::GenerativeAi::Models::Model
- 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 Resouces.
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_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
-
#base_model_id ⇒ String
The OCID of the base model that's used for fine-tuning.
-
#capabilities ⇒ Array<String>
[Required] Describes what this model can be used for.
-
#compartment_id ⇒ String
[Required] The compartment OCID for fine-tuned models.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
An optional description of the model.
-
#display_name ⇒ String
A user-friendly name.
- #fine_tune_details ⇒ OCI::GenerativeAi::Models::FineTuneDetails
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] An ID that uniquely identifies a pretrained or fine-tuned model.
-
#is_long_term_supported ⇒ BOOLEAN
Whether a model is supported long-term.
-
#lifecycle_details ⇒ String
A message describing the current state of the model in more detail that can provide actionable information.
-
#lifecycle_state ⇒ String
[Required] The lifecycle state of the model.
- #model_metrics ⇒ OCI::GenerativeAi::Models::ModelMetrics
- #previous_state ⇒ OCI::GenerativeAi::Models::Model
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
[Required] The date and time that the model was created in the format of an RFC3339 datetime string.
-
#time_deprecated ⇒ DateTime
Corresponds to the time when the custom model and its associated foundation model will be deprecated.
-
#time_updated ⇒ DateTime
The date and time that the model was updated in the format of an RFC3339 datetime string.
-
#type ⇒ String
[Required] The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
-
#vendor ⇒ String
The provider of the base model.
-
#version ⇒ String
The version of the model.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Model
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Model
Initializes the object
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 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 |
# File 'lib/oci/generative_ai/models/model.rb', line 217 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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = 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.
86 87 88 |
# File 'lib/oci/generative_ai/models/model.rb', line 86 def base_model_id @base_model_id end |
#capabilities ⇒ Array<String>
[Required] Describes what this model can be used for.
54 55 56 |
# File 'lib/oci/generative_ai/models/model.rb', line 54 def capabilities @capabilities end |
#compartment_id ⇒ String
[Required] The compartment OCID for fine-tuned models. For pretrained models, this value is null.
50 51 52 |
# File 'lib/oci/generative_ai/models/model.rb', line 50 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\"}}
123 124 125 |
# File 'lib/oci/generative_ai/models/model.rb', line 123 def @defined_tags end |
#description ⇒ String
An optional description of the model.
46 47 48 |
# File 'lib/oci/generative_ai/models/model.rb', line 46 def description @description end |
#display_name ⇒ String
A user-friendly name.
74 75 76 |
# File 'lib/oci/generative_ai/models/model.rb', line 74 def display_name @display_name end |
#fine_tune_details ⇒ OCI::GenerativeAi::Models::FineTuneDetails
93 94 95 |
# File 'lib/oci/generative_ai/models/model.rb', line 93 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\"}
115 116 117 |
# File 'lib/oci/generative_ai/models/model.rb', line 115 def @freeform_tags end |
#id ⇒ String
[Required] An ID that uniquely identifies a pretrained or fine-tuned model.
42 43 44 |
# File 'lib/oci/generative_ai/models/model.rb', line 42 def id @id end |
#is_long_term_supported ⇒ BOOLEAN
Whether a model is supported long-term. Only applicable to base models.
100 101 102 |
# File 'lib/oci/generative_ai/models/model.rb', line 100 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.
62 63 64 |
# File 'lib/oci/generative_ai/models/model.rb', line 62 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The lifecycle state of the model.
58 59 60 |
# File 'lib/oci/generative_ai/models/model.rb', line 58 def lifecycle_state @lifecycle_state end |
#model_metrics ⇒ OCI::GenerativeAi::Models::ModelMetrics
96 97 98 |
# File 'lib/oci/generative_ai/models/model.rb', line 96 def model_metrics @model_metrics end |
#previous_state ⇒ OCI::GenerativeAi::Models::Model
107 108 109 |
# File 'lib/oci/generative_ai/models/model.rb', line 107 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\"}}
130 131 132 |
# File 'lib/oci/generative_ai/models/model.rb', line 130 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time that the model was created in the format of an RFC3339 datetime string.
78 79 80 |
# File 'lib/oci/generative_ai/models/model.rb', line 78 def time_created @time_created end |
#time_deprecated ⇒ DateTime
Corresponds to the time when the custom model and its associated foundation model will be deprecated.
104 105 106 |
# File 'lib/oci/generative_ai/models/model.rb', line 104 def time_deprecated @time_deprecated end |
#time_updated ⇒ DateTime
The date and time that the model was updated in the format of an RFC3339 datetime string.
82 83 84 |
# File 'lib/oci/generative_ai/models/model.rb', line 82 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.
90 91 92 |
# File 'lib/oci/generative_ai/models/model.rb', line 90 def type @type end |
#vendor ⇒ String
The provider of the base model.
66 67 68 |
# File 'lib/oci/generative_ai/models/model.rb', line 66 def vendor @vendor end |
#version ⇒ String
The version of the model.
70 71 72 |
# File 'lib/oci/generative_ai/models/model.rb', line 70 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/oci/generative_ai/models/model.rb', line 133 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', 'previous_state': :'previousState', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/oci/generative_ai/models/model.rb', line 162 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', '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.
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/oci/generative_ai/models/model.rb', line 379 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 && previous_state == other.previous_state && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/oci/generative_ai/models/model.rb', line 429 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
409 410 411 |
# File 'lib/oci/generative_ai/models/model.rb', line 409 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
418 419 420 |
# File 'lib/oci/generative_ai/models/model.rb', line 418 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, previous_state, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
462 463 464 465 466 467 468 469 470 471 |
# File 'lib/oci/generative_ai/models/model.rb', line 462 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
456 457 458 |
# File 'lib/oci/generative_ai/models/model.rb', line 456 def to_s to_hash.to_s end |