Class: OCI::AiLanguage::Models::Model
- Inherits:
-
Object
- Object
- OCI::AiLanguage::Models::Model
- Defined in:
- lib/oci/ai_language/models/model.rb
Overview
Description of the a Model.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID for the model's compartment.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
A short description of the Model.
-
#display_name ⇒ String
[Required] A user-friendly display name for the resource.
- #evaluation_results ⇒ OCI::AiLanguage::Models::EvaluationResults
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] Unique identifier model OCID of a model that is immutable on creation.
-
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
[Required] The state of the model.
-
#model_details ⇒ OCI::AiLanguage::Models::ModelDetails
This attribute is required.
-
#project_id ⇒ String
[Required] The OCID of the project to associate with the model.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
- #test_strategy ⇒ OCI::AiLanguage::Models::TestStrategy
-
#time_created ⇒ DateTime
[Required] The time the the model was created.
-
#time_updated ⇒ DateTime
The time the model was updated.
- #training_dataset ⇒ OCI::AiLanguage::Models::DatasetDetails
-
#version ⇒ String
For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done <<service>>::<<service-name>>_<<model-type-version>>::<<custom model on which this training has to be done>> ex: ai-lang::NER_V1::CUSTOM-V0.
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
170 171 172 173 174 175 176 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 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/oci/ai_language/models/model.rb', line 170 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.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.project_id = attributes[:'projectId'] if attributes[:'projectId'] raise 'You cannot provide both :projectId and :project_id' if attributes.key?(:'projectId') && attributes.key?(:'project_id') self.project_id = attributes[:'project_id'] if attributes[:'project_id'] self.description = attributes[:'description'] if attributes[:'description'] self.model_details = attributes[:'modelDetails'] if attributes[:'modelDetails'] raise 'You cannot provide both :modelDetails and :model_details' if attributes.key?(:'modelDetails') && attributes.key?(:'model_details') self.model_details = attributes[:'model_details'] if attributes[:'model_details'] 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.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.training_dataset = attributes[:'trainingDataset'] if attributes[:'trainingDataset'] raise 'You cannot provide both :trainingDataset and :training_dataset' if attributes.key?(:'trainingDataset') && attributes.key?(:'training_dataset') self.training_dataset = attributes[:'training_dataset'] if attributes[:'training_dataset'] self.evaluation_results = attributes[:'evaluationResults'] if attributes[:'evaluationResults'] raise 'You cannot provide both :evaluationResults and :evaluation_results' if attributes.key?(:'evaluationResults') && attributes.key?(:'evaluation_results') self.evaluation_results = attributes[:'evaluation_results'] if attributes[:'evaluation_results'] self.test_strategy = attributes[:'testStrategy'] if attributes[:'testStrategy'] raise 'You cannot provide both :testStrategy and :test_strategy' if attributes.key?(:'testStrategy') && attributes.key?(:'test_strategy') self.test_strategy = attributes[:'test_strategy'] if attributes[:'test_strategy'] self.version = attributes[:'version'] if attributes[:'version'] 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
#compartment_id ⇒ String
[Required] The OCID for the model's compartment.
32 33 34 |
# File 'lib/oci/ai_language/models/model.rb', line 32 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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
89 90 91 |
# File 'lib/oci/ai_language/models/model.rb', line 89 def @defined_tags end |
#description ⇒ String
A short description of the Model.
40 41 42 |
# File 'lib/oci/ai_language/models/model.rb', line 40 def description @description end |
#display_name ⇒ String
[Required] A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
28 29 30 |
# File 'lib/oci/ai_language/models/model.rb', line 28 def display_name @display_name end |
#evaluation_results ⇒ OCI::AiLanguage::Models::EvaluationResults
66 67 68 |
# File 'lib/oci/ai_language/models/model.rb', line 66 def evaluation_results @evaluation_results end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
83 84 85 |
# File 'lib/oci/ai_language/models/model.rb', line 83 def @freeform_tags end |
#id ⇒ String
[Required] Unique identifier model OCID of a model that is immutable on creation
24 25 26 |
# File 'lib/oci/ai_language/models/model.rb', line 24 def id @id end |
#lifecycle_details ⇒ String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
60 61 62 |
# File 'lib/oci/ai_language/models/model.rb', line 60 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The state of the model.
56 57 58 |
# File 'lib/oci/ai_language/models/model.rb', line 56 def lifecycle_state @lifecycle_state end |
#model_details ⇒ OCI::AiLanguage::Models::ModelDetails
This attribute is required.
44 45 46 |
# File 'lib/oci/ai_language/models/model.rb', line 44 def model_details @model_details end |
#project_id ⇒ String
[Required] The OCID of the project to associate with the model.
36 37 38 |
# File 'lib/oci/ai_language/models/model.rb', line 36 def project_id @project_id end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }
95 96 97 |
# File 'lib/oci/ai_language/models/model.rb', line 95 def @system_tags end |
#test_strategy ⇒ OCI::AiLanguage::Models::TestStrategy
69 70 71 |
# File 'lib/oci/ai_language/models/model.rb', line 69 def test_strategy @test_strategy end |
#time_created ⇒ DateTime
[Required] The time the the model was created. An RFC3339 formatted datetime string.
48 49 50 |
# File 'lib/oci/ai_language/models/model.rb', line 48 def time_created @time_created end |
#time_updated ⇒ DateTime
The time the model was updated. An RFC3339 formatted datetime string.
52 53 54 |
# File 'lib/oci/ai_language/models/model.rb', line 52 def time_updated @time_updated end |
#training_dataset ⇒ OCI::AiLanguage::Models::DatasetDetails
63 64 65 |
# File 'lib/oci/ai_language/models/model.rb', line 63 def training_dataset @training_dataset end |
#version ⇒ String
For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done <<service>>::<<service-name>>_<<model-type-version>>::<<custom model on which this training has to be done>> ex: ai-lang::NER_V1::CUSTOM-V0
77 78 79 |
# File 'lib/oci/ai_language/models/model.rb', line 77 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/oci/ai_language/models/model.rb', line 98 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'project_id': :'projectId', 'description': :'description', 'model_details': :'modelDetails', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'training_dataset': :'trainingDataset', 'evaluation_results': :'evaluationResults', 'test_strategy': :'testStrategy', 'version': :'version', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/oci/ai_language/models/model.rb', line 123 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'project_id': :'String', 'description': :'String', 'model_details': :'OCI::AiLanguage::Models::ModelDetails', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'training_dataset': :'OCI::AiLanguage::Models::DatasetDetails', 'evaluation_results': :'OCI::AiLanguage::Models::EvaluationResults', 'test_strategy': :'OCI::AiLanguage::Models::TestStrategy', 'version': :'String', '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.
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/oci/ai_language/models/model.rb', line 287 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && project_id == other.project_id && description == other.description && model_details == other.model_details && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && training_dataset == other.training_dataset && evaluation_results == other.evaluation_results && test_strategy == other.test_strategy && version == other.version && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/oci/ai_language/models/model.rb', line 333 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
313 314 315 |
# File 'lib/oci/ai_language/models/model.rb', line 313 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
322 323 324 |
# File 'lib/oci/ai_language/models/model.rb', line 322 def hash [id, display_name, compartment_id, project_id, description, model_details, time_created, time_updated, lifecycle_state, lifecycle_details, training_dataset, evaluation_results, test_strategy, version, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
366 367 368 369 370 371 372 373 374 375 |
# File 'lib/oci/ai_language/models/model.rb', line 366 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
360 361 362 |
# File 'lib/oci/ai_language/models/model.rb', line 360 def to_s to_hash.to_s end |