Merge pull request #137 from alexrudall/remove-deprecated-endpoints

Remove deprecated endpoints

Author: alexrudall

README.md

@@ -188,7 +188,7 @@ You may need to wait a short time for processing to complete. Once processed, yo
     fine_tuned_model = JSON.parse(response.body)["fine_tuned_model"]
 ```
 
-This fine-tuned model name can then be used in classifications:
+This fine-tuned model name can then be used in completions:
 
 ```ruby
     response = client.completions(
@@ -247,58 +247,6 @@ Pass a string to check if it violates OpenAI's Content Policy:
     => 5.505014632944949e-05
 ```
 
-### Classifications
-
-Pass examples and a query to predict the most likely labels:
-
-```ruby
-    response = client.classifications(parameters: {
-        examples: [
-            ["A happy moment", "Positive"],
-            ["I am sad.", "Negative"],
-            ["I am feeling awesome", "Positive"]
-        ],
-        query: "It is a raining day :(",
-        model: "text-ada-001"
-    })
-```
-
-Or use the ID of a file you've uploaded:
-
-```ruby
-    response = client.classifications(parameters: {
-        file: "123abc,
-        query: "It is a raining day :(",
-        model: "text-ada-001"
-    })
-```
-
-### Answers
-
-Pass documents, a question string, and an example question/response to get an answer to a question:
-
-```ruby
-    response = client.answers(parameters: {
-        documents: ["Puppy A is happy.", "Puppy B is sad."],
-        question: "which puppy is happy?",
-        model: "text-curie-001",
-        examples_context: "In 2017, U.S. life expectancy was 78.6 years.",
-        examples: [["What is human life expectancy in the United States?","78 years."]],
-    })
-```
-
-Or use the ID of a file you've uploaded:
-
-```ruby
-    response = client.answers(parameters: {
-        file: "123abc",
-        question: "which puppy is happy?",
-        model: "text-curie-001",
-        examples_context: "In 2017, U.S. life expectancy was 78.6 years.",
-        examples: [["What is human life expectancy in the United States?","78 years."]],
-    })
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

lib/ruby/openai.rb

@@ -1,6 +1,5 @@
 require "httparty"
 require "ruby/openai/client"
-require "ruby/openai/engines"
 require "ruby/openai/files"
 require "ruby/openai/finetunes"
 require "ruby/openai/images"

lib/ruby/openai/client.rb

@@ -7,45 +7,18 @@ def initialize(access_token: nil, organization_id: nil)
       Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
-    def answers(parameters: {})
-      warn "[DEPRECATION WARNING] [ruby-openai] `Client#answers` is deprecated and will
-      be removed from the OpenAI API on 3 December 2022 and from ruby-openai v3.0.
-      More information: https://help.openai.com/en/articles/6233728-answers-transition-guide"
-
-      OpenAI::Client.post(path: "/answers", parameters: parameters)
-    end
-
-    def classifications(parameters: {})
-      warn "[DEPRECATION WARNING] [ruby-openai] `Client#classifications` is deprecated and will
-      be removed from the OpenAI API on 3 December 2022 and from ruby-openai v3.0.
-      More information: https://help.openai.com/en/articles/6272941-classifications-transition-guide"
-
-      OpenAI::Client.post(path: "/classifications", parameters: parameters)
-    end
-
-    def completions(engine: nil, parameters: {})
-      parameters = deprecate_engine(engine: engine, method: "completions", parameters: parameters)
-
+    def completions(parameters: {})
       OpenAI::Client.post(path: "/completions", parameters: parameters)
     end
 
     def edits(parameters: {})
       OpenAI::Client.post(path: "/edits", parameters: parameters)
     end
 
-    def embeddings(engine: nil, parameters: {})
-      parameters = deprecate_engine(engine: engine, method: "embeddings", parameters: parameters)
-
+    def embeddings(parameters: {})
       OpenAI::Client.post(path: "/embeddings", parameters: parameters)
     end
 
-    def engines
-      warn "[DEPRECATION WARNING] [ruby-openai] `Client#engines` is deprecated and will
-      be removed from ruby-openai v3.0. Use `Client#models` instead."
-
-      @engines ||= OpenAI::Engines.new
-    end
-
     def files
       @files ||= OpenAI::Files.new
     end
@@ -66,14 +39,6 @@ def moderations(parameters: {})
       OpenAI::Client.post(path: "/moderations", parameters: parameters)
     end
 
-    def search(engine:, parameters: {})
-      warn "[DEPRECATION WARNING] [ruby-openai] `Client#search` is deprecated and will
-      be removed from the OpenAI API on 3 December 2022 and from ruby-openai v3.0.
-      More information: https://help.openai.com/en/articles/6272952-search-transition-guide"
-
-      OpenAI::Client.post(path: "/engines/#{engine}/search", parameters: parameters)
-    end
-
     def self.get(path:)
       HTTParty.get(
         uri(path: path),
@@ -107,23 +72,5 @@ def self.delete(path:)
         "OpenAI-Organization" => Ruby::OpenAI.configuration.organization_id
       }
     end
-
-    private
-
-    def deprecate_engine(engine:, method:, parameters:)
-      return parameters unless engine
-
-      parameters = { model: engine }.merge(parameters)
-
-      warn "[DEPRECATION WARNING] [ruby-openai] Passing `engine` directly to `Client##{method}` is
-      deprecated and will be removed in ruby-openai 3.0. Pass `model` within `parameters` instead:
-      client.completions(parameters: { #{parameters.map { |k, v| "#{k}: \"#{v}\"" }.join(', ')} })"
-
-      parameters
-    end
-
-    def documents_or_file(documents: nil, file: nil)
-      documents ? { documents: documents } : { file: file }
-    end
   end
 end