ruby-openai 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73d5bf4fb81e5c4901998a20fcebc52a0f2c81edc12e7e8abac06a2171dd5c6e
-  data.tar.gz: 4775fd5959d4c5949cec0a02212a73ddc2b3af8cde3f1f9d996bcd3c71031c62
+  metadata.gz: 7fc83568b242ec1d301ebe76a0eeb5a22485f94cb287df47b92c1a46f47c193d
+  data.tar.gz: 2736973c009f727093c14960cb1468e00f3af357281ea8bba237d82da7d39ff4
 SHA512:
-  metadata.gz: 1a8d81ddbb8e2542f968549ef4014600c7cd6fff78404501a7d72d322d823651842e0b0f1aaf96238d5a2ea870eda7e626c53652e21aba105703b062c746487c
-  data.tar.gz: 3ff7ba70a3fc55b2e9e56144a221ac485e3d3c2854980a3b340aeffc4c0a544bed8a2506d7c71f387403482eb4c8565f4a6705dad582f47ea726593d4c82a135
+  metadata.gz: 8056501328713524128f12120f3d005f4d980d1d73cedb2f0994ac59cb2e5c52fc43ddc12519640ac2834eaa61c774888c5e59e31b8035ba22cc7f09ddbffc6f
+  data.tar.gz: be7f713a587469f977615f16f03161252c9a729f79ff9e73e1b09c365fb52266d3c4c329630f226a6f56fe2cc2fe7f5346e00d9503470095cf1b9922ba084218

data/.circleci/config.yml

@@ -42,3 +42,4 @@ workflows:
                 - cimg/ruby:2.7-node
                 - cimg/ruby:3.0-node
                 - cimg/ruby:3.1-node
+                - cimg/ruby:3.2-node

data/CHANGELOG.md

