ruby-openai 1.5.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eae2966d67581585125aac11431d33db3af2f472d0970dad242316783ded514e
-  data.tar.gz: 53f357b92d77a79c48539b69216c4b06c2f0fd0584be17dfbf54576ea02ffed4
+  metadata.gz: 4fafce333da7c64cacff4af92a1aa6f9a6b852a6c84bcf139668ad6763e93be0
+  data.tar.gz: bd5ae87214057466912c2892123e5d1ab6efc2dc570cbbe00c13679417506706
 SHA512:
-  metadata.gz: 67c875aa8dde9a199aead346a6b45af8aed00ddf81b2db667c055c1ef9e86dea2d43e5b3d23e1e659dbfb0468a40ab9c419b52115a61491217c8c1b0d65aff3c
-  data.tar.gz: 4d55769b42b9b295ff4c065c9f4abdbaaf5e96b998eb707e3a64f4161355d20c5e8ee0b417c80029b376e70fe9c69e0521c397ac82523aa05874e8ecbeaac7ce
+  metadata.gz: 1eac6b65e9ed0b8f932f0f9b65670df4a96e988a56c8ea302abbcf675b670917d4f1dd9289cfc0fa0be5868811888e0e67851338258ccfa8c5954fee82b1df6a
+  data.tar.gz: e1b856074548b44c228170c8f211737df30d1106edf5097d115df5b286447959bbbd30f6d7d3d8b33a88ebcd64303596240804192c710329b421749da8eac709

data/.circleci/config.yml

@@ -36,10 +36,9 @@ workflows:
       - rubocop
       - test:
           matrix:
-              parameters:
-                ruby-image:
-                  - cimg/ruby:2.5-node
-                  - cimg/ruby:2.6-node
-                  - cimg/ruby:2.7-node
-                  - cimg/ruby:3.0-node
-                  - cimg/ruby:3.1-node
+            parameters:
+              ruby-image:
+                - cimg/ruby:2.6-node
+                - cimg/ruby:2.7-node
+                - cimg/ruby:3.0-node
+                - cimg/ruby:3.1-node

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   NewCops: enable
   SuggestExtensions: false
 

data/CHANGELOG.md

@@ -5,6 +5,26 @@ 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).
 
+## [2.0.1] - 2022-10-22
+
+### Removed
+
+- Deprecate Client#answers endpoint.
+- Deprecate Client#classifications endpoint.
+
+## [2.0.0] - 2022-09-19
+
+### Removed
+
+- [BREAKING] Remove support for Ruby 2.5.
+- [BREAKING] Remove support for passing `query`, `documents` or `file` as top-level parameters to `Client#search`.
+- Deprecate Client#search endpoint.
+- Deprecate Client#engines endpoints.
+
+### Added
+
+- Add Client#models endpoints to list and query available models.
+
 ## [1.5.0] - 2022-09-18
 
 ### Added

data/Gemfile

@@ -6,6 +6,6 @@ gemspec
 gem "byebug", "~> 11.1.3"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.11"
-gem "rubocop", "~> 1.28.2"
-gem "vcr", "~> 6.0.0"
+gem "rubocop", "~> 1.37.0"
+gem "vcr", "~> 6.1.0"
 gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (1.5.0)
+    ruby-openai (2.0.1)
       dotenv (>= 2.7.6, < 2.9.0)
       httparty (>= 0.18.1, < 0.21.0)
 
