omniai 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1694fba08fa9ef9bd8dc3496ce1acbc3c321357d082303869df74ee667a83a65
-  data.tar.gz: c0d98caa29e034c610d20654cc175e42eeb69cef414ba79a5fda61d883d2d9f3
+  metadata.gz: b730453eea6e211031174bde7e43485b5402b9f0590bb832924762f8c2f6345c
+  data.tar.gz: cad17682fc35243454f58b28a9bf0e2d48f9857415bfe3b72012f370b7e9d4ab
 SHA512:
-  metadata.gz: ddfcd3c15811a63b401290577b36170573e4e170064a8cf64686ceacfc1ddb2c3e5af10ab2a7bb1057db9fe691b8359a94da24c0ce774f71ed5df50063b3925b
-  data.tar.gz: 66dcd111279e7de048473789cfae9020a0c6bb9b812bdd10a1bb2c2c12ee246bd9cebf6b7890322fdcc4a72743033746bd9e5a3f8d283b43ae0bbea5315de05e
+  metadata.gz: 0ebd9716858486dc399504b8caefd3d4186cdc97da05715e8519fcbc2238b38672f6a760e5134b3231bfc4683662f69098edc3eb6bd22808e91658bb4207b1b4
+  data.tar.gz: b7623a59effdc4714cbf78f8dd950cde0d3746da0dfc39ec7c9a6caf745ffedbd841d0b72097b1fdd30dd73f3f8ba35e7736a4253b32b7d2fcd7367c732172b0

data/README.md

@@ -65,7 +65,7 @@ Clients that support chat (e.g. Anthropic w/ "Claude", Google w/ "Gemini", Mistr
 #### w/ a Simple Prompt
 
 ```ruby
-completion = client.chat.completion('Tell me a joke.')
+completion = client.chat('Tell me a joke.')
 puts(completion.choice.message.content) # '...'
 ```
 
@@ -82,7 +82,7 @@ messages = [
     content: 'What is the capital of Canada?',
   },
 ]
-completion = client.chat.completion(messages, model: '...', temperature: 0.7, format: :json)
+completion = client.chat(messages, model: '...', temperature: 0.7, format: :json)
 puts(completion.choice.message.content) # '...'
 ```
 
@@ -102,7 +102,7 @@ message = {
   ]
 }
 
-completion = client.chat.completion(message)
+completion = client.chat(message)
 puts(completion.choice.message.content) # '...'
 ```
 
@@ -112,5 +112,5 @@ puts(completion.choice.message.content) # '...'
 stream = proc do |chunk|
   print(chunk.choice.delta.content) # '...'
 end
