omniai 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 341ce12cf0950b167a43c298f3ccb1df821bbdc469bc6824b14219bef4e38ab5
-  data.tar.gz: 9badfe7e48d20fe84054d9206e8572a333f382407c3236a3715e1d85cf6b6a84
+  metadata.gz: 8b3d66712c9a2fd460abf00c29b056b87ff8cdd08c8b38d69ece0755d8c76578
+  data.tar.gz: f0fdf7b20e3f3cc3c4e2bee6d21b68bd917d9267c9f1297dec91f2f8bccc71e9
 SHA512:
-  metadata.gz: f81164e402f5e1e4b2ccc2e627675d42631cfda985bf91469eb32735a789eecbe69c7f10bd9d2d5b4959f2d0f2484ae1bf7ced58f607a7cae822846c831ce96c
-  data.tar.gz: '0182828dad6fb6f6d98550608c3bd57ee980ff4acbcc6dfb3ee7d61a16200566f1c8965424537583d0b73225298ca5eba6ddafd3c51791ca847f53264a7654fd'
+  metadata.gz: 98c6c3380181aaf7ad858968b998adab49f8cd200d94755ff6cf79423378dd401c4c538147aeb416b023c47fe7f1806a8742a9486429e90bcc487eb8944cba52
+  data.tar.gz: f251bb7436e9536275a285508f63964693a067378f55a72b3cf01fb9cb801f55ef96fd8a64c9b4e5790c6c400ee6adcee64f6dc5dc413e92b42d5f869afce45f

data/README.md

@@ -87,40 +87,11 @@ client = OmniAI::Example::Client.new(logger:)
 ```
 
 ```
-I, [...]  INFO -- : > POST https://...
-D, [...] DEBUG -- : Authorization: Bearer ...
+[INFO]: POST https://...
+[INFO]: 200 OK
 ...
-{"messages":[{"role":"user","content":"Tell me a joke!"}],"model":"..."}
-I, [...]  INFO -- : < 200 OK
-D, [...] DEBUG -- : Date: ...
-...
-{
-  "id": "...",
-  "object": "...",
-  ...
-}
 ```
 
-The level of the logger can be configured to either `INFO` and `DEBUG`:
-
-**INFO**:
-
-```ruby
-logger.level = Logger::INFO
-```
-
-- Request: verb / URI
-- Response: status
-
-**DEBUG**:
-
-```ruby
-logger.level = Logger::DEBUG
-```
-
-- Request: verb / URI / headers / body
-- Response: status / headers / body
-
 #### Timeouts
 
 Timeouts are configurable by passing a `timeout` an integer duration for the request / response of any APIs using:
@@ -222,3 +193,38 @@ tempfile = client.speak('The quick brown fox jumps over a lazy dog.', voice: 'HA
 tempfile.close
 tempfile.unlink
 ```
+
+## CLI
+
+OmniAI packages a basic command line interface (CLI) to allow for exploration of various APIs. A detailed CLI documentation can be found via help:
+
+```bash
+omniai --help
+```
+
+### Chat
+
+#### w/ a Prompt
+
+```bash
+omniai chat "What is the coldest place on earth?"
+```
+
+```
+The coldest place on earth is Antarctica.
+```
+
+#### w/o a Prompt
+
+```bash
+omniai chat --provider="openai" --model="gpt-4" --temperature="0.5"
+```
+
+```
+Type 'exit' or 'quit' to abort.
+# What is the warmet place on earth?
+```
+
+```
+The warmest place on earth is Africa.
+```

data/exe/omniai

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'omniai'
+
+cli = OmniAI::CLI.new
+cli.parse

data/lib/omniai/chat.rb

@@ -45,7 +45,7 @@ module OmniAI
     # @param client [OmniAI::Client] the client
     # @param model [String] required
     # @param temperature [Float, nil] optional
