ruby-openai 5.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 996d39cd32c3c05c73efea0177c12d0751b5dda208b2855aaac440af7b2702d8
-  data.tar.gz: 65471a670e34f537fe4878322c87978f1c2beaf93336a7f2104baaa86b018c60
+  metadata.gz: 88af78318c57c49636755099d6c8837e62762dee65e27465160b1d3778721edd
+  data.tar.gz: d6abf778678cf1813ce61efcf5874ecb0e4157a9cb08f6e958948b6d4f5d74ab
 SHA512:
-  metadata.gz: deab41c7c7f4ee21b4ed1a17f289b147b2e4960b33fd12ce863d5bdb8c835a955215d01438890c1ab8d9a1c7026faba0e5b8359c1fe3d9139082f8de58dce616
-  data.tar.gz: 3309d1c3a68736816c4f3bd1d465021ee3f162b5f5c3dbb7915ed5ce6f3a8d7014f9f1c4b07cf630f3f90201bdbe0ec308f1dc00fb6b075f45546fe519afb553
+  metadata.gz: 046c91484f51ea3973698c2bd3a7ff627df3a8413097757e4cd7debaf540ee40eb162cfdc6df41b2973cba3a5ef17014c8c18f544c777a5a45d93cb8530fe232
+  data.tar.gz: 196cd9c830e5e2639c16fc02431b2dfad8286cc098c85b47c6c42c2c64a2f570a8412f021846ffdff0c057a184a298c43c82e69b0f2ad1b25f048b0c76969422

data/CHANGELOG.md

@@ -5,6 +5,18 @@ 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).
 
