ruby-openai 3.0.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd89bdf882febca95eb2a6ca2d0d28afda7fa0d73a369ee61cb56038376247c
-  data.tar.gz: 5e9ee20773b1322dc940655ed3cbd040a667f27337f0a310bb6bbd9db8df2931
+  metadata.gz: 9e8ff1d30efd244fc448e8f473834796b8b02b627a5a4fc4edfdb79062119cfd
+  data.tar.gz: dfd511d71c4a8d351e298cb6759bc876467840c70d073b0835259d18a4e4aa6e
 SHA512:
-  metadata.gz: 40388adbfd46c7461f56d088dbc346206b1e44d27f32cfef766544dce0d76843723d10c4d050ed2564d8f940fc1daa0631084c412d10f75c7ee185f5cffbec43
-  data.tar.gz: a94573f8cfd2cd0a488746a1971e72a678d0761732c586c7d2d9ee4c74f7496d2a214d9c09b90371dc9cd86da6ddf64d58d91ff3bbb9c7eba70bb8f462e78e5c
+  metadata.gz: 6df6919af3e66c044d7309f6f7272078a12a2532702ced4175365b9ca618b7f6cac88e8aa7d84ed9884fea053d032505b9b1a3be8f7a39cb47c056e2e7a87849
+  data.tar.gz: 529f048e9a35a7169f688cc49bb78a68b5787919c716dcb8c4017357db3124ed637314c931578b05aeedc76c72045c8f3144682c32f2a3879188270cbe7eae8d

data/CHANGELOG.md

@@ -5,6 +5,23 @@ 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.2.0] - 2023-02-13
+
+### Added
+
+- Add Files#content endpoint - thanks [@unixneo](https://github.com/unixneo) for raising!
+
+## [3.1.0] - 2023-02-13
+
+### Added
+
+- Add Finetunes#delete endpoint - thanks [@lancecarlson](https://github.com/lancecarlson) for flagging this.
+- Add VCR header and body matching - thanks [@petergoldstein](https://github.com/petergoldstein)!
+
+### Fixed
+
+- Update File#upload specs to remove deprecated `answers` purpose.
+
 ## [3.0.3] - 2023-01-07
 
 ### Added

data/Gemfile

@@ -7,6 +7,6 @@ gem "byebug", "~> 11.1.3"
 gem "dotenv", "~> 2.8.1"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.12"
-gem "rubocop", "~> 1.42.0"
+gem "rubocop", "~> 1.45.1"
 gem "vcr", "~> 6.1.0"
 gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    ruby-openai (3.0.3)
-      httparty (>= 0.18.1, < 0.22.0)
+    ruby-openai (3.2.0)
+      httparty (>= 0.18.1)
 
 GEM
   remote: https://rubygems.org/
@@ -23,12 +23,12 @@ GEM
     mini_mime (1.1.2)
     multi_xml (0.6.0)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -36,27 +36,27 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.42.0)
+    rubocop (1.45.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     vcr (6.1.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
@@ -71,10 +71,10 @@ DEPENDENCIES
   dotenv (~> 2.8.1)
   rake (~> 13.0)
   rspec (~> 3.12)
-  rubocop (~> 1.42.0)
+  rubocop (~> 1.45.1)
   ruby-openai!
   vcr (~> 6.1.0)
   webmock (~> 3.18.1)
 
 BUNDLED WITH
-   2.2.20
+   2.4.5

data/README.md

@@ -134,29 +134,23 @@ You can use the embeddings endpoint to get a vector of numbers representing an i
 Put your data in a `.jsonl` file like this:
 
 ```json
-    {"text": "puppy A is happy", "metadata": "emotional state of puppy A"}
-    {"text": "puppy B is sad", "metadata": "emotional state of puppy B"}
+    {"prompt":"Overjoyed with my new phone! ->", "completion":" positive"}
+    {"prompt":"@lakers disappoint for a third straight night ->", "completion":" negative"}
 ```
 
 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/sentiment.jsonl", purpose: "fine-tune" })
     client.files.list
     client.files.retrieve(id: 123)
+    client.files.content(id: 123)
     client.files.delete(id: 123)
 ```
 
 ### Fine-tunes
 
-Put your fine-tuning data in a `.jsonl` file like this:
-
-```json
-    {"prompt":"Overjoyed with my new phone! ->", "completion":" positive"}
-    {"prompt":"@lakers disappoint for a third straight night ->", "completion":" negative"}
-```
-
-and pass the path to `client.files.upload` to upload it to OpenAI and get its ID:
+Upload your fine-tuning data in a `.jsonl` file as above and get its ID:
 
 ```ruby
     response = client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
@@ -200,6 +194,12 @@ This fine-tuned model name can then be used in completions:
     JSON.parse(response.body)["choices"].map { |c| c["text"] }
 ```
 
+You can delete the fine-tuned model when you are done with it:
+
+```ruby
+    client.finetunes.delete(fine_tuned_model: fine_tuned_model)
+```
+
 ### Image Generation
 
 Generate an image using DALL·E! The size of any generated images must be one of `256x256`, `512x512` or `1024x1024` -

data/lib/ruby/openai/files.rb

@@ -22,6 +22,10 @@ module OpenAI
       OpenAI::Client.get(path: "/files/#{id}")
     end
 
+    def content(id:)
+      OpenAI::Client.get(path: "/files/#{id}/content")
+    end
+
     def delete(id:)
       OpenAI::Client.delete(path: "/files/#{id}")
     end

data/lib/ruby/openai/finetunes.rb

@@ -24,5 +24,13 @@ module OpenAI
     def events(id:)
       OpenAI::Client.get(path: "/fine-tunes/#{id}/events")
     end
+
+    def delete(fine_tuned_model:)
+      if fine_tuned_model.start_with?("ft-")
+        raise ArgumentError, "Please give a fine_tuned_model name, not a fine-tune ID"
+      end
+
+      OpenAI::Client.delete(path: "/models/#{fine_tuned_model}")
+    end
   end
 end

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "3.0.3".freeze
+    VERSION = "3.2.0".freeze
   end
 end

data/ruby-openai.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", ">= 0.18.1", "< 0.22.0"
+  spec.add_dependency "httparty", ">= 0.18.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-07 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
 description: 
 email:
 - alexrudall@users.noreply.github.com
@@ -86,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for the OpenAI GPT-3 API