omniai 1.4.2 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df4f1096ec0d74c8ab26e5cfc8db4902009d1bb398ed9913e801b31203d1ae66
-  data.tar.gz: 9cff5f3ecdc6a540bbbd3ca6501dbd07585a1f9dfe8127a09ee6421a51f79c2f
+  metadata.gz: a989cab03afca85385b23f4684d377b8d1a09533a73899fa79eebcce4f4a3260
+  data.tar.gz: bb39575e251b0dd6cf6e0e3b24ba86765fd550feeb3a222ce5f785ca654e8741
 SHA512:
-  metadata.gz: db82f7cf3e8b43f55080c1ae1af2f6f9767dec7870bf23e2424eee8a272671b565f279829d9768fbb447eec8821fcd7da22058da8a4016b4de271a389a115c1c
-  data.tar.gz: 84362d233dbafa2dd6403b3d65056c7b836eb0b2ce420f4395c86188887f12ba7cb59caead7cfbc44d80bfa03ad2ef342b62f8235ace58afd0284e8e25b5c243
+  metadata.gz: e20f0ee5ab32ceb95e33e38888c81e28f936294cfcd9a3dad80a8d89a9fd3241477455e706d70fb949502b01cdf968547104e55931138512b4e617dd9688fe02
+  data.tar.gz: 58aa9a8a43b2e8a7580beac909b7ddd34fcaaa3d9c60c9105d3dba0cd18923f7361473fdb863890fbfa17013a1339b71008381e105bd961de44dec67db8eac8b

data/Gemfile

@@ -13,3 +13,4 @@ gem 'rubocop-rake'
 gem 'rubocop-rspec'
 gem 'simplecov'
 gem 'webmock'
+gem 'yard'

data/README.md

