openai-client 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be7dc55119b7220165c1025d64ddf0f9a9f4a05efb79f4ffd03fece3c7cd60be
-  data.tar.gz: 591cdc0fe81065d49db7907a0b9f740a17962744cdb9cc3ecdf1b9d40967c50e
+  metadata.gz: a80665d3e20f6c56644b2dd0b03b5f7a4231b3e0ef1d947af3094917944c885c
+  data.tar.gz: fd1bb8de6a7d955be8b2265e637a3bad4b09823e538a1c5b49ae8e3b4c8f067a
 SHA512:
-  metadata.gz: 8d6f2dc7fa5cc014cf77a2defd2e0efce3f6da336612d3812c9b7df74befba4fc9a069c24c2491d16fc518fd22b985422d6a9c7e06f63c217728d70a6caf4eb4
-  data.tar.gz: ba737dc9d234a49fb20afc98223354dee5a66f1efbac4d95df3b0676b0a8cad95688fbd1b4c38a49d24f5fe8f9001269b33596b03b7fd979aaaa1c39225e300b
+  metadata.gz: 5e6414ba8bf6453fb683870b8a90a7ffaea0101461d73baded7c0572a47bddabca443b1854b42f31db9a1ce95f957111a93bde585692d1f69a15a942d6b42ddd
+  data.tar.gz: '043982ac4ac832a6d8c8078996469bbddc794d56f113a35e2d3869338a34d49f2db58888d15cdd6713cb0e36a254d69e5eb9d26ab301bd9442de44e75298fba6'

data/Gemfile.lock

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

data/README.md

@@ -12,6 +12,20 @@ This gem is a wrapper for calling the OpenAI and GPT-3 APIs.
   * [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)
