ruby-openai 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 141a4b28c980797b7b04fd8434e03755341fdfbc542e7ba2425b8d467662ef34
-  data.tar.gz: 934ed9a6b66897c370c8d5c8787d2508a95f55e695d312bab2c4227af5f820ca
+  metadata.gz: e9f91687f2b4e37ef74018f8454392416afbe43ad08f5f8d671a1a9dc8feba82
+  data.tar.gz: 902a8bbd495d8ee56800f695aa3a264a8ded26475c11874040871b4765c8dacf
 SHA512:
-  metadata.gz: f4bccb5f8b6ac3fc05ac592af972412a284dfb2aa4015657faa8358d7e00e060b508153413c8d8416e991886724e795a5c26125485ffec3181dcb2fd3d84e298
-  data.tar.gz: 7a2138265ae5235d870d6ddae69acf016132c71bef8b5781d5854c6ad970396d3b466b59cd14f82891b11d81b8833483ccf757f899be71cbb9f12f6608aaffd8
+  metadata.gz: 5b631c7f78b6de8d7c20acc61e4fc22eca4f372e488ba55e10267cedfd91c9b340334c69403fd28a26c71cfaa52678e7ea9c8410121139e9069abdadf5f37cf8
+  data.tar.gz: 40cb9e2f2848a954e5f786979d207a08b698ef6c5fb787afd564cd7945e5e758555ec2d99967a507bd2ae05b63ee8a7b518a197d8b2b6d39b19839c4398caf48

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.3.0] - 2022-12-23
+
+### Added
+
+- Add Images#edit and Images#variations endpoint to modify images with DALL·E.
+
+## [2.2.0] - 2022-12-15
+
+### Added
+
+- Add Organization ID to headers so users can charge credits to the correct organization.
+- Thanks [@mridul911](https://github.com/mridul911) for raising this and [@maks112v](https://github.com/maks112v) for adding it!
+
 ## [2.1.0] - 2022-11-13
 
 ### Added

data/Gemfile

@@ -6,6 +6,6 @@ gemspec
 gem "byebug", "~> 11.1.3"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.12"
-gem "rubocop", "~> 1.38.0"
+gem "rubocop", "~> 1.41.1"
 gem "vcr", "~> 6.1.0"
 gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (2.1.0)
+    ruby-openai (2.3.0)
       dotenv (>= 2.7.6, < 2.9.0)
       httparty (>= 0.18.1, < 0.21.0)
 
@@ -20,18 +20,18 @@ GEM
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    json (2.6.2)
+    json (2.6.3)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
     public_suffix (4.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -46,7 +46,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.38.0)
+    rubocop (1.41.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -56,7 +56,7 @@ GEM
       rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.3.0)
@@ -73,7 +73,7 @@ DEPENDENCIES
   byebug (~> 11.1.3)
   rake (~> 13.0)
   rspec (~> 3.12)
-  rubocop (~> 1.38.0)
+  rubocop (~> 1.41.1)
   ruby-openai!
   vcr (~> 6.1.0)
   webmock (~> 3.18.1)

data/README.md

@@ -5,7 +5,9 @@
 [![CircleCI Build Status](https://circleci.com/gh/alexrudall/ruby-openai.svg?style=shield)](https://circleci.com/gh/alexrudall/ruby-openai)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/codeclimate/codeclimate/maintainability)
 
-Use the [OpenAI GPT-3 API](https://openai.com/blog/openai-api/) with Ruby! 🤖❤️
+Use the [OpenAI API](https://openai.com/blog/openai-api/) with Ruby! 🤖❤️
+
+Generate text with GPT-3, create images with DALL·E, or write code with Codex...
 
 ## Installation
 
@@ -35,14 +37,16 @@ and require with:
 
 ## Usage
 
-Get your API key from [https://beta.openai.com/account/api-keys](https://beta.openai.com/account/api-keys)
+- Get your API key from [https://beta.openai.com/account/api-keys](https://beta.openai.com/account/api-keys)
+- If you belong to multiple organizations, you can get your Organization ID from [https://beta.openai.com/account/org-settings](https://beta.openai.com/account/org-settings)
 
 ### With dotenv
 
-If you're using [dotenv](https://github.com/motdotla/dotenv), you can add your secret key to your .env file:
+If you're using [dotenv](https://github.com/motdotla/dotenv), you can add your secret keys to your .env file:
 
 ```
     OPENAI_ACCESS_TOKEN=access_token_goes_here
+    OPENAI_ORGANIZATION_ID=organization_id_goes_here # Optional.
 ```
 
 And create a client:
@@ -56,7 +60,10 @@ And create a client:
 Alternatively you can pass your key directly to a new client:
 
 ```ruby
-    client = OpenAI::Client.new(access_token: "access_token_goes_here")
+    client = OpenAI::Client.new(
+        access_token: "access_token_goes_here",
+        organization_id: "organization_id_goes_here"
+    )
 ```
 
 ### Models
@@ -194,17 +201,42 @@ This fine-tuned model name can then be used in classifications:
     JSON.parse(response.body)["choices"].map { |c| c["text"] }
 ```
 
-### Images
+### Image Generation
 
 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") }
+    puts response.dig("data", 0, "url")
+    => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+```
+
+![Ruby](https://i.ibb.co/6y4HJFx/img-d-Tx-Rf-RHj-SO5-Gho-Cbd8o-LJvw3.png)
+
+### Image Edit
+
+Fill in the transparent part of an image, or upload a mask with transparent sections to indicate the parts of an image that can be changed according to your prompt...
+
+```ruby
+    response = client.images.edit(parameters: { prompt: "A solid red Ruby on a blue background", image: "image.png", mask: "mask.png" })
+    puts response.dig("data", 0, "url")
+    => "https://oaidalleapiprodscus.blob.core.windows.net/private/org-Rf437IxKhh..."
+```
+
+![Ruby](https://i.ibb.co/sWVh3BX/dalle-ruby.png)
+
+### Image Variations
+
+Create n variations of an image.
+
+```ruby
+    response = client.images.variations(parameters: { image: "image.png", n: 2 })
+    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)
+![Ruby](https://i.ibb.co/TWJLP2y/img-miu-Wk-Nl0-QNy-Xtj-Lerc3c0l-NW.png)
+![Ruby](https://i.ibb.co/ScBhDGB/img-a9-Be-Rz-Au-Xwd-AV0-ERLUTSTGdi.png)
 
 ### Moderations
 
@@ -276,7 +308,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
+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).
 
 ## License
 

data/lib/ruby/openai/client.rb

@@ -3,8 +3,9 @@ module OpenAI
     include HTTParty
     base_uri "https://api.openai.com"
 
-    def initialize(access_token: nil)
+    def initialize(access_token: nil, organization_id: nil)
       @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
+      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
     end
 
     def answers(version: default_version, parameters: {})
@@ -43,23 +44,25 @@ module OpenAI
       warn "[DEPRECATION WARNING] [ruby-openai] `Client#engines` is deprecated and will
       be removed from ruby-openai v3.0. Use `Client#models` instead."
 
-      @engines ||= OpenAI::Engines.new(access_token: @access_token)
+      @engines ||= OpenAI::Engines.new(access_token: @access_token,
+                                       organization_id: @organization_id)
     end
 
     def files
-      @files ||= OpenAI::Files.new(access_token: @access_token)
+      @files ||= OpenAI::Files.new(access_token: @access_token, organization_id: @organization_id)
     end
 
     def finetunes
-      @finetunes ||= OpenAI::Finetunes.new(access_token: @access_token)
+      @finetunes ||= OpenAI::Finetunes.new(access_token: @access_token,
+                                           organization_id: @organization_id)
     end
 
     def images
-      @images ||= OpenAI::Images.new(access_token: @access_token)
+      @images ||= OpenAI::Images.new(access_token: @access_token, organization_id: @organization_id)
     end
 
     def models
-      @models ||= OpenAI::Models.new(access_token: @access_token)
+      @models ||= OpenAI::Models.new(access_token: @access_token, organization_id: @organization_id)
     end
 
     def moderations(version: default_version, parameters: {})
@@ -101,7 +104,8 @@ module OpenAI
         url,
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         },
         body: parameters.to_json
       )

data/lib/ruby/openai/engines.rb

@@ -3,8 +3,9 @@ module OpenAI
     include HTTParty
     base_uri "https://api.openai.com"
 
-    def initialize(access_token: nil)
+    def initialize(access_token: nil, organization_id: nil)
       @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
+      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
     end
 
     def list(version: default_version)
@@ -12,7 +13,8 @@ module OpenAI
         "/#{version}/engines",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end
@@ -22,7 +24,8 @@ module OpenAI
         "/#{version}/engines/#{id}",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end

data/lib/ruby/openai/files.rb

@@ -3,8 +3,9 @@ module OpenAI
     include HTTParty
     base_uri "https://api.openai.com"
 
-    def initialize(access_token: nil)
+    def initialize(access_token: nil, organization_id: nil)
       @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
+      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
     end
 
     def list(version: default_version)
@@ -12,7 +13,8 @@ module OpenAI
         "/#{version}/files",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end
@@ -24,7 +26,8 @@ module OpenAI
         "/#{version}/files",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         },
         body: parameters.merge(file: File.open(parameters[:file]))
       )
@@ -35,7 +38,8 @@ module OpenAI
         "/#{version}/files/#{id}",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end
@@ -45,7 +49,8 @@ module OpenAI
         "/#{version}/files/#{id}",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end

data/lib/ruby/openai/finetunes.rb

@@ -3,8 +3,9 @@ module OpenAI
     include HTTParty
     base_uri "https://api.openai.com"
 
-    def initialize(access_token: nil)
+    def initialize(access_token: nil, organization_id: nil)
       @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
+      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
     end
 
     def list(version: default_version)
@@ -12,7 +13,8 @@ module OpenAI
         "/#{version}/fine-tunes",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end
@@ -22,7 +24,8 @@ module OpenAI
         "/#{version}/fine-tunes",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         },
         body: parameters.to_json
       )
@@ -33,7 +36,8 @@ module OpenAI
         "/#{version}/fine-tunes/#{id}",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end
@@ -43,7 +47,8 @@ module OpenAI
         "/#{version}/fine-tunes/#{id}/cancel",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end
@@ -53,7 +58,8 @@ module OpenAI
         "/#{version}/fine-tunes/#{id}/events",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end

data/lib/ruby/openai/images.rb

@@ -3,8 +3,9 @@ module OpenAI
     include HTTParty
     base_uri "https://api.openai.com"
 
-    def initialize(access_token: nil)
+    def initialize(access_token: nil, organization_id: nil)
       @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
+      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
     end
 
     def generate(version: default_version, parameters: {})
@@ -12,16 +13,51 @@ module OpenAI
         "/#{version}/images/generations",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         },
         body: parameters.to_json
       )
     end
 
+    def edit(version: default_version, parameters: {})
+      parameters = open_files(parameters)
+
+      self.class.post(
+        "/#{version}/images/edits",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
+        },
+        body: parameters
+      )
+    end
+
+    def variations(version: default_version, parameters: {})
+      parameters = open_files(parameters)
+
+      self.class.post(
+        "/#{version}/images/variations",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
+        },
+        body: parameters
+      )
+    end
+
     private
 
     def default_version
       "v1".freeze
     end
+
+    def open_files(parameters)
+      parameters = parameters.merge(image: File.open(parameters[:image]))
+      parameters = parameters.merge(mask: File.open(parameters[:mask])) if parameters[:mask]
+      parameters
+    end
   end
 end

data/lib/ruby/openai/models.rb

@@ -3,8 +3,9 @@ module OpenAI
     include HTTParty
     base_uri "https://api.openai.com"
 
-    def initialize(access_token: nil)
+    def initialize(access_token: nil, organization_id: nil)
       @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
+      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
     end
 
     def list(version: default_version)
@@ -12,7 +13,8 @@ module OpenAI
         "/#{version}/models",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end
@@ -22,7 +24,8 @@ module OpenAI
         "/#{version}/models/#{id}",
         headers: {
           "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
+          "Authorization" => "Bearer #{@access_token}",
+          "OpenAI-Organization" => @organization_id
         }
       )
     end

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "2.1.0".freeze
+    VERSION = "2.3.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv