ruby-openai 0.3.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df318e71dd94c35f0779b393494833aba28be2d0849e76593cf1caa023694e28
-  data.tar.gz: 294916dd3edb50a70bed4bc2c6b96c0b385e19b25e7ded70f696b143be7e776b
+  metadata.gz: 9a10874422fb2b2250857d43afe2baa501152ba0358dadfe12d4a2c21f106325
+  data.tar.gz: 5bfbedd2a2347ee7479ebcdf48dc4c7fe8e4dc74fcd721c9c3beeb1386b3199e
 SHA512:
-  metadata.gz: e9762da7271d38a2f1ea744923799321df71e1d9025e2f7d8a4ca72a621a406760106e7d718ba6e493a1fc63e45d3c44032c874fc5b9ae3b553602066cfa789a
-  data.tar.gz: 8709f60b06f8b7713cb82f106d4c9c4698b04d327760bd57c6d466344f55abf61dd20feb2886f7f1f506d40941d04dbd75bb3b0725af02ac79d13cffc4f1fb0b
+  metadata.gz: 67f860d7243072419bc21c91bce26e71b8def68115f91347822770e087c2cc898b42cf2b8fd2a97155d7b44cf79d096e54e6dd16b0842d680ddcef4effb4ca9c
+  data.tar.gz: 6283aaf2aba88b61f47c6218a62bf70c837c9d9a8893bea5f1ee27801f2168f5868329fe33b3de827e056f278e6c70f61b7d70b18582ffc87586bce579374d47

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.7
-
   NewCops: enable
+  SuggestExtensions: false
 
 Style/Documentation:
   # Skips checking to make sure top level modules / classes have a comment.

data/CHANGELOG.md

@@ -5,6 +5,44 @@ 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.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
+
+- Add Client#answers endpoint for question/answer response on documents or a file.
+
+## [1.1.0] - 2021-04-07
+
+### Added
+
+- Add Client#files to allow file upload.
+- Add Client#search(file:) so you can search a file.
+
+## [1.0.0] - 2021-02-01
+
+### Removed
+
+- Remove deprecated method Client#call - use Client#completions instead.
+
+### Changed
+
+- Rename 'master' branch to 'main' branch.
+- Bump dependencies.
+
 ## [0.3.0] - 2020-11-22
 
 ### Added

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexrudall/ruby-openai. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 gem "byebug", "~> 11.1.3"
 gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 0.93.1"
+gem "rspec", "~> 3.10"
+gem "rubocop", "~> 1.12.1"
 gem "vcr", "~> 6.0.0"
-gem "webmock", "~> 3.9.2"
+gem "webmock", "~> 3.12.2"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (0.3.0)
+    ruby-openai (1.2.2)
       dotenv (~> 2.7.6)
       httparty (~> 0.18.1)
 
@@ -10,9 +10,10 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     byebug (11.1.3)
-    crack (0.4.4)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
     dotenv (2.7.6)
     hashdiff (1.0.1)
@@ -21,44 +22,44 @@ 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.0225)
     multi_xml (0.6.0)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.8.2)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.93.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.12.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.7.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
     vcr (6.0.0)
-    webmock (3.9.2)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -69,11 +70,11 @@ PLATFORMS
 DEPENDENCIES
   byebug (~> 11.1.3)
   rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.93.1)
+  rspec (~> 3.10)
+  rubocop (~> 1.12.1)
   ruby-openai!
   vcr (~> 6.0.0)
