Class: OCI::GenerativeAiAgentRuntime::Models::ChatResult

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

Overview

The response of a chat request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 69

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

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

  self.tool_results = attributes[:'toolResults'] if attributes[:'toolResults']

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

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

  self.required_actions = attributes[:'requiredActions'] if attributes[:'requiredActions']

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

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

  self.guardrail_result = attributes[:'guardrailResult'] if attributes[:'guardrailResult']

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

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

Instance Attribute Details

#guardrail_result ⇒ String

Captures the result of guardrail evaluations as JSON string performed on either the input to the agent or the output generated by the agent.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 30

def guardrail_result
  @guardrail_result
end

#message ⇒ OCI::GenerativeAiAgentRuntime::Models::Message

Returns:



13
14
15
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 13

def message
  @message
end

#required_actions ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::RequiredAction>

A list of actions the agent requires the user or agent client to perform.

Returns:



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

def required_actions
  @required_actions
end

#tool_results ⇒ Hash<String, String>

A map where each key is a toolId and the value contains tool type and additional dynamic results.

Returns:

  • (Hash<String, String>) 


21
22
23
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 21

def tool_results
  @tool_results
end

#traces ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::Trace>

The trace that displays the internal progression, such as reasoning and actions during an execution.

Returns:



17
18
19
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 17

def traces
  @traces
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'message': :'message',
    'traces': :'traces',
    'tool_results': :'toolResults',
    'required_actions': :'requiredActions',
    'guardrail_result': :'guardrailResult'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'message': :'OCI::GenerativeAiAgentRuntime::Models::Message',
    'traces': :'Array<OCI::GenerativeAiAgentRuntime::Models::Trace>',
    'tool_results': :'Hash<String, String>',
    'required_actions': :'Array<OCI::GenerativeAiAgentRuntime::Models::RequiredAction>',
    'guardrail_result': :'String'
    # 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



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 105

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

  self.class == other.class &&
    message == other.message &&
    traces == other.traces &&
    tool_results == other.tool_results &&
    required_actions == other.required_actions &&
    guardrail_result == other.guardrail_result
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 139

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


119
120
121
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 128

def hash
  [message, traces, tool_results, required_actions, guardrail_result].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 172

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



166
167
168
 
# File 'lib/oci/generative_ai_agent_runtime/models/chat_result.rb', line 166

def to_s
  to_hash.to_s
end