omniai 1.2.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2820bc43050fa4484a25e1a967b3d12ac71a3d5659e735f5904040990acf47b8
-  data.tar.gz: 8894714bf0c8055ca173176d8eeb078ce6f93a0481c19df3fd2dae911fbb264d
+  metadata.gz: 28e6e2a736d78cbc0135308eb28320a85a319b78a888cd96fa3320456c3c0222
+  data.tar.gz: '044786d21ba8f2316599836af153c6dec80d055a0cbcf1e843c000296d1df350'
 SHA512:
-  metadata.gz: b2658cb0bf197315f3679225a214871ffdbf670cabb65f3126b4a1e7ccd40b6f38810e9fea828b71eb1c9fae819f94e824dedc65ed69cc7531e496d9ae027896
-  data.tar.gz: 3f525900c8c319076549235713418e7cc7e87167151668900e3073530004b9bb1561469a9b02914dfac63eff4f35b67fbf9ca66171b5471cf24c665e280f3d23
+  metadata.gz: c260f1b52fe5ffec70dc5c6755426c9798062bb234da303d76ec21319d450433e95f03ca787fcfa8cd966899235416d5a83580ffd11c24615d8a58df8d64efbc
+  data.tar.gz: 0acc9d0556d0bf8de430ca3a52977c88c6a43edfe017226d1831b4ccc034d2ba3bcde38fad112d61d8910bfc9a9ee440999354919a8d4c3cb614a0d0fc3e2314

data/Gemfile

@@ -4,8 +4,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'logger'
 gem 'rake'
-
 gem 'rspec'
 gem 'rspec_junit_formatter'
 gem 'rubocop'

data/README.md