-    # @param stream [Proc, nil] optional
+    # @param stream [Proc, IO, nil] optional
     # @param format [Symbol, nil] optional - :json
     def initialize(messages, client:, model:, temperature: nil, stream: nil, format: nil)
       @messages = messages
@@ -59,6 +59,7 @@ module OmniAI
     # @raise [HTTPError]
     def process!
       response = request!
+
       raise HTTPError, response.flush unless response.status.ok?
 
       parse!(response:)
@@ -96,7 +97,14 @@ module OmniAI
     def stream!(response:)
       raise Error, "#{self.class.name}#stream! unstreamable" unless @stream
 
-      Stream.new(response:).stream! { |chunk| @stream.call(chunk) }
+      Stream.new(response:).stream! do |chunk|
+        case @stream
+        when IO then @stream << chunk
+        else @stream.call(chunk)
+        end
+      end
+
+      @stream.flush if @stream.is_a?(IO)
     end
 
     # @return [Array<Hash>]

data/lib/omniai/cli/base_handler.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class CLI
+    # A generic handler for CLI commands (e.g. 'omnia chat').
+    class BaseHandler
+      # @param stdin [IO] an optional stream for stdin
+      # @param stdout [IO] an optional stream for stdout
+      # @param provider [String] an optional provider (defaults to 'openai')
+      # @param argv [Array<String>]
+      def self.handle!(argv:, stdin: $stdin, stdout: $stdout, provider: 'openai')
+        new(stdin:, stdout:, provider:).handle!(argv:)
+      end
+
+      # @param stdin [IO] an optional stream for stdin
+      # @param stdout [IO] an optional stream for stdout
+      # @param provider [String] an optional provider (defaults to 'openai')
+      def initialize(stdin: $stdin, stdout: $stdout, provider: 'openai')
+        @stdin = stdin
+        @stdout = stdout
+        @provider = provider
+        @args = {}
+      end
+
+      # @param argv [Array<String>]
+      def handle!(argv:)
+        raise NotImplementedError, "#{self.class}#handle! undefined"
+      end
+
+      private
+
+      # @return [OmniAI::Client]
+      def client
+        @client ||= OmniAI::Client.find(provider: @provider)
+      end
+    end
+  end
+end

data/lib/omniai/cli/chat_handler.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class CLI
+    # Used for CLI usage of 'omnia chat'.
+    class ChatHandler < BaseHandler
+      def handle!(argv:)
+        parser.parse!(argv)
+
+        if argv.empty?
+          listen!
+        else
+          chat(prompt: argv.join(' '))
+        end
+      end
+
+      private
+
+      def listen!
+        @stdout.puts('Type "exit" or "quit" to leave.')
+
+        loop do
+          @stdout.print('# ')
+          prompt = @stdin.gets&.chomp
+
+          break if prompt.nil? || prompt.match?(/\A(exit|quit)\z/i)
+
+          chat(prompt:)
+        rescue Interrupt
+          break
+        end
+      end
+
+      # @param prompt [String]
+      def chat(prompt:)
+        client.chat(prompt, **@args, stream: @stdout)
+      end
+
+      # @return [OptionParser]
+      def parser
+        OptionParser.new do |options|
+          options.banner = 'usage: omniai chat [options] "<prompt>"'
+
+          options.on('-h', '--help', 'help') do
+            @stdout.puts(options)
+            exit
+          end
+
+          options.on('-p', '--provider=PROVIDER', 'provider') { |provider| @provider = provider }
+          options.on('-m', '--model=MODEL', 'model') { |model| @args[:model] = model }
+          options.on('-t', '--temperature=TEMPERATURE', Float, 'temperature') do |temperature|
+            @args[:temperature] = temperature
+          end
+          options.on('-f', '--format=FORMAT', 'format') { |format| @args[:format] = format.intern }
+        end
+      end
+    end
+  end
+end

