Add support for cancelling runs

Author: Haegin

lib/openai/http.rb

@@ -12,6 +12,12 @@ def get(path:)
       end&.body)
     end
 
+    def post(path:)
+      parse_jsonl(conn.post(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
     def json_post(path:, parameters:)
       conn.post(uri(path: path)) do |req|
         configure_json_post_request(req, parameters)

lib/openai/http_headers.rb

@@ -1,5 +1,11 @@
 module OpenAI
   module HTTPHeaders
+    def add_headers(headers)
+      @extra_headers = extra_headers.merge(headers.transform_keys(&:to_s))
+    end
+
+    private
+
     def headers
       if azure?
         azure_headers
@@ -26,9 +32,5 @@ def azure_headers
     def extra_headers
       @extra_headers ||= {}
     end
-
-    def add_headers(headers)
-      @extra_headers = extra_headers.merge(headers.transform_keys(&:to_s))
-    end
   end
 end

lib/openai/runs.rb

@@ -20,6 +20,10 @@ def modify(id:, thread_id:, parameters: {})
       @client.json_post(path: "/threads/#{thread_id}/runs/#{id}", parameters: parameters)
     end
 
+    def cancel(id:, thread_id:)
+      @client.post(path: "/threads/#{thread_id}/runs/#{id}/cancel")
+    end
+
     def submit_tool_outputs(thread_id:, run_id:, parameters: {})
       @client.json_post(path: "/threads/#{thread_id}/runs/#{run_id}/submit_tool_outputs",
                         parameters: parameters)

spec/fixtures/cassettes/runs_cancel.yml

@@ -1,3 +1,5 @@
+require "byebug"
+
 RSpec.describe OpenAI::Client do
   describe "#runs" do
     describe "#list" do
@@ -66,6 +68,40 @@
       end
     end
 
+    describe "#cancel" do
+      let(:cassette) { "runs cancel" }
+
+      context "for a run in progress" do
+        let(:response) do
+          OpenAI::Client.new.runs.cancel(
+            id: "run_tWHF8ZDAEHDxetXOFIEiUvJr",
+            thread_id: "thread_gOFC5endN7iUfAhpekz50O5G"
+          )
+        end
+
+        it "succeeds" do
+          VCR.use_cassette(cassette) do
+            expect(response["object"]).to eq "thread.run"
+          end
+        end
+      end
+
+      context "for a completed run" do
+        let(:response) do
+          OpenAI::Client.new.runs.cancel(
+            id: "run_1bs2QXbSoM9kfQ4UxRbOjfpP",
+            thread_id: "thread_UCMWkz0d98AqtTSrFZjfh89x"
+          )
+        end
+
+        it "responds with a 400" do
+          VCR.use_cassette(cassette) do
+            expect { response }.to raise_error(Faraday::BadRequestError)
+          end
+        end
+      end
+    end
+
     describe "#submit_tool_outputs" do
       let(:cassette) { "runs submit_tool_outputs" }
       let(:response) do