Merge pull request #569 from alexrudall/8.0.0

v8

Author: alexrudall

.circleci/config.yml

@@ -38,7 +38,6 @@ workflows:
           matrix:
             parameters:
               ruby-image:
-                - cimg/ruby:2.6-node
                 - cimg/ruby:2.7-node
                 - cimg/ruby:3.0-node
                 - cimg/ruby:3.1-node

CHANGELOG.md

@@ -5,6 +5,28 @@ 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).
 
+## [8.0.0] - 2025-03-14
+
+### Added
+
+- Add Responses endpoints - thanks to my excellent colleague [@simonx1](https://github.com/simonx1) for your work on this!
+- Add docs for the Deepseek chat API.
+- Add Models#delete - thanks to [bennysghost](https://github.com/bennysghost).
+
+### Fixed
+
+- [BREAKING] Try to JSON parse everything. If it fails, fall back gracefully to returning the raw response. Thank you to [@gregszero](https://github.com/gregszero) and the many others who raised this issue.
+- [BREAKING] An unknown file type will no longer prevent file upload, but instead raise a warning.
+- [BREAKING] ruby-openai longer requires "faraday/multipart" for Faraday 1 users (Faraday 1 already includes it and it was causing a warning). Thanks to [ajGingrich](https://github.com/ajGingrich) for raising this!
+- Add `user_data` and `evals` as options for known File types - thank you to [jontec](https://github.com/jontec) for this fix!
+- Fix a syntax ambiguity in Client.rb - thank you to [viralpraxis](https://github.com/viralpraxis).
+
+### Removed
+
+- [BREAKING] Backwards compatibility for `require "ruby/openai"` is removed - from v8 on you MUST use `require "openai"`. This fixes a deprecation warning with Ruby 3.4. Thanks to [@ndemianc](https://github.com/ndemianc) for this PR.
+- [BREAKING] Removed support for Ruby 2.6. ruby-openai may still work with this version but it's no longer supported.
+- Removed the 'OpenAI-Beta' header from Batches API requests.
+
 ## [7.4.0] - 2025-02-10
 
 ### Added

Gemfile

@@ -3,10 +3,11 @@ source "https://rubygems.org"
 # Include gem dependencies from ruby-openai.gemspec
 gemspec
 
+# Development dependencies. Not included in the publised gem.
 gem "byebug", "~> 11.1.3"
-gem "dotenv", "~> 2.8.1"
-gem "rake", "~> 13.2"
+gem "dotenv", "~> 2.8.1" # >= v3 will require removing support for Ruby 2.7 from CI.
+gem "rake", "~> 13.2.1"
 gem "rspec", "~> 3.13"
-gem "rubocop", "~> 1.50.2"
-gem "vcr", "~> 6.1.0"
-gem "webmock", "~> 3.24.0"
+gem "rubocop", "~> 1.74.0"
+gem "vcr", "~> 6.3.1"
+gem "webmock", "~> 3.25.1"

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (7.4.0)
+    ruby-openai (8.0.0)
       event_stream_parser (>= 0.3.0, < 2.0.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
@@ -13,7 +13,7 @@ GEM
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
+    bigdecimal (3.1.9)
     byebug (11.1.3)
     crack (1.0.0)
       bigdecimal
@@ -28,16 +28,20 @@ GEM
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
     faraday-net_http (3.0.2)
-    hashdiff (1.1.1)
-    json (2.6.3)
+    hashdiff (1.1.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
     multipart-post (2.3.0)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
-    public_suffix (5.1.1)
+      racc
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.8.0)
+    regexp_parser (2.10.0)
     rexml (3.3.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -52,23 +56,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.50.2)
+    rubocop (1.74.0)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    unicode-display_width (2.4.2)
-    vcr (6.1.0)
-    webmock (3.24.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -79,12 +87,12 @@ PLATFORMS
 DEPENDENCIES
   byebug (~> 11.1.3)
   dotenv (~> 2.8.1)
-  rake (~> 13.2)
+  rake (~> 13.2.1)
   rspec (~> 3.13)
-  rubocop (~> 1.50.2)
+  rubocop (~> 1.74.0)
   ruby-openai!
-  vcr (~> 6.1.0)
-  webmock (~> 3.24.0)
+  vcr (~> 6.3.1)
+  webmock (~> 3.25.1)
 
 BUNDLED WITH
    2.4.5

README.md

@@ -328,6 +328,12 @@ client.models.list
 client.models.retrieve(id: "gpt-4o")
 ```
 
+You can also delete any finetuned model you generated, if you're an account Owner on your OpenAI organization:
+
+```ruby
+client.models.delete(id: "ft:gpt-4o-mini:acemeco:suffix:abc123")
+```
+
 ### Chat
 
 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):
@@ -466,15 +472,16 @@ You can stream it as well!
 ```
 
 ### Responses API
-OpenAI's most advanced interface for generating model responses. Supports text and image inputs, and text outputs. Create stateful interactions with the model, using the output of previous responses as input. Extend the model's capabilities with built-in tools for file search, web search, computer use, and more. Allow the model access to external systems and data using function calling.
+[OpenAI's most advanced interface for generating model responses](https://platform.openai.com/docs/api-reference/responses). Supports text and image inputs, and text outputs. Create stateful interactions with the model, using the output of previous responses as input. Extend the model's capabilities with built-in tools for file search, web search, computer use, and more. Allow the model access to external systems and data using function calling.
 
 #### Create a Response
 ```ruby
 response = client.responses.create(parameters: {
   model: "gpt-4o",
-  input: "Hello!"
+  input: "Hello! I'm Szymon!"
 })
 puts response.dig("output", 0, "content", 0, "text")
+# => Hello Szymon! How can I assist you today?
 ```
 
 #### Follow-up Messages
@@ -485,6 +492,7 @@ followup = client.responses.create(parameters: {
   previous_response_id: response["id"]
 })
 puts followup.dig("output", 0, "content", 0, "text")
+# => Your name is Szymon! How can I help you today?
 ```
 
 #### Tool Calls
@@ -510,35 +518,39 @@ response = client.responses.create(parameters: {
     }
   ]
 })
-puts response.dig("output", 0, "name") # => "get_current_weather"
+puts response.dig("output", 0, "name")
+# => "get_current_weather"
 ```
 
 #### Streaming
 ```ruby
-chunks = []
-streamer = proc { |chunk, _| chunks << chunk }
-client.responses.create(parameters: {
-  model: "gpt-4o",
-  input: "Hello!",
-  stream: streamer
-})
-output = chunks
-  .select { |c| c["type"] == "response.output_text.delta" }
-  .map { |c| c["delta"] }
-  .join
-puts output
+client.responses.create(
+  parameters: {
+    model: "gpt-4o", # Required.
+    input: "Hello!", # Required.
+    stream: proc do |chunk, _bytesize|
+      if chunk["type"] == "response.output_text.delta"
+        print chunk["delta"]
+        $stdout.flush  # Ensure output is displayed immediately
+      end
+    end
+  }
+)
+# => "Hi there! How can I assist you today?..."
 ```
 
 #### Retrieve a Response
 ```ruby
 retrieved_response = client.responses.retrieve(response_id: response["id"])
-puts retrieved_response["object"] # => "response"
+puts retrieved_response["object"]
+# => "response"
 ```
 
 #### Delete a Response
 ```ruby
 deletion = client.responses.delete(response_id: response["id"])
-puts deletion["deleted"] # => true
+puts deletion["deleted"]
+# => true
 ```
 
 #### List Input Items
@@ -852,6 +864,12 @@ You can also capture the events for a job:
 client.finetunes.list_events(id: fine_tune_id)
 ```
 
+You can also delete any finetuned model you generated, if you're an account Owner on your OpenAI organization:
+
+```ruby
+client.models.delete(id: fine_tune_id)
+```
+
 ### Vector Stores
 
 Vector Store objects give the File Search tool the ability to search your files.
@@ -1650,6 +1668,12 @@ To run all tests, execute the command `bundle exec rake`, which will also run th
 > [!WARNING]
 > If you have an `OPENAI_ACCESS_TOKEN` and `OPENAI_ADMIN_TOKEN` in your `ENV`, running the specs will hit the actual API, which will be slow and cost you money - 2 cents or more! Remove them from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.
 
+### To check for deprecations
+
+```
+bundle exec ruby -e "Warning[:deprecated] = true; require 'rspec'; exit RSpec::Core::Runner.run(['spec/openai/client/http_spec.rb:25'])"
+```
+
 ## Release
 
 First run the specs without VCR so they actually hit the API. This will cost 2 cents or more. Set OPENAI_ACCESS_TOKEN and OPENAI_ADMIN_TOKEN in your environment.

lib/openai.rb

@@ -1,6 +1,5 @@
 require "faraday"
 require "faraday/multipart" if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new("2.0")
-
 require_relative "openai/http"
 require_relative "openai/client"
 require_relative "openai/files"
@@ -32,12 +31,7 @@ def call(env)
     rescue Faraday::Error => e
       raise e unless e.response.is_a?(Hash)
 
-      logger = Logger.new($stdout)
-      logger.formatter = proc do |_severity, _datetime, _progname, msg|
-        "\033[31mOpenAI HTTP Error (spotted in ruby-openai #{VERSION}): #{msg}\n\033[0m"
-      end
-      logger.error(e.response[:body])
-
+      OpenAI.log_message("OpenAI HTTP Error", e.response[:body], :error)
       raise e
     end
   end
@@ -73,25 +67,38 @@ def initialize
 
   class << self
     attr_writer :configuration
-  end
 
-  def self.configuration
-    @configuration ||= OpenAI::Configuration.new
-  end
+    def configuration
+      @configuration ||= OpenAI::Configuration.new
+    end
 
-  def self.configure
-    yield(configuration)
-  end
+    def configure
+      yield(configuration)
+    end
 
-  # Estimate the number of tokens in a string, using the rules of thumb from OpenAI:
-  # https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them
-  def self.rough_token_count(content = "")
-    raise ArgumentError, "rough_token_count requires a string" unless content.is_a? String
-    return 0 if content.empty?
+    # Estimate the number of tokens in a string, using the rules of thumb from OpenAI:
+    # https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them
+    def rough_token_count(content = "")
+      raise ArgumentError, "rough_token_count requires a string" unless content.is_a? String
+      return 0 if content.empty?
+
+      count_by_chars = content.size / 4.0
+      count_by_words = content.split.size * 4.0 / 3
+      estimate = ((count_by_chars + count_by_words) / 2.0).round
+      [1, estimate].max
+    end
 
-    count_by_chars = content.size / 4.0
-    count_by_words = content.split.size * 4.0 / 3
-    estimate = ((count_by_chars + count_by_words) / 2.0).round
-    [1, estimate].max
+    # Log a message with appropriate formatting
+    # @param prefix [String] Prefix to add to the message
+    # @param message [String] The message to log
+    # @param level [Symbol] The log level (:error, :warn, etc.)
+    def log_message(prefix, message, level = :warn)
+      color = level == :error ? "\033[31m" : "\033[33m"
+      logger = Logger.new($stdout)
+      logger.formatter = proc do |_severity, _datetime, _progname, msg|
+        "#{color}#{prefix} (spotted in ruby-openai #{VERSION}): #{msg}\n\033[0m"
+      end
+      logger.send(level, message)
+    end
   end
 end

lib/openai/files.rb

@@ -20,9 +20,7 @@ def list(parameters: {})
     def upload(parameters: {})
       file_input = parameters[:file]
       file = prepare_file_input(file_input: file_input)
-
       validate(file: file, purpose: parameters[:purpose], file_input: file_input)
-
       @client.multipart_post(
         path: "/files",
         parameters: parameters.merge(file: file)
@@ -57,8 +55,12 @@ def prepare_file_input(file_input:)
 
     def validate(file:, purpose:, file_input:)
       raise ArgumentError, "`file` is required" if file.nil?
+
       unless PURPOSES.include?(purpose)
-        raise ArgumentError, "`purpose` must be one of `#{PURPOSES.join(',')}`"
+        filename = file_input.is_a?(String) ? File.basename(file_input) : "uploaded file"
+        message = "The purpose '#{purpose}' for file '#{filename}' is not in the known purpose "
+        message += "list: #{PURPOSES.join(', ')}."
+        OpenAI.log_message("Warning", message, :warn)
       end
 
       validate_jsonl(file: file) if file_input.is_a?(String) && file_input.end_with?(".jsonl")

lib/openai/version.rb

@@ -1,3 +1,3 @@
 module OpenAI
-  VERSION = "7.4.0".freeze
+  VERSION = "8.0.0".freeze
 end