ruby-openai 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8fe14b8e08b05f4743569e5c94f92552032802bf0eb4fd39fd8168ea6e1105
-  data.tar.gz: 70933cec4140ffe73c52e0bc25e5afc2bb65d4348b1c8138f95acc8b7ccdb500
+  metadata.gz: 54bd37da173d97fdb58db219e057eec6997a3694c463d79cdc6e04fce86713fd
+  data.tar.gz: 051e5bd9b7dfe58040e0c1107c96da85f9a8c8d655987a7214dc3ce9f4663829
 SHA512:
-  metadata.gz: 58572f5ea0262e16d9b6a916e5a1ae04e786804cdb04771e443ce8c6010b4d6ba2956e1cb5c82a03d743d83e8511f91e9510b6ac5b36ab257435c5cd02dc41f2
-  data.tar.gz: b655c9054c7d89c8dfb8b1f364acc7e70a8aece46bdaf4c365a693d81dc97db83f8e6fe325e8e7eabdec12c079aca9c12e402ac909fe485e721cf8613d46f403
+  metadata.gz: bcf13d22abf4a3f46a82622d6f34be59cab1fd068d1fe29709da89fa434611b5a0ada0397cc3dc0e091406174b5ad8472c6647c553d2bdf6b8fcfe5d1d547c81
+  data.tar.gz: 6ed690d12edb3d1aac43894f6704365ed1535b124286fd6b048dbe8606499d28e474f89096bba8780b8eadbebc201918a6e6a754cc03d942221bb31dad4de8c0

data/CHANGELOG.md

@@ -5,6 +5,15 @@ 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).
 
+## [1.4.0] - 2021-12-11
+
+### Added
+
+- Add Client#engines endpoints to list and query available engines.
+- Add Client#finetunes endpoints to create and use fine-tuned models.
+- Add Client#embeddings endpoint to get vector representations of inputs.
+- Add tests and examples for more engines.
+
 ## [1.3.1] - 2021-07-14
 
 ### Changed

data/Gemfile

@@ -6,6 +6,6 @@ gemspec
 gem "byebug", "~> 11.1.3"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.10"
-gem "rubocop", "~> 1.18.3"
+gem "rubocop", "~> 1.23.0"
 gem "vcr", "~> 6.0.0"
-gem "webmock", "~> 3.13.0"
+gem "webmock", "~> 3.14.0"

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    ruby-openai (1.3.1)
+    ruby-openai (1.4.0)
       dotenv (~> 2.7.6)
-      httparty (~> 0.18.1)
+      httparty (>= 0.18.1, < 0.21.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,15 +17,15 @@ GEM
     diff-lcs (1.4.4)
     dotenv (2.7.6)
     hashdiff (1.0.1)
-    httparty (0.18.1)
+    httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0704)
+    mime-types-data (3.2021.0901)
     multi_xml (0.6.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
@@ -45,22 +45,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.18.3)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
+    rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     vcr (6.0.0)
-    webmock (3.13.0)
-      addressable (>= 2.3.6)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
@@ -71,10 +71,10 @@ DEPENDENCIES
   byebug (~> 11.1.3)
   rake (~> 13.0)
   rspec (~> 3.10)
-  rubocop (~> 1.18.3)
+  rubocop (~> 1.23.0)
   ruby-openai!
   vcr (~> 6.0.0)
-  webmock (~> 3.13.0)
+  webmock (~> 3.14.0)
 
 BUNDLED WITH
-   2.2.3
+   2.2.20

data/README.md

