Class: OCI::AiDocument::Models::ModelSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_document/models/model_summary.rb

Overview

The metadata about the model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 191

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

  raise 'You cannot provide both :modelType and :model_type' if attributes.key?(:'modelType') && attributes.key?(:'model_type')

  self.model_type = attributes[:'model_type'] if attributes[:'model_type']

  self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion']

  raise 'You cannot provide both :modelVersion and :model_version' if attributes.key?(:'modelVersion') && attributes.key?(:'model_version')

  self.model_version = attributes[:'model_version'] if attributes[:'model_version']

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

  self.tenancy_id = attributes[:'tenancyId'] if attributes[:'tenancyId']

  raise 'You cannot provide both :tenancyId and :tenancy_id' if attributes.key?(:'tenancyId') && attributes.key?(:'tenancy_id')

  self.tenancy_id = attributes[:'tenancy_id'] if attributes[:'tenancy_id']

  self.alias_name = attributes[:'aliasName'] if attributes[:'aliasName']

  raise 'You cannot provide both :aliasName and :alias_name' if attributes.key?(:'aliasName') && attributes.key?(:'alias_name')

  self.alias_name = attributes[:'alias_name'] if attributes[:'alias_name']

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

  raise 'You cannot provide both :testingDataset and :testing_dataset' if attributes.key?(:'testingDataset') && attributes.key?(:'testing_dataset')

  self.testing_dataset = attributes[:'testing_dataset'] if attributes[:'testing_dataset']

  self.validation_dataset = attributes[:'validationDataset'] if attributes[:'validationDataset']

  raise 'You cannot provide both :validationDataset and :validation_dataset' if attributes.key?(:'validationDataset') && attributes.key?(:'validation_dataset')

  self.validation_dataset = attributes[:'validation_dataset'] if attributes[:'validation_dataset']

  self.component_models = attributes[:'componentModels'] if attributes[:'componentModels']

  raise 'You cannot provide both :componentModels and :component_models' if attributes.key?(:'componentModels') && attributes.key?(:'component_models')

  self.component_models = attributes[:'component_models'] if attributes[:'component_models']

  self.is_composed_model = attributes[:'isComposedModel'] unless attributes[:'isComposedModel'].nil?
  self.is_composed_model = false if is_composed_model.nil? && !attributes.key?(:'isComposedModel') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isComposedModel and :is_composed_model' if attributes.key?(:'isComposedModel') && attributes.key?(:'is_composed_model')

  self.is_composed_model = attributes[:'is_composed_model'] unless attributes[:'is_composed_model'].nil?
  self.is_composed_model = false if is_composed_model.nil? && !attributes.key?(:'isComposedModel') && !attributes.key?(:'is_composed_model') # rubocop:disable Style/StringLiterals

  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

#alias_name ⇒ String

the alias name of the model.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 66

def alias_name
  @alias_name
end

#compartment_id ⇒ String

[Required] The compartment identifier.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 26

def compartment_id
  @compartment_id
end

#component_models ⇒ Array<OCI::AiDocument::Models::ComponentModel>

The OCID list of active custom Key Value models that need to be composed.

Returns:



79
80
81
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 79

def component_models
  @component_models
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


95
96
97
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 95

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the model.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 22

def description
  @description
end

#display_name ⇒ String

A human-friendly name for the model, which can be changed.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 18

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


89
90
91
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 89

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] A unique identifier that is immutable after creation.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 14

def id
  @id
end

#is_composed_model ⇒ BOOLEAN

Set to true when the model is created by using multiple key value extraction models.

Returns:

  • (BOOLEAN) 


83
84
85
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 83

def is_composed_model
  @is_composed_model
end

#lifecycle_details ⇒ String

A message describing the current state in more detail, that can provide actionable information if training failed.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 54

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the model.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 50

def lifecycle_state
  @lifecycle_state
end

#model_type ⇒ String

[Required] The type of the Document model.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 30

def model_type
  @model_type
end

#model_version ⇒ String

[Required] The version of the model.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 34

def model_version
  @model_version
end

#precision ⇒ Float

The precision of the trained model.

Returns:

  • (Float) 


58
59
60
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 58

def precision
  @precision
end

#project_id ⇒ String

[Required] The OCID of the project that contains the model.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 38

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. For example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


101
102
103
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 101

def system_tags
  @system_tags
end

#tenancy_id ⇒ String

The tenancy id of the model.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 62

def tenancy_id
  @tenancy_id
end

#testing_dataset ⇒ OCI::AiDocument::Models::Dataset

Returns:



72
73
74
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 72

def testing_dataset
  @testing_dataset
end

#time_created ⇒ DateTime

[Required] When the model was created, as an RFC3339 datetime string.

Returns:

  • (DateTime) 


42
43
44
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 42

def time_created
  @time_created
end

#time_updated ⇒ DateTime

When the model was modified, as an RFC3339 datetime string.

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 46

def time_updated
  @time_updated
end

#training_dataset ⇒ OCI::AiDocument::Models::Dataset

Returns:



69
70
71
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 69

def training_dataset
  @training_dataset
end

#validation_dataset ⇒ OCI::AiDocument::Models::Dataset

Returns:



75
76
77
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 75

def validation_dataset
  @validation_dataset
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 104

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'model_type': :'modelType',
    'model_version': :'modelVersion',
    'project_id': :'projectId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'precision': :'precision',
    'tenancy_id': :'tenancyId',
    'alias_name': :'aliasName',
    'training_dataset': :'trainingDataset',
    'testing_dataset': :'testingDataset',
    'validation_dataset': :'validationDataset',
    'component_models': :'componentModels',
    'is_composed_model': :'isComposedModel',
    '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
155
156
157
158
159
160
161
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 134

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'model_type': :'String',
    'model_version': :'String',
    'project_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'precision': :'Float',
    'tenancy_id': :'String',
    'alias_name': :'String',
    'training_dataset': :'OCI::AiDocument::Models::Dataset',
    'testing_dataset': :'OCI::AiDocument::Models::Dataset',
    'validation_dataset': :'OCI::AiDocument::Models::Dataset',
    'component_models': :'Array<OCI::AiDocument::Models::ComponentModel>',
    'is_composed_model': :'BOOLEAN',
    '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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 327

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 &&
    model_type == other.model_type &&
    model_version == other.model_version &&
    project_id == other.project_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    precision == other.precision &&
    tenancy_id == other.tenancy_id &&
    alias_name == other.alias_name &&
    training_dataset == other.training_dataset &&
    testing_dataset == other.testing_dataset &&
    validation_dataset == other.validation_dataset &&
    component_models == other.component_models &&
    is_composed_model == other.is_composed_model &&
    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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 378

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


358
359
360
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 358

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



367
368
369
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 367

def hash
  [id, display_name, description, compartment_id, model_type, model_version, project_id, time_created, time_updated, lifecycle_state, lifecycle_details, precision, tenancy_id, alias_name, training_dataset, testing_dataset, validation_dataset, component_models, is_composed_model, 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



411
412
413
414
415
416
417
418
419
420
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 411

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



405
406
407
 
# File 'lib/oci/ai_document/models/model_summary.rb', line 405

def to_s
  to_hash.to_s
end