ruby-openai 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54bd37da173d97fdb58db219e057eec6997a3694c463d79cdc6e04fce86713fd
-  data.tar.gz: 051e5bd9b7dfe58040e0c1107c96da85f9a8c8d655987a7214dc3ce9f4663829
+  metadata.gz: eae2966d67581585125aac11431d33db3af2f472d0970dad242316783ded514e
+  data.tar.gz: 53f357b92d77a79c48539b69216c4b06c2f0fd0584be17dfbf54576ea02ffed4
 SHA512:
-  metadata.gz: bcf13d22abf4a3f46a82622d6f34be59cab1fd068d1fe29709da89fa434611b5a0ada0397cc3dc0e091406174b5ad8472c6647c553d2bdf6b8fcfe5d1d547c81
-  data.tar.gz: 6ed690d12edb3d1aac43894f6704365ed1535b124286fd6b048dbe8606499d28e474f89096bba8780b8eadbebc201918a6e6a754cc03d942221bb31dad4de8c0
+  metadata.gz: 67c875aa8dde9a199aead346a6b45af8aed00ddf81b2db667c055c1ef9e86dea2d43e5b3d23e1e659dbfb0468a40ab9c419b52115a61491217c8c1b0d65aff3c
+  data.tar.gz: 4d55769b42b9b295ff4c065c9f4abdbaaf5e96b998eb707e3a64f4161355d20c5e8ee0b417c80029b376e70fe9c69e0521c397ac82523aa05874e8ecbeaac7ce

data/.circleci/config.yml

@@ -8,7 +8,7 @@ jobs:
   rubocop:
     parallelism: 1
     docker:
-      - image: cimg/ruby:3.0-node
+      - image: cimg/ruby:3.1-node
     steps:
       - checkout
       - ruby/install-deps
@@ -37,4 +37,9 @@ workflows:
       - test:
           matrix:
               parameters:
-                ruby-image: ['cimg/ruby:2.5-node', 'cimg/ruby:2.6-node', 'cimg/ruby:2.7-node', 'cimg/ruby:3.0-node']
+                ruby-image:
+                  - cimg/ruby:2.5-node
+                  - cimg/ruby:2.6-node
+                  - cimg/ruby:2.7-node
+                  - cimg/ruby:3.0-node
+                  - cimg/ruby:3.1-node

data/CHANGELOG.md

@@ -5,6 +5,13 @@ 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.5.0] - 2022-09-18
+
+### Added
+
+- Add Client#moderations endpoint to check OpenAI's Content Policy.
+- Add Client#edits endpoints to transform inputs according to instructions.
+
 ## [1.4.0] - 2021-12-11
 
 ### Added

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 gem "byebug", "~> 11.1.3"
 gem "rake", "~> 13.0"
-gem "rspec", "~> 3.10"
-gem "rubocop", "~> 1.23.0"
+gem "rspec", "~> 3.11"
+gem "rubocop", "~> 1.28.2"
 gem "vcr", "~> 6.0.0"
-gem "webmock", "~> 3.14.0"
+gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    ruby-openai (1.4.0)
-      dotenv (~> 2.7.6)
+    ruby-openai (1.5.0)
+      dotenv (>= 2.7.6, < 2.9.0)
       httparty (>= 0.18.1, < 0.21.0)
 
 GEM
@@ -14,52 +14,52 @@ GEM
     byebug (11.1.3)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
-    dotenv (2.7.6)
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
     hashdiff (1.0.1)
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0901)
+    mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.3.1)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.23.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.28.2)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.1.0)
     vcr (6.0.0)
-    webmock (3.14.0)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -70,11 +70,11 @@ PLATFORMS
 DEPENDENCIES
   byebug (~> 11.1.3)
   rake (~> 13.0)
-  rspec (~> 3.10)
-  rubocop (~> 1.23.0)
+  rspec (~> 3.11)
+  rubocop (~> 1.28.2)
   ruby-openai!
   vcr (~> 6.0.0)
-  webmock (~> 3.14.0)
+  webmock (~> 3.18.1)
 
 BUNDLED WITH
    2.2.20

data/README.md

