Class: OCI::GenerativeAi::Models::GenerativeAiProject

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

Overview

A GenerativeAiProject is a logical container that stores conversation, file and containers.

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

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerativeAiProject

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



154
155
156
157
158
159
160
161
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
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
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 154

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

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

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

  self.long_term_memory_config = attributes[:'longTermMemoryConfig'] if attributes[:'longTermMemoryConfig']

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

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

  self.short_term_memory_optimization_config = attributes[:'shortTermMemoryOptimizationConfig'] if attributes[:'shortTermMemoryOptimizationConfig']

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

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

  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

#compartment_id ⇒ String

[Required] Owning compartment OCID for a GenerativeAiProject.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 40

def compartment_id
  @compartment_id
end

#conversation_config ⇒ OCI::GenerativeAi::Models::ConversationConfig

Returns:



59
60
61
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 59

def conversation_config
  @conversation_config
end

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

[Required] 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>>) 


81
82
83
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 81

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the GenerativeAiProject.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 36

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 32

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


73
74
75
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 73

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] An OCID that uniquely identifies a GenerativeAiProject.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 28

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail that can provide actionable information.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 56

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of a GenerativeAiProject.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 52

def lifecycle_state
  @lifecycle_state
end

#long_term_memory_config ⇒ OCI::GenerativeAi::Models::LongTermMemoryConfig

Returns:



62
63
64
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 62

def long_term_memory_config
  @long_term_memory_config
end

#short_term_memory_optimization_config ⇒ OCI::GenerativeAi::Models::ShortTermMemoryOptimizationConfig

Returns:



65
66
67
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 65

def short_term_memory_optimization_config
  @short_term_memory_optimization_config
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\"}}

Returns:

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


88
89
90
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 88

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time that the generativeAiProject was created in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 44

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time that the generativeAiProject was updated in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 48

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 91

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'conversation_config': :'conversationConfig',
    'long_term_memory_config': :'longTermMemoryConfig',
    'short_term_memory_optimization_config': :'shortTermMemoryOptimizationConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'conversation_config': :'OCI::GenerativeAi::Models::ConversationConfig',
    'long_term_memory_config': :'OCI::GenerativeAi::Models::LongTermMemoryConfig',
    'short_term_memory_optimization_config': :'OCI::GenerativeAi::Models::ShortTermMemoryOptimizationConfig',
    '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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 257

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 &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    conversation_config == other.conversation_config &&
    long_term_memory_config == other.long_term_memory_config &&
    short_term_memory_optimization_config == other.short_term_memory_optimization_config &&
    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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 300

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


280
281
282
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 280

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 289

def hash
  [id, display_name, description, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, conversation_config, long_term_memory_config, short_term_memory_optimization_config, 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



333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 333

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



327
328
329
 
# File 'lib/oci/generative_ai/models/generative_ai_project.rb', line 327

def to_s
  to_hash.to_s
end