Add edits feature

lib/openai.rb

@@ -1,6 +1,7 @@
 require "openai/choice"
 require "openai/client"
 require "openai/completion"
+require "openai/edit"
 require "openai/engine"
 require "openai/logprobs"
 require "openai/search_result"

lib/openai/client.rb

@@ -73,6 +73,32 @@ def completions(prompt: nil, max_tokens: nil, temperature: nil, top_p: nil, n: n
       )
     end
 
+    def edits(input: nil, instruction: nil, n: nil, temperature: nil, top_p: nil, engine: default_engine)
+      body = {
+        "input"             => input,
+        "instruction"       => instruction,
+        "n"                 => n,
+        "temperature"       => temperature,
+        "top_p"             => top_p
+      }.compact
+
+      edit = post("/v1/engines/#{engine}/edits", body: body)
+
+      choices = edit[:choices]&.map do |choice|
+        Choice.new(
+          index: choice[:index],
+          text: choice[:text]
+        )
+      end
+
+      Edit.new(
+        choices: choices,
+        created: edit[:created],
+        usage: edit[:usage],
+        object: edit[:object],
+      )
+    end
+
     def search(documents:, query:, engine: default_engine)
       body = {
         "documents" => documents,

lib/openai/edit.rb

@@ -0,0 +1,7 @@
+module OpenAI
+  Edit = Struct.new(:choices, :created, :usage, :object, keyword_init: true) do
+    def created_at
+      Time.at(created)
+    end
+  end
+end

lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

spec/fixtures/edits.json

@@ -0,0 +1 @@
+{"choices":[{"finish_reason":null,"index":0,"logprobs":null,"text":"What day of the week is it?\n"}],"created":1677528012,"usage":{"prompt_tokens":25,"completion_tokens":28,"total_tokens":53},"object":"edit"}

spec/openai/client_spec.rb

@@ -104,6 +104,21 @@
     end
   end
 
+  describe "#edits" do
+    before do
+      stub_request(:post, "https://api.openai.com/v1/engines/text-davinci-edit-001/edits")
+        .with(headers: request_headers)
+        .to_return(body: File.read("spec/fixtures/edits.json"), headers: response_headers)
+    end
+
+    it "creates an edit" do
+      input = "What day of the wek is it?"
+      instruction = "Fix the spelling mistakes"
+      results = client.edits(input: input, instruction: instruction, engine: "text-davinci-edit-001")
+      expect(results).to be_a(OpenAI::Edit)
+    end
+  end
+
   describe "#search" do
     before do
       stub_request(:post, "https://api.openai.com/v1/engines/ada/search")