omniai-openai 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01d9c9144c74769c3eed7d8ec37f4cab63885057d5f16b02727e8c26e94414a0
-  data.tar.gz: 98e56e503c8ba01d3822d448dab53c94fef16d08c3f7896884e381f0b10b54fb
+  metadata.gz: 8a95f906f1bf54382e8ace7ae6b1622ad22d2502a23c4804038b1ca66ff43086
+  data.tar.gz: 6694a63f7f76e2d41220a18e2ea852a19e956a8258761b71e9a0ec747197c9a9
 SHA512:
-  metadata.gz: 652b78a11ffb57f7b884d39fd08222fd4a87a0105a32ec0304d7d09efde5988b7f6058d3fbed46b6b3b8e8d44fec5191ffe925804f953456502020ea9cc8ef6f
-  data.tar.gz: 41c3516078e9a9411eebea6a0eaf3424b6a756d8b714697e51817e02f7faa9c4f170dc38c2fadb21c325a7576c5ae615468e3fb5d1438014532ae1be4c43d37b
+  metadata.gz: c19cd98191bd1826f24af180bcf87e96670fc162c6555bf368e4eda9305cdf5fa465585c74764d55481181752f563a581b09e3b1583220df70d9b227861a51d8
+  data.tar.gz: b6eb2fdeb33dcf4dda02f2b608e13ae3cc29c687b0c9eb31bdecaf72d07548b0201c68efe3e40cd754b368d2b2f84813e5eeb207878dbc6355fe4a67a8308f3e

data/README.md

