openai-client 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa13b10a22961929472de3fc7cb1ebedc43c5d46d2e1b221d3e7ac39293af99e
-  data.tar.gz: d848b51aa150fe3b33f755cd774f8e959550bfeef82daf475976756fe0b3a12a
+  metadata.gz: 3cbf3dd44125f32b91842962afe23cd6c9598d1860134d9bbdf00f7aee8a0324
+  data.tar.gz: 5082017517a67520e653376ee73bc267c7775d2e85979b7fb38ef8a19267fc20
 SHA512:
-  metadata.gz: 30b8d9843d40343ba72e06450c7262238a2d2d67bfffe6d59c55c61e4d20535985c513bc8b692bab193b5df3e2427b82ede2f441e50834d3fb15bf5f61d2d272
-  data.tar.gz: '0817ca7dce3899b5e43a5a87fad228c370051475ccd41c475d5c5e32560cfa3cfca318006f59a8fb611be722cf08c76a82cb8184407c53d2e92999e6d38bed47'
+  metadata.gz: 24b0f29f7e4c58a3f881fcd06a68d833e8c3185990d572983f43e68d86a97ec4911d2ffa9f906c5408b0aac142e7a8fca6029f406325f3082dcf695a83e8c605
+  data.tar.gz: f82ba652ebcaea9407f6b4667a5b98351af1352c48e112a0a90773a909bd1f043979a1cd2fc261be9bd714c1fe85298b3a95eec32bd2878168307e1336724de9

data/Gemfile.lock

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

data/README.md

@@ -5,20 +5,33 @@ This gem is a wrapper for calling the OpenAI and GPT-3 APIs.
 * [Installation](#installation)
 * [Usage](#usage)
 * [OpenAI Models API](#openai-models-api)
+  * [List Models](#list-models)
+  * [Find Model](#find-model)
 * [OpenAI Completions API](#openai-completions-api)
+  * [Create Completion](#create-completion)
 * [OpenAI Edits API](#openai-edits-api)
+  * [Create Edit](#create-edit)
 * [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)
 * [OpenAI Embeddings API](#openai-embeddings-api)
+  * [Create Embeddings](#create-embeddings)
 * [OpenAI Moderations API](#openai-moderations-api)
+  * [Create Moderation](#create-moderation)
 * [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
 
@@ -56,6 +69,18 @@ end
 
 ## OpenAI Models API
 
+### List Models
+
+```ruby
+Openai::Client.models.list
+```
+
+### Find Model
+
+```ruby
+Openai::Client.models.find(model_id)
+```
+
 ```ruby
 # Models
 Openai::Client.models.list
@@ -66,6 +91,8 @@ Openai::Client.models.find(model_id)
 
 ## OpenAI Completions API
 
+### Create Completion
+
 ```ruby
 request_body = {
   model: 'text-davinci-003',
@@ -81,10 +108,12 @@ request_body = {
 Openai::Client.completions.create(request_body)
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/completions/create)
+[API Documentation](https://platform.openai.com/docs/api-reference/completions/create)
 
 ## OpenAI Edits API
 
+### Create Edit
+
 ```ruby
 request_body = {
   model: 'text-davinci-edit-001',
@@ -94,7 +123,7 @@ request_body = {
 Openai::Client.edits.create(request_body)
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/edits/create)
+[API Documentation](https://platform.openai.com/docs/api-reference/edits/create)
 
 ## OpenAI Image API
 
@@ -110,7 +139,7 @@ request_body = {
 response = Openai::Client.images.create(request_body)
 ```
 
-[API 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
 
@@ -129,7 +158,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.
 
-[API 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
 
@@ -145,10 +174,12 @@ response = Openai::Client.images.variations(request_body)
 
 - `image` - must be a valid PNG file, less than 4MB, and square.
 
-[API 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
 
+### Create Embeddings
+
 ```ruby
 request_body = {
   model: 'text-embedding-ada-002',
@@ -157,10 +188,12 @@ request_body = {
 Openai::Client.embeddings.create(request_body)
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/embeddings/create)
+[API Documentation](https://platform.openai.com/docs/api-reference/embeddings/create)
 
 ## OpenAI Moderations API
 
+### Create Moderation
+
 ```ruby
 request_body = {
   model: 'text-moderation-latest', # text-moderation-stable or text-moderation-latest
@@ -169,7 +202,7 @@ request_body = {
 Openai::Client.moderations.create(request_body)
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/moderations/create)
+[API Documentation](https://platform.openai.com/docs/api-reference/moderations/create)
 
 ## OpenAI Files API
 
@@ -179,7 +212,7 @@ Openai::Client.moderations.create(request_body)
 Openai::Client.files.list
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/files/list)
+[API Documentation](https://platform.openai.com/docs/api-reference/files/list)
 
 ### Find File
 
@@ -187,7 +220,7 @@ Openai::Client.files.list
 Openai::Client.files.find(file_id)
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/files/retrieve)
+[API Documentation](https://platform.openai.com/docs/api-reference/files/retrieve)
 
 ### Find File Content
 
@@ -195,7 +228,7 @@ Openai::Client.files.find(file_id)
 Openai::Client.files.find_content(file_id)
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/files/retrieve-content)
+[API Documentation](https://platform.openai.com/docs/api-reference/files/retrieve-content)
 
 ### Upload File
 
@@ -216,7 +249,7 @@ Example (file.jsonl):
 ...
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/files/upload)
+[API Documentation](https://platform.openai.com/docs/api-reference/files/upload)
 
 ### Delete File
 
@@ -224,7 +257,64 @@ Example (file.jsonl):
 Openai::Client.files.delete(file_id)
 ```
 
-[API documentation](https://platform.openai.com/docs/api-reference/files/delete)
+[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/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -10,3 +11,9 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb'] # optional
+  t.options = ['--any', '--extra', '--opts'] # optional
+  t.stats_options = ['--list-undoc']         # optional
+end

data/lib/openai/client/files.rb

@@ -46,7 +46,7 @@ module Openai
       #
       # @param [String] id file ID
       #
-      # @return [Hash] found file or nil
+      # @return [Hash] found file
       def find(id)
         Http.new.get("#{PATH}/#{id}").body
       rescue Faraday::Error
@@ -58,7 +58,7 @@ module Openai
       #
       # @param [String] id file ID
       #
-      # @return [Hash] the contents of the specified file or nil
+      # @return [Hash] the contents of the specified file
       def find_content(id)
         Http.new.get("#{PATH}/#{id}/content").body
       rescue Faraday::Error

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/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/version.rb

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

data/lib/openai/client.rb

@@ -15,18 +15,28 @@ 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', 'moderations', 'files'].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.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Ihor Tykhonenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -60,6 +60,7 @@ files:
 - 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