@@ -9,19 +9,29 @@ A simple Ruby wrapper for the [OpenAI GPT-3 API](https://openai.com/blog/openai-
 
 ## Installation
 
+### Bundler
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby-openai'
+    gem 'ruby-openai'
 ```
 
 And then execute:
 
-    $ bundle install
+$ bundle install
+
+### Gem install
+
+Or install with:
 
-Or install it yourself as:
+$ gem install ruby-openai
 
-    $ gem install ruby-openai
+and require with:
+
+```ruby
+    require "ruby/openai"
+```
 
 ## Usage
 
@@ -37,7 +47,7 @@ If you're using [dotenv](https://github.com/motdotla/dotenv), you can add your s
 
 And create a client:
 
-```
+```ruby
     client = OpenAI::Client.new
 ```
 
@@ -45,15 +55,42 @@ And create a client:
 
 Alternatively you can pass your key directly to a new client:
 
-```
+```ruby
     client = OpenAI::Client.new(access_token: "access_token_goes_here")
 ```
 
-### Completions
+### Engines
 
-The engine options are currently "ada", "babbage", "curie" and "davinci". Hit the OpenAI API for a completion:
+There are different engines that can be used to generate text. For a full list and to retrieve information about a single engine:
 
+```ruby
+    client.engines.list
+    client.engines.retrieve(id: 'ada')
 ```
+
+#### Examples
+
+- [Base](https://beta.openai.com/docs/engines/base-series)
+  - ada
+  - babbage
+  - curie
+  - davinci
+- [Instruct](https://beta.openai.com/docs/engines/instruct-series-beta)
+  - ada-instruct-beta
+  - babbage-instruct-beta
+  - curie-instruct-beta-v2
+  - davinci-instruct-beta-v3
+- [Codex (private beta)](https://beta.openai.com/docs/engines/codex-series-private-beta)
+  - davinci-codex
+  - cushman-codex
+- [Content Filter](https://beta.openai.com/docs/engines/content-filter)
+  - content-filter-alpha
+
+### Completions
+
+Hit the OpenAI API for a completion:
+
+```ruby
     response = client.completions(engine: "davinci", parameters: { prompt: "Once upon a time", max_tokens: 5 })
     puts response.parsed_response['choices'].map{ |c| c["text"] }
     => [", there lived a great"]
@@ -63,14 +100,14 @@ The engine options are currently "ada", "babbage", "curie" and "davinci". Hit th
 
 Put your data in a `.jsonl` file like this:
 
-```
+```json
     {"text": "puppy A is happy", "metadata": "emotional state of puppy A"}
     {"text": "puppy B is sad", "metadata": "emotional state of puppy B"}
 ```
 
 and pass the path to `client.files.upload` to upload it to OpenAI, and then interact with it:
 
-```
+```ruby
     client.files.upload(parameters: { file: 'path/to/puppy.jsonl', purpose: 'search' })
     client.files.list
     client.files.retrieve(id: 123)
@@ -81,7 +118,7 @@ and pass the path to `client.files.upload` to upload it to OpenAI, and then inte
 
 Pass documents and a query string to get semantic search scores against each document:
 
-```
+```ruby
     response = client.search(engine: "ada", parameters: { documents: %w[washington hospital school], query: "president" })
     puts response["data"].map { |d| d["score"] }
     => [202.0, 48.052, 19.247]
@@ -89,7 +126,7 @@ Pass documents and a query string to get semantic search scores against each doc
 
 You can alternatively search using the ID of a file you've uploaded:
 
-```
+```ruby
     client.search(engine: "ada", parameters: { file: "abc123", query: "happy" })
 ```
 
@@ -97,7 +134,7 @@ You can alternatively search using the ID of a file you've uploaded:
 
 Pass documents, a question string, and an example question/response to get an answer to a question:
 
-```
+```ruby
     response = client.answers(parameters: {
         documents: ["Puppy A is happy.", "Puppy B is sad."],
         question: "which puppy is happy?",
@@ -109,7 +146,7 @@ Pass documents, a question string, and an example question/response to get an an
 
 Or use the ID of a file you've uploaded:
 
-```
+```ruby
     response = client.answers(parameters: {
         file: "123abc",
         question: "which puppy is happy?",
@@ -123,7 +160,7 @@ Or use the ID of a file you've uploaded:
 
 Pass examples and a query to predict the most likely labels:
 
-```
+```ruby
     response = client.classifications(parameters: {
         examples: [
             ["A happy moment", "Positive"],
@@ -137,7 +174,7 @@ Pass examples and a query to predict the most likely labels:
 
 Or use the ID of a file you've uploaded:
 
-```
+```ruby
     response = client.classifications(parameters: {
         file: "123abc,
         query: "It is a raining day :(",
@@ -145,6 +182,74 @@ Or use the ID of a file you've uploaded:
     })
 ```
 
+### Fine-tunes
+
+Put your fine-tuning data in a `.jsonl` file like this:
+
+```json
+    {"prompt":"Overjoyed with my new phone! ->", "completion":" positive"}
+    {"prompt":"@lakers disappoint for a third straight night ->", "completion":" negative"}
+```
+
+and pass the path to `client.files.upload` to upload it to OpenAI and get its ID:
+
+```ruby
+    response = client.files.upload(parameters: { file: 'path/to/sentiment.jsonl', purpose: 'fine-tune' })
+    file_id = JSON.parse(response.body)["id"]
+```
+
+You can then use this file ID to create a fine-tune model:
+
+```ruby
+    response = client.finetunes.create(
+        parameters: {
+        training_file: file_id,
+        model: "ada"
+    })
+    fine_tune_id = JSON.parse(response.body)["id"]
+```
+
+That will give you the fine-tune ID. If you made a mistake you can cancel the fine-tune model before it is processed:
+
+```ruby
+    client.finetunes.cancel(id: fine_tune_id)
+```
+
+You may need to wait a short time for processing to complete. Once processed, you can use list or retrieve to get the name of the fine-tuned model:
+
+```ruby
+    client.finetunes.list
+    response = client.finetunes.retrieve(id: fine_tune_id)
+    fine_tuned_model = JSON.parse(response.body)["fine_tuned_model"]
+```
+
+This fine-tuned model name can then be used in classifications:
+
+```ruby
+    response = client.completions(
+        parameters: {
+            model: fine_tuned_model,
+            prompt: "I love Mondays!"
+        }
+    )
+    JSON.parse(response.body)["choices"].map { |c| c["text"] }
+```
+
+Do not pass the engine parameter when using a fine-tuned model.
+
+### Embeddings
+
+You can use the embeddings endpoint to get a vector of numbers representing an input. You can then compare these vectors for different inputs to efficiently check how similar the inputs are.
+
+```ruby
+    client.embeddings(
+        engine: "babbage-similarity",
+        parameters: {
+          input: "The food was delicious and the waiter..."
+        }
+    )
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ruby/openai/client.rb

@@ -15,14 +15,30 @@ module OpenAI
       post(url: "/#{version}/classifications", parameters: parameters)
     end
 
-    def completions(engine:, version: default_version, parameters: {})
-      post(url: "/#{version}/engines/#{engine}/completions", parameters: parameters)
+    def completions(engine: nil, version: default_version, parameters: {})
+      if engine
+        post(url: "/#{version}/engines/#{engine}/completions", parameters: parameters)
+      else
+        post(url: "/#{version}/completions", parameters: parameters)
+      end
+    end
+
+    def embeddings(engine:, version: default_version, parameters: {})
+      post(url: "/#{version}/engines/#{engine}/embeddings", parameters: parameters)
+    end
+
+    def engines
+      @engines ||= OpenAI::Engines.new(access_token: @access_token)
     end
 
     def files
       @files ||= OpenAI::Files.new(access_token: @access_token)
     end
 
+    def finetunes
+      @finetunes ||= OpenAI::Finetunes.new(access_token: @access_token)
+    end
+
     # rubocop:disable Layout/LineLength
     # rubocop:disable Metrics/ParameterLists
     def search(engine:, query: nil, documents: nil, file: nil, version: default_version, parameters: {})

data/lib/ruby/openai/engines.rb

@@ -0,0 +1,36 @@
+module OpenAI
+  class Engines
+    include HTTParty
+    base_uri "https://api.openai.com"
+
+    def initialize(access_token: nil)
+      @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
+    end
+
+    def list(version: default_version)
+      self.class.get(
+        "/#{version}/engines",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def retrieve(id:, version: default_version)
+      self.class.get(
+        "/#{version}/engines/#{id}",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    private
+
+    def default_version
+      "v1".freeze
+    end
+  end
+end

data/lib/ruby/openai/finetunes.rb

@@ -0,0 +1,67 @@
+module OpenAI
+  class Finetunes
+    include HTTParty
+    base_uri "https://api.openai.com"
+
+    def initialize(access_token: nil)
+      @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
+    end
+
+    def list(version: default_version)
+      self.class.get(
+        "/#{version}/fine-tunes",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def create(version: default_version, parameters: {})
+      self.class.post(
+        "/#{version}/fine-tunes",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        },
+        body: parameters.to_json
+      )
+    end
+
+    def retrieve(id:, version: default_version)
+      self.class.get(
+        "/#{version}/fine-tunes/#{id}",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def cancel(id:, version: default_version)
+      self.class.post(
+        "/#{version}/fine-tunes/#{id}/cancel",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def events(id:, version: default_version)
+      self.class.get(
+        "/#{version}/fine-tunes/#{id}/events",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    private
+
+    def default_version
+      "v1".freeze
+    end
+  end
+end

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "1.3.1".freeze
+    VERSION = "1.4.0".freeze
   end
 end

data/lib/ruby/openai.rb

@@ -1,5 +1,7 @@
 require "httparty"
+require "ruby/openai/engines"
 require "ruby/openai/files"
+require "ruby/openai/finetunes"
 require "ruby/openai/client"
 require "ruby/openai/version"
 require "dotenv/load"

data/ruby-openai.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/alexrudall/ruby-openai"
   spec.metadata["changelog_uri"] = "https://github.com/alexrudall/ruby-openai/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "dotenv", "~> 2.7.6"
-  spec.add_dependency "httparty", "~> 0.18.1"
+  spec.add_dependency "httparty", ">= 0.18.1", "< 0.21.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -28,16 +28,22 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
 description: 
 email:
 - alexrudall@users.noreply.github.com
@@ -65,7 +71,9 @@ files:
 - bin/setup
 - lib/ruby/openai.rb
 - lib/ruby/openai/client.rb
+- lib/ruby/openai/engines.rb
 - lib/ruby/openai/files.rb
+- lib/ruby/openai/finetunes.rb
 - lib/ruby/openai/version.rb
 - pull_request_template.md
 - ruby-openai.gemspec
@@ -76,6 +84,7 @@ metadata:
   homepage_uri: https://github.com/alexrudall/ruby-openai
   source_code_uri: https://github.com/alexrudall/ruby-openai
   changelog_uri: https://github.com/alexrudall/ruby-openai/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -91,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for the OpenAI GPT-3 API