omniai 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb51f64b3514f196e07be3b77f2ca538878602af864f5c2c49e5e2506f05bfaf
-  data.tar.gz: f4069c9f19fbcc6f2caf90ab28e32ed83c8700b2ea8c686059afc612997b1ea6
+  metadata.gz: b478ff0decf827e07f67c3c85973ad576f546980417f82ff5f71949c99157e22
+  data.tar.gz: edcd0f60037d10fca5aec3ecc6cbd08c0c9b1c42aa9353506c232821cbd0fe0f
 SHA512:
-  metadata.gz: 06ece9d4bd7db17c57bff05f3323ba2ddd5e10803a5e5b460d8f5c66ffad932880230270d5a3e5e3653e46c6aaeec0926cff740414c9bb8d0e799062e4ce3139
-  data.tar.gz: 8443711ec0a65da572ce47a2da284ef63e277bdffc64663ab0577c4ded90105faaa666819f09b9d8ac2d2e457db8f4c07303b987ebb96e719648dd8624e419c0
+  metadata.gz: 69d8116cf9313da66fc89857332d8efb9e2005f007474dd377ec8c34ffb5c18e22155740390acb793f255447399f176605f0306e94c99c0e160346581fd1e597
+  data.tar.gz: 5c7975664071ff8158d5fd9e33fac37f7874b856d319edb0555deeefb78ac70e1dd7c13ffde015a5b0029c4b1ad26554d34ba0ca294bbf8acc81365adef1705c

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!

data/lib/omniai/chat.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module OmniAI
-  # An abstract class that provides an interface for chatting for various vendors (e.g. OpenAI::ChatGPT).
+  # An abstract class that provides an interface for chatting for various vendors (e.g. OpenAI’s ChatGPT).
   #
   # Usage:
   #
@@ -23,13 +23,14 @@ module OmniAI
 
     # @raise [OmniAI::Error]
     #
-    # @param messages [String]
-    # @param model [String]
-    # @param format [Symbol] either :text or :json
-    # @param temperature [Float]
+    # @param messages [String, Array, Hash, OmnniAI::Chat::Message]
+    # @param model [String] optional
+    # @param format [Symbol] optional :text or :json
+    # @param temperature [Float, nil] optional
+    # @param stream [Proc, nil] optional
     #
     # @return [OmniAI::Chat::Request]
-    def completion(messages, model:, temperature: 0.0, format: :text)
+    def completion(messages, model:, temperature: nil, format: nil, stream: nil)
       raise NotImplementedError, "#{self.class.name}#completion undefined"
     end
   end

data/lib/omniai/client.rb

@@ -6,7 +6,7 @@ module OmniAI
   # Usage:
   #
   #   class OmniAI::OpenAI::Client < OmniAI::Client
-  #     def initialize(api_key: ENV.fetch('OPENAI_API_KEY'))
+  #     def initialize(api_key: ENV.fetch('OPENAI_API_KEY'), logger: nil)
   #       super
   #     end
   #
@@ -21,13 +21,15 @@ module OmniAI
     attr_accessor :api_key
 
     # @param api_key [String]
-    def initialize(api_key:)
+    # @param logger [Logger]
+    def initialize(api_key:, logger: nil)
       @api_key = api_key
+      @logger = logger
     end
 
     # @return [HTTP::Client]
     def connection
-      HTTP.auth("Bearer #{api_key}")
+      raise NotImplementedError, "#{self.class.name}#connection undefined"
     end
 
     # @return [OmniAI::Chat] an instance of OmniAI::Chat

data/lib/omniai/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Kevin Sylvestre