+* [OpenAI Fine-Tunes API](#openai-fine-tunes-api)
+  * [Create Fine-Tune](#create-fine-tune)
+  * [List Fine-Tunes](#list-fine-tunes)
+  * [Find Fine-Tune](#find-fine-tune)
+  * [List Fine-Tune Events](#list-fine-tune-events)
+  * [Cancel Fine-Tune](#cancel-fine-tune)
+  * [Delete Fine-Tune Model](#delete-fine-tune-model)
 
 ## Installation
 
@@ -74,7 +88,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
 
@@ -87,7 +101,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
 
@@ -103,7 +117,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
 
@@ -122,7 +136,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
 
@@ -138,7 +152,7 @@ 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
 
@@ -150,7 +164,131 @@ request_body = {
 Openai::Client.embeddings.create(request_body)
 ```
 
-[Request body documentation](https://platform.openai.com/docs/api-reference/embeddings/create)
+[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)
+
+## OpenAI Fine-Tunes API
+
+### Create Fine-Tune
+
+```ruby
+request_body = {
+  training_file: "file-XGinujblHPwGLSztz8cPS8XY"
+}
+
+Openai::Client.fine_tunes.create(request_body)
+```
+
+[API Documentation](https://platform.openai.com/docs/api-reference/fine-tunes/create)
+
+### List Fine-Tunes
+
+```ruby
+Openai::Client.fine_tunes.list
+```
+
+[API Documentation](https://platform.openai.com/docs/api-reference/fine-tunes/list)
+
+### Find Fine-Tune
+
+```ruby
+Openai::Client.fine_tunes.find(fine_tune_id)
+```
+
+[API Documentation](https://platform.openai.com/docs/api-reference/fine-tunes/retrieve)
+
+### List Fine-Tune Events
+
+```ruby
+Openai::Client.fine_tunes.find_events(fine_tune_id)
+```
+
+[API Documentation](https://platform.openai.com/docs/api-reference/fine-tunes/events)
+
+### Cancel Fine-Tune
+
+```ruby
+Openai::Client.fine_tunes.cancel(fine_tune_id)
+```
+
+[API Documentation](https://platform.openai.com/docs/api-reference/fine-tunes/cancel)
+
+### Delete Fine-Tune Model
+
+```ruby
+Openai::Client.models.delete(model_id)
+```
+
+[API Documentation](https://platform.openai.com/docs/api-reference/fine-tunes/delete-model)
+
+> - You must have the Owner role in your organization.
+> - Make sure you provide the Model ID and not the Fine-Tune ID.
 
 ## Contributing
 

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
+      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
+      def find_content(id)
+        Http.new.get("#{PATH}/#{id}/content").body
+      rescue Faraday::Error
+        nil
+      end
+    end
+  end
+end

data/lib/openai/client/fine_tunes.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class FineTunes
+      PATH = 'fine-tunes'
+
+      # @api public
+      # Public: Makes an API call to return list the organization's fine-tuning jobs.
+      #
+      # @return [Hash] a list of fine-tuning jobs
+      def list
+        Http.new.get(PATH).body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to find info about the fine-tune job.
+      #
+      # @param [String] id the ID of the fine-tune job
+      #
+      # @return [Hash] found fine-tune info
+      def find(id)
+        Http.new.get("#{PATH}/#{id}").body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to find fine-grained status updates for a fine-tune job.
+      #
+      # @param [String] id the ID of the fine-tune job
+      #
+      # @return [Hash] found fine-grained status updates
+      def find_events(id)
+        Http.new.get("#{PATH}/#{id}/events").body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to cancel a fine-tune job.
+      #
+      # @param [String] id the ID of the fine-tune job
+      #
+      # @return [Hash] the fine-tune related info
+      def cancel(id)
+        Http.new.post("#{PATH}/#{id}/cancel").body
+      rescue Faraday::Error
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to create a job that fine-tunes a specified model from a given dataset.
+      #
+      # @param [Hash] body request body
+      #
+      # @return [Hash] details of the enqueued job including job status and the name of the fine-tuned models
+      def create(body)
+        Http.new.post(PATH, body).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/models.rb

@@ -20,12 +20,24 @@ module Openai
       #
       # @param [String] id model id
       #
-      # @return [Hash] found model or nil
+      # @return [Hash] found model
       def find(id)
         Http.new.get("#{PATH}/#{id}").body
       rescue Faraday::Error
         nil
       end
+
+      # @api public
+      # Public: Makes an API call to delete a model.
+      #
+      # @param [String] id model id
+      #
+      # @return [Hash] the model
+      def delete(id)
+        Http.new.delete("#{PATH}/#{id}").body
+      rescue Faraday::Error
+        nil
+      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.5.0'
+    VERSION = '0.8.0'
   end
 end

data/lib/openai/client.rb

@@ -13,18 +13,30 @@ require 'openai/client/edits'
 require 'openai/client/completions'
 require 'openai/client/images'
 require 'openai/client/embeddings'
+require 'openai/client/moderations'
+require 'openai/client/files'
+require 'openai/client/fine_tunes'
 
 module Openai
   module Client
     extend Configurable
 
-    ATTRS = ['models', 'edits', 'completions', 'images', 'embeddings'].freeze
+    ATTRS = [
+      'models',
+      'edits',
+      'completions',
+      'images',
+      'embeddings',
+      'moderations',
+      'files',
+      'fine_tunes'
+    ].freeze
 
     class << self
       ATTRS.each do |attr|
         define_method(attr) do
-          instance_variable_get("@#{attr}") || instance_variable_set("@#{attr}",
-                                                                     const_get(attr.capitalize, self).new)
+          klass = const_get(attr.split('_').map(&:capitalize).join, self)
+          instance_variable_get("@#{attr}") || instance_variable_set("@#{attr}", klass.new)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.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
@@ -59,9 +59,13 @@ files:
 - lib/openai/client/configuration.rb
 - lib/openai/client/edits.rb
 - lib/openai/client/embeddings.rb
+- lib/openai/client/files.rb
+- lib/openai/client/fine_tunes.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