omniai 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05ed0777b6e88c023738b43e5188d722ca9bf372a7cabda61a800ae5a7a13a7
-  data.tar.gz: e2f0220221030ce99bc81dfd456a7505bce557594ba03336d5445ff4a7188b7d
+  metadata.gz: a989cab03afca85385b23f4684d377b8d1a09533a73899fa79eebcce4f4a3260
+  data.tar.gz: bb39575e251b0dd6cf6e0e3b24ba86765fd550feeb3a222ce5f785ca654e8741
 SHA512:
-  metadata.gz: 9ec41c146e0052129894ad17fdcbd8768b96d76114f85604098153c901a842b4d59cc78121ad5e77a7a7501c17c3caf060ed2bcf4c05fea3523fc8c081f8479b
-  data.tar.gz: 11c641f64597f09bff8d67dd00b5599701868c7b31bbb12675191cd554e94b051c97e6f7251e355dcf849b9693f34dc0f29c8b8b0ac92a77fa0ff00ca6c2d05e
+  metadata.gz: e20f0ee5ab32ceb95e33e38888c81e28f936294cfcd9a3dad80a8d89a9fd3241477455e706d70fb949502b01cdf968547104e55931138512b4e617dd9688fe02
+  data.tar.gz: 58aa9a8a43b2e8a7580beac909b7ddd34fcaaa3d9c60c9105d3dba0cd18923f7361473fdb863890fbfa17013a1339b71008381e105bd961de44dec67db8eac8b

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

@@ -98,10 +98,10 @@ module OmniAI
       end
     end
 
-    # @param response [OmniAI::Chat::Completion]
-    # @return [OmniAI::Chat::Completion]
+    # @param response [HTTP::Response]
+    # @return [OmniAI::Chat::Response::Completion]
     def complete!(response:)
-      completion = self.class::Completion.new(data: response.parse)
+      completion = self.class::Response::Completion.new(data: response.parse)
 
       if @tools && completion.tool_call_required?
         @messages = [
@@ -120,11 +120,13 @@ 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, StringIO
-          @stream << chunk.choice.delta.content
-          @stream.flush
+          if chunk.content?
+            @stream << chunk.content
+            @stream.flush
+          end
         else @stream.call(chunk)
         end
       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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -68,20 +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/function.rb
-- lib/omniai/chat/message.rb
-- lib/omniai/chat/message_choice.rb
-- lib/omniai/chat/stream.rb
-- lib/omniai/chat/tool_call.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

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.new(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,70 +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 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 [OmniAI::Chat::Usage]
-      def usage
-        @usage ||= Usage.new(data: @data['usage']) if @data['usage']
-      end
-
-      # @return [Array<OmniAI::Chat::MessageChoice>]
-      def choices
-        @choices ||= @data['choices'].map { |data| MessageChoice.new(data:) }
-      end
-
-      # @param index [Integer] optional - default is 0
-      # @return [OmniAI::Chat::MessageChoice]
-      def choice(index: 0)
-        choices[index]
-      end
-
-      # @return [Boolean]
-      def tool_call_required?
-        choices.any? { |choice| choice.message.tool_call_list.any? }
-      end
-
-      # @return [Array<OmniAI::Chat::ToolCall>]
-      def tool_call_list
-        list = []
-        choices.each do |choice|
-          list += choice.message.tool_call_list
-        end
-        list
-      end
-    end
-  end
-end

data/lib/omniai/chat/delta.rb

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

data/lib/omniai/chat/delta_choice.rb

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

data/lib/omniai/chat/function.rb

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

data/lib/omniai/chat/message.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A message returned by the API.
-    class Message
-      # @return [Hash]
-      attr_accessor :data
-
-      # @param data [Hash]
-      def initialize(data:)
-        @data = data
-      end
-
-      # @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::ToolCall>]
-      def tool_call_list
-        @tool_call_list ||=
-          @data['tool_calls'] ? @data['tool_calls'].map { |tool_call_data| ToolCall.new(data: tool_call_data) } : []
-      end
-    end
-  end
-end

data/lib/omniai/chat/message_choice.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A choice returned by the API.
-    class MessageChoice
-      # @param data [Hash]
-      def initialize(data:)
-        @data = data
-      end
-
-      # @return [Integer]
-      def index
-        @data['index']
-      end
-
-      # @return [OmniAI::Chat::Message]
-      def message
-        @message ||= Message.new(data: @data['message'])
-      end
-
-      # @return [String]
-      def inspect
-        "#<#{self.class.name} index=#{index} message=#{message.inspect}>"
-      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/tool_call.rb

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

data/lib/omniai/chat/usage.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A usage returned by the API.
-    class Usage
-      attr_accessor :data
-
-      # @param data [Hash]
-      def initialize(data:)
-        @data = data
-      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
-
-      def total_tokens
-        @data['total_tokens'] || (input_tokens + output_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