openai-client 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 374775f26834baae35b6799f23ebc4c1f82379292c7b67fb0529a85a3dbee23b
-  data.tar.gz: 00a67ee196ac3f0b6e52f377605c76273c968d3aec03a47820f75ed6955907eb
+  metadata.gz: 3fdb9832b6b6a5b14a1b14537ac74595fa1a85a689f84fc7f2411651812b6131
+  data.tar.gz: 57d4465e713d0ff02e7c5b97dcc32b3db7e96085b3850d00a4076eb2de8509ae
 SHA512:
-  metadata.gz: ddd4d92869f64c240c45924ea43b6b9acda29ec97f57c5e3f54d5b5602ec4b43e754247b53407758c20fa10abb54a8399324a59e85437d0869bd4f4e6c448a36
-  data.tar.gz: 24ec9056e95a781ed5d0f6c18c205738a375b3fb990168f41f6a1be6fec34769772403fff93d531b900d67be217a0acc6c6ff84737ef54a47dd4f23956c84354
+  metadata.gz: 78fb79a3c56a1ad02ac6574f619dc8c5492b30d167478b5678730768e40b1c91adccebebceb238440a51915337d331472de8de9b711133d4276fd49066a33123
+  data.tar.gz: bd23759e786d446ed0e14ad63b7db1e4b438f5b7291cb68ec97b38928e00e3be38e73664909f3c6837c0b7391154f317ef45b23e95628cef5fe35fc97c955742

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openai-client (0.3.0)
+    openai-client (0.4.1)
       faraday (~> 1.8)
       faraday_middleware (~> 1.2)
 

data/README.md

@@ -1,23 +1,43 @@
 # Openai::Client
+
 This gem is a wrapper for calling the OpenAI and GPT-3 APIs.
 
