omniai 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53ccc1363252abefa6089ff068b11b3ac15b5817339dc935ae9b78cf1d146b20
-  data.tar.gz: 1b4fe76443ef245f7198c1d55edab1fa6d985afbef1638705caf3d40a1b88c05
+  metadata.gz: bab309e1be1b9acc7671c341b8e50cd0ec257ac22b254899b3661e428432f290
+  data.tar.gz: 7968c811a16cf77172b087a03693641dbca83f2ba683e5eff30eda05ad4817e4
 SHA512:
-  metadata.gz: f687cd00e0cbed7994d8a172c657d135741e8ca5afdc8f4bcff53ffb6ec6746f553f26cfeeddcf08a81a261e72e7dcd0b4aee06e0b9e336016a1843189bb4a29
-  data.tar.gz: 6d89697cc18301852e6648b2a323634a59df9bf90032146d35837ead4a4746bad13527aeef8c67af8cd0290bdaae3177de50d29c220c8fff86f844f081484970
+  metadata.gz: b22be38a54e83cb76c45e94d739290ee2530e51d81fd892e8a749deba3a54f88d9f7ec99a159df2688dadd7f5be9ce0a6ad03acfc7d0344e7ae4910e910f3bce
+  data.tar.gz: a5a11dd87da47b2f5ee4a49d9a37bbfe55ccb1ff3b0a6da48544d076eb850e925343775ea90cbdf6a30f309bcb2d3e783be21798d7deecfc2762dca80a886393

data/README.md

@@ -22,7 +22,7 @@ gem install omniai-openai
 
 ## Usage
 
-### Chat
+### Client
 
 #### Anthropic (Claude)
 
@@ -30,8 +30,6 @@ gem install omniai-openai
 require 'omniai-anthropic'
 
 client = OmniAI::Anthropic::Client.new
-completion = client.chat.completion('Tell me a joke.')
-completion.choice.message.content # '...'
 ```
 
 #### Google (Gemini)
@@ -40,8 +38,6 @@ completion.choice.message.content # '...'
 require 'omniai-google'
 
 client = OmniAI::Google::Client.new
-completion = client.chat.completion('Tell me a joke.')
-completion.choice.message.content # '...'
 ```
 
 #### Mistral (LeChat)
@@ -50,8 +46,6 @@ completion.choice.message.content # '...'
 require 'omniai-mistral'
 
 client = OmniAI::Mistral::Client.new
-completion = client.chat.completion('Tell me a joke.')
-completion.choice.message.content # '...'
 ```
 
 #### OpenAI (ChatGPT)
@@ -63,3 +57,20 @@ client = OmniAI::OpenAI::Client.new
 completion = client.chat.completion('Tell me a joke.')
 completion.choice.message.content # '...'
 ```
+
+### Chat
+
+#### Basic
+
+```ruby
+completion = client.chat.completion('Tell me a joke.')
+puts(completion.choice.message.content) # '...'
+```
+
+#### Streaming
+
+```ruby
+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 delta returned by the API.
+    class CompletionChunk
+      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
+    # An class wrapping the response completion. A vendor may override if custom behavior is required.
+    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

@@ -19,23 +19,20 @@ module OmniAI
     #    client.chat.completion(messages, model: "...", temperature: 0.0, format: :text)
     class Request
       # @param client [OmniAI::Client] the client
-      # @param messages [String]
-      # @param model [String]
-      # @param temperature [Float]
-      # @param format [Symbol] either :text or :json
-      def initialize(client:, messages:, model:, temperature: 0.0, format: :text)
+      # @param messages [String] required
+      # @param model [String] required
+      # @param temperature [Float, nil] optional
+      # @param stream [Proc, nil] optional
+      # @param format [Symbol, nil] optional - :text or :json
+      def initialize(client:, messages:, model:, temperature: nil, stream: nil, format: nil)
         @client = client
         @messages = messages
         @model = model
         @temperature = temperature
+        @stream = stream
         @format = format
       end
 
-      # @param prompt [String, Message]
-      # @param model [String]
-      # @param format [Symbol] either :text or :json
-      # @param temperature [Float]
-      # @return [Hash]
       # @raise [ExecutionError]
       def process!
         response = request!
@@ -49,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
+    # An class wrapping the response usage. A vendor may override if custom behavior is required.
+    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.7'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 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,13 @@ 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