@@ -2,13 +2,15 @@
 
 [![CircleCI](https://circleci.com/gh/ksylvest/omniai.svg?style=svg)](https://circleci.com/gh/ksylvest/omniai)
 
-OmniAI is a flexible AI library that standardizes the APIs for multiple AI providers:
+OmniAI is a flexible AI library that standardizes the APIs of many different AIs:
 
 - [OmniAI::Anthropic](https://github.com/ksylvest/omniai-anthropic)
 - [OmniAI::Google](https://github.com/ksylvest/omniai-google)
 - [OmniAI::Mistral](https://github.com/ksylvest/omniai-mistral)
 - [OmniAI::OpenAI](https://github.com/ksylvest/omniai-openai)
 
+All libraries are community maintained.
+
 ## Installation
 
 ```sh
@@ -72,6 +74,50 @@ Ollama support is offered through [OmniAI::OpenAI](https://github.com/ksylvest/o
 
 [Usage with Ollama](https://github.com/ksylvest/omniai-openai#usage-with-ollama)
 
+#### Logging
+
+Logging the **request** / **response** is configurable by passing a logger into any client:
+
+```ruby
+require 'omniai/openai'
+require 'logger'
+
+logger = Logger.new(STDOUT)
+client = OmniAI::Example::Client.new(logger:)
+```
+
+```
+[INFO]: POST https://...
+[INFO]: 200 OK
+...
+```
+
+#### Timeouts
+
+Timeouts are configurable by passing a `timeout` an integer duration for the request / response of any APIs using:
+
+```ruby
+require 'omniai/openai'
+require 'logger'
+
+logger = Logger.new(STDOUT)
+client = OmniAI::OpenAI::Client.new(timeout: 8) # i.e. 8 seconds
+```
+
+Timeouts are also be configurable by passing a `timeout` hash with `timeout` / `read` / `write` / `keys using:
+
+```ruby
+require 'omniai/openai'
+require 'logger'
+
+logger = Logger.new(STDOUT)
+client = OmniAI::OpenAI::Client.new(timeout: {
+  read: 2, # i.e. 2 seconds
+  write: 3, # i.e. 3 seconds
+  connect: 4, # i.e. 4 seconds
+})
+```
+
 ### Chat
 
 Clients that support chat (e.g. Anthropic w/ "Claude", Google w/ "Gemini", Mistral w/ "LeChat", OpenAI w/ "ChatGPT", etc) generate completions using the following calls:

data/lib/omniai/chat.rb

@@ -59,6 +59,7 @@ module OmniAI
     # @raise [HTTPError]
     def process!
       response = request!
+
       raise HTTPError, response.flush unless response.status.ok?
 
       parse!(response:)

data/lib/omniai/client.rb

@@ -9,19 +9,36 @@ module OmniAI
   #     def initialize(api_key: ENV.fetch('OPENAI_API_KEY'), logger: nil)
   #       super
   #     end
+  #
+  #     # @return [HTTP::Client]
+  #     def connection
+  #       @connection ||= super.auth("Bearer: #{@api_key}")
+  #     end
   #   end
   class Client
     class Error < StandardError; end
 
-    attr_accessor :api_key, :logger, :host
+    # @return [String, nil]
+    attr_accessor :api_key
+
+    # @return [Logger, nil]
+    attr_accessor :logger
+
+    # @return [String, nil]
+    attr_accessor :host
+
+    # @return [Integer, nil]
+    attr_accessor :timeout
 
-    # @param api_key [String] optional
-    # @param host [String] optional - supports for customzing the host of the client (e.g. 'http://localhost:8080')
-    # @param logger [Logger] optional
-    def initialize(api_key: nil, logger: nil, host: nil)
+    # @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
+    # @param timeout [Integer, nil] optional
+    def initialize(api_key: nil, logger: nil, host: nil, timeout: nil)
       @api_key = api_key
       @host = host
       @logger = logger
+      @timeout = timeout
     end
 
     # @return [String]
@@ -39,7 +56,10 @@ module OmniAI
 
     # @return [HTTP::Client]
     def connection
-      raise NotImplementedError, "#{self.class.name}#connection undefined"
+      http = HTTP.persistent(@host)
+      http = http.use(instrumentation: { instrumenter: Instrumentation.new(logger: @logger) }) if @logger
+      http = http.timeout(@timeout) if @timeout
+      http
     end
 
     # @raise [OmniAI::Error]

data/lib/omniai/config.rb

@@ -1,9 +1,56 @@
 # frozen_string_literal: true
 
 module OmniAI
-  # A configuration for each agent w/ `api_key` / `host` / `logger`.
+  # A configuration for each agent w/ `api_key` / `host` / `logger`. Usage:
+  #
+  #   OmniAI::OpenAI.config do |config|
+  #     config.api_key = '...'
+  #     config.host = 'http://localhost:8080'
+  #     config.logger = Logger.new(STDOUT)
+  #     config.timeout = 15
+  #     config.chat_options = { ... }
+  #     config.transcribe_options = { ... }
+  #     config.speak_options = { ... }
+  #   end
   class Config
-    attr_accessor :api_key, :host, :logger
+    # @return [String, nil]
+    attr_accessor :api_key
+
+    # @return [String, nil]
+    attr_accessor :host
+
+    # @return [Logger, nil]
+    attr_accessor :logger
+
+    # @return [Integer, Hash{Symbol => Integer}, nil]
+    # @option timeout [Integer] :read
+    # @option timeout [Integer] :write
+    # @option timeout [Integer] :connect
+    attr_accessor :timeout
+
+    # @return [Hash]
+    attr_accessor :chat_options
+
+    # @return [Hash]
+    attr_accessor :transcribe_options
+
+    # @return [Hash]
+    attr_accessor :speak_options
+
+    # @param api_key [String] optional
+    # @param host [String] optional
+    # @param logger [Logger] optional
+    # @param timeout [Integer] optional
+    def initialize(api_key: nil, host: nil, logger: nil, timeout: nil)
+      @api_key = api_key
+      @host = host
+      @logger = logger
+      @timeout = timeout
+
+      @chat_options = {}
+      @transcribe_options = {}
+      @speak_options = {}
+    end
 
     # @return [String]
     def inspect

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.2.3'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.1
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -80,6 +80,7 @@ files:
 - lib/omniai/chat/usage.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