Merge pull request #35 from alexrudall/add_new_endpoints

Add file upload

Author: alexrudall

.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.7
-
   NewCops: enable
+  SuggestExtensions: false
 
 Style/Documentation:
   # Skips checking to make sure top level modules / classes have a comment.

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).
 
+## [1.1.0] - 2021-04-07
+
+### Added
+
+- Add Client#files to allow file upload.
+- Add Client#search(file:) so you can search a file.
+
 ## [1.0.0] - 2021-02-01
 
 ### Removed

Gemfile.lock

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

README.md

@@ -58,6 +58,24 @@ The engine options are currently "ada", "babbage", "curie" and "davinci". Hit th
     => [", there lived a great"]
 ```
 
+### Files
+
+Put your data in a `.jsonl` file like this:
+
+```
+    {"text": "puppy A is happy", "metadata": "emotional state of puppy A"}
+    {"text": "puppy B is sad", "metadata": "emotional state of puppy B"}
+```
+
+and pass the path to `client.files.upload` to upload it to OpenAI, and then interact with it:
+
+```
+    client.files.upload(parameters: { file: 'path/to/puppy.jsonl', purpose: 'search' })
+    client.files.list
+    client.files.retrieve(id: 123)
+    client.files.delete(id: 123)
+```
+
 ### Search
 
 Pass documents and a query string to get semantic search scores against each document:
@@ -68,6 +86,12 @@ Pass documents and a query string to get semantic search scores against each doc
     => [202.0, 48.052, 19.247]
 ```
 
+You can alternatively search using the ID of a file you've uploaded:
+
+```
+    client.search(engine: "ada", file: "abc123", query: "happy")
+```
+
 ## 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,4 +1,5 @@
 require "httparty"
+require "ruby/openai/files"
 require "ruby/openai/client"
 require "ruby/openai/version"
 require "dotenv/load"

lib/ruby/openai/client.rb

@@ -18,16 +18,18 @@ def completions(engine:, version: default_version, parameters: {})
       )
     end
 
-    def search(engine:, documents:, query:, version: default_version)
+    def files
+      @files ||= OpenAI::Files.new(access_token: @access_token)
+    end
+
+    def search(engine:, query:, documents: nil, file: nil, version: default_version)
       self.class.post(
         "/#{version}/engines/#{engine}/search",
         headers: {
           "Content-Type" => "application/json",
           "Authorization" => "Bearer #{@access_token}"
         },
-        body: {
-          documents: documents, query: query
-        }.to_json
+        body: { query: query }.merge(documents_or_file(documents: documents, file: file)).to_json
       )
     end
 
@@ -36,5 +38,9 @@ def search(engine:, documents:, query:, version: default_version)
     def default_version
       "v1".freeze
     end
+
+    def documents_or_file(documents: nil, file: nil)
+      documents ? { documents: documents } : { file: file }
+    end
   end
 end

lib/ruby/openai/files.rb

@@ -0,0 +1,57 @@
+module OpenAI
+  class Files
+    include HTTParty
+    base_uri "https://api.openai.com"
+
+    def initialize(access_token: nil)
+      @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
+    end
+
+    def list(version: default_version)
+      self.class.get(
+        "/#{version}/files",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def upload(version: default_version, parameters: {})
+      self.class.post(
+        "/#{version}/files",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        },
+        body: parameters.merge(file: File.open(parameters[:file]))
+      )
+    end
+
+    def retrieve(id:, version: default_version)
+      self.class.get(
+        "/#{version}/files/#{id}",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def delete(id:, version: default_version)
+      self.class.delete(
+        "/#{version}/files/#{id}",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    private
+
+    def default_version
+      "v1".freeze
+    end
+  end
+end

lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.0".freeze
   end
 end

pull_request_template.md

@@ -1,7 +1,5 @@
 ## All Submissions:
 
-* [ ] Have you followed the guidelines in our [Contributing document](../../blob/main/CONTRIBUTING.md)?
-* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
-* [ ] Do the tests pass? (`rake spec`)
-* [ ] Does Rubocop pass? (`rubocop`)
+* [ ] Have you followed the guidelines in our [Contributing document](../blob/main/CONTRIBUTING.md)?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
 * [ ] Have you added an explanation of what your changes do and why you'd like us to include them?