@@ -5,6 +5,29 @@ 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.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
+
+- Add ability to run the specs without VCR cassettes using `NO_VCR=true bundle exec rspec`.
+- Add Ruby 3.2 to CircleCI config - thanks [@petergoldstein](https://github.com/petergoldstein)!
+- A bit of detail added to the README on DALLE image sizes - thanks [@ndemianc](https://github.com/ndemianc)!
+
+### Fixed
+
+- Fix finetunes and files uploads endpoints - thanks [@chaadow](https://github.com/chaadow) for your PR on this and [@petergoldstein](https://github.com/petergoldstein) for the PR we ultimately went with.
+
 ## [3.0.2] - 2022-12-27
 
 ### Fixed

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.41.1"
+gem "rubocop", "~> 1.45.1"
 gem "vcr", "~> 6.1.0"
 gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    ruby-openai (3.0.2)
-      httparty (>= 0.18.1, < 0.21.0)
+    ruby-openai (3.1.0)
+      httparty (>= 0.18.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     byebug (11.1.3)
     crack (0.4.5)
@@ -16,21 +16,19 @@ GEM
     diff-lcs (1.5.0)
     dotenv (2.8.1)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     json (2.6.3)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
+    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 (4.0.7)
+    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)
@@ -38,27 +36,27 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.41.1)
+    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.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.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)
@@ -73,10 +71,10 @@ DEPENDENCIES
   dotenv (~> 2.8.1)
   rake (~> 13.0)
   rspec (~> 3.12)
-  rubocop (~> 1.41.1)
+  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,14 +134,14 @@ 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.delete(id: 123)
@@ -149,14 +149,7 @@ and pass the path to `client.files.upload` to upload it to OpenAI, and then inte
 
 ### 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,12 +193,19 @@ 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!
+Generate an image using DALL·E! The size of any generated images must be one of `256x256`, `512x512` or `1024x1024` -
+if not specified the image will default to `1024x1024`.
 
 ```ruby
-    response = client.images.generate(parameters: { prompt: "A baby sea otter cooking pasta wearing a hat of some sort" })
+    response = client.images.generate(parameters: { prompt: "A baby sea otter cooking pasta wearing a hat of some sort", size: "256x256" })
     puts response.dig("data", 0, "url")
     => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
 ```
@@ -249,9 +249,19 @@ Pass a string to check if it violates OpenAI's Content Policy:
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Release
+
+First run the specs without VCR so they actually hit the API. This will cost about 2 cents. You'll need to add your `OPENAI_ACCESS_TOKEN=` in `.env`.
+
+```
+  NO_VCR=true bundle exec rspec
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, update `CHANGELOG.md`, run `bundle install` to update Gemfile.lock, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Then update the version number in `version.rb`, update `CHANGELOG.md`, run `bundle install` to update Gemfile.lock, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/ruby/openai/client.rb

@@ -8,15 +8,15 @@ module OpenAI
     end
 
     def completions(parameters: {})
-      OpenAI::Client.post(path: "/completions", parameters: parameters)
+      OpenAI::Client.json_post(path: "/completions", parameters: parameters)
     end
 
     def edits(parameters: {})
-      OpenAI::Client.post(path: "/edits", parameters: parameters)
+      OpenAI::Client.json_post(path: "/edits", parameters: parameters)
     end
 
     def embeddings(parameters: {})
-      OpenAI::Client.post(path: "/embeddings", parameters: parameters)
+      OpenAI::Client.json_post(path: "/embeddings", parameters: parameters)
     end
 
     def files
@@ -36,7 +36,7 @@ module OpenAI
     end
 
     def moderations(parameters: {})
-      OpenAI::Client.post(path: "/moderations", parameters: parameters)
+      OpenAI::Client.json_post(path: "/moderations", parameters: parameters)
     end
 
     def self.get(path:)
@@ -46,11 +46,19 @@ module OpenAI
       )
     end
 
-    def self.post(path:, parameters: nil)
+    def self.json_post(path:, parameters:)
       HTTParty.post(
         uri(path: path),
         headers: headers,
-        body: parameters.to_json
+        body: parameters&.to_json
+      )
+    end
+
+    def self.multipart_post(path:, parameters: nil)
+      HTTParty.post(
+        uri(path: path),
+        headers: headers.merge({ "Content-Type" => "multipart/form-data" }),
+        body: parameters
       )
     end
 

data/lib/ruby/openai/files.rb

@@ -12,7 +12,7 @@ module OpenAI
     def upload(parameters: {})
       validate(file: parameters[:file])
 
-      OpenAI::Client.post(
+      OpenAI::Client.multipart_post(
         path: "/files",
         parameters: parameters.merge(file: File.open(parameters[:file]))
       )

data/lib/ruby/openai/finetunes.rb

@@ -10,7 +10,7 @@ module OpenAI
     end
 
     def create(parameters: {})
-      OpenAI::Client.post(path: "/fine-tunes", parameters: parameters)
+      OpenAI::Client.json_post(path: "/fine-tunes", parameters: parameters)
     end
 
     def retrieve(id:)
@@ -18,11 +18,19 @@ module OpenAI
     end
 
     def cancel(id:)
-      OpenAI::Client.post(path: "/fine-tunes/#{id}/cancel")
+      OpenAI::Client.multipart_post(path: "/fine-tunes/#{id}/cancel")
     end
 
     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/images.rb

@@ -6,15 +6,15 @@ module OpenAI
     end
 
     def generate(parameters: {})
-      OpenAI::Client.post(path: "/images/generations", parameters: parameters)
+      OpenAI::Client.json_post(path: "/images/generations", parameters: parameters)
     end
 
     def edit(parameters: {})
-      OpenAI::Client.post(path: "/images/edits", parameters: open_files(parameters))
+      OpenAI::Client.multipart_post(path: "/images/edits", parameters: open_files(parameters))
     end
 
     def variations(parameters: {})
-      OpenAI::Client.post(path: "/images/variations", parameters: open_files(parameters))
+      OpenAI::Client.multipart_post(path: "/images/variations", parameters: open_files(parameters))
     end
 
     private

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "3.0.2".freeze
+    VERSION = "3.1.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.21.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.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-27 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.21.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.21.0
 description: 
 email:
 - alexrudall@users.noreply.github.com
@@ -44,7 +38,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -87,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

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4