omniai 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b478ff0decf827e07f67c3c85973ad576f546980417f82ff5f71949c99157e22
-  data.tar.gz: edcd0f60037d10fca5aec3ecc6cbd08c0c9b1c42aa9353506c232821cbd0fe0f
+  metadata.gz: 7f87f1b50c279a434ef7c23fb84f66321450897a62c9db0eda70659e3ac024a6
+  data.tar.gz: 334d3055c491bb582107b62ff555bba9bd175d9a23d7492cbfb07bdae4a1b876
 SHA512:
-  metadata.gz: 69d8116cf9313da66fc89857332d8efb9e2005f007474dd377ec8c34ffb5c18e22155740390acb793f255447399f176605f0306e94c99c0e160346581fd1e597
-  data.tar.gz: 5c7975664071ff8158d5fd9e33fac37f7874b856d319edb0555deeefb78ac70e1dd7c13ffde015a5b0029c4b1ad26554d34ba0ca294bbf8acc81365adef1705c
+  metadata.gz: c6ed29f063e505bf58ad6ca19f8d4dace1627f73fb3bee8b52fb5f9756d550f3ff322e7ef00d286044eaa9a0b48a16811e62efb70c130948302834e9206a362d
+  data.tar.gz: 512fa19f0b5cb1c67a081d413bdf8e9b964716f08151fc20b048f5c2b46edc4eb8ec891563eb510c98e7ae5749c63afbbb661546718ec219f1287592c1f351da

data/README.md

@@ -22,44 +22,57 @@ gem install omniai-openai
 
 ## Usage
 
-### Chat
+OmniAI implements APIs for a number of popular clients by default. A client can be initialized using the specific gem (e.g. `omniai-openai` for `OmniAI::OpenAI`). Vendor specific docs can be found within each repo.
+
+### Client
 
-#### Anthropic (Claude)
+#### [OmniAI::Anthropic](https://github.com/ksylvest/omniai-anthropic)
 
 ```ruby
 require 'omniai-anthropic'
 
 client = OmniAI::Anthropic::Client.new
-completion = client.chat.completion('Tell me a joke.')
-completion.choice.message.content # '...'
 ```
 
-#### Google (Gemini)
+#### [OmniAI::Google](https://github.com/ksylvest/omniai-google)
 
 ```ruby
 require 'omniai-google'
 
 client = OmniAI::Google::Client.new
-completion = client.chat.completion('Tell me a joke.')
-completion.choice.message.content # '...'
 ```
 
-#### Mistral (LeChat)
+#### [OmniAI::Mistral](https://github.com/ksylvest/omniai-mistral)
 
 ```ruby
 require 'omniai-mistral'
 
 client = OmniAI::Mistral::Client.new
-completion = client.chat.completion('Tell me a joke.')
-completion.choice.message.content # '...'
 ```
 
-#### OpenAI (ChatGPT)
+#### [OmniAI::OpenAI](https://github.com/ksylvest/omniai-openai)
 
 ```ruby
 require 'omniai-openai'
 
 client = OmniAI::OpenAI::Client.new
+```
+
+### Chat
+
+Clients that support chat (e.g. Anthropic w/ "Claude", Google w/ "Gemini", Mistral w/ "LeChat", OpenAI w/ "ChatGPT", etc) can generate completions using either a basic or streaming API:
+
+#### Basic
+
+```ruby
 completion = client.chat.completion('Tell me a joke.')
-completion.choice.message.content # '...'
+puts(completion.choice.message.content) # '...'
+```
+
+#### Streaming
+
+```ruby
+client.chat.completion 'Tell me a joke.', stream: proc do |chunk|
+  print(chunk.choice.delta.content) # '...'
+end
 ```

data/lib/omniai/chat/choice.rb

@@ -4,14 +4,26 @@ module OmniAI
   class Chat
     # A choice returned by the API.
     class Choice
-      attr_accessor :index, :message, :role
+      attr_accessor :data
 
-      # @param index [Integer]
-      # @param message [OmniAI::Chat::Message]
-      # @param role [String]
-      def initialize(index:, message:)
-        @index = index
-        @message = message
+      # @param data [Hash]
+      def initialize(data:)
+        @data = data
+      end
+
+      # @return [Integer]
+      def index
+        @data['index']
+      end
+
+      # @return [OmniAI::Chat::Delta]
+      def delta
+        Delta.new(data: @data['delta']) if @data['delta']
+      end
+
+      # @return [OmniAI::Chat::Message]
+      def message
+        Message.new(data: @data['message']) if @data['message']
       end
     end
   end

data/lib/omniai/chat/chunk.rb

@@ -0,0 +1,41 @@
+# 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
+
+      # @param [index] [Integer]
+      # @return [OmniAI::Chat::Delta]
+      def choice(index: 0)
+        choices[index]
+      end
+    end
+  end
+end

data/lib/omniai/chat/completion.rb

