omniai 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2820bc43050fa4484a25e1a967b3d12ac71a3d5659e735f5904040990acf47b8
-  data.tar.gz: 8894714bf0c8055ca173176d8eeb078ce6f93a0481c19df3fd2dae911fbb264d
+  metadata.gz: 341ce12cf0950b167a43c298f3ccb1df821bbdc469bc6824b14219bef4e38ab5
+  data.tar.gz: 9badfe7e48d20fe84054d9206e8572a333f382407c3236a3715e1d85cf6b6a84
 SHA512:
-  metadata.gz: b2658cb0bf197315f3679225a214871ffdbf670cabb65f3126b4a1e7ccd40b6f38810e9fea828b71eb1c9fae819f94e824dedc65ed69cc7531e496d9ae027896
-  data.tar.gz: 3f525900c8c319076549235713418e7cc7e87167151668900e3073530004b9bb1561469a9b02914dfac63eff4f35b67fbf9ca66171b5471cf24c665e280f3d23
+  metadata.gz: f81164e402f5e1e4b2ccc2e627675d42631cfda985bf91469eb32735a789eecbe69c7f10bd9d2d5b4959f2d0f2484ae1bf7ced58f607a7cae822846c831ce96c
+  data.tar.gz: '0182828dad6fb6f6d98550608c3bd57ee980ff4acbcc6dfb3ee7d61a16200566f1c8965424537583d0b73225298ca5eba6ddafd3c51791ca847f53264a7654fd'

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,79 @@ 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:)
+```
+
+```
+I, [...]  INFO -- : > POST https://...
+D, [...] DEBUG -- : Authorization: Bearer ...
+...
+{"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:
+
+```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/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(logging: { 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/version.rb

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

metadata

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