data/lib/omniai/cli.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module OmniAI
+  # Used when interacting with the suite from the command line interface (CLI).
+  #
+  # Usage:
+  #
+  #   cli = OmniAI::CLI.new
+  #   cli.parse
+  class CLI
+    ChatArgs = Struct.new(:provider, :model, :temperature)
+
+    # @param in [IO] a stream
+    # @param out [IO] a stream
+    # @param provider [String] a provider
+    def initialize(stdin: $stdin, stdout: $stdout, provider: 'openai')
+      @stdin = stdin
+      @stdout = stdout
+      @provider = provider
+      @args = {}
+    end
+
+    def parse(argv = ARGV)
+      parser.order!(argv)
+      command = argv.shift
+      return if command.nil?
+
+      case command
+      when 'chat' then ChatHandler.handle!(stdin: @stdin, stdout: @stdout, provider: @provider, argv:)
+      else raise Error, "unsupported command=#{command.inspect}"
+      end
+    end
+
+    private
+
+    # @return [OptionParser]
+    def parser
+      OptionParser.new do |options|
+        options.banner = 'usage: omniai [options] <command> [<args>]'
+
+        options.on('-h', '--help', 'help') do
+          @stdout.puts(options)
+          exit
+        end
+
+        options.on('-v', '--version', 'version') do
+          @stdout.puts(VERSION)
+          exit
+        end
+
+        options.on('-p', '--provider=PROVIDER', 'provider (default="openai")') do |provider|
+          @provider = provider
+        end
+
+        options.separator <<~COMMANDS
+          commands:
+            chat
+        COMMANDS
+      end
+    end
+  end
+end

data/lib/omniai/client.rb

@@ -16,8 +16,6 @@ module OmniAI
   #     end
   #   end
   class Client
-    class Error < StandardError; end
-
     # @return [String, nil]
     attr_accessor :api_key
 
@@ -30,6 +28,68 @@ module OmniAI
     # @return [Integer, nil]
     attr_accessor :timeout
 
+    # Initialize a client for Anthropic. This method requires the provider if it is undefined.
+    #
+    # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    # @return [Class<OmniAI::Client>]
+    def self.anthropic
+      require 'omniai/anthropic' unless defined?(OmniAI::Anthropic::Client)
+      OmniAI::Anthropic::Client
+    rescue LoadError
+      raise Error, "requires 'omniai-anthropic': `gem install omniai-anthropic`"
+    end
+
+    # Lookup the `OmniAI::Google::Client``. This method requires the provider if it is undefined.
+    #
+    # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    # @return [Class<OmniAI::Client>]
+    def self.google
+      require 'omniai/google' unless defined?(OmniAI::Google::Client)
+      OmniAI::Google::Client
+    rescue LoadError
+      raise Error, "requires 'omniai-google': `gem install omniai-google`"
+    end
+
+    # Initialize a client for Mistral. This method requires the provider if it is undefined.
+    #
+    # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    # @return [Class<OmniAI::Client>]
+    def self.mistral
+      require 'omniai/mistral' unless defined?(OmniAI::Mistral::Client)
+      OmniAI::Mistral::Client
+    rescue LoadError
+      raise Error, "requires 'omniai-mistral': `gem install omniai-mistral`"
+    end
+
+    # Initialize a client for OpenAI. This method requires the provider if it is undefined.
+    #
+    # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    # @return [Class<OmniAI::Client>]
+    def self.openai
+      require 'omniai/openai' unless defined?(OmniAI::OpenAI::Client)
+      OmniAI::OpenAI::Client
+    rescue LoadError
+      raise Error, "requires 'omniai-openai': `gem install omniai-openai`"
+    end
+
+    # Initialize a client by provider (e.g. 'openai'). This method attempts to require the provider.
+    #
+    # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    # @param provider [String] required (e.g. 'anthropic', 'google', 'mistral', 'openai', etc)
+    # @return [OmniAI::Client]
+    def self.find(provider:, **)
+      klass =
+        case provider
+        when 'anthropic' then anthropic
+        when 'google' then google
+        when 'mistral' then mistral
+        when 'openai' then openai
+        else raise Error, "unknown provider=#{provider.inspect}"
+        end
+
+      klass.new(**)
+    end
+
     # @param api_key [String, nil] optional
     # @param host [String, nil] optional - supports for customzing the host of the client (e.g. 'http://localhost:8080')
     # @param logger [Logger, nil] optional