@@ -143,7 +143,9 @@ completion = client.chat(messages, model: '...', temperature: 0.7, format: :json
 completion.choice.message.content  # '...'
 ```
 
-#### Completions using Real-Time Streaming
+#### Completions using Streaming via Proc
+
+A real-time stream of messages can be generated by passing in a proc:
 
 ```ruby
 stream = proc do |chunk|
@@ -152,6 +154,35 @@ end
 client.chat('Tell me a joke.', stream:)
 ```
 
+#### Completion using Streaming via IO
+
+The above code can also be supplied any IO (e.g. `File`, `$stdout`, `$stdin`, etc):
+
+```ruby
+client.chat('Tell me a story', stream: $stdout)
+```
+
+#### Completion with Tools
+
+A chat can also be initialized with tools:
+
+```ruby
+client.chat('What is the weather in "London, England" and "Madrid, Spain"?', tools: [
+  OmniAI::Tool.new(
+    proc { |location:, unit: 'celsius'| "It is #{rand(20..50)}° #{unit} in #{location}" },
+    name: 'Weather',
+    description: 'Lookup the weather in a location',
+    parameters: OmniAI::Tool::Parameters.new(
+      properties: {
+        location: OmniAI::Tool::Property.string(description: 'The city and country (e.g. Toronto, Canada).'),
+        unit: OmniAI::Tool::Property.string(enum: %w[celcius farenheit]),
+      },
+      required: %i[location]
+    )
+  )
+])
+```
+
 ### Transcribe
 
 Clients that support transcribe (e.g. OpenAI w/ "Whisper") convert recordings to text via the following calls:

data/lib/omniai/chat/response/choice.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # For use with MessageChoice or DeltaChoice.
+      class Choice < Resource
+        # @return [Integer]
+        def index
+          @data['index']
+        end
+
+        # @return [OmniAI::Chat::Response::Part]
+        def part
+          raise NotImplementedError, "#{self.class.name}#part undefined"
+        end
+
+        # @return [OmniAI::Chat::Response::ToolCallList]
+        def tool_call_list
+          part.tool_call_list
+        end
+
+        # @return [Boolean]
+        def tool_call_list?
+          tool_call_list.any?
+        end
+
+        # @return [String, nil]
+        def content
+          part.content
+        end
+
+        # @return [Boolean]
+        def content?
+          !content.nil?
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/chunk.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A chunk returned by the API.
+      class Chunk < Payload
+        # @return [Array<OmniAI::Chat::Response::DeltaChoice>]
+        def choices
+          @choices ||= @data['choices'].map { |data| DeltaChoice.new(data:) }
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/completion.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A completion returned by the API.
+      class Completion < Payload
+        # @return [Array<OmniAI::Chat:Response:::MessageChoice>]
+        def choices
+          @choices ||= @data['choices'].map { |data| MessageChoice.new(data:) }
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/delta.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A delta returned by the API.
+      class Delta < Part
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/delta_choice.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A delta choice returned by the API.
+      class DeltaChoice < Choice
+        # @return [String]
+        def inspect
+          "#<#{self.class.name} index=#{index} delta=#{delta.inspect}>"
+        end
+
+        # @return [OmniAI::Chat::Response::Delta]
+        def delta
+          @delta ||= Delta.new(data: @data['delta'])
+        end
+
+        # @return [OmniAI::Chat::Response::Delta]
+        def part
+          delta
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/function.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A function returned by the API.
+      class Function < Resource
+        # @return [String]
+        def inspect
+          "#<#{self.class.name} name=#{name.inspect} arguments=#{arguments.inspect}>"
+        end
+
+        # @return [String]
+        def name
+          @data['name']
+        end
+
+        # @return [Hash, nil]
+        def arguments
+          JSON.parse(@data['arguments']) if @data['arguments']
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/message.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A message returned by the API.
+      class Message < Part
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/message_choice.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A choice returned by the API.
+      class MessageChoice < Choice
+        # @return [String]
+        def inspect
+          "#<#{self.class.name} index=#{index} message=#{message.inspect}>"
+        end
+
+        # @return [OmniAI::Chat::Response::Message]
+        def message
+          @message ||= Message.new(data: @data['message'])
+        end
+
+        # @return [OmniAI::Chat::Response::Message]
+        def part
+          message
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/part.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # Either a delta or message.
+      class Part < Resource
+        # @return [String]
+        def inspect
+          "#<#{self.class.name} role=#{role.inspect} content=#{content.inspect}>"
+        end
+
+        # @return [String]
+        def role
+          @data['role'] || Role::USER
+        end
+
+        # @return [String, nil]
+        def content
+          @data['content']
+        end
+
+        # @return [Array<OmniAI::Chat::Response::ToolCall>]
+        def tool_call_list
+          return [] unless @data['tool_calls']
+
+          @tool_call_list ||= @data['tool_calls'].map { |tool_call_data| ToolCall.new(data: tool_call_data) }
+        end
+
+        # @param index [Integer]
+        # @return [OmniAI::Chat::Response::ToolCall, nil]
+        def tool_call(index: 0)
+          tool_call_list[index]
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/payload.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A chunk or completion.
+      class Payload < Resource
+        # @return [String]
+        def inspect
+          "#<#{self.class.name} id=#{id.inspect} choices=#{choices.inspect}>"
+        end
+
+        # @return [String]
+        def id
+          @data['id']
+        end
+
+        # @return [Time]
+        def created
+          Time.at(@data['created']) if @data['created']
+        end
+
+        # @return [Time]
+        def updated
+          Time.at(@data['updated']) if @data['updated']
+        end
+
+        # @return [String]
+        def model
+          @data['model']
+        end
+
+        # @return [Array<OmniAI::Chat::Response::Choice>]
+        def choices
+          raise NotImplementedError, "#{self.class.name}#choices undefined"
+        end
+
+        # @param index [Integer]
+        # @return [OmniAI::Chat::Response::DeltaChoice]
+        def choice(index: 0)
+          choices[index]
+        end
+
+        # @param index [Integer]
+        # @return [OmniAI::Chat::Response::Part]
+        def part(index: 0)
+          choice(index:).part
+        end
+
+        # @return [OmniAI::Chat::Response::Usage]
+        def usage
+          @usage ||= Usage.new(data: @data['usage']) if @data['usage']
+        end
+
+        # @return [String, nil]
+        def content
+          choice.content
+        end
+
+        # @return [Boolean]
+        def content?
+          choice.content?
+        end
+
+        # @return [Array<OmniAI::Chat::Response:ToolCall>]
+        def tool_call_list
+          choice.tool_call_list
+        end
+
+        # @return [Boolean]
+        def tool_call_list?
+          choice.tool_call_list?
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/resource.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A generic data to handle response.
+      class Resource
+        attr_accessor :data
+
+        # @param data [Hash]
+        def initialize(data:)
+          @data = data
+        end
+
+        # @return [String]
+        def inspect
+          "#<#{self.class.name} data=#{@data.inspect}>"
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/stream.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A stream given when streaming.
+      class Stream
+        # @param response [HTTP::Response]
+        def initialize(response:)
+          @response = response
+          @parser = EventStreamParser::Parser.new
+        end
+
+        # @yield [OmniAI::Chat::Chunk]
+        def stream!
+          @response.body.each do |chunk|
+            @parser.feed(chunk) do |_, data|
+              next if data.eql?('[DONE]')
+
+              yield(Chunk.new(data: JSON.parse(data)))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/tool_call.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A tool-call returned by the API.
+      class ToolCall < Resource
+        # @return [String]
+        def inspect
+          "#<#{self.class.name} id=#{id.inspect} type=#{type.inspect}>"
+        end
+
+        # @return [String]
+        def id
+          @data['id']
+        end
+
+        # @return [String]
+        def type
+          @data['type']
+        end
+
+        # @return [OmniAI::Chat::Response::Function]
+        def function
+          @function ||= Function.new(data: @data['function']) if @data['function']
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/response/usage.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Response
+      # A usage returned by the API.
+      class Usage < Resource
+        # @return [String]
+        def inspect
+          properties = [
+            "input_tokens=#{input_tokens}",
+            "output_tokens=#{output_tokens}",
+            "total_tokens=#{total_tokens}",
+          ]
+          "#<#{self.class.name} #{properties.join(' ')}>"
+        end
+
+        # @return [Integer]
+        def input_tokens
+          @data['input_tokens'] || @data['prompt_tokens']
+        end
+
+        # @return [Integer]
+        def output_tokens
+          @data['output_tokens'] || @data['completion_tokens']
+        end
+
+        # @return [Integer]
+        def total_tokens
+          @data['total_tokens'] || (input_tokens + output_tokens)
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat.rb

@@ -27,10 +27,19 @@ module OmniAI
   class Chat
     JSON_PROMPT = 'Respond with valid JSON. Do not include any non-JSON in the response.'
 
+    # An error raised when a chat makes a tool-call for a tool that cannot be found.
+    class ToolCallLookupError < Error
+      def initialize(tool_call)
+        super("missing tool for tool_call=#{tool_call.inspect}")
+        @tool_call = tool_call
+      end
+    end
+
     module Role
       ASSISTANT = 'assistant'
       USER = 'user'
       SYSTEM = 'system'
+      TOOL = 'tool'
     end
 
     module Format
@@ -46,13 +55,15 @@ module OmniAI
     # @param model [String] required
     # @param temperature [Float, nil] optional
     # @param stream [Proc, IO, nil] optional
+    # @param tools [Array<OmniAI::Tool>] optional
     # @param format [Symbol, nil] optional - :json
-    def initialize(messages, client:, model:, temperature: nil, stream: nil, format: nil)
-      @messages = messages
+    def initialize(messages, client:, model:, temperature: nil, stream: nil, tools: nil, format: nil)
+      @messages = arrayify(messages)
       @client = client
       @model = model
       @temperature = temperature
       @stream = stream
+      @tools = tools
       @format = format
     end
 
@@ -87,9 +98,21 @@ module OmniAI
       end
     end
 
-    # @param response [OmniAI::Chat::Completion]
+    # @param response [HTTP::Response]
+    # @return [OmniAI::Chat::Response::Completion]
     def complete!(response:)
-      self.class::Completion.new(data: response.parse)
+      completion = self.class::Response::Completion.new(data: response.parse)
+
+      if @tools && completion.tool_call_required?
+        @messages = [
+          *@messages,
+          *completion.choices.map(&:message).map(&:data),
+          *(completion.tool_call_list.map { |tool_call| execute_tool_call(tool_call) }),
+        ]
+        process!
+      else
+        completion
+      end
     end
 
     # @param response [HTTP::Response]
@@ -97,21 +120,23 @@ module OmniAI
     def stream!(response:)
       raise Error, "#{self.class.name}#stream! unstreamable" unless @stream
 
-      self.class::Stream.new(response:).stream! do |chunk|
+      self.class::Response::Stream.new(response:).stream! do |chunk|
         case @stream
-        when IO
-          @stream << chunk.choice.delta.content
-          @stream.flush
+        when IO, StringIO
+          if chunk.content?
+            @stream << chunk.content
+            @stream.flush
+          end
         else @stream.call(chunk)
         end
       end
 
-      @stream.puts if @stream.is_a?(IO)
+      @stream.puts if @stream.is_a?(IO) || @stream.is_a?(StringIO)
     end
 
     # @return [Array<Hash>]
     def messages
-      arrayify(@messages).map do |content|
+      @messages.map do |content|
         case content
         when String then { role: Role::USER, content: }
         when Hash then content
@@ -133,5 +158,26 @@ module OmniAI
         .accept(:json)
         .post(path, json: payload)
     end
+
+    # @param tool_call [OmniAI::Chat::ToolCall]
+    def execute_tool_call(tool_call)
+      function = tool_call.function
+
+      tool = @tools.find { |entry| function.name == entry.name } || raise(ToolCallLookupError, tool_call)
+      result = tool.call(function.arguments)
+
+      prepare_tool_call_message(tool_call:, content: result)
+    end
+
+    # @param tool_call [OmniAI::Chat::ToolCall]
+    # @param content [String]
+    def prepare_tool_call_message(tool_call:, content:)
+      {
+        role: Role::TOOL,
+        name: tool_call.function.name,
+        tool_call_id: tool_call.id,
+        content:,
+      }
+    end
   end
 end

data/lib/omniai/cli/chat_handler.rb

@@ -4,6 +4,7 @@ module OmniAI
   class CLI
     # Used for CLI usage of 'omnia chat'.
     class ChatHandler < BaseHandler
+      # @param argv [Array<String>]
       def handle!(argv:)
         parser.parse!(argv)
 

data/lib/omniai/cli.rb

@@ -12,8 +12,8 @@ module OmniAI
   class CLI
     ChatArgs = Struct.new(:provider, :model, :temperature)
 
-    # @param in [IO] a stream
-    # @param out [IO] a stream
+    # @param stdin [IO] a stream
+    # @param stdout [IO] a stream
     # @param provider [String] a provider
     def initialize(stdin: $stdin, stdout: $stdout, provider: 'openai')
       @stdin = stdin
@@ -22,6 +22,7 @@ module OmniAI
       @args = {}
     end
 
+    # @param argv [Array<String>]
     def parse(argv = ARGV)
       parser.order!(argv)
       command = argv.shift

data/lib/omniai/client.rb

@@ -129,9 +129,10 @@ module OmniAI
     # @param format [Symbol] optional :text or :json
     # @param temperature [Float, nil] optional
     # @param stream [Proc, nil] optional
+    # @param tools [Array<OmniAI::Tool>] optional
     #
     # @return [OmniAI::Chat::Completion]
-    def chat(messages, model:, temperature: nil, format: nil, stream: nil)
+    def chat(messages, model:, temperature: nil, format: nil, stream: nil, tools: nil)
       raise NotImplementedError, "#{self.class.name}#chat undefined"
     end
 
@@ -144,7 +145,7 @@ module OmniAI
     # @param temperature [Float, nil] optional
     # @param format [Symbol] :text, :srt, :vtt, or :json (default)
     #
-    # @return text [OmniAI::Transcribe::Transcription]
+    # @return [OmniAI::Transcribe::Transcription]
     def transcribe(io, model:, language: nil, prompt: nil, temperature: nil, format: nil)
       raise NotImplementedError, "#{self.class.name}#speak undefined"
     end

data/lib/omniai/config.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module OmniAI
-  # A configuration for each agent w/ `api_key` / `host` / `logger`. Usage:
+  # A configuration for each agent w/ `api_key` / `host` / `logger`.
+  #
+  # Usage:
   #
   #   OmniAI::OpenAI.config do |config|
   #     config.api_key = '...'

data/lib/omniai/instrumentation.rb

@@ -18,7 +18,6 @@ module OmniAI
       @logger.error("#{name}: #{error.message}")
     end
 
-    # @param name [String]
     # @param payload [Hash]
     # @option payload [HTTP::Request] :request
     def start(_, payload)
@@ -26,7 +25,6 @@ module OmniAI
       @logger.info("#{request.verb.upcase} #{request.uri}")
     end
 
-    # @param name [String]
     # @param payload [Hash]
     # @option payload [HTTP::Response] :response
     def finish(_, payload)

data/lib/omniai/tool/parameters.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Tool
+    # Usage:
+    #
+    # parameters = OmniAI::Tool::Parameters.new(properties: {
+    #   n: OmniAI::Tool::Parameters.integer(description: 'The nth number to calculate.')
+    #   required: %i[n]
+    # })
+    class Parameters
+      module Type
+        OBJECT = 'object'
+      end
+
+      # @param type [String]
+      # @param properties [Hash]
+      # @param required [Array<String>]
+      # @return [OmniAI::Tool::Parameters]
+      def initialize(type: Type::OBJECT, properties: {}, required: [])
+        @type = type
+        @properties = properties
+        @required = required
+      end
+
+      # @return [Hash]
+      def prepare
+        {
+          type: @type,
+          properties: @properties.transform_values(&:prepare),
+          required: @required,
+        }.compact
+      end
+
+      # @param args [Hash]
+      # @return [Hash]
+      def parse(args)
+        result = {}
+        @properties.each do |name, property|
+          value = args[String(name)]
+          result[name.intern] = property.parse(value) if value
+        end
+        result
+      end
+    end
+  end
+end

data/lib/omniai/tool/property.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Tool
+    # Usage:
+    #
+    # property = OmniAI::Tool::Property.new(type: 'string', description: 'The nth number to calculate.')
+    class Property
+      module Type
+        BOOLEAN = 'boolean'
+        INTEGER = 'integer'
+        STRING = 'string'
+        NUMBER = 'number'
+      end
+
+      # @return [String]
+      attr_reader :type
+
+      # @return [String, nil]
+      attr_reader :description
+
+      # @return [Array<String>, nil]
+      attr_reader :enum
+
+      # @param description [String]
+      # @param enum [Array<String>]
+      # @return [OmniAI::Tool::Property]
+      def self.boolean(description: nil, enum: nil)
+        new(type: Type::BOOLEAN, description:, enum:)
+      end
+
+      # @param description [String]
+      # @param enum [Array<String>]
+      # @return [OmniAI::Tool::Property]
+      def self.integer(description: nil, enum: nil)
+        new(type: Type::INTEGER, description:, enum:)
+      end
+
+      # @param description [String]
+      # @param enum [Array<String>]
+      # @return [OmniAI::Tool::Property]
+      def self.string(description: nil, enum: nil)
+        new(type: Type::STRING, description:, enum:)
+      end
+
+      # @param description [String]
+      # @param enum [Array<String>]
+      # @return [OmniAI::Tool::Property]
+      def self.number(description: nil, enum: nil)
+        new(type: Type::NUMBER, description:, enum:)
+      end
+
+      # @param description [String]
+      # @param enum [Array<String>]
+      # @return [OmniAI::Tool::Property]
+      def initialize(type:, description: nil, enum: nil)
+        @type = type
+        @description = description
+        @enum = enum
+      end
+
+      # @example
+      #   property.prepare
+      #   # {
+      #   #   type: 'string',
+      #   #   description: 'The unit (e.g. "fahrenheit" or "celsius").'
+      #   #   enum: %w[fahrenheit celsius]
+      #   # }
+      #
+      # @return [Hash]
+      def prepare
+        {
+          type: @type,
+          description: @description,
+          enum: @enum,
+        }.compact
+      end
+
+      # @return [String, Integer, Float, Boolean, Object]
+      def parse(value)
+        case @type
+        when Type::INTEGER then Integer(value)
+        when Type::STRING then String(value)
+        when Type::NUMBER then Float(value)
+        else value
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tool.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module OmniAI
+  # Usage:
+  #
+  #   fibonacci = proc do |n:|
+  #     next(0) if n == 0
+  #     next(1) if n == 1
+  #     fibonacci.call(n: n - 1) + fibonacci.call(n: n - 2)
+  #   end
+  #
+  #   tool = OmniAI::Tool.new(fibonacci,
+  #     name: 'Fibonacci',
+  #     description: 'Cacluate the nth Fibonacci',
+  #     parameters: OmniAI::Tool::Parameters.new(
+  #       properties: {
+  #         n: OmniAI::Tool::Property.integer(description: 'The nth Fibonacci number to calculate')
+  #       },
+  #       required: %i[n],
+  #      )
+  #   )
+  class Tool
+    # @return [Proc]
+    attr_accessor :function
+
+    # @return [String]
+    attr_accessor :name
+
+    # @return [String, nil]
+    attr_accessor :description
+
+    # @return [Hash, nil]
+    attr_accessor :parameters
+
+    # @param function [Proc]
+    # @param name [String]
+    # @param description [String]
+    # @param parameters [Hash]
+    def initialize(function, name:, description: nil, parameters: nil)
+      @function = function
+      @name = name
+      @description = description
+      @parameters = parameters
+    end
+
+    # @example
+    #   tool.prepare
+    #   # {
+    #   #   type: 'function',
+    #   #   function: {
+    #   #     name: 'Fibonacci',
+    #   #     description: 'Calculate the nth Fibonacci number',
+    #   #     parameters: {
+    #   #       type: 'object',
+    #   #       properties: {
+    #   #         n: OmniAI::Tool::Property.integer(description: 'The nth Fibonacci number to calculate')
+    #   #       },
+    #   #       required: ['n']
+    #   #     }
+    #   #   }
+    #   # }
+    #
+    # @return [Hash]
+    def prepare
+      {
+        type: 'function',
+        function: {
+          name: @name,
+          description: @description,
+          parameters: @parameters&.prepare,
+        }.compact,
+      }
+    end
+
+    # @example
+    #   tool.call({ "n" => 6 })
+    #   #=> 8
+    #
+    # @param args [Hash]
+    # @return [String]
+    def call(args = {})
+      @function.call(**(@parameters ? @parameters.parse(args) : args))
+    end
+  end
+end

data/lib/omniai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniAI
-  VERSION = '1.4.2'
+  VERSION = '1.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-04 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -68,18 +68,24 @@ files:
 - exe/omniai
 - lib/omniai.rb
 - lib/omniai/chat.rb
-- lib/omniai/chat/chunk.rb
-- lib/omniai/chat/completion.rb
 - lib/omniai/chat/content/file.rb
 - lib/omniai/chat/content/media.rb
 - lib/omniai/chat/content/text.rb
 - lib/omniai/chat/content/url.rb
-- lib/omniai/chat/delta.rb
-- lib/omniai/chat/delta_choice.rb
-- lib/omniai/chat/message.rb
-- lib/omniai/chat/message_choice.rb
-- lib/omniai/chat/stream.rb
-- lib/omniai/chat/usage.rb
+- lib/omniai/chat/response/choice.rb
+- lib/omniai/chat/response/chunk.rb
+- lib/omniai/chat/response/completion.rb
+- lib/omniai/chat/response/delta.rb
+- lib/omniai/chat/response/delta_choice.rb
+- lib/omniai/chat/response/function.rb
+- lib/omniai/chat/response/message.rb
+- lib/omniai/chat/response/message_choice.rb
+- lib/omniai/chat/response/part.rb
+- lib/omniai/chat/response/payload.rb
+- lib/omniai/chat/response/resource.rb
+- lib/omniai/chat/response/stream.rb
+- lib/omniai/chat/response/tool_call.rb
+- lib/omniai/chat/response/usage.rb
 - lib/omniai/cli.rb
 - lib/omniai/cli/base_handler.rb
 - lib/omniai/cli/chat_handler.rb
@@ -87,6 +93,9 @@ files:
 - lib/omniai/config.rb
 - lib/omniai/instrumentation.rb
 - lib/omniai/speak.rb
+- lib/omniai/tool.rb
+- lib/omniai/tool/parameters.rb
+- lib/omniai/tool/property.rb
 - lib/omniai/transcribe.rb
 - lib/omniai/transcribe/transcription.rb
 - lib/omniai/version.rb
@@ -112,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.14
 signing_key: 
 specification_version: 4
 summary: A generalized framework for interacting with many AI services

data/lib/omniai/chat/chunk.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A chunk returned by the API.
-    class Chunk
-      attr_accessor :data
-
-      # @param data [Hash]
-      def initialize(data:)
-        @data = data
-      end
-
-      # @return [String]
-      def id
-        @data['id']
-      end
-
-      # @return [Time]
-      def created
-        Time.at(@data['created']) if @data['created']
-      end
-
-      # @return [Time]
-      def updated
-        Time.at(@data['updated']) if @data['updated']
-      end
-
-      # @return [String]
-      def model
-        @data['model']
-      end
-
-      # @return [Array<OmniAI::Chat::DeltaChoice>]
-      def choices
-        @choices ||= @data['choices'].map { |data| DeltaChoice.for(data:) }
-      end
-
-      # @param index [Integer]
-      # @return [OmniAI::Chat::Delta]
-      def choice(index: 0)
-        choices[index]
-      end
-    end
-  end
-end

data/lib/omniai/chat/completion.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A completion returned by the API.
-    class Completion
-      attr_accessor :data
-
-      # @param data [Hash]
-      def initialize(data:)
-        @data = data
-      end
-
-      # @return [String]
-      def id
-        @data['id']
-      end
-
-      # @return [Time]
-      def created
-        Time.at(@data['created']) if @data['created']
-      end
-
-      # @return [Time]
-      def updated
-        Time.at(@data['updated']) if @data['updated']
-      end
-
-      # @return [String]
-      def model
-        @data['model']
-      end
-
-      # @return [OmniAI::Chat::Usage]
-      def usage
-        return unless @data['usage']
-
-        @usage ||= Usage.for(data: @data['usage'])
-      end
-
-      # @return [Array<OmniAI::Chat::MessageChoice>]
-      def choices
-        @choices ||= @data['choices'].map { |data| MessageChoice.for(data:) }
-      end
-
-      # @param index [Integer] optional - default is 0
-      # @return [OmniAI::Chat::MessageChoice]
-      def choice(index: 0)
-        choices[index]
-      end
-    end
-  end
-end

data/lib/omniai/chat/delta.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A delta returned by the API.
-    class Delta
-      attr_accessor :role, :content
-
-      # @param data [Hash]
-      # @return [OmniAI::Chat::Message]
-      def self.for(data:)
-        content = data['content'] || data[:content]
-        role = data['role'] || data[:role]
-
-        new(content:, role: role || Role::USER)
-      end
-
-      # @param content [String]
-      # @param role [String]
-      def initialize(content:, role: nil)
-        @content = content
-        @role = role
-      end
-
-      # @return [String]
-      def inspect
-        "#<#{self.class.name} role=#{role.inspect} content=#{content.inspect}>"
-      end
-    end
-  end
-end

data/lib/omniai/chat/delta_choice.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A delta choice returned by the API.
-    class DeltaChoice
-      attr_accessor :index, :delta
-
-      # @param data [Hash]
-      # @return [OmniAI::Chat::Choice]
-      def self.for(data:)
-        index = data['index']
-        delta = Delta.for(data: data['delta'])
-
-        new(index:, delta:)
-      end
-
-      # @param index [Integer]
-      # @param delta [Delta]
-      def initialize(index:, delta:)
-        @index = index
-        @delta = delta
-      end
-    end
-  end
-end

data/lib/omniai/chat/message.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A message returned by the API.
-    class Message
-      attr_accessor :role, :content
-
-      # @param data [Hash]
-      # @return [OmniAI::Chat::Message]
-      def self.for(data:)
-        content = data['content'] || data[:content]
-        role = data['role'] || data[:role]
-
-        new(content:, role: role || Role::USER)
-      end
-
-      # @param content [String]
-      # @param role [String] optional (default to "user") e.g. "assistant" / "user" / "system"
-      def initialize(content:, role: OmniAI::Chat::Role::USER)
-        @role = role
-        @content = content
-      end
-
-      # @return [String]
-      def inspect
-        "#<#{self.class.name} role=#{role.inspect} content=#{content.inspect}>"
-      end
-    end
-  end
-end

data/lib/omniai/chat/message_choice.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A choice returned by the API.
-    class MessageChoice
-      attr_accessor :index, :message
-
-      # @param data [Hash]
-      # @return [OmniAI::Chat::Choice]
-      def self.for(data:)
-        index = data['index']
-        message = Message.for(data: data['message'])
-
-        new(index:, message:)
-      end
-
-      # @param index [Integer]
-      # @param message [OmniAI::Chat::Message]
-      def initialize(index:, message:)
-        @index = index
-        @message = message
-      end
-    end
-  end
-end

data/lib/omniai/chat/stream.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A stream given when streaming.
-    class Stream
-      # @param response [HTTP::Response]
-      def initialize(response:)
-        @response = response
-        @parser = EventStreamParser::Parser.new
-      end
-
-      # @yield [OmniAI::Chat::Chunk]
-      def stream!
-        @response.body.each do |chunk|
-          @parser.feed(chunk) do |_, data|
-            next if data.eql?('[DONE]')
-
-            yield(Chunk.new(data: JSON.parse(data)))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/omniai/chat/usage.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A usage returned by the API.
-    class Usage
-      attr_accessor :input_tokens, :output_tokens, :total_tokens
-
-      # @param data [Hash]
-      # @return [OmniAI::Chat::Usage]
-      def self.for(data:)
-        input_tokens = data['input_tokens'] || data['prompt_tokens']
-        output_tokens = data['output_tokens'] || data['completion_tokens']
-        total_tokens = data['total_tokens'] || (input_tokens + output_tokens)
-
-        new(
-          input_tokens:,
-          output_tokens:,
-          total_tokens:
-        )
-      end
-
-      # @param input_tokens [Integer]
-      # @param output_tokens [Integer]
-      # @param total_tokens [Integer]
-      def initialize(input_tokens:, output_tokens:, total_tokens:)
-        @input_tokens = input_tokens
-        @output_tokens = output_tokens
-        @total_tokens = total_tokens
-      end
-
-      # @return [Integer]
-      def completion_tokens
-        @output_tokens
-      end
-
-      # @return [Integer]
-      def prompt_tokens
-        @input_tokens
-      end
-
-      # @return [String]
-      def inspect
-        "#<#{self.class.name} input_tokens=#{input_tokens} output_tokens=#{output_tokens} total_tokens=#{total_tokens}>"
-      end
-    end
-  end
-end