Class: OCI::GenerativeAi::Models::CreateGenerativeAiProjectDetails

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

Overview

The data to create a GenerativeAiProject.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateGenerativeAiProjectDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



94
95
96
97
98
99
100
101
102
103
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
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 94

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.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.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.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']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] Owning compartment OCID for a GenerativeAiProject.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

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

Returns:



24
25
26
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 24

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

Returns:

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


46
47
48
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 46

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the GenerativeAiProject.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

A user-friendly name.

Returns:

  • (String) 


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

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

Returns:

  • (Hash<String, String>) 


38
39
40
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 38

def freeform_tags
  @freeform_tags
end

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

Returns:



27
28
29
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 27

def long_term_memory_config
  @long_term_memory_config
end

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

Returns:



30
31
32
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 30

def short_term_memory_optimization_config
  @short_term_memory_optimization_config
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'conversation_config': :'conversationConfig',
    'long_term_memory_config': :'longTermMemoryConfig',
    'short_term_memory_optimization_config': :'shortTermMemoryOptimizationConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'compartment_id': :'String',
    'display_name': :'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>>'
    # 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



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 152

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

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 189

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


169
170
171
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 169

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [description, compartment_id, display_name, conversation_config, long_term_memory_config, short_term_memory_optimization_config, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 222

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



216
217
218
 
# File 'lib/oci/generative_ai/models/create_generative_ai_project_details.rb', line 216

def to_s
  to_hash.to_s
end