ruby-openai 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5927989b832799b3620dd5e1d93796d44fd3fe353d2edc2d64a4be2162bc6ff
-  data.tar.gz: 3313d8fa4ce08438fda80850736c96d73397f8f9d7baf72a365dea839c0cd876
+  metadata.gz: 141a4b28c980797b7b04fd8434e03755341fdfbc542e7ba2425b8d467662ef34
+  data.tar.gz: 934ed9a6b66897c370c8d5c8787d2508a95f55e695d312bab2c4227af5f820ca
 SHA512:
-  metadata.gz: 4604610b91ea93c5a8b08886700c656ca3651129542a6c257d5d000fc414f2a47e9ca8e8cadba622fb426a4e969fd0d058a83d857455893d172f3125852efd19
-  data.tar.gz: d8b959447a050615b4cdffd15cb7ac782b43b4d73953e6b0aa687bacf1f5872d4e9546547d4961fd0e1f5b07f40f460ae2cb136f717034e0a9199f4e5822946c
+  metadata.gz: f4bccb5f8b6ac3fc05ac592af972412a284dfb2aa4015657faa8358d7e00e060b508153413c8d8416e991886724e795a5c26125485ffec3181dcb2fd3d84e298
+  data.tar.gz: 7a2138265ae5235d870d6ddae69acf016132c71bef8b5781d5854c6ad970396d3b466b59cd14f82891b11d81b8833483ccf757f899be71cbb9f12f6608aaffd8

data/CHANGELOG.md

@@ -5,6 +5,19 @@ 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).
 
+## [2.1.0] - 2022-11-13
+
+### Added
+
+- Add Images#generate endpoint to generate images with DALL·E!
+
+## [2.0.1] - 2022-10-22
+
+### Removed
+
+- Deprecate Client#answers endpoint.
+- Deprecate Client#classifications endpoint.
+
 ## [2.0.0] - 2022-09-19
 
 ### Removed

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 gem "byebug", "~> 11.1.3"
 gem "rake", "~> 13.0"
-gem "rspec", "~> 3.11"
-gem "rubocop", "~> 1.36.0"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.38.0"
 gem "vcr", "~> 6.1.0"
 gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (2.0.0)
+    ruby-openai (2.1.0)
       dotenv (>= 2.7.6, < 2.9.0)
       httparty (>= 0.18.1, < 0.21.0)
 
@@ -31,32 +31,32 @@ GEM
     public_suffix (4.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.3.0)
@@ -72,8 +72,8 @@ PLATFORMS
 DEPENDENCIES
   byebug (~> 11.1.3)
   rake (~> 13.0)
-  rspec (~> 3.11)
-  rubocop (~> 1.36.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.38.0)
   ruby-openai!
   vcr (~> 6.1.0)
   webmock (~> 3.18.1)

data/README.md

@@ -59,6 +59,15 @@ Alternatively you can pass your key directly to a new client:
     client = OpenAI::Client.new(access_token: "access_token_goes_here")
 ```
 
+### Models
+
+There are different models that can be used to generate text. For a full list and to retrieve information about a single models:
+
+```ruby
+    client.models.list
+    client.models.retrieve(id: "text-ada-001")
+```
+
 #### Examples
 
 - [GPT-3](https://beta.openai.com/docs/models/gpt-3)
@@ -70,15 +79,6 @@ Alternatively you can pass your key directly to a new client:
   - code-davinci-002
   - code-cushman-001
 
-### Models
-
-There are different models that can be used to generate text. For a full list and to retrieve information about a single models:
-
-```ruby
-    client.models.list
-    client.models.retrieve(id: "text-ada-001")
-```
-
 ### Completions
 
 Hit the OpenAI API for a completion:
@@ -194,6 +194,18 @@ This fine-tuned model name can then be used in classifications:
     JSON.parse(response.body)["choices"].map { |c| c["text"] }
 ```
 
+### Images
+
+Generate an image using DALL·E!
+
+```ruby
+    response = client.images.generate(parameters: { prompt: "A baby sea otter cooking pasta wearing a hat of some sort" })
+    puts response.dig("data", 0, "url") }
+    => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+```
+
+![Otter Chef](https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhhQPMiIQ0Es8OwrH/user-jxM65ijkZc1qRfHC0IJ8mOIc/img-UrDvFC4tDnuhTieF7TrTJ2gq.png?st=2022-11-13T15%3A55%3A34Z&se=2022-11-13T17%3A55%3A34Z&sp=r&sv=2021-08-06&sr=b&rscd=inline&rsct=image/png&skoid=6aaadede-4fb3-4698-a8f6-684d7786b067&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2022-11-13T01%3A32%3A30Z&ske=2022-11-14T01%3A32%3A30Z&sks=b&skv=2021-08-06&sig=tLdggckHl20CnnpCleoeiAEQjy4zMjuZJiUdovmkoF0%3D)
+
 ### Moderations
 
 Pass a string to check if it violates OpenAI's Content Policy:
@@ -260,7 +272,7 @@ Or use the ID of a file you've uploaded:
 
 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.
 
-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`, 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).
+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).
 
 ## Contributing
 

data/lib/ruby/openai/client.rb

@@ -8,10 +8,18 @@ module OpenAI
     end
 
     def answers(version: default_version, parameters: {})
+      warn "[DEPRECATION WARNING] [ruby-openai] `Client#answers` is deprecated and will
+      be removed from the OpenAI API on 3 December 2022 and from ruby-openai v3.0.
+      More information: https://help.openai.com/en/articles/6233728-answers-transition-guide"
+
       post(url: "/#{version}/answers", parameters: parameters)
     end
 
     def classifications(version: default_version, parameters: {})
+      warn "[DEPRECATION WARNING] [ruby-openai] `Client#classifications` is deprecated and will
+      be removed from the OpenAI API on 3 December 2022 and from ruby-openai v3.0.
+      More information: https://help.openai.com/en/articles/6272941-classifications-transition-guide"
+
       post(url: "/#{version}/classifications", parameters: parameters)
     end
 
@@ -46,6 +54,10 @@ module OpenAI
       @finetunes ||= OpenAI::Finetunes.new(access_token: @access_token)
     end
 
+    def images
+      @images ||= OpenAI::Images.new(access_token: @access_token)
+    end
+
     def models
       @models ||= OpenAI::Models.new(access_token: @access_token)
     end

data/lib/ruby/openai/images.rb

@@ -0,0 +1,27 @@
+module OpenAI
+  class Images
+    include HTTParty
+    base_uri "https://api.openai.com"
+
+    def initialize(access_token: nil)
+      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
+    end
+
+    def generate(version: default_version, parameters: {})
+      self.class.post(
+        "/#{version}/images/generations",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        },
+        body: parameters.to_json
+      )
+    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 = "2.0.0".freeze
+    VERSION = "2.1.0".freeze
   end
 end

data/lib/ruby/openai.rb

@@ -2,6 +2,7 @@ require "httparty"
 require "ruby/openai/engines"
 require "ruby/openai/files"
 require "ruby/openai/finetunes"
+require "ruby/openai/images"
 require "ruby/openai/models"
 require "ruby/openai/client"
 require "ruby/openai/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2022-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -80,6 +80,7 @@ files:
 - lib/ruby/openai/engines.rb
 - lib/ruby/openai/files.rb
 - lib/ruby/openai/finetunes.rb
+- lib/ruby/openai/images.rb
 - lib/ruby/openai/models.rb
 - lib/ruby/openai/version.rb
 - pull_request_template.md