@@ -20,17 +20,18 @@ GEM
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
+    json (2.6.2)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     public_suffix (4.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.3.1)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -45,20 +46,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.28.2)
+    rubocop (1.37.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.22.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
+    rubocop-ast (1.22.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-    vcr (6.0.0)
+    unicode-display_width (2.3.0)
+    vcr (6.1.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -71,9 +73,9 @@ DEPENDENCIES
   byebug (~> 11.1.3)
   rake (~> 13.0)
   rspec (~> 3.11)
-  rubocop (~> 1.28.2)
+  rubocop (~> 1.37.0)
   ruby-openai!
-  vcr (~> 6.0.0)
+  vcr (~> 6.1.0)
   webmock (~> 3.18.1)
 
 BUNDLED WITH

data/README.md

@@ -14,7 +14,7 @@ Use the [OpenAI GPT-3 API](https://openai.com/blog/openai-api/) with Ruby! 🤖
 Add this line to your application's Gemfile:
 
 ```ruby
-    gem 'ruby-openai'
+    gem "ruby-openai"
 ```
 
 And then execute:
@@ -59,26 +59,38 @@ Alternatively you can pass your key directly to a new client:
     client = OpenAI::Client.new(access_token: "access_token_goes_here")
 ```
 
+### Models
+
+There are different models that can be used to generate text. For a full list and to retrieve information about a single models:
+
+```ruby
+    client.models.list
+    client.models.retrieve(id: "text-ada-001")
+```
+
 #### Examples
 
-- [GPT-3](https://beta.openai.com/docs/engines/gpt-3)
+- [GPT-3](https://beta.openai.com/docs/models/gpt-3)
   - text-ada-001
   - text-babbage-001
   - text-curie-001
   - text-davinci-001
-- [Codex (private beta)](https://beta.openai.com/docs/engines/codex-series-private-beta)
+- [Codex (private beta)](https://beta.openai.com/docs/models/codex-series-private-beta)
   - code-davinci-002
   - code-cushman-001
-- [Content Filter](https://beta.openai.com/docs/engines/content-filter)
-  - content-filter-alpha
 
 ### Completions
 
 Hit the OpenAI API for a completion:
 
 ```ruby
-    response = client.completions(engine: "text-davinci-001", parameters: { prompt: "Once upon a time", max_tokens: 5 })
-    puts response.parsed_response['choices'].map{ |c| c["text"] }
+    response = client.completions(
+        parameters: {
+            model: "text-davinci-001",
+            prompt: "Once upon a time",
+            max_tokens: 5
+        })
+    puts response["choices"].map { |c| c["text"] }
     => [", there lived a great"]
 ```
 
@@ -104,9 +116,9 @@ You can use the embeddings endpoint to get a vector of numbers representing an i
 
 ```ruby
     client.embeddings(
-        engine: "babbage-similarity",
         parameters: {
-          input: "The food was delicious and the waiter..."
+            model: "babbage-similarity",
+            input: "The food was delicious and the waiter..."
         }
     )
 ```
@@ -123,7 +135,7 @@ Put your data in a `.jsonl` file like this:
 and pass the path to `client.files.upload` to upload it to OpenAI, and then interact with it:
 
 ```ruby
-    client.files.upload(parameters: { file: 'path/to/puppy.jsonl', purpose: 'search' })
+    client.files.upload(parameters: { file: "path/to/puppy.jsonl", purpose: "search" })
     client.files.list
     client.files.retrieve(id: 123)
     client.files.delete(id: 123)
@@ -141,7 +153,7 @@ Put your fine-tuning data in a `.jsonl` file like this:
 and pass the path to `client.files.upload` to upload it to OpenAI and get its ID:
 
 ```ruby
-    response = client.files.upload(parameters: { file: 'path/to/sentiment.jsonl', purpose: 'fine-tune' })
+    response = client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
     file_id = JSON.parse(response.body)["id"]
 ```
 
@@ -182,8 +194,6 @@ This fine-tuned model name can then be used in classifications:
     JSON.parse(response.body)["choices"].map { |c| c["text"] }
 ```
 
-Do not pass the engine parameter when using a fine-tuned model.
-
 ### Moderations
 
 Pass a string to check if it violates OpenAI's Content Policy:
@@ -194,22 +204,6 @@ Pass a string to check if it violates OpenAI's Content Policy:
     => 5.505014632944949e-05
 ```
 
-### Searches
-
-Pass documents and a query string to get semantic search scores against each document:
-
-```ruby
-    response = client.search(engine: "text-ada-001", parameters: { documents: %w[washington hospital school], query: "president" })
-    puts response["data"].map { |d| d["score"] }
-    => [202.0, 48.052, 19.247]
-```
-
-You can alternatively search using the ID of a file you've uploaded:
-
-```ruby
-    client.search(engine: "text-ada-001", parameters: { file: "abc123", query: "happy" })
-```
-
 ### Classifications
 
 Pass examples and a query to predict the most likely labels:
@@ -262,15 +256,6 @@ Or use the ID of a file you've uploaded:
     })
 ```
 
-### Engines
-
-There are different engines that can be used to generate text. For a full list and to retrieve information about a single engine:
-
-```ruby
-    client.engines.list
-    client.engines.retrieve(id: 'text-ada-001')
-```
-
 ## 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

@@ -8,30 +8,41 @@ module OpenAI
     end
 
     def answers(version: default_version, 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"
+
       post(url: "/#{version}/answers", parameters: parameters)
     end
 
     def classifications(version: default_version, 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"
+
       post(url: "/#{version}/classifications", parameters: parameters)
     end
 
     def completions(engine: nil, version: default_version, parameters: {})
-      if engine
-        post(url: "/#{version}/engines/#{engine}/completions", parameters: parameters)
-      else
-        post(url: "/#{version}/completions", parameters: parameters)
-      end
+      parameters = deprecate_engine(engine: engine, method: "completions", parameters: parameters)
+
+      post(url: "/#{version}/completions", parameters: parameters)
     end
 
     def edits(version: default_version, parameters: {})
       post(url: "/#{version}/edits", parameters: parameters)
     end
 
-    def embeddings(engine:, version: default_version, parameters: {})
-      post(url: "/#{version}/engines/#{engine}/embeddings", parameters: parameters)
+    def embeddings(engine: nil, version: default_version, parameters: {})
+      parameters = deprecate_engine(engine: engine, method: "embeddings", parameters: parameters)
+
+      post(url: "/#{version}/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(access_token: @access_token)
     end
 
@@ -43,35 +54,35 @@ module OpenAI
       @finetunes ||= OpenAI::Finetunes.new(access_token: @access_token)
     end
 
+    def models
+      @models ||= OpenAI::Models.new(access_token: @access_token)
+    end
+
     def moderations(version: default_version, parameters: {})
       post(url: "/#{version}/moderations", parameters: parameters)
     end
 
-    # rubocop:disable Layout/LineLength
-    # rubocop:disable Metrics/ParameterLists
-    def search(engine:, query: nil, documents: nil, file: nil, version: default_version, parameters: {})
-      return legacy_search(engine: engine, query: query, documents: documents, file: file, version: version) if query || documents || file
+    def search(engine:, version: default_version, 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"
 
       post(url: "/#{version}/engines/#{engine}/search", parameters: parameters)
     end
-    # rubocop:enable Layout/LineLength
-    # rubocop:enable Metrics/ParameterLists
 
     private
 
-    # rubocop:disable Layout/LineLength
-    def legacy_search(engine:, query:, documents: nil, file: nil, version: default_version)
-      warn "[DEPRECATION] Passing `query`, `documents` or `file` directly to `Client#search` is deprecated and will be removed in a future version of ruby-openai.
-        Please nest these terms within `parameters` instead, like this:
-        client.search(engine: 'davinci', parameters: { query: 'president', documents: %w[washington hospital school] })
-      "
+    def deprecate_engine(engine:, method:, parameters:)
+      return parameters unless engine
 
-      post(
-        url: "/#{version}/engines/#{engine}/search",
-        parameters: { query: query }.merge(documents_or_file(documents: documents, file: file))
-      )
+      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
-    # rubocop:enable Layout/LineLength
 
     def default_version
       "v1".freeze

data/lib/ruby/openai/models.rb

@@ -0,0 +1,36 @@
+module OpenAI
+  class Models
+    include HTTParty
+    base_uri "https://api.openai.com"
+
+    def initialize(access_token: nil)
+      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
+    end
+
+    def list(version: default_version)
+      self.class.get(
+        "/#{version}/models",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def retrieve(id:, version: default_version)
+      self.class.get(
+        "/#{version}/models/#{id}",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    private
+
+    def default_version
+      "v1".freeze
+    end
+  end
+end

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "1.5.0".freeze
+    VERSION = "2.0.1".freeze
   end
 end

data/lib/ruby/openai.rb

@@ -2,6 +2,7 @@ require "httparty"
 require "ruby/openai/engines"
 require "ruby/openai/files"
 require "ruby/openai/finetunes"
+require "ruby/openai/models"
 require "ruby/openai/client"
 require "ruby/openai/version"
 require "dotenv/load"

data/ruby-openai.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "A Ruby gem for the OpenAI GPT-3 API"
   spec.homepage      = "https://github.com/alexrudall/ruby-openai"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/alexrudall/ruby-openai"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-18 00:00:00.000000000 Z
+date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -80,6 +80,7 @@ files:
 - lib/ruby/openai/engines.rb
 - lib/ruby/openai/files.rb
 - lib/ruby/openai/finetunes.rb
+- lib/ruby/openai/models.rb
 - lib/ruby/openai/version.rb
 - pull_request_template.md
 - ruby-openai.gemspec
@@ -99,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="