Merge pull request alexrudall#119 from alexrudall/dalle

Add DALL·E Images#generate endpoint!

CHANGELOG.md

@@ -5,6 +5,12 @@ 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

README.md

@@ -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:

lib/ruby/openai.rb

@@ -2,6 +2,7 @@
 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"

lib/ruby/openai/client.rb

@@ -54,6 +54,10 @@ def finetunes
  @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

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

lib/ruby/openai/version.rb

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

spec/ruby/openai/client/images_spec.rb

@@ -0,0 +1,24 @@
+RSpec.describe OpenAI::Client do
+ describe "#images" do
+ describe "#generate", :vcr do
+ let(:response) do
+ OpenAI::Client.new.images.generate(
+ parameters: {
+ prompt: prompt,
+ size: size
+ }
+ )
+ end
+ let(:cassette) { "images generate #{prompt}" }
+ let(:prompt) { "A baby sea otter cooking pasta wearing a hat of some sort" }
+ let(:size) { "256x256" }
+
+ it "succeeds" do
+ VCR.use_cassette(cassette) do
+ r = JSON.parse(response.body)
+ expect(r.dig("data", 0, "url")).to include("dalle")
+ end
+ end
+ end
+ end
+end