@@ -57,7 +117,7 @@ module OmniAI
     # @return [HTTP::Client]
     def connection
       http = HTTP.persistent(@host)
-      http = http.use(logging: { logger: @logger }) if @logger
+      http = http.use(instrumentation: { instrumenter: Instrumentation.new(logger: @logger) }) if @logger
       http = http.timeout(@timeout) if @timeout
       http
     end

data/lib/omniai/instrumentation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OmniAI
+  # Used for logging.
+  class Instrumentation
+    # @param logger [Logger]
+    def initialize(logger:)
+      @logger = logger
+    end
+
+    # @param name [String]
+    # @param payload [Hash]
+    # @option payload [Exception] :error
+    def instrument(name, payload = {})
+      error = payload[:error]
+      return unless error
+
+      @logger.error("#{name}: #{error.message}")
+    end
+
+    # @param name [String]
+    # @param payload [Hash]
+    # @option payload [HTTP::Request] :request
+    def start(_, payload)
+      request = payload[:request]
+      @logger.info("#{request.verb.upcase} #{request.uri}")
+    end
+
+    # @param name [String]
+    # @param payload [Hash]
+    # @option payload [HTTP::Response] :response
+    def finish(_, payload)
+      response = payload[:response]
+      @logger.info("#{response.status.code} #{response.status.reason}")
+    end
+  end
+end

data/lib/omniai/speak.rb

@@ -84,6 +84,7 @@ module OmniAI
     # @return [Tempfile]
     def process!(&block)
       response = request!
+
       raise HTTPError, response.flush unless response.status.ok?
 
       if block

data/lib/omniai/transcribe.rb

@@ -117,6 +117,7 @@ module OmniAI
     # @return [OmniAI::Transcribe::Transcription]
     def process!
       response = request!
+
       raise HTTPError, response.flush unless response.status.ok?
 
       text = @format.nil? || @format.eql?(Format::JSON) ? response.parse['text'] : String(response.body)

data/lib/omniai/version.rb

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

data/lib/omniai.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'event_stream_parser'
 require 'http'
 require 'uri'
@@ -8,6 +9,7 @@ require 'zeitwerk'
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect 'omniai' => 'OmniAI'
 loader.inflector.inflect 'url' => 'URL'
+loader.inflector.inflect 'cli' => 'CLI'
 loader.setup
 
 module OmniAI

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -56,7 +56,8 @@ description: An interface for OpenAI's ChatGPT, Google's Gemini, Anthropic's Cla
   Mistral's LeChat, etc.
 email:
 - kevin@ksylvest.com
-executables: []
+executables:
+- omniai
 extensions: []
 extra_rdoc_files: []
 files:
@@ -64,6 +65,7 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- exe/omniai
 - lib/omniai.rb
 - lib/omniai/chat.rb
 - lib/omniai/chat/chunk.rb
@@ -78,8 +80,12 @@ files:
 - lib/omniai/chat/message_choice.rb
 - lib/omniai/chat/stream.rb
 - lib/omniai/chat/usage.rb
+- lib/omniai/cli.rb
+- lib/omniai/cli/base_handler.rb
+- lib/omniai/cli/chat_handler.rb
 - lib/omniai/client.rb
 - lib/omniai/config.rb
+- lib/omniai/instrumentation.rb
 - lib/omniai/speak.rb
 - lib/omniai/transcribe.rb
 - lib/omniai/transcribe/transcription.rb