ruby-openai 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a958db13dbbf94dbbeeadb2dba89e9c00eb17c40def662e85074410becbca3c5
-  data.tar.gz: 2ec73b390ef82c2e8f5498d6abf195cf49c40a03e6b446e42f7715df0bfc27fd
+  metadata.gz: 2b8fe14b8e08b05f4743569e5c94f92552032802bf0eb4fd39fd8168ea6e1105
+  data.tar.gz: 70933cec4140ffe73c52e0bc25e5afc2bb65d4348b1c8138f95acc8b7ccdb500
 SHA512:
-  metadata.gz: ed8d2bcedcc30defd2acb28d29be00c2c07bf80b38dd7748323c0661b90f1b09da5c21c7dd7b6014161d7fd966e9da6854d996236c032744d4f0fe70f0a4abb2
-  data.tar.gz: a846cf9bb2888dd30a89b5796ead927615ccb46647ef803a88cfc281c08e7064857a6ee025f4611d9b7db4b0760198c7504b65257ec1584b88196ca4d27a8423
+  metadata.gz: 58572f5ea0262e16d9b6a916e5a1ae04e786804cdb04771e443ce8c6010b4d6ba2956e1cb5c82a03d743d83e8511f91e9510b6ac5b36ab257435c5cd02dc41f2
+  data.tar.gz: b655c9054c7d89c8dfb8b1f364acc7e70a8aece46bdaf4c365a693d81dc97db83f8e6fe325e8e7eabdec12c079aca9c12e402ac909fe485e721cf8613d46f403

data/.circleci/config.yml

@@ -8,7 +8,7 @@ jobs:
   rubocop:
     parallelism: 1
     docker:
-      - image: cimg/ruby:2.7-node
+      - image: cimg/ruby:3.0-node
     steps:
       - checkout
       - ruby/install-deps
@@ -16,9 +16,12 @@ jobs:
           name: Run Rubocop
           command: bundle exec rubocop
   test:
+    parameters:
+      ruby-image:
+        type: string
     parallelism: 1
     docker:
-      - image: cimg/ruby:2.7-node
+      - image: << parameters.ruby-image >>
     steps:
       - checkout
       - ruby/install-deps
@@ -31,4 +34,7 @@ workflows:
   checks:
     jobs:
       - rubocop
-      - test
+      - 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']

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: webmock
+    versions:
+    - 3.11.1
+    - 3.11.3
+  - dependency-name: rspec
+    versions:
+    - 3.10.0

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 2.5
   NewCops: enable
   SuggestExtensions: false
 

data/CHANGELOG.md

@@ -5,6 +5,36 @@ 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.3.1] - 2021-07-14
+
+### Changed
+
+- Add backwards compatibility from Ruby 2.5+.
+
+## [1.3.0] - 2021-04-18
+
+### Added
+
+- Add Client#classifications to predict the most likely labels based on examples or a file.
+
+### Fixed
+
+- Fixed Files#upload which was previously broken by the validation code!
+
+## [1.2.2] - 2021-04-18
+
+### Changed
+
+- Add Client#search(parameters:) to allow passing `max_rerank` or `return_metadata`.
+- Deprecate Client#search with query, file or document parameters at the top level.
+- Thanks [@stevegeek](https://github.com/stevegeek) for pointing this issue out!
+
+## [1.2.1] - 2021-04-11
+
+### Added
+
+- Add validation of JSONL files to make it easier to debug during upload.
+
 ## [1.2.0] - 2021-04-08
 
 ### Added

data/Gemfile

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

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    ruby-openai (1.2.0)
+    ruby-openai (1.3.1)
       dotenv (~> 2.7.6)
       httparty (~> 0.18.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     byebug (11.1.3)
@@ -22,16 +22,16 @@ GEM
       multi_xml (>= 0.5.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
+    mime-types-data (3.2021.0704)
     multi_xml (0.6.0)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -45,21 +45,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.12.1)
+    rubocop (1.18.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.0.0)
     vcr (6.0.0)
-    webmock (3.12.2)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       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.12.1)
+  rubocop (~> 1.18.3)
   ruby-openai!
   vcr (~> 6.0.0)
-  webmock (~> 3.12.2)
+  webmock (~> 3.13.0)
 
 BUNDLED WITH
    2.2.3

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/ruby-openai.svg)](https://badge.fury.io/rb/ruby-openai)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexrudall/ruby-openai/blob/main/LICENSE.txt)
 [![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/).
 
@@ -81,7 +82,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:
 
 ```
-    response = client.search(engine: "ada", documents: %w[washington hospital school], query: "president")
+    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 +90,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:
 
 ```
-    client.search(engine: "ada", file: "abc123", query: "happy")
+    client.search(engine: "ada", parameters: { file: "abc123", query: "happy" })
 ```
 
 ### Answers
@@ -106,7 +107,7 @@ Pass documents, a question string, and an example question/response to get an an
     })
 ```
 
-You can alternatively search using the ID of a file you've uploaded:
+Or use the ID of a file you've uploaded:
 
 ```
     response = client.answers(parameters: {
@@ -118,11 +119,37 @@ You can alternatively search using the ID of a file you've uploaded:
     })
 ```
 
+### Classifications
+
+Pass examples and a query to predict the most likely labels:
+
+```
+    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"
+    })
+```
+
+Or use the ID of a file you've uploaded:
+
+```
+    response = client.classifications(parameters: {
+        file: "123abc,
+        query: "It is a raining day :(",
+        model: "ada"
+    })
+```
+
 ## 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, update `CHANGELOG.md`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/ruby/openai/client.rb

@@ -8,44 +8,47 @@ module OpenAI
     end
 
     def answers(version: default_version, parameters: {})
-      self.class.post(
-        "/#{version}/answers",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
-        },
-        body: parameters.to_json
-      )
+      post(url: "/#{version}/answers", parameters: parameters)
+    end
+
+    def classifications(version: default_version, parameters: {})
+      post(url: "/#{version}/classifications", parameters: parameters)
     end
 
     def completions(engine:, version: default_version, parameters: {})
-      self.class.post(
-        "/#{version}/engines/#{engine}/completions",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
-        },
-        body: parameters.to_json
-      )
+      post(url: "/#{version}/engines/#{engine}/completions", parameters: parameters)
     end
 
     def files
       @files ||= OpenAI::Files.new(access_token: @access_token)
     end
 
