openai-client 0.4.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fdb9832b6b6a5b14a1b14537ac74595fa1a85a689f84fc7f2411651812b6131
-  data.tar.gz: 57d4465e713d0ff02e7c5b97dcc32b3db7e96085b3850d00a4076eb2de8509ae
+  metadata.gz: fa13b10a22961929472de3fc7cb1ebedc43c5d46d2e1b221d3e7ac39293af99e
+  data.tar.gz: d848b51aa150fe3b33f755cd774f8e959550bfeef82daf475976756fe0b3a12a
 SHA512:
-  metadata.gz: 78fb79a3c56a1ad02ac6574f619dc8c5492b30d167478b5678730768e40b1c91adccebebceb238440a51915337d331472de8de9b711133d4276fd49066a33123
-  data.tar.gz: bd23759e786d446ed0e14ad63b7db1e4b438f5b7291cb68ec97b38928e00e3be38e73664909f3c6837c0b7391154f317ef45b23e95628cef5fe35fc97c955742
+  metadata.gz: 30b8d9843d40343ba72e06450c7262238a2d2d67bfffe6d59c55c61e4d20535985c513bc8b692bab193b5df3e2427b82ede2f441e50834d3fb15bf5f61d2d272
+  data.tar.gz: '0817ca7dce3899b5e43a5a87fad228c370051475ccd41c475d5c5e32560cfa3cfca318006f59a8fb611be722cf08c76a82cb8184407c53d2e92999e6d38bed47'

data/Gemfile.lock

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

data/README.md