+## [6.0.0] - 2023-11-06
+
+### Added
+
+- [BREAKING] HTTP errors will now be raised by ruby-openai as Faraday:Errors, including when streaming! Implemented by [@atesgoral](https://github.com/atesgoral)
+- [BREAKING] Switch from legacy Finetunes to the new Fine-tune-jobs endpoints. Implemented by [@lancecarlson](https://github.com/lancecarlson)
+- [BREAKING] Remove deprecated Completions endpoints - use Chat instead.
+
+### Fix
+
+- [BREAKING] Fix issue where :stream parameters where replaced by a boolean in the client application. Thanks to [@martinjaimem](https://github.com/martinjaimem), [@vickymadrid03](https://github.com/vickymadrid03) and [@nicastelo](https://github.com/nicastelo) for spotting and fixing this issue.
+
 ## [5.2.0] - 2023-10-30
 
 ### Fix

data/Gemfile

@@ -5,8 +5,8 @@ gemspec
 
 gem "byebug", "~> 11.1.3"
 gem "dotenv", "~> 2.8.1"
-gem "rake", "~> 13.0"
+gem "rake", "~> 13.1"
 gem "rspec", "~> 3.12"
 gem "rubocop", "~> 1.50.2"
 gem "vcr", "~> 6.1.0"
-gem "webmock", "~> 3.18.1"
+gem "webmock", "~> 3.19.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (5.2.0)
+    ruby-openai (6.0.0)
       event_stream_parser (>= 0.3.0, < 1.0.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
@@ -9,16 +9,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.1.1)
     byebug (11.1.3)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     dotenv (2.8.1)
     event_stream_parser (0.3.0)
-    faraday (2.7.10)
+    faraday (2.7.11)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
@@ -30,11 +32,11 @@ GEM
     parallel (1.22.1)
     parser (3.2.2.0)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
+    public_suffix (5.0.3)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     regexp_parser (2.8.0)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -64,7 +66,7 @@ GEM
     ruby2_keywords (0.0.5)
     unicode-display_width (2.4.2)
     vcr (6.1.0)
-    webmock (3.18.1)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -75,12 +77,12 @@ PLATFORMS
 DEPENDENCIES
   byebug (~> 11.1.3)
   dotenv (~> 2.8.1)
-  rake (~> 13.0)
+  rake (~> 13.1)
   rspec (~> 3.12)
   rubocop (~> 1.50.2)
   ruby-openai!
   vcr (~> 6.1.0)
-  webmock (~> 3.18.1)
+  webmock (~> 3.19.1)
 
 BUNDLED WITH
    2.4.5

data/README.md

@@ -149,7 +149,7 @@ client.models.retrieve(id: "text-ada-001")
 #### Examples
 
 - [GPT-4 (limited beta)](https://platform.openai.com/docs/models/gpt-4)
-  - gpt-4
+  - gpt-4 (uses current version)
   - gpt-4-0314
   - gpt-4-32k
 - [GPT-3.5](https://platform.openai.com/docs/models/gpt-3-5)
@@ -161,9 +161,9 @@ client.models.retrieve(id: "text-ada-001")
   - text-babbage-001
   - text-curie-001
 
-### ChatGPT
+### Chat
 
-ChatGPT is a model that can be used to generate text in a conversational style. You can use it to [generate a response](https://platform.openai.com/docs/api-reference/chat/create) to a sequence of [messages](https://platform.openai.com/docs/guides/chat/introduction):
+GPT is a model that can be used to generate text in a conversational style. You can use it to [generate a response](https://platform.openai.com/docs/api-reference/chat/create) to a sequence of [messages](https://platform.openai.com/docs/guides/chat/introduction):
 
 ```ruby
 response = client.chat(
@@ -176,11 +176,11 @@ puts response.dig("choices", 0, "message", "content")
 # => "Hello! How may I assist you today?"
 ```
 
-### Streaming ChatGPT
+### Streaming Chat
 
-[Quick guide to streaming ChatGPT with Rails 7 and Hotwire](https://gist.github.com/alexrudall/cb5ee1e109353ef358adb4e66631799d)
+[Quick guide to streaming Chat with Rails 7 and Hotwire](https://gist.github.com/alexrudall/cb5ee1e109353ef358adb4e66631799d)
 
-You can stream from the API in realtime, which can be much faster and used to create a more engaging user experience. Pass a [Proc](https://ruby-doc.org/core-2.6/Proc.html) (or any object with a `#call` method) to the `stream` parameter to receive the stream of text chunks as they are generated. Each time one or more chunks is received, the proc will be called once with each chunk, parsed as a Hash. If OpenAI returns an error, `ruby-openai` will pass that to your proc as a Hash.
+You can stream from the API in realtime, which can be much faster and used to create a more engaging user experience. Pass a [Proc](https://ruby-doc.org/core-2.6/Proc.html) (or any object with a `#call` method) to the `stream` parameter to receive the stream of completion chunks as they are generated. Each time one or more chunks is received, the proc will be called once with each chunk, parsed as a Hash. If OpenAI returns an error, `ruby-openai` will raise a Faraday error.
 
 ```ruby
 client.chat(
@@ -195,7 +195,7 @@ client.chat(
 # => "Anna is a young woman in her mid-twenties, with wavy chestnut hair that falls to her shoulders..."
 ```
 
-Note: the API docs state that token usage is included in the streamed chat chunk objects, but this doesn't currently appear to be the case. To count tokens while streaming, try `OpenAI.rough_token_count` or [tiktoken_ruby](https://github.com/IAPark/tiktoken_ruby).
+Note: OpenAPI currently does not report token usage for streaming responses. To count tokens while streaming, try `OpenAI.rough_token_count` or [tiktoken_ruby](https://github.com/IAPark/tiktoken_ruby). We think that each call to the stream proc corresponds to a single token, so you can also try counting the number of calls to the proc to get the completion token count.
 
 ### Functions
 
@@ -257,21 +257,6 @@ end
 # => "The weather is nice 🌞"
 ```
 
-### Completions
-
-Hit the OpenAI API for a completion using other GPT-3 models:
-
-```ruby
-response = client.completions(
-    parameters: {
-        model: "text-davinci-001",
-        prompt: "Once upon a time",
-        max_tokens: 5
-    })
-puts response["choices"].map { |c| c["text"] }
-# => [", there lived a great"]
-```
-
 ### Edits
 
 Send a string and some instructions for what to do to the string:
@@ -323,22 +308,22 @@ client.files.content(id: "file-123")
 client.files.delete(id: "file-123")
 ```
 
-### Fine-tunes
+### Finetunes
 
 Upload your fine-tuning data in a `.jsonl` file as above and get its ID:
 
 ```ruby
-response = client.files.upload(parameters: { file: "path/to/sentiment.jsonl", purpose: "fine-tune" })
+response = client.files.upload(parameters: { file: "path/to/sarcasm.jsonl", purpose: "fine-tune" })
 file_id = JSON.parse(response.body)["id"]
 ```
 
-You can then use this file ID to create a fine-tune model:
+You can then use this file ID to create a fine tuning job:
 
 ```ruby
 response = client.finetunes.create(
     parameters: {
     training_file: file_id,
-    model: "ada"
+    model: "gpt-3.5-turbo-0613"
 })
 fine_tune_id = response["id"]
 ```
@@ -369,10 +354,10 @@ response = client.completions(
 response.dig("choices", 0, "text")
 ```
 
-You can delete the fine-tuned model when you are done with it:
+You can also capture the events for a job:
 
-```ruby
-client.finetunes.delete(fine_tuned_model: fine_tuned_model)
+```
+client.finetunes.list_events(id: fine_tune_id)
 ```
 
 ### Image Generation
@@ -455,6 +440,18 @@ puts response["text"]
 # => "Transcription of the text"
 ```
 
+#### Errors
+
+HTTP errors can be caught like this:
+
+```
+  begin
+    OpenAI::Client.new.models.retrieve(id: "text-ada-001")
+  rescue Faraday::Error => e
+    raise "Got a Faraday error: #{e}"
+  end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/openai/client.rb

@@ -25,10 +25,6 @@ module OpenAI
       json_post(path: "/chat/completions", parameters: parameters)
     end
 
-    def completions(parameters: {})
-      json_post(path: "/completions", parameters: parameters)
-    end
-
     def edits(parameters: {})
       json_post(path: "/edits", parameters: parameters)
     end

data/lib/openai/finetunes.rb

@@ -5,31 +5,23 @@ module OpenAI
     end
 
     def list
-      @client.get(path: "/fine-tunes")
+      @client.get(path: "/fine_tuning/jobs")
     end
 
     def create(parameters: {})
-      @client.json_post(path: "/fine-tunes", parameters: parameters)
+      @client.json_post(path: "/fine_tuning/jobs", parameters: parameters)
     end
 
     def retrieve(id:)
-      @client.get(path: "/fine-tunes/#{id}")
+      @client.get(path: "/fine_tuning/jobs/#{id}")
     end
 
     def cancel(id:)
-      @client.multipart_post(path: "/fine-tunes/#{id}/cancel")
+      @client.json_post(path: "/fine_tuning/jobs/#{id}/cancel", parameters: {})
     end
 
-    def events(id:)
-      @client.get(path: "/fine-tunes/#{id}/events")
-    end
-
-    def delete(fine_tuned_model:)
-      if fine_tuned_model.start_with?("ft-")
-        raise ArgumentError, "Please give a fine_tuned_model name, not a fine-tune ID"
-      end
-
-      @client.delete(path: "/models/#{fine_tuned_model}")
+    def list_events(id:)
+      @client.get(path: "/fine_tuning/jobs/#{id}/events")
     end
   end
 end

data/lib/openai/http.rb

@@ -3,55 +3,46 @@ require "event_stream_parser"
 module OpenAI
   module HTTP
     def get(path:)
-      to_json(conn.get(uri(path: path)) do |req|
+      parse_jsonl(conn.get(uri(path: path)) do |req|
         req.headers = headers
       end&.body)
     end
 
     def json_post(path:, parameters:)
-      to_json(conn.post(uri(path: path)) do |req|
-        if parameters[:stream].respond_to?(:call)
-          req.options.on_data = to_json_stream(user_proc: parameters[:stream])
-          parameters[:stream] = true # Necessary to tell OpenAI to stream.
-        elsif parameters[:stream]
-          raise ArgumentError, "The stream parameter must be a Proc or have a #call method"
-        end
-
-        req.headers = headers
-        req.body = parameters.to_json
-      end&.body)
+      conn.post(uri(path: path)) do |req|
+        configure_json_post_request(req, parameters)
+      end&.body
     end
 
     def multipart_post(path:, parameters: nil)
-      to_json(conn(multipart: true).post(uri(path: path)) do |req|
+      conn(multipart: true).post(uri(path: path)) do |req|
         req.headers = headers.merge({ "Content-Type" => "multipart/form-data" })
         req.body = multipart_parameters(parameters)
-      end&.body)
+      end&.body
     end
 
     def delete(path:)
-      to_json(conn.delete(uri(path: path)) do |req|
+      conn.delete(uri(path: path)) do |req|
         req.headers = headers
-      end&.body)
+      end&.body
     end
 
     private
 
-    def to_json(string)
-      return unless string
+    def parse_jsonl(response)
+      return unless response
+      return response unless response.is_a?(String)
 
-      JSON.parse(string)
-    rescue JSON::ParserError
       # Convert a multiline string of JSON objects to a JSON array.
-      JSON.parse(string.gsub("}\n{", "},{").prepend("[").concat("]"))
+      response = response.gsub("}\n{", "},{").prepend("[").concat("]")
+
+      JSON.parse(response)
     end
 
     # Given a proc, returns an outer proc that can be used to iterate over a JSON stream of chunks.
     # For each chunk, the inner user_proc is called giving it the JSON object. The JSON object could
     # be a data object or an error object as described in the OpenAI API documentation.
     #
-    # If the JSON object for a given data or error message is invalid, it is ignored.
-    #
     # @param user_proc [Proc] The inner proc to call for each JSON object in the chunk.
     # @return [Proc] An outer proc that iterates over a raw stream, converting it to JSON.
     def to_json_stream(user_proc:)
@@ -59,25 +50,22 @@ module OpenAI
 
       proc do |chunk, _bytes, env|
         if env && env.status != 200
-          emit_json(json: chunk, user_proc: user_proc)
-        else
-          parser.feed(chunk) do |_type, data|
-            emit_json(json: data, user_proc: user_proc) unless data == "[DONE]"
-          end
+          raise_error = Faraday::Response::RaiseError.new
+          raise_error.on_complete(env.merge(body: JSON.parse(chunk)))
         end
-      end
-    end
 
-    def emit_json(json:, user_proc:)
-      user_proc.call(JSON.parse(json))
-    rescue JSON::ParserError
-      # Ignore invalid JSON.
+        parser.feed(chunk) do |_type, data|
+          user_proc.call(JSON.parse(data)) unless data == "[DONE]"
+        end
+      end
     end
 
     def conn(multipart: false)
       Faraday.new do |f|
         f.options[:timeout] = @request_timeout
         f.request(:multipart) if multipart
+        f.response :raise_error
+        f.response :json
       end
     end
 
@@ -123,5 +111,19 @@ module OpenAI
         Faraday::UploadIO.new(value, "", value.path)
       end
     end
+
+    def configure_json_post_request(req, parameters)
+      req_parameters = parameters.dup
+
+      if parameters[:stream].respond_to?(:call)
+        req.options.on_data = to_json_stream(user_proc: parameters[:stream])
+        req_parameters[:stream] = true # Necessary to tell OpenAI to stream.
+      elsif parameters[:stream]
+        raise ArgumentError, "The stream parameter must be a Proc or have a #call method"
+      end
+
+      req.headers = headers
+      req.body = req_parameters.to_json
+    end
   end
 end

data/lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "5.2.0".freeze
+  VERSION = "6.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser