Merge pull request alexrudall#40 from alexrudall/classifications

Add Classifications

Author: alexrudall

CHANGELOG.md

@@ -5,6 +5,16 @@ 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).
 
+## [1.3.0] - 2021-04-18
+
+### Added
+
+- Add Client#classifications to predict the most likely labels based on examples or a file.
+
+### Fixed
+
+- Fixed Files#upload which was previously broken by the validation code!
+
 ## [1.2.2] - 2021-04-18
 
 ### Changed

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (1.2.2)
+    ruby-openai (1.3.0)
       dotenv (~> 2.7.6)
       httparty (~> 0.18.1)
 

README.md

@@ -107,7 +107,7 @@ Pass documents, a question string, and an example question/response to get an an
     })
 ```
 
-You can alternatively search using the ID of a file you've uploaded:
+Or use the ID of a file you've uploaded:
 
 ```
     response = client.answers(parameters: {
@@ -119,6 +119,32 @@ You can alternatively search using the ID of a file you've uploaded:
     })
 ```
 
+### Classifications
+
+Pass examples and a query to predict the most likely labels:
+
+```
+    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: "ada"
+    })
+```
+
+Or use the ID of a file you've uploaded:
+
+```
+    response = client.classifications(parameters: {
+        file: "123abc,
+        query: "It is a raining day :(",
+        model: "ada"
+    })
+```
+
 ## 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/client.rb

@@ -8,25 +8,15 @@ def initialize(access_token: nil)
     end
 
     def answers(version: default_version, parameters: {})
-      self.class.post(
-        "/#{version}/answers",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
-        },
-        body: parameters.to_json
-      )
+      post(url: "/#{version}/answers", parameters: parameters)
+    end
+
+    def classifications(version: default_version, parameters: {})
+      post(url: "/#{version}/classifications", parameters: parameters)
     end
 
     def completions(engine:, version: default_version, parameters: {})
-      self.class.post(
-        "/#{version}/engines/#{engine}/completions",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
-        },
-        body: parameters.to_json
-      )
+      post(url: "/#{version}/engines/#{engine}/completions", parameters: parameters)
     end
 
     def files
@@ -38,37 +28,25 @@ def files
     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
 
-      self.class.post(
-        "/#{version}/engines/#{engine}/search",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
-        },
-        body: parameters.to_json
-      )
+      post(url: "/#{version}/engines/#{engine}/search", parameters: parameters)
     end
     # rubocop:enable Layout/LineLength
     # rubocop:enable Metrics/ParameterLists
 
     private
 
-    # rubocop:disable Metrics/MethodLength
     # 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] })
       "
-      self.class.post(
-        "/#{version}/engines/#{engine}/search",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
-        },
-        body: { query: query }.merge(documents_or_file(documents: documents, file: file)).to_json
+
+      post(
+        url: "/#{version}/engines/#{engine}/search",
+        parameters: { query: query }.merge(documents_or_file(documents: documents, file: file))
       )
     end
-    # rubocop:enable Metrics/MethodLength
     # rubocop:enable Layout/LineLength
 
     def default_version
@@ -78,5 +56,16 @@ def default_version
     def documents_or_file(documents: nil, file: nil)
       documents ? { documents: documents } : { file: file }
     end
+
+    def post(url:, parameters:)
+      self.class.post(
+        url,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        },
+        body: parameters.to_json
+      )
+    end
   end
 end

lib/ruby/openai/files.rb

@@ -18,15 +18,15 @@ def list(version: default_version)
     end
 
     def upload(version: default_version, parameters: {})
-      file = validate(file: parameters[:file])
+      validate(file: parameters[:file])
 
       self.class.post(
         "/#{version}/files",
         headers: {
           "Content-Type" => "application/json",
           "Authorization" => "Bearer #{@access_token}"
         },
-        body: parameters.merge(file: file)
+        body: parameters.merge(file: File.open(parameters[:file]))
       )
     end
 

lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "1.2.2".freeze
+    VERSION = "1.3.0".freeze
   end
 end