omniai-openai 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fa0f1acc820456282d48d42e9bc1154f8aa9b83fe9fa86817e1d3446a8cd31d
-  data.tar.gz: cd4c84c579985a17c96edadcb91324b545035bf170fb20c3172855e13e83586c
+  metadata.gz: e3afb339ec2a0e69d5a268fd134aae4119e3140ccad493f22d7db43b817145a4
+  data.tar.gz: f49c3cfd25228e49555981cc93e05e6702d3ce4edde9fa07277bc68c83312361
 SHA512:
-  metadata.gz: c4583c5da031c749e56b6ec2bbcf59daaebe8f873c5fe9a9cbdfdfb67acf8d8eabc798a754fe5e2784fd73495bb91181deb3e323d00e0e84d962ff86624192a5
-  data.tar.gz: fcf7612d1f7361697820a3e14cf5558fe83fb096b1154a5c3a67c3c6c64823d230e1c1d029252ee91fa0e9cd26bbba398fc18612189171db891d47a830536266
+  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,21 +36,41 @@ 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:
 
 ```ruby
-completion = client.chat.completion('Tell me a joke!')
+completion = client.chat('Tell me a joke!')
 completion.choice.message.content # 'Why did the chicken cross the road? To get to the other side.'
 ```
 
 ```ruby
-completion = client.chat.completion({
+completion = client.chat({
   role: OmniAI::Chat::Role::USER,
   content: 'Is it wise to jump off a bridge?'
 })
@@ -58,7 +78,7 @@ completion.choice.message.content # 'No.'
 ```
 
 ```ruby
-completion = client.chat.completion([
+completion = client.chat([
   {
     role: OmniAI::Chat::Role::SYSTEM,
     content: 'You are a helpful assistant.'
@@ -73,7 +93,7 @@ completion.choice.message.content # 'The capital of Canada is Ottawa.'
 `model` takes an optional string (default is `gtp-4o`):
 
 ```ruby
-completion = client.chat.completion('How fast is a cheetah?', model: OmniAI::OpenAI::Chat::Model::GPT_3_5_TURBO)
+completion = client.chat('How fast is a cheetah?', model: OmniAI::OpenAI::Chat::Model::GPT_3_5_TURBO)
 completion.choice.message.content # 'A cheetah can reach speeds over 100 km/h.'
 ```
 
@@ -84,7 +104,7 @@ completion.choice.message.content # 'A cheetah can reach speeds over 100 km/h.'
 `temperature` takes an optional float between `0.0` and `2.0` (defaults is `0.7`):
 
 ```ruby
-completion = client.chat.completion('Pick a number between 1 and 5', temperature: 2.0)
+completion = client.chat('Pick a number between 1 and 5', temperature: 2.0)
 completion.choice.message.content # '3'
 ```
 
@@ -98,7 +118,7 @@ completion.choice.message.content # '3'
 stream = proc do |chunk|
   print(chunk.choice.delta.content) # 'Better', 'three', 'hours', ...
 end
-client.chat.completion('Be poetic.', stream:)
+client.chat('Be poetic.', stream:)
 ```
 
 [OpenAI API Reference `stream`](https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream)
@@ -108,7 +128,7 @@ client.chat.completion('Be poetic.', stream:)
 `format` takes an optional symbol (`:json`) and that setes the `response_format` to `json_object`:
 
 ```ruby
-completion = client.chat.completion([
+completion = client.chat([
   { role: OmniAI::Chat::Role::SYSTEM, content: OmniAI::Chat::JSON_PROMPT },
   { role: OmniAI::Chat::Role::USER, content: 'What is the name of the drummer for the Beatles?' }
 ], format: :json)

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.1.1'
+    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.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -69,7 +69,8 @@ files:
 - lib/omniai/openai/transcribe.rb
 - lib/omniai/openai/version.rb
 homepage: https://github.com/ksylvest/omniai-openai
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/ksylvest/omniai-openai
   changelog_uri: https://github.com/ksylvest/omniai-openai/releases