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:, **options) ⇒ ToolCallResult

Returns a new instance of ToolCallResult.

Parameters:

  • content (Object) —

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

  • tool_call_id (String)
  • options (Hash) —

    optional - used for provider-specific options



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

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

Instance Attribute Details

#content ⇒ Object

Returns:

  • (Object) 


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

def content
  @content
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

#tool_call_id ⇒ ToolCall

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:



59
60
61
62
63
64
65
66
67
 
# File 'lib/omniai/chat/tool_call_result.rb', line 59

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

#inspect ⇒ String

Returns:

  • (String) 


29
30
31
 
# File 'lib/omniai/chat/tool_call_result.rb', line 29

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) 


45
46
47
48
49
50
51
52
53
 
# File 'lib/omniai/chat/tool_call_result.rb', line 45

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

#text ⇒ String?

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

Returns:

  • (String, nil) 


36
37
38
39
40
 
# File 'lib/omniai/chat/tool_call_result.rb', line 36

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

  JSON.generate(@content)
end