omniai 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab309e1be1b9acc7671c341b8e50cd0ec257ac22b254899b3661e428432f290
-  data.tar.gz: 7968c811a16cf77172b087a03693641dbca83f2ba683e5eff30eda05ad4817e4
+  metadata.gz: 7f87f1b50c279a434ef7c23fb84f66321450897a62c9db0eda70659e3ac024a6
+  data.tar.gz: 334d3055c491bb582107b62ff555bba9bd175d9a23d7492cbfb07bdae4a1b876
 SHA512:
-  metadata.gz: b22be38a54e83cb76c45e94d739290ee2530e51d81fd892e8a749deba3a54f88d9f7ec99a159df2688dadd7f5be9ce0a6ad03acfc7d0344e7ae4910e910f3bce
-  data.tar.gz: a5a11dd87da47b2f5ee4a49d9a37bbfe55ccb1ff3b0a6da48544d076eb850e925343775ea90cbdf6a30f309bcb2d3e783be21798d7deecfc2762dca80a886393
+  metadata.gz: c6ed29f063e505bf58ad6ca19f8d4dace1627f73fb3bee8b52fb5f9756d550f3ff322e7ef00d286044eaa9a0b48a16811e62efb70c130948302834e9206a362d
+  data.tar.gz: 512fa19f0b5cb1c67a081d413bdf8e9b964716f08151fc20b048f5c2b46edc4eb8ec891563eb510c98e7ae5749c63afbbb661546718ec219f1287592c1f351da

data/README.md

@@ -22,9 +22,11 @@ gem install omniai-openai
 
 ## Usage
 
+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'
@@ -32,7 +34,7 @@ require 'omniai-anthropic'
 client = OmniAI::Anthropic::Client.new
 ```
 
-#### Google (Gemini)
+#### [OmniAI::Google](https://github.com/ksylvest/omniai-google)
 
 ```ruby
 require 'omniai-google'
@@ -40,7 +42,7 @@ require 'omniai-google'
 client = OmniAI::Google::Client.new
 ```
 
-#### Mistral (LeChat)
+#### [OmniAI::Mistral](https://github.com/ksylvest/omniai-mistral)
 
 ```ruby
 require 'omniai-mistral'
@@ -48,18 +50,18 @@ require 'omniai-mistral'
 client = OmniAI::Mistral::Client.new
 ```
 
-#### OpenAI (ChatGPT)
+#### [OmniAI::OpenAI](https://github.com/ksylvest/omniai-openai)
 
 ```ruby
 require 'omniai-openai'
 
 client = OmniAI::OpenAI::Client.new
-completion = client.chat.completion('Tell me a joke.')
-completion.choice.message.content # '...'
 ```
 
 ### 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
@@ -70,7 +72,7 @@ puts(completion.choice.message.content) # '...'
 #### Streaming
 
 ```ruby
-stream = proc do |chunk|
+client.chat.completion 'Tell me a joke.', stream: proc do |chunk|
   print(chunk.choice.delta.content) # '...'
 end
 ```

data/lib/omniai/chat/chunk.rb

@@ -2,8 +2,8 @@
 
 module OmniAI
   class Chat
-    # A delta returned by the API.
-    class CompletionChunk
+    # A chunk returned by the API.
+    class Chunk
       attr_accessor :data
 
       # @param data [Hash]

data/lib/omniai/chat/completion.rb

@@ -2,7 +2,7 @@
 
 module OmniAI
   class Chat
-    # An class wrapping the response completion. A vendor may override if custom behavior is required.
+    # A completion returned by the API.
     class Completion
       attr_accessor :data
 

data/lib/omniai/chat/usage.rb

@@ -2,7 +2,7 @@
 
 module OmniAI
   class Chat
-    # An class wrapping the response usage. A vendor may override if custom behavior is required.
+    # A usage returned by the API.
     class Completion
       attr_accessor :data
 

data/lib/omniai/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -72,7 +72,6 @@ files:
 - lib/omniai/chat/delta.rb
 - lib/omniai/chat/message.rb
 - lib/omniai/chat/request.rb
-- lib/omniai/chat/stream.rb
 - lib/omniai/chat/usage.rb
 - lib/omniai/client.rb
 - lib/omniai/version.rb

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