Class: OCI::GenerativeAiAgentRuntime::Models::ChatDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent_runtime/models/chat_details.rb

Overview

Chat details for managing user interactions and tool executions.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 77

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

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

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

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

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

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

  self.session_id = attributes[:'sessionId'] if attributes[:'sessionId']

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

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

  self.tool_parameters = attributes[:'toolParameters'] if attributes[:'toolParameters']

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

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

  self.tool_inputs = attributes[:'toolInputs'] if attributes[:'toolInputs']

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

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

  self.performed_actions = attributes[:'performedActions'] if attributes[:'performedActions']

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

  self.performed_actions = attributes[:'performed_actions'] if attributes[:'performed_actions']
end

Instance Attribute Details

#performed_actions ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::PerformedAction>

A list of actions that have been performed based on prior required actions.

Returns:



35
36
37
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 35

def performed_actions
  @performed_actions
end

#session_id ⇒ String

Optional sessionId. If not provided, will chat without any prior context.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 22

def session_id
  @session_id
end

#should_stream ⇒ BOOLEAN

Whether to stream the response.

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 18

def should_stream
  @should_stream
end

#tool_inputs ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::ToolInput>

Array of tool input objects, each specifying a tool's ID, type, and corresponding input parameters required for execution.

Returns:



31
32
33
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 31

def tool_inputs
  @tool_inputs
end

#tool_parameters ⇒ Hash<String, String>

A map where each key is a toolId and the value contains tool type and additional dynamic parameters. This field is deprecated and will be removed after July 02 2026.

Returns:

  • (Hash<String, String>) 


26
27
28
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 26

def tool_parameters
  @tool_parameters
end

#user_message ⇒ String

The input user message content for the chat.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 14

def user_message
  @user_message
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'user_message': :'userMessage',
    'should_stream': :'shouldStream',
    'session_id': :'sessionId',
    'tool_parameters': :'toolParameters',
    'tool_inputs': :'toolInputs',
    'performed_actions': :'performedActions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'user_message': :'String',
    'should_stream': :'BOOLEAN',
    'session_id': :'String',
    'tool_parameters': :'Hash<String, String>',
    'tool_inputs': :'Array<OCI::GenerativeAiAgentRuntime::Models::ToolInput>',
    'performed_actions': :'Array<OCI::GenerativeAiAgentRuntime::Models::PerformedAction>'
    # 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



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 129

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

  self.class == other.class &&
    user_message == other.user_message &&
    should_stream == other.should_stream &&
    session_id == other.session_id &&
    tool_parameters == other.tool_parameters &&
    tool_inputs == other.tool_inputs &&
    performed_actions == other.performed_actions
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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 164

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


144
145
146
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 144

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



153
154
155
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 153

def hash
  [user_message, should_stream, session_id, tool_parameters, tool_inputs, performed_actions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 197

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



191
192
193
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_details.rb', line 191

def to_s
  to_hash.to_s
end