+* [Installation](#installation)
+* [Usage](#usage)
+* [OpenAI Models API](#openai-models-api)
+* [OpenAI Completions API](#openai-completions-api)
+* [OpenAI Edits API](#openai-edits-api)
+* [OpenAI Image API](#openai-image-api)
+  * [Create an Image](#create-an-image)
+  * [Create an Image Edit](#create-an-image-edit)
+  * [Create an Image Variation](#create-an-image-variation)
+
+
+
 ## Installation
+
 Add this line to your application's Gemfile:
+
 ```ruby
 gem 'openai-client'
 ```
+
 And then execute:
+
 ```bash
 bundle
 ```
+
 Or install it yourself as:
+
 ```bash
 gem install openai-client
 ```
 
 ## Usage
-- API key (`access_token`) https://beta.openai.com/account/api-keys.
-- Organization ID (if needed) https://beta.openai.com/account/org-settings.
+
+- API key (`access_token`) <https://beta.openai.com/account/api-keys>.
+- Organization ID (if needed) <https://beta.openai.com/account/org-settings>.
 
 ```ruby
 require 'openai-client'
@@ -29,6 +49,7 @@ end
 ```
 
 ## OpenAI Models API
+
 ```ruby
 # Models
 Openai::Client.models.list
@@ -36,7 +57,9 @@ Openai::Client.models.list
 # Find a Model
 Openai::Client.models.find(model_id)
 ```
+
 ## OpenAI Completions API
+
 ```ruby
 request_body = {
   model: 'text-davinci-003',
@@ -51,9 +74,11 @@ request_body = {
 }
 Openai::Client.completions.create(request_body)
 ```
-[Completions request body documentation](https://platform.openai.com/docs/api-reference/completions/create)
+
+[Request body documentation](https://platform.openai.com/docs/api-reference/completions/create)
 
 ## OpenAI Edits API
+
 ```ruby
 request_body = {
   model: 'text-davinci-edit-001',
@@ -62,10 +87,64 @@ request_body = {
 }
 Openai::Client.edits.create(request_body)
 ```
-[Edits request body documentation](https://platform.openai.com/docs/api-reference/edits/create)
+
+[Request body documentation](https://platform.openai.com/docs/api-reference/edits/create)
+
+## OpenAI Image API
+
+### Create an Image
+
+```ruby
+request_body = {
+  prompt: 'A cute baby sea otter',
+  n: 1,                  # between 1 and 10
+  size: '1024x1024',     # 256x256, 512x512, or 1024x1024
+  response_format: 'url' # url or b64_json
+}
+response = Openai::Client.images.create(request_body)
+```
+
+[Request body documentation](https://platform.openai.com/docs/api-reference/images/create)
+
+### Create an Image Edit
+
+```ruby
+request_body = {
+  image: '/absolute/path/to/image/you/want/to/change/img.png'
+  mask: '/absolute/path/to/mask.png'
+  prompt: 'A cute baby sea otter wearing a beret',
+  n: 1,                  # between 1 and 10
+  size: '1024x1024',     # 256x256, 512x512, or 1024x1024
+  response_format: 'url' # url or b64_json
+}
+response = Openai::Client.images.edit(request_body)
+```
+
+- `image` - must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.
+- `mask` - an additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.
+
+[Request body documentation](https://platform.openai.com/docs/api-reference/images/create-edit)
+
+### Create an Image Variation
+
+```ruby
+request_body = {
+  image: '/absolute/path/to/image.png'
+  n: 1,                  # between 1 and 10
+  size: '1024x1024',     # 256x256, 512x512, or 1024x1024
+  response_format: 'url' # url or b64_json
+}
+response = Openai::Client.images.variations(request_body)
+```
+
+- `image` - must be a valid PNG file, less than 4MB, and square.
+
+[Request body documentation](https://platform.openai.com/docs/api-reference/images/create-variation)
 
 ## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/itikhonenko/openai-client.
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/itikhonenko/openai-client>.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/openai/client/completions.rb

@@ -13,7 +13,7 @@ module Openai
       # @return [Hash] a hash with a completion
       def create(body)
         Http.new.post(PATH, body).body
-      rescue StandardError
+      rescue Faraday::Error
         nil
       end
     end

data/lib/openai/client/edits.rb

@@ -13,7 +13,7 @@ module Openai
       # @return [Hash] a hash with edit
       def create(body)
         Http.new.post(PATH, body).body
-      rescue StandardError
+      rescue Faraday::Error
         nil
       end
     end

data/lib/openai/client/http.rb

@@ -8,6 +8,7 @@ module Openai
           conn.response :json
           conn.response :raise_error
           conn.request :json
+          conn.request :multipart
         end
         @logger = Openai::Client.configuration.logger
       end
@@ -42,6 +43,24 @@ module Openai
         log_error(e) && raise
       end
 
+      # @api public
+      # Public: Makes a multipart request using the Faraday HTTP Client.
+      #
+      # @param [String] path API path
+      # @param [Hash] body request body
+      #
+      # @raise [Faraday::Error] on failure API call
+      #
+      # @return [Faraday::Response] instance of Faraday::Response class
+      def multipart_post(path, body = {})
+        connection.post(path, body) do |request|
+          request.headers['Content-Type'] = 'multipart/form-data'
+          request.options.timeout = 300
+        end
+      rescue Faraday::Error => e
+        log_error(e) && raise
+      end
+
       private
 
       attr_reader :connection, :logger

data/lib/openai/client/images.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Images
+      CREATE_PATH    = 'images/generations'
+      EDIT_PATH      = 'images/edits'
+      VARIATION_PATH = 'images/variations'
+
+      # @api public
+      # Public: Makes an API call to create an image given a prompt.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] an image
+      def create(body)
+        Http.new.post(CREATE_PATH, body).body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to create an edited or extended image given an original image and a prompt.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] an edited or extended image
+      def edit(body)
+        Http.new.multipart_post(EDIT_PATH, upload_io(body, %i[image mask])).body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to creates a variation of a given image.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] a variation of a given image
+      def variations(body)
+        Http.new.multipart_post(VARIATION_PATH, upload_io(body, %i[image])).body
+      rescue Faraday::Error
+        nil
+      end
+
+      private
+
+      # @api private
+      # Internal: Creates the open IO object for the uploaded file.
+      #
+      # @param [Hash] data request body
+      # @param [Array] param_names parameter names
+      #
+      # @return [Hash] request body
+      def upload_io(data, param_names)
+        param_names.each do |param|
+          data[param] = Faraday::FilePart.new(data[param], 'rb') if data[param]
+        end
+        data
+      end
+    end
+  end
+end

data/lib/openai/client/models.rb

@@ -11,7 +11,7 @@ module Openai
       # @return [Hash] a hash with models
       def list
         Http.new.get(PATH).body
-      rescue StandardError
+      rescue Faraday::Error
         nil
       end
 
@@ -23,7 +23,7 @@ module Openai
       # @return [Hash] found model or nil
       def find(id)
         Http.new.get("#{PATH}/#{id}").body
-      rescue StandardError
+      rescue Faraday::Error
         nil
       end
     end

data/lib/openai/client/version.rb

@@ -2,6 +2,6 @@
 
 module Openai
   module Client
-    VERSION = '0.3.0'
+    VERSION = '0.4.1'
   end
 end

data/lib/openai/client.rb

@@ -11,12 +11,13 @@ require 'openai/client/http'
 require 'openai/client/models'
 require 'openai/client/edits'
 require 'openai/client/completions'
+require 'openai/client/images'
 
 module Openai
   module Client
     extend Configurable
 
-    ATTRS = ['models', 'edits', 'completions'].freeze
+    ATTRS = ['models', 'edits', 'completions', 'images'].freeze
 
     class << self
       ATTRS.each do |attr|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ihor Tykhonenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,6 +59,7 @@ files:
 - lib/openai/client/configuration.rb
 - lib/openai/client/edits.rb
 - lib/openai/client/http.rb
+- lib/openai/client/images.rb
 - lib/openai/client/models.rb
 - lib/openai/client/version.rb
 - sig/openai/client.rbs