-client.chat.completion('Tell me a joke.', stream:)
+client.chat('Tell me a joke.', stream:)
 ```

data/lib/omniai/chat.rb

@@ -1,43 +1,123 @@
 # frozen_string_literal: true
 
 module OmniAI
-  # An abstract class that provides an interface for chatting for various vendors (e.g. OpenAI’s ChatGPT).
+  # An abstract class that provides a consistent interface for processing chat requests.
   #
   # Usage:
   #
   #   class OmniAI::OpenAI::Chat < OmniAI::Chat
-  #     def completion(messages, model:, temperature: 0.0, format: :text)
-  #       # TODO: implement
+  #     module Model
+  #       GPT_4O = "gpt-4o"
   #     end
-  #   end
   #
-  # Once defined, it can be used to interface with the vendor's chat API as follows:
+  #     protected
+  #
+  #     # @return [Hash]
+  #     def payload
+  #       raise NotImplementedError, "#{self.class.name}#payload undefined"
+  #     end
   #
-  #   client.chat.completion("...", model: "...", temperature: 0.0, format: :text)
+  #     # @return [String]
+  #     def path
+  #       raise NotImplementedError, "#{self.class.name}#path undefined"
+  #     end
+  #   end
   #
-  # @param client [OmniAI::Client] the client
+  #   client.chat(messages, model: "...", temperature: 0.0, format: :text)
   class Chat
+    JSON_PROMPT = 'Respond with valid JSON. Do not include any non-JSON in the response.'
+
     module Role
       ASSISTANT = 'assistant'
       USER = 'user'
       SYSTEM = 'system'
     end
 
-    def initialize(client:)
-      @client = client
+    def self.process!(...)
+      new(...).process!
     end
 
-    # @raise [OmniAI::Error]
-    #
-    # @param messages [String, Array, Hash, OmnniAI::Chat::Message]
-    # @param model [String] optional
-    # @param format [Symbol] optional :text or :json
+    # @param messages [String] required
+    # @param client [OmniAI::Client] the client
+    # @param model [String] required
     # @param temperature [Float, nil] optional
     # @param stream [Proc, nil] optional
-    #
-    # @return [OmniAI::Chat::Request]
-    def completion(messages, model:, temperature: nil, format: nil, stream: nil)
-      raise NotImplementedError, "#{self.class.name}#completion undefined"
+    # @param format [Symbol, nil] optional - :json
+    def initialize(messages, client:, model:, temperature: nil, stream: nil, format: nil)
+      @messages = messages
+      @client = client
+      @model = model
+      @temperature = temperature
+      @stream = stream
+      @format = format
+    end
+
+    # @raise [ExecutionError]
+    def process!
+      response = request!
+      raise HTTPError, response unless response.status.ok?
+
+      parse!(response:)
+    end
+
+    protected
+
+    # @return [Hash]
+    def payload
+      raise NotImplementedError, "#{self.class.name}#payload undefined"
+    end
+
+    # @return [String]
+    def path
+      raise NotImplementedError, "#{self.class.name}#path undefined"
+    end
+
+    # @param response [HTTP::Response]
+    # @return [OmniAI::Chat::Completion]
+    def parse!(response:)
+      if @stream
+        stream!(response:)
+      else
+        complete!(response:)
+      end
+    end
+
+    # @param response [OmniAI::Chat::Completion]
+    def complete!(response:)
+      Completion.new(data: response.parse)
+    end
+
+    # @param response [HTTP::Response]
+    # @return [OmniAI::Chat::Stream]
+    def stream!(response:)
+      raise Error, "#{self.class.name}#stream! unstreamable" unless @stream
+
+      Stream.new(response:).stream! { |chunk| @stream.call(chunk) }
+    end
+
+    # @return [Array<Hash>]
+    def messages
+      arrayify(@messages).map do |content|
+        case content
+        when String then { role: OmniAI::Chat::Role::USER, content: }
+        when Hash then content
+        else raise Error, "Unsupported content=#{content.inspect}"
+        end
+      end
+    end
+
+    # @param value [Object, Array<Object>]
+    # @return [Array<Object>]
+    def arrayify(value)
+      value.is_a?(Array) ? value : [value]
+    end
+
+    # @return [HTTP::Response]
+    def request!
+      @client
+        .connection
+        .accept(:json)
+        .post(path, json: payload)
     end
   end
 end

data/lib/omniai/client.rb

@@ -9,11 +9,6 @@ module OmniAI
   #     def initialize(api_key: ENV.fetch('OPENAI_API_KEY'), logger: nil)
   #       super
   #     end
-  #
-  #     @return [OmniAI::OpenAI::Chat]
-  #     def chat
-  #       # TODO: implement
-  #     end
   #   end
   class Client
     class Error < StandardError; end
@@ -27,13 +22,27 @@ module OmniAI
       @logger = logger
     end
 
+    # @return [String]
+    def inspect
+      masked_api_key = "#{api_key[..2]}***" if api_key
+      "#<#{self.class.name} api_key=#{masked_api_key.inspect}>"
+    end
+
     # @return [HTTP::Client]
     def connection
       raise NotImplementedError, "#{self.class.name}#connection undefined"
     end
 
-    # @return [OmniAI::Chat] an instance of OmniAI::Chat
-    def chat
+    # @raise [OmniAI::Error]
+    #
+    # @param messages [String, Array, Hash]
+    # @param model [String] optional
+    # @param format [Symbol] optional :text or :json
+    # @param temperature [Float, nil] optional
+    # @param stream [Proc, nil] optional
+    #
+    # @return [OmniAI::Chat::Completion]
+    def chat(messages, model:, temperature: nil, format: nil, stream: nil)
       raise NotImplementedError, "#{self.class.name}#chat undefined"
     end
   end

data/lib/omniai/config.rb

@@ -4,5 +4,11 @@ module OmniAI
   # A configuration for each agent w/ `api_key` / `host` / `logger`.
   class Config
     attr_accessor :api_key, :host, :logger
+
+    # @return [String]
+    def inspect
+      masked_api_key = "#{api_key[..2]}***" if api_key
+      "#<#{self.class.name} api_key=#{masked_api_key.inspect} host=#{host.inspect}>"
+    end
   end
 end

data/lib/omniai/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -72,7 +72,6 @@ files:
 - lib/omniai/chat/content.rb
 - 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

data/lib/omniai/chat/request.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # An abstract class that provides a consistent interface for processing chat requests.
-    #
-    # Usage:
-    #
-    #    class OmniAI::OpenAI::ChatGPT::Request < OmniAI::Chat::Request
-    #      module Model
-    #        CHAT = "davinci"
-    #      end
-    #      def completion(messages, model:, temperature: 0.0, format: :text)
-    #      end
-    #    end
-    #
-    # Once defined, the subclass can be used to interface with the vendor's chat API as follows:
-    #
-    #    client.chat.completion(messages, model: "...", temperature: 0.0, format: :text)
-    class Request
-      # @param client [OmniAI::Client] the client
-      # @param messages [String] required
-      # @param model [String] required
-      # @param temperature [Float, nil] optional
-      # @param stream [Proc, nil] optional
-      # @param format [Symbol, nil] optional - :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
-
-      # @raise [ExecutionError]
-      def process!
-        response = request!
-        raise HTTPError, response unless response.status.ok?
-
-        parse!(response:)
-      end
-
-      protected
-
-      # @return [Hash]
-      def payload
-        raise NotImplementedError, "#{self.class.name}#payload undefined"
-      end
-
-      # @return [String]
-      def path
-        raise NotImplementedError, "#{self.class.name}#path undefined"
-      end
-
-      # @param response [HTTP::Response]
-      # @return [OmniAI::Chat::Completion]
-      def parse!(response:)
-        if @stream
-          stream!(response:)
-        else
-          complete!(response:)
-        end
-      end
-
-      # @param response [OmniAI::Chat::Completion]
-      def complete!(response:)
-        Completion.new(data: response.parse)
-      end
-
-      # @param response [HTTP::Response]
-      # @return [OmniAI::Chat::Chunk]
-      def stream!(response:)
-        raise Error, "#{self.class.name}#stream! unstreamable" unless @stream
-
-        Stream.new(response:).stream! { |chunk| @stream.call(chunk) }
-      end
-
-      # @return [Array<Hash>]
-      def messages
-        arrayify(@messages).map do |content|
-          case content
-          when String then { role: OmniAI::Chat::Role::USER, content: }
-          when Hash then content
-          else raise Error, "Unsupported content=#{content.inspect}"
-          end
-        end
-      end
-
-      # @param value [Object, Array<Object>]
-      # @return [Array<Object>]
-      def arrayify(value)
-        value.is_a?(Array) ? value : [value]
-      end
-
-      # @return [HTTP::Response]
-      def request!
-        @client
-          .connection
-          .accept(:json)
-          .post(path, json: payload)
-      end
-    end
-  end
-end