-  webmock (~> 3.9.2)
+  webmock (~> 3.12.2)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -1,8 +1,9 @@
 # Ruby::OpenAI
 
 [![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/master/LICENSE.txt)
+[![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/).
 
@@ -58,16 +59,66 @@ The engine options are currently "ada", "babbage", "curie" and "davinci". Hit th
     => [", there lived a great"]
 ```
 
+### Files
+
+Put your data in a `.jsonl` file like this:
+
+```
+    {"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:
+
+```
+    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
 
 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]
 ```
 
+You can alternatively search using the ID of a file you've uploaded:
+
+```
+    client.search(engine: "ada", parameters: { file: "abc123", query: "happy" })
+```
+
+### Answers
+
+Pass documents, a question string, and an example question/response to get an answer to a question:
+
+```
+    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."]],
+    })
+```
+
+You can alternatively search using the ID of a file you've uploaded:
+
+```
+    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."]],
+    })
+```
+
 ## 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.
@@ -76,7 +127,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/alexrudall/ruby-openai. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexrudall/ruby-openai. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -84,4 +135,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ruby::OpenAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ruby::OpenAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).

data/lib/ruby/openai.rb

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

data/lib/ruby/openai/client.rb

@@ -7,6 +7,17 @@ module OpenAI
       @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
     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
+      )
+    end
+
     def completions(engine:, version: default_version, parameters: {})
       self.class.post(
         "/#{version}/engines/#{engine}/completions",
@@ -18,44 +29,54 @@ module OpenAI
       )
     end
 
-    def search(engine:, documents:, query:, version: default_version)
+    def files
+      @files ||= OpenAI::Files.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: {})
+      return legacy_search(engine: engine, query: query, documents: documents, file: file, version: version) if query || documents || file
+
       self.class.post(
         "/#{version}/engines/#{engine}/search",
         headers: {
           "Content-Type" => "application/json",
           "Authorization" => "Bearer #{@access_token}"
         },
-        body: {
-          documents: documents, query: query
-        }.to_json
+        body: parameters.to_json
       )
     end
+    # rubocop:enable Layout/LineLength
+    # rubocop:enable Metrics/ParameterLists
+
+    private
 
     # rubocop:disable Metrics/MethodLength
     # rubocop:disable Layout/LineLength
-    def call(engine:, prompt:, max_tokens:, version: default_version)
-      warn "[DEPRECATION] `Client#call` is deprecated and will be removed in a future version of ruby-openai.
-        Please use `Client#completions` instead, like this:
-        client.completions(engine: 'davinci', parameters: { prompt: 'Once upon a time', max_tokens: 5 })
+    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] })
       "
       self.class.post(
-        "/#{version}/engines/#{engine}/completions",
+        "/#{version}/engines/#{engine}/search",
         headers: {
           "Content-Type" => "application/json",
           "Authorization" => "Bearer #{@access_token}"
         },
-        body: {
-          prompt: prompt, max_tokens: max_tokens
-        }.to_json
+        body: { query: query }.merge(documents_or_file(documents: documents, file: file)).to_json
       )
     end
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Layout/LineLength
 
-    private
-
     def default_version
       "v1".freeze
     end
+
+    def documents_or_file(documents: nil, file: nil)
+      documents ? { documents: documents } : { file: file }
+    end
   end
 end

data/lib/ruby/openai/files.rb

@@ -0,0 +1,67 @@
+module OpenAI
+  class Files
+    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}/files",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def upload(version: default_version, parameters: {})
+      file = validate(file: parameters[:file])
+
+      self.class.post(
+        "/#{version}/files",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        },
+        body: parameters.merge(file: file)
+      )
+    end
+
+    def retrieve(id:, version: default_version)
+      self.class.get(
+        "/#{version}/files/#{id}",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    def delete(id:, version: default_version)
+      self.class.delete(
+        "/#{version}/files/#{id}",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        }
+      )
+    end
+
+    private
+
+    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 = "0.3.0".freeze
+    VERSION = "1.2.2".freeze
   end
 end

data/pull_request_template.md

@@ -0,0 +1,5 @@
+## All Submissions:
+
+* [ ] Have you followed the guidelines in our [Contributing document](../blob/main/CONTRIBUTING.md)?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
+* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?

data/ruby-openai.gemspec

@@ -13,7 +13,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/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/alexrudall/ruby-openai/blob/main/CHANGELOG.md"
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-22 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -54,6 +54,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -63,7 +64,9 @@ files:
 - bin/setup
 - lib/ruby/openai.rb
 - lib/ruby/openai/client.rb
+- lib/ruby/openai/files.rb
 - lib/ruby/openai/version.rb
+- pull_request_template.md
 - ruby-openai.gemspec
 homepage: https://github.com/alexrudall/ruby-openai
 licenses:
@@ -71,7 +74,7 @@ licenses:
 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/master/CHANGELOG.md
+  changelog_uri: https://github.com/alexrudall/ruby-openai/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -87,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for the OpenAI GPT-3 API