Class: OCI::GenerativeAiAgentRuntime::Models::ToolInvocationTrace

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

Overview

The trace information about the tool selection from multiple tools.

Constant Summary

Constants inherited from Trace

OCI::GenerativeAiAgentRuntime::Models::Trace::TRACE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Trace

#key, #parent_key, #source, #time_created, #time_finished, #trace_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Trace

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ToolInvocationTrace

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
97
98
99
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 72

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['traceType'] = 'TOOL_INVOCATION_TRACE'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.tool_id = attributes[:'toolId'] if attributes[:'toolId']

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

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

  self.tool_name = attributes[:'toolName'] if attributes[:'toolName']

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

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

  self.invocation_details = attributes[:'invocationDetails'] if attributes[:'invocationDetails']

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

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

Instance Attribute Details

#invocation_details ⇒ String

The invocation details related to the selected tool.

Returns:

  • (String) 


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

def invocation_details
  @invocation_details
end

#tool_id ⇒ String

The ID of the selected tool based on the user query.

Returns:

  • (String) 


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

def tool_id
  @tool_id
end

#tool_name ⇒ String

The display name of the selected tool.

Returns:

  • (String) 


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

def tool_name
  @tool_name
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'parent_key': :'parentKey',
    'source': :'source',
    'time_created': :'timeCreated',
    'time_finished': :'timeFinished',
    'trace_type': :'traceType',
    'tool_id': :'toolId',
    'tool_name': :'toolName',
    'invocation_details': :'invocationDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'parent_key': :'String',
    'source': :'OCI::GenerativeAiAgentRuntime::Models::SourceDetails',
    'time_created': :'DateTime',
    'time_finished': :'DateTime',
    'trace_type': :'String',
    'tool_id': :'String',
    'tool_name': :'String',
    'invocation_details': :'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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 108

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

  self.class == other.class &&
    key == other.key &&
    parent_key == other.parent_key &&
    source == other.source &&
    time_created == other.time_created &&
    time_finished == other.time_finished &&
    trace_type == other.trace_type &&
    tool_id == other.tool_id &&
    tool_name == other.tool_name &&
    invocation_details == other.invocation_details
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 146

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


126
127
128
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 135

def hash
  [key, parent_key, source, time_created, time_finished, trace_type, tool_id, tool_name, invocation_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 179

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



173
174
175
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_invocation_trace.rb', line 173

def to_s
  to_hash.to_s
end