Class: OCI::GenerativeAiAgent::Models::CreateAgentDetails

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

Overview

The data to create an agent.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAgentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
144
145
146
147
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 98

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.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.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] The OCID of the compartment to create the agent in.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 23

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


50
51
52
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 50

def defined_tags
  @defined_tags
end

#description ⇒ String

Description about the agent.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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


42
43
44
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 42

def freeform_tags
  @freeform_tags
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>) 


27
28
29
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 27

def knowledge_base_ids
  @knowledge_base_ids
end

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

Returns:



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

def llm_config
  @llm_config
end

#welcome_message ⇒ String

Details about purpose and responsibility of the agent

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 31

def welcome_message
  @welcome_message
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'knowledge_base_ids': :'knowledgeBaseIds',
    'welcome_message': :'welcomeMessage',
    'llm_config': :'llmConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 69

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



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 156

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

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 193

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


173
174
175
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 173

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 182

def hash
  [display_name, description, compartment_id, knowledge_base_ids, welcome_message, llm_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



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 226

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



220
221
222
 
# File 'lib/oci/generative_ai_agent/models/create_agent_details.rb', line 220

def to_s
  to_hash.to_s
end