-    def search(engine:, query:, documents: nil, file: nil, version: default_version)
-      self.class.post(
-        "/#{version}/engines/#{engine}/search",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}"
-        },
-        body: { query: query }.merge(documents_or_file(documents: documents, file: file)).to_json
-      )
+    # rubocop:disable Layout/LineLength
+    # rubocop:disable Metrics/ParameterLists
+    def search(engine:, query: nil, documents: nil, file: nil, version: default_version, parameters: {})
+      return legacy_search(engine: engine, query: query, documents: documents, file: file, version: version) if query || documents || file
+
+      post(url: "/#{version}/engines/#{engine}/search", parameters: parameters)
     end
+    # rubocop:enable Layout/LineLength
+    # rubocop:enable Metrics/ParameterLists
 
     private
 
+    # rubocop:disable Layout/LineLength
+    def legacy_search(engine:, query:, documents: nil, file: nil, version: default_version)
+      warn "[DEPRECATION] Passing `query`, `documents` or `file` directly to `Client#search` is deprecated and will be removed in a future version of ruby-openai.
+        Please nest these terms within `parameters` instead, like this:
+        client.search(engine: 'davinci', parameters: { query: 'president', documents: %w[washington hospital school] })
+      "
+
+      post(
+        url: "/#{version}/engines/#{engine}/search",
+        parameters: { query: query }.merge(documents_or_file(documents: documents, file: file))
+      )
+    end
+    # rubocop:enable Layout/LineLength
+
     def default_version
       "v1".freeze
     end
@@ -53,5 +56,16 @@ module OpenAI
     def documents_or_file(documents: nil, file: nil)
       documents ? { documents: documents } : { file: file }
     end
+
+    def post(url:, parameters:)
+      self.class.post(
+        url,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        },
+        body: parameters.to_json
+      )
+    end
   end
 end

data/lib/ruby/openai/files.rb

@@ -18,6 +18,8 @@ module OpenAI
     end
 
     def upload(version: default_version, parameters: {})
+      validate(file: parameters[:file])
+
       self.class.post(
         "/#{version}/files",
         headers: {
@@ -53,5 +55,13 @@ module OpenAI
     def default_version
       "v1".freeze
     end
+
+    def validate(file:)
+      File.open(file).each_line.with_index do |line, index|
+        JSON.parse(line)
+      rescue JSON::ParserError => e
+        raise JSON::ParserError, "#{e.message} - found on line #{index + 1} of #{file}"
+      end
+    end
   end
 end

data/lib/ruby/openai/version.rb

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

data/ruby-openai.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "A Ruby gem for the OpenAI GPT-3 API"
   spec.homepage      = "https://github.com/alexrudall/ruby-openai"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/alexrudall/ruby-openai"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -48,6 +48,7 @@ files:
 - ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -83,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="