Class: OmniAI::Chat::ToolCallResult

Inherits:
Object
  • Object
show all
Defined in:
lib/omniai/chat/tool_call_result.rb

Overview

The result of a tool call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content:, tool_call_id:) ⇒ ToolCallResult

Returns a new instance of ToolCallResult.

Parameters:

  • content (Object)

    e.g. a string, hash, array, boolean, numeric, etc.

  • tool_call_id (String)


17
18
19
20
# File 'lib/omniai/chat/tool_call_result.rb', line 17

def initialize(content:, tool_call_id:)
  @content = content
  @tool_call_id = tool_call_id
end

Instance Attribute Details

#contentObject

Returns:

  • (Object)


9
10
11
# File 'lib/omniai/chat/tool_call_result.rb', line 9

def content
  @content
end

#tool_call_idToolCall

Returns:



13
14
15
# File 'lib/omniai/chat/tool_call_result.rb', line 13

def tool_call_id
  @tool_call_id
end

Class Method Details

.deserialize(data, context: nil) ⇒ ToolCallResult

Parameters:

  • data (Hash)
  • context (Context) (defaults to: nil)

    optional

Returns:



53
54
55
56
57
58
59
60
61
# File 'lib/omniai/chat/tool_call_result.rb', line 53

def self.deserialize(data, context: nil)
  deserialize = context&.deserializer(:tool_call_result)
  return deserialize.call(data, context:) if deserialize

  content = data["content"]
  tool_call_id = data["tool_call_id"]

  new(content:, tool_call_id:)
end

Instance Method Details

#inspectString

Returns:

  • (String)


23
24
25
# File 'lib/omniai/chat/tool_call_result.rb', line 23

def inspect
  "#<#{self.class.name} content=#{content.inspect} tool_call_id=#{tool_call_id.inspect}>"
end

#serialize(context: nil) ⇒ Hash

Parameters:

  • context (Context) (defaults to: nil)

    optional

Returns:

  • (Hash)


39
40
41
42
43
44
45
46
47
# File 'lib/omniai/chat/tool_call_result.rb', line 39

def serialize(context: nil)
  serializer = context&.serializer(:tool_call_result)
  return serializer.call(self, context:) if serializer

  content = text
  tool_call_id = @tool_call_id

  { content:, tool_call_id: }
end

#textString?

Converts the content of a tool call result to JSON unless the result is a string.

Returns:

  • (String, nil)


30
31
32
33
34
# File 'lib/omniai/chat/tool_call_result.rb', line 30

def text
  return content if content.nil? || content.is_a?(String)

  JSON.generate(@content)
end