openai.rb 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f049bfa7ff5419acf81a7cabc6e34b6bd223b8f9fcb634008544d93d87170c2f
-  data.tar.gz: d614701b82eaf3ec84e9ddb432505bbbd786f71d75378534b23400446ddb8e7b
+  metadata.gz: a36b209f6540c340ca79cfa0e245d373db12c20b1d33f4fdd418c56bfa33961d
+  data.tar.gz: a30abc667ce81ffa59ec3a65c260193554cff814d03805921f745ec9140f2942
 SHA512:
-  metadata.gz: c321d0184079826648569ab13b04675d9cbfb04027fed85b191d462c6585cc375d9144dede8ecf6d9995e48be935bf6879dba969e17492cb9c4ffe100f468fea
-  data.tar.gz: 3fd0d70f0007e3900e6df1f39ef18dcbd618b7e3384de229b50936924bb4bf80e79d19bd7a531be6caade2b915c03581cccabc32f01b5921c79bd88e224c27a0
+  metadata.gz: 0aacdfd81c1a7bbd88c2fceed1e9c3aaf38f7cc948467b45a2c3e607d5eaf6bafa084ba2a8accd08aa7430c67b08df4da810ef2e07349359b601258c9f14c550
+  data.tar.gz: c6c89ccafded9440f5a472afbcee736307e7f2daa4f82b2028515cec86cd22a224e3006bd1d858c7faa7b495e7d889691c4af76ea4720972b50022890b01d18a

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# v0.0.5
+
+* Added `OpenAI#without_cache`
+
+# v0.0.4
+
+* Added support for specifying `OpenAI.new(api_key, organization: 'org-123')`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openai.rb (0.0.3)
+    openai.rb (0.0.5)
       abstract_type (~> 0.0.7)
       anima (~> 0.3)
       concord (~> 0.1)

data/README.md

@@ -51,6 +51,13 @@ openai.api.completions.create(model: 'text-davinci-002', prompt: 'Say hi')
 
 NOTE: Delete requests are not cached
 
+To temporarily use the client without caching:
+
+```ruby
+openai = OpenAI.create(ENV.fetch('OPENAI_API_KEY'), cache: cache_dir)
+openai.without_cache.api.completions.create(...)
+```
+
 ### Tokens
 
 ```ruby

data/bin/console

@@ -17,5 +17,3 @@ openai = OpenAI.create(
 )
 
 Pry.start_without_pry_byebug(binding, quiet: true)
-
-start_repl

data/lib/openai/api/cache.rb

@@ -29,6 +29,10 @@ class OpenAI
         end
       end
 
+      def without_cache
+        client
+      end
+
       private
 
       def read_cache_or_apply(...)

data/lib/openai/api/client.rb

@@ -3,18 +3,18 @@
 class OpenAI
   class API
     class Client
-      include Concord.new(:api_key, :http)
+      include Concord.new(:api_key, :organization_id, :http)
 
       public :api_key
 
       HOST = Addressable::URI.parse('https://api.openai.com/v1')
 
-      def initialize(api_key, http: HTTP)
-        super(api_key, http)
+      def initialize(api_key, organization_id: nil, http: HTTP)
+        super(api_key, organization_id, http)
       end
 
       def inspect
-        "#<#{self.class}>"
+        "#<#{self.class} organization_id=#{organization_id.inspect}>"
       end
 
       def get(route)
@@ -62,6 +62,10 @@ class OpenAI
         unwrap_response(http_client.post(url_for(route), form: body))
       end
 
+      def without_cache
+        self
+      end
+
       private
 
       def url_for(route)
@@ -79,7 +83,9 @@ class OpenAI
       end
 
       def http_client
-        http.headers('Authorization' => "Bearer #{api_key}")
+        headers = { 'Authorization' => "Bearer #{api_key}" }
+        headers['OpenAI-Organization'] = organization_id if organization_id
+        http.headers(headers)
       end
     end
   end

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class OpenAI
-  VERSION = '0.0.3'
+  VERSION = '0.0.5'
 end

data/lib/openai.rb

@@ -28,8 +28,8 @@ class OpenAI
 
   ROOT = Pathname.new(__dir__).parent.expand_path.freeze
 
-  def self.create(api_key, cache: nil, logger: Logger.new('/dev/null'))
-    client = API::Client.new(api_key)
+  def self.create(api_key, cache: nil, organization: nil, logger: Logger.new('/dev/null'))
+    client = API::Client.new(api_key, organization_id: organization)
 
     if cache.is_a?(Pathname) && cache.directory?
       client = API::Cache.new(
@@ -41,8 +41,17 @@ class OpenAI
     new(client, logger)
   end
 
+  # @api private
+  def self.build(api_client, logger)
+    new(api_client, logger)
+  end
+
   private_class_method :new
 
+  def without_cache
+    self.class.build(api_client.without_cache, logger)
+  end
+
   def api
     API.new(api_client)
   end

data/spec/unit/openai_spec.rb

@@ -37,6 +37,25 @@ RSpec.describe OpenAI do
     )
   end
 
+  context 'when the organization ID is given to the client' do
+    let(:api_client) do
+      OpenAI::API::Client.new(
+        'sk-123',
+        organization_id: 'org-123',
+        http: http
+      )
+    end
+
+    it 'authenticates the request and includes the organization id' do
+      resource.create(model: 'text-davinci-002', prompt: 'Hello, world!')
+
+      expect(http).to have_received(:headers).with(
+        'OpenAI-Organization' => 'org-123',
+        'Authorization' => 'Bearer sk-123'
+      )
+    end
+  end
+
   context 'when the request is not 2xx' do
     let(:response_body) do
       {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - John
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-02 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_type
@@ -127,6 +127,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md