omniai-openai 1.8.2 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e2977b31559860cd16a54dca1b749d917f9a5146110b4bf6f0b42b8d11eab60
-  data.tar.gz: 30463a38bcea6ae3b95490fb9a7e8a3ed2b4d48b75a597ca1ab4476b1fe4ec5d
+  metadata.gz: a854e09772f9bbb85c5888f17118c935de8638c451e40f0e9991e48c334ee9eb
+  data.tar.gz: e83aa0301a4ace180898d86ddd1cddeccece1f9fca8da97316430ad2aebb5170
 SHA512:
-  metadata.gz: 17cac920b1ed4f0cbe8097cb86c98e9a5b26d3835d495f1609fb15b0a72169b5566d00f1cc41fbba491a9f0b2b0117f3b9d408e70062920529da7d94e7096d56
-  data.tar.gz: 9c7b2bb17652e13df0642648fb6927d9467999375c9532a780d95958f59cd1c66c41900fabd16467074003ed9701ecebcd4c8ba8eaef4694758bdbe23ef8715b
+  metadata.gz: d63e04ffdd27bc4d362d15bd6415a8101a87f973f259b034617168a5e1196505198a59c812782e3d94087a54ebf434eb959f4afb06dbba9add6d40152674e58a
+  data.tar.gz: 971dfa467e7276b0eab4495f18f343884f8f5fd3894227e8ac4643f0860d2761b6c3d9938a58ca637d8544fbeb963710b0012b1b66c588d48baf7ee282b1324e

data/README.md

@@ -23,9 +23,10 @@ client = OmniAI::OpenAI::Client.new
 A client may also be passed the following options:
 
 - `api_key` (required - default is `ENV['OPENAI_API_KEY']`)
+- `api_prefix` (optional) - used with a host when necessary
 - `organization` (optional)
 - `project` (optional)
-- `host` (optional) useful for usage with Ollama or LocalAI
+- `host` (optional) useful for usage with Ollama, LocalAI or other OpenAI API compatible services
 
 ### Configuration
 
@@ -60,6 +61,17 @@ 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)._
 
+#### Usage with [OpenRouter](https://open_router.ai/)
+
+Other fee-based systems/services have adopted all or some of the OpenAI API.  For example [open_router.ai](https://open_router.ai) is a web-services that provides access to many models and providers using their own as well as an OpenAI API.
+
+```ruby
+client  = OmniAI::OpenAI::Client.new(
+            host:       'https://open_router.ai', 
+            api_key:    ENV['OPENROUTER_API_KEY'], 
+            api_prefix: '/api')
+```
+
 ### Chat
 
 A chat completion is generated by passing in a simple text prompt:

data/lib/omniai/openai/chat.rb

@@ -22,6 +22,7 @@ module OmniAI
         GPT_3_5_TURBO = 'gpt-3.5-turbo'
         O1_MINI = 'o1-mini'
         O1_PREVIEW = 'o1-preview'
+        O1 = O1_PREVIEW
       end
 
       DEFAULT_MODEL = Model::GPT_4O
@@ -42,7 +43,7 @@ module OmniAI
 
       # @return [String]
       def path
-        "/#{OmniAI::OpenAI::Client::VERSION}/chat/completions"
+        "#{@client.api_prefix}/#{OmniAI::OpenAI::Client::VERSION}/chat/completions"
       end
     end
   end

data/lib/omniai/openai/client.rb

@@ -22,7 +22,10 @@ module OmniAI
     class Client < OmniAI::Client
       VERSION = 'v1'
 
+      attr_reader :api_prefix
+
       # @param api_key [String, nil] optional - defaults to `OmniAI::OpenAI.config.api_key`
+      # @param api_prefix [String, nil] optional - defaults to empty string
       # @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`
@@ -30,6 +33,7 @@ module OmniAI
       # @param timeout [Integer, nil] optional - defaults to `OmniAI::OpenAI.config.timeout`
       def initialize(
         api_key: OmniAI::OpenAI.config.api_key,
+        api_prefix: '',
         host: OmniAI::OpenAI.config.host,
         organization: OmniAI::OpenAI.config.organization,
         project: OmniAI::OpenAI.config.project,
@@ -47,6 +51,11 @@ module OmniAI
 
         @organization = organization
         @project = project
+
+        @api_prefix = api_prefix
+        return if @api_prefix.empty? || @api_prefix.start_with?('/')
+
+        @api_prefix.prepend('/')
       end
 
       # @return [HTTP::Client]

data/lib/omniai/openai/embed.rb

@@ -27,7 +27,7 @@ module OmniAI
 
       # @return [String]
       def path
-        "/#{OmniAI::OpenAI::Client::VERSION}/embeddings"
+        "#{@client.api_prefix}/#{OmniAI::OpenAI::Client::VERSION}/embeddings"
       end
 
       # @param [Object] value

data/lib/omniai/openai/speak.rb

@@ -30,7 +30,7 @@ module OmniAI
 
       # @return [String]
       def path
-        "/#{OmniAI::OpenAI::Client::VERSION}/audio/speech"
+        "#{@client.api_prefix}/#{OmniAI::OpenAI::Client::VERSION}/audio/speech"
       end
     end
   end

data/lib/omniai/openai/thread/message.rb

@@ -199,7 +199,7 @@ module OmniAI
 
         # @return [String]
         def path
-          "/#{OmniAI::OpenAI::Client::VERSION}/threads/#{@thread_id}/messages#{"/#{@id}" if @id}"
+          "#{@client.api_prefix}/#{OmniAI::OpenAI::Client::VERSION}/threads/#{@thread_id}/messages#{"/#{@id}" if @id}"
         end
       end
     end

data/lib/omniai/openai/thread/run.rb

@@ -252,7 +252,7 @@ module OmniAI
 
         # @return [String]
         def path
-          "/#{OmniAI::OpenAI::Client::VERSION}/threads/#{@thread_id}/runs#{"/#{@id}" if @id}"
+          "#{@client.api_prefix}/#{OmniAI::OpenAI::Client::VERSION}/threads/#{@thread_id}/runs#{"/#{@id}" if @id}"
         end
       end
     end

data/lib/omniai/openai/transcribe.rb

@@ -21,7 +21,7 @@ module OmniAI
 
       # @return [String]
       def path
-        "/#{OmniAI::OpenAI::Client::VERSION}/audio/transcriptions"
+        "#{@client.api_prefix}/#{OmniAI::OpenAI::Client::VERSION}/audio/transcriptions"
       end
     end
   end

data/lib/omniai/openai/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module OpenAI
-    VERSION = '1.8.2'
+    VERSION = '1.8.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai-openai
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.4
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.18
 signing_key: 
 specification_version: 4
 summary: A generalized framework for interacting with OpenAI