ruby-openai 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f49ef2d01087a09b453513bf5b4d19fa76ac1e650a96234be40cfe88ca70141
-  data.tar.gz: aa28c65f90677820fbc035c5f1dfaa885fdeb7ab5f613da746566f4a27194df5
+  metadata.gz: 9fb70b90b84ff4b23bf8e9ed757ae39b82adf291e5bdcb07b8f0ef5ccbe12394
+  data.tar.gz: 5391b9437fd05d7da1783e5ac960b216a7ad326f22a509ad28a21eb879bdf4a8
 SHA512:
-  metadata.gz: 8575de950acf0ad5c6439f59bd8718cd4ffdade7527ad8f5177ea95a35821bdf7d7f9535a105183dadb357f6ba322a14ba43bbbbae49dd4f782c646f9ced8a4d
-  data.tar.gz: 3f09519f5d3c364d03f9d4bb18269fe63e2670566884b099bf1c9862126c8fc10fcf30ac1774c699f8fc7c0f7fb1c57d5f677434e825421f76a5b9c6e0be13ed
+  metadata.gz: 5cbf287bf8bfc9e1b949bc050ea456d62c5259a5316710db7a617126a7a3b018707c78c03d508a5619ac024a5767865f7e98925e5c6e867dc8cb1f3687e3b9c6
+  data.tar.gz: a45ed235da6d261371ae6f1b26ae45ea2f28dd9ca3f9b362b66045d851666ea1b72e89c0253d64830183c6bae6c3c8093f7c586c65aed940b5b3003d9b652399

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

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).
 
+## [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

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexrudall/ruby-openai. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -6,6 +6,6 @@ gemspec
 gem "byebug", "~> 11.1.3"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.10"
-gem "rubocop", "~> 1.9.0"
+gem "rubocop", "~> 1.12.1"
 gem "vcr", "~> 6.0.0"
-gem "webmock", "~> 3.11.2"
+gem "webmock", "~> 3.12.2"

data/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)
 
@@ -30,7 +30,7 @@ GEM
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -45,7 +45,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.9.0)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -59,7 +59,7 @@ GEM
     ruby-progressbar (1.11.0)
     unicode-display_width (2.0.0)
     vcr (6.0.0)
-    webmock (3.11.2)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -71,10 +71,10 @@ DEPENDENCIES
   byebug (~> 11.1.3)
   rake (~> 13.0)
   rspec (~> 3.10)
-  rubocop (~> 1.9.0)
+  rubocop (~> 1.12.1)
   ruby-openai!
   vcr (~> 6.0.0)
-  webmock (~> 3.11.2)
+  webmock (~> 3.12.2)
 
 BUNDLED WITH
    2.2.3

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

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

data/lib/ruby/openai/client.rb

@@ -18,16 +18,18 @@ module OpenAI
       )
     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 @@ module OpenAI
     def default_version
       "v1".freeze
     end
+
+    def documents_or_file(documents: nil, file: nil)
+      documents ? { documents: documents } : { file: file }
+    end
   end
 end

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

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

data/pull_request_template.md

@@ -0,0 +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?
+* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -54,6 +54,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -63,7 +64,9 @@ files:
 - bin/setup
 - lib/ruby/openai.rb
 - lib/ruby/openai/client.rb
+- lib/ruby/openai/files.rb
 - lib/ruby/openai/version.rb
+- pull_request_template.md
 - ruby-openai.gemspec
 homepage: https://github.com/alexrudall/ruby-openai
 licenses: