Add persistent client connections

Author: madwork

lib/openai/client.rb

@@ -12,7 +12,7 @@ class Client
       request_timeout
       extra_headers
     ].freeze
-    attr_reader *CONFIG_KEYS, :faraday_middleware
+    attr_reader *CONFIG_KEYS
 
     def initialize(config = {}, &faraday_middleware)
       CONFIG_KEYS.each do |key|
@@ -23,7 +23,12 @@ def initialize(config = {}, &faraday_middleware)
           config[key].nil? ? OpenAI.configuration.send(key) : config[key]
         )
       end
-      @faraday_middleware = faraday_middleware
+
+      @connection = build_connection
+      faraday_middleware&.call(@connection)
+
+      @multipart_connection = build_connection(multipart: true)
+      faraday_middleware&.call(@multipart_connection)
     end
 
     def chat(parameters: {})
@@ -107,5 +112,19 @@ def beta(apis)
         client.add_headers("OpenAI-Beta": apis.map { |k, v| "#{k}=#{v}" }.join(";"))
       end
     end
+
+    private
+
+    attr_reader :connection, :multipart_connection
+
+    def build_connection(multipart: false)
+      Faraday.new do |faraday|
+        faraday.options[:timeout] = @request_timeout
+        faraday.request(:multipart) if multipart
+        faraday.use MiddlewareErrors if @log_errors
+        faraday.response :raise_error
+        faraday.response :json
+      end
+    end
   end
 end

lib/openai/http.rb

@@ -7,32 +7,32 @@ module HTTP
     include HTTPHeaders
 
     def get(path:, parameters: nil)
-      parse_jsonl(conn.get(uri(path: path), parameters) do |req|
+      parse_jsonl(connection.get(uri(path: path), parameters) do |req|
         req.headers = headers
       end&.body)
     end
 
     def post(path:)
-      parse_jsonl(conn.post(uri(path: path)) do |req|
+      parse_jsonl(connection.post(uri(path: path)) do |req|
         req.headers = headers
       end&.body)
     end
 
     def json_post(path:, parameters:)
-      conn.post(uri(path: path)) do |req|
+      connection.post(uri(path: path)) do |req|
         configure_json_post_request(req, parameters)
       end&.body
     end
 
     def multipart_post(path:, parameters: nil)
-      conn(multipart: true).post(uri(path: path)) do |req|
+      multipart_connection.post(uri(path: path)) do |req|
         req.headers = headers.merge({ "Content-Type" => "multipart/form-data" })
         req.body = multipart_parameters(parameters)
       end&.body
     end
 
     def delete(path:)
-      conn.delete(uri(path: path)) do |req|
+      connection.delete(uri(path: path)) do |req|
         req.headers = headers
       end&.body
     end
@@ -70,20 +70,6 @@ def to_json_stream(user_proc:)
       end
     end
 
-    def conn(multipart: false)
-      connection = Faraday.new do |f|
-        f.options[:timeout] = @request_timeout
-        f.request(:multipart) if multipart
-        f.use MiddlewareErrors if @log_errors
-        f.response :raise_error
-        f.response :json
-      end
-
-      @faraday_middleware&.call(connection)
-
-      connection
-    end
-
     def uri(path:)
       if azure?
         base = File.join(@uri_base, path)

spec/openai/client/client_spec.rb

@@ -44,7 +44,7 @@
       expect(c0.uri_base).to eq(OpenAI::Configuration::DEFAULT_URI_BASE)
       expect(c0.send(:headers).values).to include("Bearer #{c0.access_token}")
       expect(c0.send(:headers).values).to include(c0.organization_id)
-      expect(c0.send(:conn).options.timeout).to eq(OpenAI::Configuration::DEFAULT_REQUEST_TIMEOUT)
+      expect(c0.send(:connection).options.timeout).to eq(OpenAI::Configuration::DEFAULT_REQUEST_TIMEOUT)
       expect(c0.send(:uri, path: "")).to include(OpenAI::Configuration::DEFAULT_URI_BASE)
       expect(c0.send(:headers).values).to include("X-Default")
       expect(c0.send(:headers).values).not_to include("X-Test")
@@ -55,7 +55,7 @@
       expect(c1.request_timeout).to eq(60)
       expect(c1.uri_base).to eq("https://oai.hconeai.com/")
       expect(c1.send(:headers).values).to include(c1.access_token)
-      expect(c1.send(:conn).options.timeout).to eq(60)
+      expect(c1.send(:connection).options.timeout).to eq(60)
       expect(c1.send(:uri, path: "")).to include("https://oai.hconeai.com/")
       expect(c1.send(:headers).values).not_to include("X-Default")
       expect(c1.send(:headers).values).to include("X-Test")
@@ -67,7 +67,7 @@
       expect(c2.uri_base).to eq("https://example.com/")
       expect(c2.send(:headers).values).to include("Bearer #{c2.access_token}")
       expect(c2.send(:headers).values).to include(c2.organization_id)
-      expect(c2.send(:conn).options.timeout).to eq(1)
+      expect(c2.send(:connection).options.timeout).to eq(1)
       expect(c2.send(:uri, path: "")).to include("https://example.com/")
       expect(c2.send(:headers).values).to include("X-Default")
       expect(c2.send(:headers).values).not_to include("X-Test")
@@ -128,9 +128,7 @@
     end
 
     it "sets the logger" do
-      connection = Faraday.new
-      client.faraday_middleware.call(connection)
-      expect(connection.builder.handlers).to include Faraday::Response::Logger
+      expect(client.send(:connection).builder.handlers).to include Faraday::Response::Logger
     end
   end
 end