Merge pull request #373 from alexrudall/hidden-error

Add ability to pass Faraday config block to Client

Author: alexrudall

README.md

@@ -108,6 +108,16 @@ OpenAI.configure do |config|
 end
 ```
 
+#### Verbose Logging
+
+You can pass [Faraday middleware](https://lostisland.github.io/faraday/#/middleware/index) to the client in a block, eg. to enable verbose logging:
+
+```ruby
+  client = OpenAI::Client.new do |f|
+    f.response :logger, Logger.new($stdout), bodies: true
+  end
+```
+
 #### Azure
 
 To use the [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/) API, you can configure the gem like this:

lib/openai/client.rb

@@ -11,14 +11,15 @@ class Client
       request_timeout
       extra_headers
     ].freeze
-    attr_reader *CONFIG_KEYS
+    attr_reader *CONFIG_KEYS, :faraday_middleware
 
-    def initialize(config = {})
+    def initialize(config = {}, &faraday_middleware)
       CONFIG_KEYS.each do |key|
         # Set instance variables like api_type & access_token. Fall back to global config
         # if not present.
         instance_variable_set("@#{key}", config[key] || OpenAI.configuration.send(key))
       end
+      @faraday_middleware = faraday_middleware
     end
 
     def chat(parameters: {})

lib/openai/http.rb

@@ -71,12 +71,16 @@ def to_json_stream(user_proc:)
     end
 
     def conn(multipart: false)
-      Faraday.new do |f|
+      connection = Faraday.new do |f|
         f.options[:timeout] = @request_timeout
         f.request(:multipart) if multipart
         f.response :raise_error
         f.response :json
       end
+
+      @faraday_middleware&.call(connection)
+
+      connection
     end
 
     def uri(path:)

spec/fixtures/cassettes/gpt-3_5-turbo_function_call_chat.yml

@@ -8,10 +8,12 @@
           parameters: {
             model: model,
             messages: messages,
+            functions: functions,
             stream: stream
           }
         )
       end
+      let(:functions) { [] }
       let(:content) { response.dig("choices", 0, "message", "content") }
       let(:cassette) { "#{model} #{'streamed' if stream} chat".downcase }
 
@@ -24,6 +26,46 @@
           end
         end
 
+        context "with an invalid function call" do
+          let(:cassette) { "#{model} function call chat".downcase }
+          let(:messages) do
+            [
+              {
+                "role" => "function",
+                # "name" => "function",
+                "content" => "function"
+              }
+            ]
+          end
+          let(:functions) do
+            [
+              {
+                "name" => "function",
+                "description" => "function",
+                "parameters" =>
+                  {
+                    "type" => "object",
+                    "properties" => {
+                      "user" => {
+                        "type" => "string",
+                        "description" => "the full name of the user"
+                      }
+                    }
+                  }
+              }
+            ]
+          end
+
+          it "raises an error containing the reason" do
+            VCR.use_cassette(cassette) do
+              response
+            rescue Faraday::Error => e
+              expect(e.response.dig(:body, "error",
+                                    "message")).to include("Missing parameter 'name'")
+            end
+          end
+        end
+
         describe "streaming" do
           let(:chunks) { [] }
           let(:stream) do

spec/openai/client/chat_spec.rb

@@ -119,4 +119,18 @@
       expect(client.send(:headers)["OpenAI-Beta"]).to eq "assistants=v1"
     end
   end
+
+  context "with a block" do
+    let(:client) do
+      OpenAI::Client.new do |client|
+        client.response :logger, Logger.new($stdout), bodies: true
+      end
+    end
+
+    it "sets the logger" do
+      connection = Faraday.new
+      client.faraday_middleware.call(connection)
+      expect(connection.builder.handlers).to include Faraday::Response::Logger
+    end
+  end
 end