omniai 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 239eb058ae53afd3f28fe00a18af282a856ca842a4f81bcdf22413a02d8d44fc
-  data.tar.gz: e74ac69ab6435fd9da3d1602c9cce5e052f53bebf609d8815868b58be0897884
+  metadata.gz: 341ce12cf0950b167a43c298f3ccb1df821bbdc469bc6824b14219bef4e38ab5
+  data.tar.gz: 9badfe7e48d20fe84054d9206e8572a333f382407c3236a3715e1d85cf6b6a84
 SHA512:
-  metadata.gz: a6b18cae8b5aab610bf255860ccd514b794eda3021b2f9b3aa86020968e0f449b683b4db74291e71583698b61d7612a7e49b3ee0310c806a826f7b27c50c7d92
-  data.tar.gz: bd12b38f3c9a150fe09644aaf187aa05aa1063ee136196e11fcaa356f4fe5bdc2c93f6292a79025f301c6d35a1202186f6ad787787828dfd5af91f229a34b550
+  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/chat/chunk.rb

@@ -31,9 +31,9 @@ module OmniAI
         @data['model']
       end
 
-      # @return [Array<OmniAI::Chat::Choice>]
+      # @return [Array<OmniAI::Chat::DeltaChoice>]
       def choices
-        @choices ||= @data['choices'].map { |data| Choice.for(data:) }
+        @choices ||= @data['choices'].map { |data| DeltaChoice.for(data:) }
       end
 
       # @param index [Integer]

data/lib/omniai/chat/completion.rb

@@ -38,13 +38,13 @@ module OmniAI
         @usage ||= Usage.for(data: @data['usage'])
       end
 
-      # @return [Array<OmniAI::Chat::Choice>]
+      # @return [Array<OmniAI::Chat::MessageChoice>]
       def choices
-        @choices ||= @data['choices'].map { |data| Choice.for(data:) }
+        @choices ||= @data['choices'].map { |data| MessageChoice.for(data:) }
       end
 
       # @param index [Integer] optional - default is 0
-      # @return [OmniAI::Chat::Choice]
+      # @return [OmniAI::Chat::MessageChoice]
       def choice(index: 0)
         choices[index]
       end

data/lib/omniai/chat/delta_choice.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # A delta choice returned by the API.
+    class DeltaChoice
+      attr_accessor :index, :delta
+
+      # @param data [Hash]
+      # @return [OmniAI::Chat::Choice]
+      def self.for(data:)
+        index = data['index']
+        delta = Delta.for(data: data['delta'])
+
+        new(index:, delta:)
+      end
+
+      # @param index [Integer]
+      # @param delta [Delta]
+      def initialize(index:, delta:)
+        @index = index
+        @delta = delta
+      end
+    end
+  end
+end

data/lib/omniai/chat/message_choice.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # A choice returned by the API.
+    class MessageChoice
+      attr_accessor :index, :message
+
+      # @param data [Hash]
+      # @return [OmniAI::Chat::Choice]
+      def self.for(data:)
+        index = data['index']
+        message = Message.for(data: data['message'])
+
+        new(index:, message:)
+      end
+
+      # @param index [Integer]
+      # @param message [OmniAI::Chat::Message]
+      def initialize(index:, message:)
+        @index = index
+        @message = message
+      end
+    end
+  end
+end

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.2'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -66,7 +66,6 @@ files:
 - bin/setup
 - lib/omniai.rb
 - lib/omniai/chat.rb
-- lib/omniai/chat/choice.rb
 - lib/omniai/chat/chunk.rb
 - lib/omniai/chat/completion.rb
 - lib/omniai/chat/content/file.rb
@@ -74,7 +73,9 @@ files:
 - lib/omniai/chat/content/text.rb
 - lib/omniai/chat/content/url.rb
 - lib/omniai/chat/delta.rb
+- lib/omniai/chat/delta_choice.rb
 - lib/omniai/chat/message.rb
+- lib/omniai/chat/message_choice.rb
 - lib/omniai/chat/stream.rb
 - lib/omniai/chat/usage.rb
 - lib/omniai/client.rb

data/lib/omniai/chat/choice.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A choice returned by the API.
-    class Choice
-      attr_accessor :index, :delta, :message
-
-      # @param data [Hash]
-      # @return [OmniAI::Chat::Choice]
-      def self.for(data:)
-        index = data['index']
-        delta = Delta.for(data: data['delta']) if data['delta']
-        message = Message.for(data: data['message']) if data['message']
-
-        new(index:, delta:, message:)
-      end
-
-      # @param index [Integer]
-      # @param delta [OmniAI::Chat::Delta] optional
-      # @param message [OmniAI::Chat::Message] optional
-      def initialize(index:, delta:, message:)
-        @index = index
-        @delta = delta
-        @message = message
-      end
-    end
-  end
-end