@@ -5,7 +5,7 @@
 [![CircleCI Build Status](https://circleci.com/gh/alexrudall/ruby-openai.svg?style=shield)](https://circleci.com/gh/alexrudall/ruby-openai)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/codeclimate/codeclimate/maintainability)
 
-A simple Ruby wrapper for the [OpenAI GPT-3 API](https://openai.com/blog/openai-api/).
+Use the [OpenAI GPT-3 API](https://openai.com/blog/openai-api/) with Ruby! 🤖❤️
 
 ## Installation
 
@@ -35,7 +35,7 @@ and require with:
 
 ## Usage
 
-Get your API key from [https://beta.openai.com/docs/developer-quickstart/your-api-keys](https://beta.openai.com/docs/developer-quickstart/your-api-keys)
+Get your API key from [https://beta.openai.com/account/api-keys](https://beta.openai.com/account/api-keys)
 
 ### With dotenv
 
@@ -59,30 +59,16 @@ Alternatively you can pass your key directly to a new client:
     client = OpenAI::Client.new(access_token: "access_token_goes_here")
 ```
 
-### Engines
-
-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
+- [GPT-3](https://beta.openai.com/docs/engines/gpt-3)
+  - text-ada-001
+  - text-babbage-001
+  - text-curie-001
+  - text-davinci-001
 - [Codex (private beta)](https://beta.openai.com/docs/engines/codex-series-private-beta)
-  - davinci-codex
-  - cushman-codex
+  - code-davinci-002
+  - code-cushman-001
 - [Content Filter](https://beta.openai.com/docs/engines/content-filter)
   - content-filter-alpha
 
@@ -91,95 +77,56 @@ There are different engines that can be used to generate text. For a full list a
 Hit the OpenAI API for a completion:
 
 ```ruby
-    response = client.completions(engine: "davinci", parameters: { prompt: "Once upon a time", max_tokens: 5 })
+    response = client.completions(engine: "text-davinci-001", parameters: { prompt: "Once upon a time", max_tokens: 5 })
     puts response.parsed_response['choices'].map{ |c| c["text"] }
     => [", there lived a great"]
 ```
 
-### Files
-
-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)
-    client.files.delete(id: 123)
-```
-
-### Search
+### Edits
 
-Pass documents and a query string to get semantic search scores against each document:
+Send a string and some instructions for what to do to the string:
 
 ```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]
-```
-
-You can alternatively search using the ID of a file you've uploaded:
-
-```ruby
-    client.search(engine: "ada", parameters: { file: "abc123", query: "happy" })
+    response = client.edits(
+        parameters: {
+            model: "text-davinci-edit-001",
+            input: "What day of the wek is it?",
+            instruction: "Fix the spelling mistakes"
+        }
+    )
+    puts response.dig("choices", 0, "text")
+    => What day of the week is it?
 ```
 
-### Answers
-
-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?",
-        model: "curie",
-        examples_context: "In 2017, U.S. life expectancy was 78.6 years.",
-        examples: [["What is human life expectancy in the United States?","78 years."]],
-    })
-```
+### Embeddings
 
-Or use the ID of a file you've uploaded:
+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
-    response = client.answers(parameters: {
-        file: "123abc",
-        question: "which puppy is happy?",
-        model: "curie",
-        examples_context: "In 2017, U.S. life expectancy was 78.6 years.",
-        examples: [["What is human life expectancy in the United States?","78 years."]],
-    })
+    client.embeddings(
+        engine: "babbage-similarity",
+        parameters: {
+          input: "The food was delicious and the waiter..."
+        }
+    )
 ```
 
-### Classifications
+### Files
 
-Pass examples and a query to predict the most likely labels:
+Put your data in a `.jsonl` file like this:
 
-```ruby
-    response = client.classifications(parameters: {
-        examples: [
-            ["A happy moment", "Positive"],
-            ["I am sad.", "Negative"],
-            ["I am feeling awesome", "Positive"]
-        ],
-        query: "It is a raining day :(",
-        model: "ada"
-    })
+```json
+    {"text": "puppy A is happy", "metadata": "emotional state of puppy A"}
+    {"text": "puppy B is sad", "metadata": "emotional state of puppy B"}
 ```
 
-Or use the ID of a file you've uploaded:
+and pass the path to `client.files.upload` to upload it to OpenAI, and then interact with it:
 
 ```ruby
-    response = client.classifications(parameters: {
-        file: "123abc,
-        query: "It is a raining day :(",
-        model: "ada"
-    })
+    client.files.upload(parameters: { file: 'path/to/puppy.jsonl', purpose: 'search' })
+    client.files.list
+    client.files.retrieve(id: 123)
+    client.files.delete(id: 123)
 ```
 
 ### Fine-tunes
@@ -204,7 +151,7 @@ You can then use this file ID to create a fine-tune model:
     response = client.finetunes.create(
         parameters: {
         training_file: file_id,
-        model: "ada"
+        model: "text-ada-001"
     })
     fine_tune_id = JSON.parse(response.body)["id"]
 ```
@@ -237,17 +184,91 @@ This fine-tuned model name can then be used in classifications:
 
 Do not pass the engine parameter when using a fine-tuned model.
 
-### Embeddings
+### Moderations
 
-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.
+Pass a string to check if it violates OpenAI's Content Policy:
 
 ```ruby
-    client.embeddings(
-        engine: "babbage-similarity",
-        parameters: {
-          input: "The food was delicious and the waiter..."
-        }
-    )
+    response = client.moderations(parameters: { input: "I'm worried about that." })
+    puts response.dig("results", 0, "category_scores", "hate")
+    => 5.505014632944949e-05
+```
+
+### Searches
+
+Pass documents and a query string to get semantic search scores against each document:
+
+```ruby
+    response = client.search(engine: "text-ada-001", parameters: { documents: %w[washington hospital school], query: "president" })
+    puts response["data"].map { |d| d["score"] }
+    => [202.0, 48.052, 19.247]
+```
+
+You can alternatively search using the ID of a file you've uploaded:
+
+```ruby
+    client.search(engine: "text-ada-001", parameters: { file: "abc123", query: "happy" })
+```
+
+### Classifications
+
+Pass examples and a query to predict the most likely labels:
+
+```ruby
+    response = client.classifications(parameters: {
+        examples: [
+            ["A happy moment", "Positive"],
+            ["I am sad.", "Negative"],
+            ["I am feeling awesome", "Positive"]
+        ],
+        query: "It is a raining day :(",
+        model: "text-ada-001"
+    })
+```
+
+Or use the ID of a file you've uploaded:
+
+```ruby
+    response = client.classifications(parameters: {
+        file: "123abc,
+        query: "It is a raining day :(",
+        model: "text-ada-001"
+    })
+```
+
+### Answers
+
+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?",
+        model: "text-curie-001",
+        examples_context: "In 2017, U.S. life expectancy was 78.6 years.",
+        examples: [["What is human life expectancy in the United States?","78 years."]],
+    })
+```
+
+Or use the ID of a file you've uploaded:
+
+```ruby
+    response = client.answers(parameters: {
+        file: "123abc",
+        question: "which puppy is happy?",
+        model: "text-curie-001",
+        examples_context: "In 2017, U.S. life expectancy was 78.6 years.",
+        examples: [["What is human life expectancy in the United States?","78 years."]],
+    })
+```
+
+### Engines
+
+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: 'text-ada-001')
 ```
 
 ## Development

data/lib/ruby/openai/client.rb

@@ -4,7 +4,7 @@ module OpenAI
     base_uri "https://api.openai.com"
 
     def initialize(access_token: nil)
-      @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
+      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
     end
 
     def answers(version: default_version, parameters: {})
@@ -23,6 +23,10 @@ module OpenAI
       end
     end
 
+    def edits(version: default_version, parameters: {})
+      post(url: "/#{version}/edits", parameters: parameters)
+    end
+
     def embeddings(engine:, version: default_version, parameters: {})
       post(url: "/#{version}/engines/#{engine}/embeddings", parameters: parameters)
     end
@@ -39,6 +43,10 @@ module OpenAI
       @finetunes ||= OpenAI::Finetunes.new(access_token: @access_token)
     end
 
+    def moderations(version: default_version, parameters: {})
+      post(url: "/#{version}/moderations", parameters: parameters)
+    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

@@ -4,7 +4,7 @@ module OpenAI
     base_uri "https://api.openai.com"
 
     def initialize(access_token: nil)
-      @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
+      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
     end
 
     def list(version: default_version)

data/lib/ruby/openai/files.rb

@@ -4,7 +4,7 @@ module OpenAI
     base_uri "https://api.openai.com"
 
     def initialize(access_token: nil)
-      @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
+      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
     end
 
     def list(version: default_version)

data/lib/ruby/openai/finetunes.rb

@@ -4,7 +4,7 @@ module OpenAI
     base_uri "https://api.openai.com"
 
     def initialize(access_token: nil)
-      @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
+      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
     end
 
     def list(version: default_version)

data/lib/ruby/openai/version.rb

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

data/ruby-openai.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "dotenv", "~> 2.7.6"
+  spec.add_dependency "dotenv", ">= 2.7.6", "< 2.9.0"
   spec.add_dependency "httparty", ">= 0.18.1", "< 0.21.0"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for the OpenAI GPT-3 API