@@ -0,0 +1,51 @@
+# 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
+        @usage ||= Usage.new(data: @data['usage']) if @data['usage']
+      end
+
+      # @return [Array<OmniAI::Chat::Choice>]
+      def choices
+        @choices ||= @data['choices'].map { |choice| Choice.new(data: choice) }
+      end
+
+      # @param [index] [Integer] optional - default is 0
+      # @return [OmniAI::Chat::Choice]
+      def choice(index: 0)
+        choices[index]
+      end
+    end
+  end
+end

data/lib/omniai/chat/delta.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # A delta returned by the API.
+    class Delta
+      attr_accessor :data
+
+      # @param content [Integer]
+      # @param role [String]
+      def initialize(data:)
+        @data = data
+      end
+
+      # @return [String, nil]
+      def role
+        @data['role']
+      end
+
+      # @return [String, nil]
+      def content
+        @data['content']
+      end
+    end
+  end
+end

data/lib/omniai/chat/message.rb

@@ -4,13 +4,22 @@ module OmniAI
   class Chat
     # A message returned by the API.
     class Message
-      attr_accessor :content, :role
+      attr_accessor :data
 
       # @param content [Integer]
       # @param role [String]
-      def initialize(content:, role:)
-        @content = content
-        @role = role
+      def initialize(data:)
+        @data = data
+      end
+
+      # @return [String]
+      def role
+        @data['role']
+      end
+
+      # @return [String]
+      def content
+        @data['content']
       end
     end
   end

data/lib/omniai/chat/request.rb

@@ -46,7 +46,26 @@ module OmniAI
       # @param response [HTTP::Response]
       # @return [OmniAI::Chat::Completion::Response]
       def parse!(response:)
-        raise NotImplementedError, "#{self.class.name}#parse! undefined"
+        if @stream
+          stream!(response:)
+        else
+          OmniAI::OpenAI::Chat::Completion.new(data: response.parse)
+        end
+      end
+
+      # @param response [HTTP::Response]
+      # @return [OmniAI::Chat::Chunk]
+      def stream!(response:)
+        parser = EventStreamParser::Parser.new
+
+        response.body.each do |chunk|
+          parser.feed(chunk) do |_, data|
+            break if data.eql?('[DONE]')
+
+            chunk = OmniAI::OpenAI::Chat::Chunk.new(data: data.parse)
+            @stream.call(chunk)
+          end
+        end
       end
 
       # @return [Hash]

data/lib/omniai/chat/usage.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # A usage returned by the API.
+    class Completion
+      attr_accessor :data
+
+      # @param data [Hash]
+      def initialize(data:)
+        @data = data
+      end
+
+      # @return [Integer]
+      def completion_tokens
+        @data['completion_tokens']
+      end
+
+      # @return [Integer]
+      def prompt_tokens
+        @data['prompt_tokens']
+      end
+
+      # @return [Integer]
+      def total_tokens
+        @data['total_tokens']
+      end
+    end
+  end
+end

data/lib/omniai/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: event_stream_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -53,10 +67,12 @@ files:
 - lib/omniai.rb
 - lib/omniai/chat.rb
 - lib/omniai/chat/choice.rb
+- lib/omniai/chat/chunk.rb
+- lib/omniai/chat/completion.rb
+- lib/omniai/chat/delta.rb
 - lib/omniai/chat/message.rb
 - lib/omniai/chat/request.rb
-- lib/omniai/chat/response.rb
-- lib/omniai/chat/stream.rb
+- lib/omniai/chat/usage.rb
 - lib/omniai/client.rb
 - lib/omniai/version.rb
 homepage: https://github.com/ksylvest/omniai

data/lib/omniai/chat/response.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # An abstract class that provides a consistent interface for processing chat responses.
-    #
-    # Usage:
-    #
-    #   class OmniAI::OpenAI::Chat::Response < OmniAI::Chat::Response
-    #     def choices
-    #       # TODO: implement
-    #     end
-    #   end
-    class Response
-      attr_accessor :data
-
-      # @param data [Hash]
-      def initialize(data:)
-        @data = data
-      end
-
-      # @param [index] [Integer]
-      # @return [OmniAI::Chat::Choice]
-      def choice(index: 0)
-        choices[index]
-      end
-
-      # @return [Array<OmniAI::Chat::Choice>]
-      def choices
-        raise NotImplementedError, "#{self.class.name}#choices undefined"
-      end
-    end
-  end
-end

data/lib/omniai/chat/stream.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A processor for streaming back events in chunks.
-    class Stream
-      LINE_REGEX = /data:\s*(?<data>.*)\n\n/
-
-      def initialize
-        @buffer = String.new
-      end
-
-      # @yield [data] a parsed hash
-      # @param [String] chunk
-      def process!(chunk)
-        @buffer << chunk
-
-        while (line = @buffer.slice!(LINE_REGEX))
-          match = LINE_REGEX.match(line)
-          data = match[:data]
-          break if data.eql?('[DONE]')
-
-          yield JSON.parse(data)
-        end
-      end
-    end
-  end
-end