Merge pull request #349 from alexrudall/fine-tuning-jobs

Add fine-tuning jobs and remove deprecated finetunes

Author: alexrudall

README.md

@@ -308,22 +308,22 @@ client.files.content(id: "file-123")
 client.files.delete(id: "file-123")
 ```
 
-### Fine-tunes
+### Finetunes
 
 Upload your fine-tuning data in a `.jsonl` file as above and get its ID:
 
 ```ruby
-response = client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
-file_id = response["id"]
+response = client.files.upload(parameters: { file: "path/to/sarcasm.jsonl", purpose: "fine-tune" })
+file_id = JSON.parse(response.body)["id"]
 ```
 
-You can then use this file ID to create a fine-tune model:
+You can then use this file ID to create a fine tuning job:
 
 ```ruby
 response = client.finetunes.create(
     parameters: {
     training_file: file_id,
-    model: "ada"
+    model: "gpt-3.5-turbo-0613"
 })
 fine_tune_id = response["id"]
 ```
@@ -342,21 +342,22 @@ response = client.finetunes.retrieve(id: fine_tune_id)
 fine_tuned_model = response["fine_tuned_model"]
 ```
 
-This fine-tuned model name can then be used in chats:
+This fine-tuned model name can then be used in completions:
 
 ```ruby
-response = client.chat(
+response = client.completions(
     parameters: {
         model: fine_tuned_model,
-        messages: [{ role: "user", content: "I love Mondays!"}]
-    })
-puts response.dig("choices", 0, "message", "content")
+        prompt: "I love Mondays!"
+    }
+)
+response.dig("choices", 0, "text")
 ```
 
-You can delete the fine-tuned model when you are done with it:
+You can also capture the events for a job:
 
-```ruby
-client.finetunes.delete(fine_tuned_model: fine_tuned_model)
+```
+client.finetunes.list_events(id: fine_tune_id)
 ```
 
 ### Image Generation

lib/openai/finetunes.rb

@@ -5,31 +5,23 @@ def initialize(client:)
     end
 
     def list
-      @client.get(path: "/fine-tunes")
+      @client.get(path: "/fine_tuning/jobs")
     end
 
     def create(parameters: {})
-      @client.json_post(path: "/fine-tunes", parameters: parameters)
+      @client.json_post(path: "/fine_tuning/jobs", parameters: parameters)
     end
 
     def retrieve(id:)
-      @client.get(path: "/fine-tunes/#{id}")
+      @client.get(path: "/fine_tuning/jobs/#{id}")
     end
 
     def cancel(id:)
-      @client.multipart_post(path: "/fine-tunes/#{id}/cancel")
+      @client.json_post(path: "/fine_tuning/jobs/#{id}/cancel", parameters: {})
     end
 
-    def events(id:)
-      @client.get(path: "/fine-tunes/#{id}/events")
-    end
-
-    def delete(fine_tuned_model:)
-      if fine_tuned_model.start_with?("ft-")
-        raise ArgumentError, "Please give a fine_tuned_model name, not a fine-tune ID"
-      end
-
-      @client.delete(path: "/models/#{fine_tuned_model}")
+    def list_events(id:)
+      @client.get(path: "/fine_tuning/jobs/#{id}/events")
     end
   end
 end

lib/openai/http.rb

@@ -3,39 +3,40 @@
 module OpenAI
   module HTTP
     def get(path:)
-      to_json(conn.get(uri(path: path)) do |req|
+      parse_jsonl(conn.get(uri(path: path)) do |req|
         req.headers = headers
       end&.body)
     end
 
     def json_post(path:, parameters:)
-      to_json(conn.post(uri(path: path)) do |req|
+      conn.post(uri(path: path)) do |req|
         configure_json_post_request(req, parameters)
-      end&.body)
+      end&.body
     end
 
     def multipart_post(path:, parameters: nil)
-      to_json(conn(multipart: true).post(uri(path: path)) do |req|
+      conn(multipart: true).post(uri(path: path)) do |req|
         req.headers = headers.merge({ "Content-Type" => "multipart/form-data" })
         req.body = multipart_parameters(parameters)
-      end&.body)
+      end&.body
     end
 
     def delete(path:)
-      to_json(conn.delete(uri(path: path)) do |req|
+      conn.delete(uri(path: path)) do |req|
         req.headers = headers
-      end&.body)
+      end&.body
     end
 
     private
 
-    def to_json(string)
-      return unless string
+    def parse_jsonl(response)
+      return unless response
+      return response unless response.is_a?(String)
 
-      JSON.parse(string)
-    rescue JSON::ParserError
       # Convert a multiline string of JSON objects to a JSON array.
-      JSON.parse(string.gsub("}\n{", "},{").prepend("[").concat("]"))
+      response = response.gsub("}\n{", "},{").prepend("[").concat("]")
+
+      JSON.parse(response)
     end
 
     # Given a proc, returns an outer proc that can be used to iterate over a JSON stream of chunks.
@@ -64,6 +65,7 @@ def conn(multipart: false)
         f.options[:timeout] = @request_timeout
         f.request(:multipart) if multipart
         f.response :raise_error
+        f.response :json
       end
     end