Class: OCI::GenerativeAiAgent::Models::AgentSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent/models/agent_summary.rb

Overview

Summary information about an agent.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AgentSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :knowledge_base_ids (Array<String>) —

    The value to assign to the #knowledge_base_ids property

  • :welcome_message (String) —

    The value to assign to the #welcome_message property

  • :llm_config (OCI::GenerativeAiAgent::Models::LlmConfig) —

    The value to assign to the #llm_config property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



150
151
152
153
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
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 150

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

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

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

  self.welcome_message = attributes[:'welcomeMessage'] if attributes[:'welcomeMessage']

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

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

  self.llm_config = attributes[:'llmConfig'] if attributes[:'llmConfig']

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

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

  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.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] The OCID of the compartment.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 26

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\"}}

Returns:

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


77
78
79
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 77

def defined_tags
  @defined_tags
end

#description ⇒ String

Description about the agent.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 22

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 18

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>) 


69
70
71
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 69

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Agent.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 14

def id
  @id
end

#knowledge_base_ids ⇒ Array<String>

List of OCID of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026.

Returns:

  • (Array<String>) 


30
31
32
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 30

def knowledge_base_ids
  @knowledge_base_ids
end

#lifecycle_details ⇒ String

A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 61

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the agent.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 55

def lifecycle_state
  @lifecycle_state
end

#llm_config ⇒ OCI::GenerativeAiAgent::Models::LlmConfig

Returns:



37
38
39
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 37

def llm_config
  @llm_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>>) 


84
85
86
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 84

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the agent was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 44

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the agent was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 51

def time_updated
  @time_updated
end

#welcome_message ⇒ String

Details about purpose and responsibility of the agent

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 34

def welcome_message
  @welcome_message
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 87

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'knowledge_base_ids': :'knowledgeBaseIds',
    'welcome_message': :'welcomeMessage',
    'llm_config': :'llmConfig',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'knowledge_base_ids': :'Array<String>',
    'welcome_message': :'String',
    'llm_config': :'OCI::GenerativeAiAgent::Models::LlmConfig',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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.

Parameters:

  • other (Object) —

    the other object to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 240

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 &&
    knowledge_base_ids == other.knowledge_base_ids &&
    welcome_message == other.welcome_message &&
    llm_config == other.llm_config &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 283

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


263
264
265
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 263

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



272
273
274
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 272

def hash
  [id, display_name, description, compartment_id, knowledge_base_ids, welcome_message, llm_config, time_created, time_updated, lifecycle_state, lifecycle_details, 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



316
317
318
319
320
321
322
323
324
325
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 316

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



310
311
312
 
# File 'lib/oci/generative_ai_agent/models/agent_summary.rb', line 310

def to_s
  to_hash.to_s
end