@@ -2,7 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/ksylvest/omniai-openai.svg?style=svg)](https://circleci.com/gh/ksylvest/omniai-openai)
 
-An OpenAI implementation of the [OmniAI](https://github.com/ksylvest/omniai) APIs.
+An OpenAI implementation of the [OmniAI](https://github.com/ksylvest/omniai) interface supporting ChatGPT, Whisper, Text-to-Voice, Voice-to-Text, and more. This library is community maintained.
 
 ## Installation
 
@@ -25,7 +25,7 @@ A client may also be passed the following options:
 - `api_key` (required - default is `ENV['OPENAI_API_KEY']`)
 - `organization` (optional)
 - `project` (optional)
-- `host` (optional)
+- `host` (optional) useful for usage with Ollama or LocalAI
 
 ### Configuration
 
@@ -36,10 +36,30 @@ OmniAI::OpenAI.configure do |config|
   config.api_key = 'sk-...' # default: ENV['OPENAI_API_KEY']
   config.organization = '...' # default: ENV['OPENAI_ORGANIZATION']
   config.project = '...' # default: ENV['OPENAI_PROJECT']
-  config.host = '...' # default: 'https://api.openai.com'
+  config.host = '...' # default: 'https://api.openai.com' - override for usage with LocalAI / Ollama
 end
 ```
 
+#### Usage with [LocalAI](https://localai.io/)
+
+LocalAI offers [built in compatability with the OpenAI specification](https://localai.io/). To initialize a client that points to a Ollama change the host accordingly:
+
+```ruby
+client = OmniAI::OpenAI::Client.new(host: 'http://localhost:8080', api_key: nil)
+```
+
+_For details on installation or running LocalAI see the [getting started tutorial](https://localai.io/basics/getting_started/)._
+
+#### Usage with [Ollama](https://www.ollama.com/)
+
+Ollama offers [built in compatability with the OpenAI specification](https://ollama.com/blog/openai-compatibility). To initialize a client that points to a Ollama change the host accordingly:
+
+```ruby
+client = OmniAI::OpenAI::Client.new(host: 'http://localhost:11434', api_key: nil)
+```
+
+_For details on installation or running Ollama checkout [the project README](https://github.com/ollama/ollama)._
+
 ### Chat
 
 A chat completion is generated by passing in prompts using any a variety of formats:

data/lib/omniai/openai/client.rb

@@ -22,30 +22,38 @@ module OmniAI
     class Client < OmniAI::Client
       VERSION = 'v1'
 
-      # @param api_key [String] optional - defaults to `OmniAI::OpenAI.config.api_key`
-      # @param project_id [String] optional - defaults to `OmniAI::OpenAI.config.project`
-      # @param organization_id [String] optional - defaults to `OmniAI::OpenAI.config.organization`
-      # @param logger [Logger] optional - defaults to `OmniAI::OpenAI.config.logger`
+      # @param api_key [String, nil] optional - defaults to `OmniAI::OpenAI.config.api_key`
+      # @param host [String] optional - defaults to `OmniAI::OpenAI.config.host`
+      # @param project [String, nil] optional - defaults to `OmniAI::OpenAI.config.project`
+      # @param organization [String, nil] optional - defaults to `OmniAI::OpenAI.config.organization`
+      # @param logger [Logger, nil] optional - defaults to `OmniAI::OpenAI.config.logger`
+      # @param timeout [Integer, nil] optional - defaults to `OmniAI::OpenAI.config.timeout`
       def initialize(
         api_key: OmniAI::OpenAI.config.api_key,
+        host: OmniAI::OpenAI.config.host,
         organization: OmniAI::OpenAI.config.organization,
         project: OmniAI::OpenAI.config.project,
         logger: OmniAI::OpenAI.config.logger,
-        host: OmniAI::OpenAI.config.host
+        timeout: OmniAI::OpenAI.config.timeout
       )
-        raise(ArgumentError, %(ENV['OPENAI_API_KEY'] must be defined or `api_key` must be passed)) if api_key.nil?
+        if api_key.nil? && host.eql?(Config::DEFAULT_HOST)
+          raise(
+            ArgumentError,
+            %(ENV['OPENAI_API_KEY'] must be defined or `api_key` must be passed when using #{Config::DEFAULT_HOST})
+          )
+        end
 
-        super(api_key:, logger:)
+        super(api_key:, host:, logger:, timeout:)
 
         @organization = organization
         @project = project
-        @host = host
       end
 
       # @return [HTTP::Client]
       def connection
         @connection ||= begin
-          http = HTTP.auth("Bearer #{api_key}").persistent(@host)
+          http = super
+          http = http.auth("Bearer #{@api_key}") if @api_key
           http = http.headers('OpenAI-Organization': @organization) if @organization
           http = http.headers('OpenAI-Project': @project) if @project
           http

data/lib/omniai/openai/config.rb

@@ -2,19 +2,36 @@
 
 module OmniAI
   module OpenAI
-    # Configuration for managing the OpenAI `api_key` / `organization` / `project` / `logger`.
+    # Configuration for OpenAI.
     class Config < OmniAI::Config
-      attr_accessor :organization, :project, :chat_options, :transcribe_options, :speak_options
+      DEFAULT_HOST = 'https://api.openai.com'
 
-      def initialize
-        super
-        @api_key = ENV.fetch('OPENAI_API_KEY', nil)
-        @organization = ENV.fetch('OPENAI_ORGANIZATION', nil)
-        @project = ENV.fetch('OPENAI_PROJECT', nil)
-        @host = ENV.fetch('OPENAI_HOST', 'https://api.openai.com')
-        @chat_options = {}
-        @transcribe_options = {}
-        @speak_options = {}
+      # @!attribute [rw] organization
+      #   @return [String, nil] passed as `OpenAI-Organization` if specified
+      attr_accessor :organization
+
+      # @!attribute [rw] project
+      #   @return [String, nil] passed as `OpenAI-Organization` if specified
+      attr_accessor :project
+
+      # @param api_key [String, nil] optional - defaults to `ENV['OPENAI_API_KEY']`
+      # @param host [String, nil] optional - defaults to ENV['OPENAI_HOST'] w/ fallback to `DEFAULT_HOST`
+      # @param organization [String, nil] optional - defaults to `ENV['OPENAI_ORGANIZATION']`
+      # @param project [String, nil] optional - defaults to `ENV['OPENAI_PROJECT']`
+      # @param logger [Logger, nil] optional
+      # @param timeout [Integer, Hash, nil] optional
+      def initialize(
+        api_key: ENV.fetch('OPENAI_API_KEY', nil),
+        host: ENV.fetch('OPENAI_HOST', DEFAULT_HOST),
+        organization: ENV.fetch('OPENAI_ORGANIZATION', nil),
+        project: ENV.fetch('OPENAI_PROJECT', nil),
+        logger: nil,
+        timeout: nil
+      )
+        super(api_key:, host:, logger:, timeout:)
+
+        @organization = organization
+        @project = project
       end
     end
   end

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  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