omniai-openai 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01d9c9144c74769c3eed7d8ec37f4cab63885057d5f16b02727e8c26e94414a0
-  data.tar.gz: 98e56e503c8ba01d3822d448dab53c94fef16d08c3f7896884e381f0b10b54fb
+  metadata.gz: e3afb339ec2a0e69d5a268fd134aae4119e3140ccad493f22d7db43b817145a4
+  data.tar.gz: f49c3cfd25228e49555981cc93e05e6702d3ce4edde9fa07277bc68c83312361
 SHA512:
-  metadata.gz: 652b78a11ffb57f7b884d39fd08222fd4a87a0105a32ec0304d7d09efde5988b7f6058d3fbed46b6b3b8e8d44fec5191ffe925804f953456502020ea9cc8ef6f
-  data.tar.gz: 41c3516078e9a9411eebea6a0eaf3424b6a756d8b714697e51817e02f7faa9c4f170dc38c2fadb21c325a7576c5ae615468e3fb5d1438014532ae1be4c43d37b
+  metadata.gz: 4455db3523b81301793b936528312394cb0f98b8f51ad7a49f5f6fe5811c2969dcaf679649deb0cb90bfec5fdf5838f3ba6444eea645d560ceaaaf96b9c15f5f
+  data.tar.gz: 804f70fd6067cba057aaa7dbbe7d65f5edaa389e5315fb4a107f154fbafa1139d33ad637439e8b838036767c02e4e2cfed0d69c43c0a36cb805bb4dfe21eb907

data/README.md

@@ -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

@@ -33,19 +33,24 @@ module OmniAI
         logger: OmniAI::OpenAI.config.logger,
         host: OmniAI::OpenAI.config.host
       )
-        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:)
 
         @organization = organization
         @project = project
-        @host = host
       end
 
       # @return [HTTP::Client]
       def connection
         @connection ||= begin
-          http = HTTP.auth("Bearer #{api_key}").persistent(@host)
+          http = HTTP.persistent(@host)
+          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

@@ -6,12 +6,14 @@ module OmniAI
     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')
+        @host = ENV.fetch('OPENAI_HOST', DEFAULT_HOST)
         @chat_options = {}
         @transcribe_options = {}
         @speak_options = {}

data/lib/omniai/openai/version.rb

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

metadata

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