@@ -11,8 +11,14 @@ This gem is a wrapper for calling the OpenAI and GPT-3 APIs.
   * [Create an Image](#create-an-image)
   * [Create an Image Edit](#create-an-image-edit)
   * [Create an Image Variation](#create-an-image-variation)
-
-
+* [OpenAI Embeddings API](#openai-embeddings-api)
+* [OpenAI Moderations API](#openai-moderations-api)
+* [OpenAI Files API](#openai-files-api)
+  * [List Files](#list-files)
+  * [Find File](#find-file)
+  * [Find File Content](#find-file-content)
+  * [Upload File](#upload-file)
+  * [Delete File](#delete-file)
 
 ## Installation
 
@@ -75,7 +81,7 @@ request_body = {
 Openai::Client.completions.create(request_body)
 ```
 
-[Request body documentation](https://platform.openai.com/docs/api-reference/completions/create)
+[API documentation](https://platform.openai.com/docs/api-reference/completions/create)
 
 ## OpenAI Edits API
 
@@ -88,7 +94,7 @@ request_body = {
 Openai::Client.edits.create(request_body)
 ```
 
-[Request body documentation](https://platform.openai.com/docs/api-reference/edits/create)
+[API documentation](https://platform.openai.com/docs/api-reference/edits/create)
 
 ## OpenAI Image API
 
@@ -104,7 +110,7 @@ request_body = {
 response = Openai::Client.images.create(request_body)
 ```
 
-[Request body documentation](https://platform.openai.com/docs/api-reference/images/create)
+[API documentation](https://platform.openai.com/docs/api-reference/images/create)
 
 ### Create an Image Edit
 
@@ -123,7 +129,7 @@ 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)
+[API documentation](https://platform.openai.com/docs/api-reference/images/create-edit)
 
 ### Create an Image Variation
 
@@ -139,7 +145,86 @@ 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)
+[API documentation](https://platform.openai.com/docs/api-reference/images/create-variation)
+
+## OpenAI Embeddings API
+
+```ruby
+request_body = {
+  model: 'text-embedding-ada-002',
+  input: 'The food was delicious and the waiter...'
+}
+Openai::Client.embeddings.create(request_body)
+```
+
+[API documentation](https://platform.openai.com/docs/api-reference/embeddings/create)
+
+## OpenAI Moderations API
+
+```ruby
+request_body = {
+  model: 'text-moderation-latest', # text-moderation-stable or text-moderation-latest
+  input: 'I want to kill them.'
+}
+Openai::Client.moderations.create(request_body)
+```
+
+[API documentation](https://platform.openai.com/docs/api-reference/moderations/create)
+
+## OpenAI Files API
+
+### List Files
+
+```ruby
+Openai::Client.files.list
+```
+
+[API documentation](https://platform.openai.com/docs/api-reference/files/list)
+
+### Find File
+
+```ruby
+Openai::Client.files.find(file_id)
+```
+
+[API documentation](https://platform.openai.com/docs/api-reference/files/retrieve)
+
+### Find File Content
+
+```ruby
+Openai::Client.files.find_content(file_id)
+```
+
+[API documentation](https://platform.openai.com/docs/api-reference/files/retrieve-content)
+
+### Upload File
+
+```ruby
+request_body = {
+  file: '/absolute/path/to/file.jsonl',
+  purpose: 'fine-tune'
+}
+Openai::Client.files.upload(request_body)
+```
+> The file format must be jsonl, where each line contains the prompt and completion properties.
+
+Example (file.jsonl):
+
+```json
+{"prompt": "<prompt text>", "completion": "<ideal generated text>"}
+{"prompt": "<prompt text>", "completion": "<ideal generated text>"}
+...
+```
+
+[API documentation](https://platform.openai.com/docs/api-reference/files/upload)
+
+### Delete File
+
+```ruby
+Openai::Client.files.delete(file_id)
+```
+
+[API documentation](https://platform.openai.com/docs/api-reference/files/delete)
 
 ## Contributing
 

data/lib/openai/client/embeddings.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Embeddings
+      PATH = 'embeddings'
+
+      # @api public
+      # Public: Makes an API call to create an embedding.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] an embedding
+      def create(body)
+        Http.new.post(PATH, body).body
+      rescue Faraday::Error
+        nil
+      end
+    end
+  end
+end

data/lib/openai/client/files.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'openai/client/utils'
+
+module Openai
+  module Client
+    class Files
+      PATH = 'files'
+
+      # @api public
+      # Public: Makes an API call to return all files that belong to the user's organization.
+      #
+      # @return [Hash] a list of files
+      def list
+        Http.new.get(PATH).body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to upload a file.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] the file
+      def upload(body)
+        Http.new.multipart_post(PATH, Utils.upload_io(body, %i[file], 'jsonl')).body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to delete the file.
+      #
+      # @param [String] id file ID
+      #
+      # @return [Hash] the file
+      def delete(id)
+        Http.new.delete("#{PATH}/#{id}").body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to find the file by the ID.
+      #
+      # @param [String] id file ID
+      #
+      # @return [Hash] found file or nil
+      def find(id)
+        Http.new.get("#{PATH}/#{id}").body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to find the contents of the specified file.
+      #
+      # @param [String] id file ID
+      #
+      # @return [Hash] the contents of the specified file or nil
+      def find_content(id)
+        Http.new.get("#{PATH}/#{id}/content").body
+      rescue Faraday::Error
+        nil
+      end
+    end
+  end
+end

data/lib/openai/client/http.rb

@@ -61,6 +61,20 @@ module Openai
         log_error(e) && raise
       end
 
+      # @api public
+      # Public: Makes a DELETE request using the Faraday HTTP Client.
+      #
+      # @param [String] path API path
+      #
+      # @raise [Faraday::Error] on failure API call
+      #
+      # @return [Faraday::Response] instance of Faraday::Response class
+      def delete(path)
+        connection.delete(path)
+      rescue Faraday::Error => e
+        log_error(e) && raise
+      end
+
       private
 
       attr_reader :connection, :logger

data/lib/openai/client/images.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'openai/client/utils'
+
 module Openai
   module Client
     class Images
@@ -26,7 +28,7 @@ module Openai
       #
       # @return [Hash] an edited or extended image
       def edit(body)
-        Http.new.multipart_post(EDIT_PATH, upload_io(body, %i[image mask])).body
+        Http.new.multipart_post(EDIT_PATH, Utils.upload_io(body, %i[image mask], 'png')).body
       rescue Faraday::Error
         nil
       end
@@ -38,26 +40,10 @@ module Openai
       #
       # @return [Hash] a variation of a given image
       def variations(body)
-        Http.new.multipart_post(VARIATION_PATH, upload_io(body, %i[image])).body
+        Http.new.multipart_post(VARIATION_PATH, Utils.upload_io(body, %i[image], 'png')).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/moderations.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Moderations
+      PATH = 'moderations'
+
+      # @api public
+      # Public: Makes an API call to create a moderation.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] a moderation
+      def create(body)
+        Http.new.post(PATH, body).body
+      rescue Faraday::Error
+        nil
+      end
+    end
+  end
+end

data/lib/openai/client/utils.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    module Utils
+      class << self
+        # @api private
+        # Internal: Creates the open IO object for the uploaded file.
+        #
+        # @param [Hash] data request body
+        # @param [Array] param_names parameter names
+        # @param [String] content_type content type of the file data
+        #
+        # @return [Hash] request body
+        def upload_io(data, param_names, content_type)
+          param_names.each do |param|
+            data[param] = Faraday::FilePart.new(data[param], content_type) if data[param]
+          end
+          data
+        end
+      end
+    end
+  end
+end

data/lib/openai/client/version.rb

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

data/lib/openai/client.rb

@@ -12,12 +12,15 @@ require 'openai/client/models'
 require 'openai/client/edits'
 require 'openai/client/completions'
 require 'openai/client/images'
+require 'openai/client/embeddings'
+require 'openai/client/moderations'
+require 'openai/client/files'
 
 module Openai
   module Client
     extend Configurable
 
-    ATTRS = ['models', 'edits', 'completions', 'images'].freeze
+    ATTRS = ['models', 'edits', 'completions', 'images', 'embeddings', 'moderations', 'files'].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.4.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Ihor Tykhonenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,9 +58,13 @@ files:
 - lib/openai/client/configurable.rb
 - lib/openai/client/configuration.rb
 - lib/openai/client/edits.rb
+- lib/openai/client/embeddings.rb
+- lib/openai/client/files.rb
 - lib/openai/client/http.rb
 - lib/openai/client/images.rb
 - lib/openai/client/models.rb
+- lib/openai/client/moderations.rb
+- lib/openai/client/utils.rb
 - lib/openai/client/version.rb
 - sig/openai/client.rbs
 homepage: https://github.com/itikhonenko/openai-client