ruby-openai 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50fc900251b1e7c0c1a9f1f18c779871cba3691c9e3cd32a022286f6ee5978f2
-  data.tar.gz: '015428f6b586a0c504f839c6b38eb6842bd7c964805049ec8af706bf18fe8307'
+  metadata.gz: 2a823ba01c0dbec587f96e5d2d59b6eb67e48c348b00a7e78f415c6b65583d05
+  data.tar.gz: 98e7ae98831997f66bcbd73c644c78b0f5ed291b5b98c6ca01e5152596ca7b25
 SHA512:
-  metadata.gz: ab310b17e7282ba6885b468373b10d27f33ef50effff6b61d07d5d677e2b4153346ca355c66803521dc55bed87c8799a1da1513dd04ff8e4d36a53ec382b9d77
-  data.tar.gz: f29975d47364d66ca01ffebdf6adfeb2b660b808ec4cf704f35aaa775be73bfb0aff09673a3b0ee540dd8c35e70c2af24e909ba336c8cdbe22a2f9c6bd868781
+  metadata.gz: 15a75647453b2b526680b5e2d3b7bc3d5ef6b05f223bdef0194e751f829228d9db7d17d5c483db66bf7706983c4d996ff4c348b505e6d52b6cbb5ef523e68133
+  data.tar.gz: a7362b11bfeefa471e70369696d746d5c89c201ef374799a6163dbad814f405d7642861d588ef6360f088e21d41ba4b10e7f40467d2a4d515767ea66bf52b4d3

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.1] - 2022-12-26
+
+### Removed
+
+- [BREAKING] Remove deprecated answers, classifications, embeddings, engines and search endpoints.
+- [BREAKING] Remove ability to pass engine to completions and embeddings outside of the parameters hash.
+
 ## [3.0.0] - 2022-12-26
 
 ### Added
@@ -15,8 +22,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 - [BREAKING] Remove ability to include access_token directly via ENV vars.
-- [BREAKING] Remove deprecated answers, classifications, embeddings, engines and search endpoints.
-- [BREAKING] Remove ability to pass engine to completions and embeddings outside of the parameters hash.
 - [BREAKING] Remove ability to pass API version directly to endpoints.
 
 ## [2.3.0] - 2022-12-23

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (3.0.0)
+    ruby-openai (3.0.1)
       httparty (>= 0.18.1, < 0.21.0)
 
 GEM

data/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.

data/lib/ruby/openai/client.rb

@@ -7,25 +7,7 @@ module OpenAI
       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
 
@@ -33,19 +15,10 @@ module OpenAI
       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 @@ module OpenAI
       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 @@ module OpenAI
         "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

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "3.0.0".freeze
+    VERSION = "3.0.1".freeze
   end
 end

data/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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Alex
@@ -57,7 +57,6 @@ files:
 - bin/setup
 - lib/ruby/openai.rb
 - lib/ruby/openai/client.rb
-- lib/ruby/openai/engines.rb
 - lib/ruby/openai/files.rb
 - lib/ruby/openai/finetunes.rb
 - lib/ruby/openai/images.rb

data/lib/ruby/openai/engines.rb

@@ -1,16 +0,0 @@
-module OpenAI
-  class Engines
-    def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
-    end
-
-    def list
-      OpenAI::Client.get(path: "/engines")
-    end
-
-    def retrieve(id:)
-      OpenAI::Client.get(path: "/engines/#{id}")
-    end
-  end
-end