ruby-openai 7.4.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 636458da173c91f143246acd3a13d2092345cfe9c2ad8b0496b4b5520f215272
-  data.tar.gz: 7705418143eccf24f1b4bc97abab406919ac7297e130bbdde498081ad3539b61
+  metadata.gz: 25124958f17722e0cc4168772bf02daf283b0d43dd2a2c143575ad23fc5539ac
+  data.tar.gz: cfaa4cb81ee668a4296774d7bce0591a2c23a3f0944794acde1db3e89586d199
 SHA512:
-  metadata.gz: a2f6e3b4b275283e526bec8e68743156cd80840309d66050b74d1ab493695fcd6099fa0383f8b462cb6369af2a6118a8d83dd899e4d8a6a29e2d801ea9ecddd1
-  data.tar.gz: 9e26a6e2b5a0b6f8b05ad7bb5c0799fa3a85aa96e772c020bd33332bf476b45c40a8d3574c7b11d057889d39040efb9d87e80bfb5932bf604f19cdef8122b05b
+  metadata.gz: d2ded6da66a157a190c24b0f7748a833d13ae9a4da67b52879eae8510e74cd90d80ffa6faaf573375c3a26d74b091165af6b30ca51c4cf860b1ba6f5c633cbdf
+  data.tar.gz: d31a28fafe6cac7caa99537f97a0fa1b0b918ebea09371d730e6d425b9bf228c726d9207c7a2bd08070103d49c9aa71e34ecf4f7ea888c2321f5fa128abf4fdc

data/.circleci/config.yml

@@ -38,9 +38,9 @@ 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
                 - cimg/ruby:3.2-node
                 - cimg/ruby:3.3-node
+                - cimg/ruby:3.4-node

data/CHANGELOG.md

@@ -5,7 +5,35 @@ 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).
 
-## [7.4.0] - 2024-02-10
+## [8.1.0] - 2025-03-30
+
+### Added
+
+- Add Vector#search endpoint - thank you [@jaebrownn](https://github.com/jaebrownn) for this PR!
+
+## [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
 

data/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"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (7.4.0)
+    ruby-openai (8.1.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

data/README.md

@@ -1,11 +1,12 @@
 # Ruby OpenAI
+
 [![Gem Version](https://img.shields.io/gem/v/ruby-openai.svg)](https://rubygems.org/gems/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)
 
 Use the [OpenAI API](https://openai.com/blog/openai-api/) with Ruby! 🤖❤️
 
-Stream text with GPT-4, transcribe and translate audio with Whisper, or create images with DALL·E...
+Stream chats with the Responses API, transcribe and translate audio with Whisper, create images with DALL·E, and much more...
 
 💥 Click [subscribe now](https://mailchi.mp/8c7b574726a9/ruby-openai) to hear first about new releases in the Rails AI newsletter!
 
@@ -16,7 +17,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
 ## Contents
 
 - [Ruby OpenAI](#ruby-openai)
-- [Table of Contents](#table-of-contents)
+  - [Contents](#contents)
   - [Installation](#installation)
     - [Bundler](#bundler)
     - [Gem install](#gem-install)
@@ -29,6 +30,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
         - [Errors](#errors)
         - [Faraday middleware](#faraday-middleware)
       - [Azure](#azure)
+      - [Deepseek](#deepseek)
       - [Ollama](#ollama)
       - [Groq](#groq)
     - [Counting Tokens](#counting-tokens)
@@ -37,6 +39,14 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
       - [Streaming Chat](#streaming-chat)
       - [Vision](#vision)
       - [JSON Mode](#json-mode)
+    - [Responses API](#responses-api)
+      - [Create a Response](#create-a-response)
+      - [Follow-up Messages](#follow-up-messages)
+      - [Tool Calls](#tool-calls)
+      - [Streaming](#streaming)
+      - [Retrieve a Response](#retrieve-a-response)
+      - [Delete a Response](#delete-a-response)
+      - [List Input Items](#list-input-items)
     - [Functions](#functions)
     - [Completions](#completions)
     - [Embeddings](#embeddings)
@@ -68,6 +78,7 @@ Stream text with GPT-4, transcribe and translate audio with Whisper, or create i
     - [Usage](#usage)
     - [Errors](#errors-1)
   - [Development](#development)
+    - [To check for deprecations](#to-check-for-deprecations)
   - [Release](#release)
   - [Contributing](#contributing)
   - [License](#license)
@@ -86,7 +97,7 @@ gem "ruby-openai"
 And then execute:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
 ### Gem install
@@ -94,7 +105,7 @@ $ bundle install
 Or install with:
 
 ```bash
-$ gem install ruby-openai
+gem install ruby-openai
 ```
 
 and require with:
@@ -228,6 +239,28 @@ end
 
 where `AZURE_OPENAI_URI` is e.g. `https://custom-domain.openai.azure.com/openai/deployments/gpt-35-turbo`
 
+#### Deepseek
+
+[Deepseek](https://api-docs.deepseek.com/) is compatible with the OpenAI chat API. Get an access token from [here](https://platform.deepseek.com/api_keys), then:
+
+```ruby
+client = OpenAI::Client.new(
+  access_token: "deepseek_access_token_goes_here",
+  uri_base: "https://api.deepseek.com/"
+)
+
+client.chat(
+  parameters: {
+    model: "deepseek-chat", # Required.
+    messages: [{ role: "user", content: "Hello!"}], # Required.
+    temperature: 0.7,
+    stream: proc do |chunk, _bytesize|
+     print chunk.dig("choices", 0, "delta", "content")
+    end
+  }
+)
+```
+
 #### Ollama
 
 Ollama allows you to run open-source LLMs, such as Llama 3, locally. It [offers chat compatibility](https://github.com/ollama/ollama/blob/main/docs/openai.md) with the OpenAI API.
@@ -304,6 +337,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):
@@ -441,6 +480,102 @@ You can stream it as well!
   # }
 ```
 
+### Responses API
+
+[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! I'm Szymon!"
+})
+puts response.dig("output", 0, "content", 0, "text")
+# => Hello Szymon! How can I assist you today?
+```
+
+#### Follow-up Messages
+
+```ruby
+followup = client.responses.create(parameters: {
+  model: "gpt-4o",
+  input: "Remind me, what is my name?",
+  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
+
+```ruby
+response = client.responses.create(parameters: {
+  model: "gpt-4o",
+  input: "What's the weather in Paris?",
+  tools: [
+    {
+      "type" => "function",
+      "name" => "get_current_weather",
+      "description" => "Get the current weather in a given location",
+      "parameters" => {
+        "type" => "object",
+        "properties" => {
+          "location" => {
+            "type" => "string",
+            "description" => "The geographic location to get the weather for"
+          }
+        },
+        "required" => ["location"]
+      }
+    }
+  ]
+})
+puts response.dig("output", 0, "name")
+# => "get_current_weather"
+```
+
+#### Streaming
+
+```ruby
+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"
+```
+
+#### Delete a Response
+
+```ruby
+deletion = client.responses.delete(response_id: response["id"])
+puts deletion["deleted"]
+# => true
+```
+
+#### List Input Items
+
+```ruby
+input_items = client.responses.input_items(response_id: response["id"])
+puts input_items["object"] # => "list"
+```
+
 ### Functions
 
 You can describe and pass in functions and the model will intelligently choose to output a JSON object containing arguments to call them - eg., to use your method `get_current_weather` to get the weather in a given location. Note that tool_choice is optional, but if you exclude it, the model will choose whether to use the function or not ([see here](https://platform.openai.com/docs/api-reference/chat/create#chat-create-tool_choice)).
@@ -746,6 +881,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.
@@ -786,6 +927,27 @@ response = client.vector_stores.modify(
 )
 ```
 
+You can search a vector store for relevant chunks based on a query:
+
+```ruby
+response = client.vector_stores.search(
+  id: vector_store_id,
+  parameters: {
+    query: "What is the return policy?",
+    max_num_results: 20,
+    ranking_options: {
+      # Add any ranking options here in line with the API documentation
+    },
+    rewrite_query: true,
+    filters: {
+      type: "eq",
+      property: "region",
+      value: "us"
+    }
+  }
+)
+```
+
 You can delete vector stores:
 
 ```ruby
@@ -1464,6 +1626,7 @@ File.binwrite('demo.mp3', response)
 ```
 
 ### Usage
+
 The Usage API provides information about the cost of various OpenAI services within your organization.
 To use Admin APIs like Usage, you need to set an OPENAI_ADMIN_TOKEN, which can be generated [here](https://platform.openai.com/settings/organization/admin-keys).
 
@@ -1544,6 +1707,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.

data/lib/openai/batches.rb

@@ -1,7 +1,7 @@
 module OpenAI
   class Batches
     def initialize(client:)
-      @client = client.beta(assistants: OpenAI::Assistants::BETA_VERSION)
+      @client = client
     end
 
     def list(parameters: {})

data/lib/openai/client.rb

@@ -5,7 +5,7 @@ module OpenAI
     SENSITIVE_ATTRIBUTES = %i[@access_token @admin_token @organization_id @extra_headers].freeze
     CONFIG_KEYS = %i[access_token admin_token api_type api_version extra_headers
                      log_errors organization_id request_timeout uri_base].freeze
-    attr_reader *CONFIG_KEYS, :faraday_middleware
+    attr_reader(*CONFIG_KEYS, :faraday_middleware)
     attr_writer :access_token
 
     def initialize(config = {}, &faraday_middleware)
@@ -52,6 +52,10 @@ module OpenAI
       @models ||= OpenAI::Models.new(client: self)
     end
 
+    def responses
+      @responses ||= OpenAI::Responses.new(client: self)
+    end
+
     def assistants
       @assistants ||= OpenAI::Assistants.new(client: self)
     end

data/lib/openai/files.rb

@@ -5,6 +5,8 @@ module OpenAI
       batch
       fine-tune
       vision
+      user_data
+      evals
     ].freeze
 
     def initialize(client:)
@@ -18,9 +20,7 @@ module OpenAI
     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)
@@ -55,8 +55,12 @@ module OpenAI
 
     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")

data/lib/openai/http.rb

@@ -7,47 +7,52 @@ module OpenAI
     include HTTPHeaders
 
     def get(path:, parameters: nil)
-      parse_jsonl(conn.get(uri(path: path), parameters) do |req|
+      parse_json(conn.get(uri(path: path), parameters) do |req|
         req.headers = headers
       end&.body)
     end
 
     def post(path:)
-      parse_jsonl(conn.post(uri(path: path)) do |req|
+      parse_json(conn.post(uri(path: path)) do |req|
         req.headers = headers
       end&.body)
     end
 
     def json_post(path:, parameters:, query_parameters: {})
-      conn.post(uri(path: path)) do |req|
+      parse_json(conn.post(uri(path: path)) do |req|
         configure_json_post_request(req, parameters)
         req.params = req.params.merge(query_parameters)
-      end&.body
+      end&.body)
     end
 
     def multipart_post(path:, parameters: nil)
-      conn(multipart: true).post(uri(path: path)) do |req|
+      parse_json(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:)
-      conn.delete(uri(path: path)) do |req|
+      parse_json(conn.delete(uri(path: path)) do |req|
         req.headers = headers
-      end&.body
+      end&.body)
     end
 
     private
 
-    def parse_jsonl(response)
+    def parse_json(response)
       return unless response
       return response unless response.is_a?(String)
 
-      # Convert a multiline string of JSON objects to a JSON array.
-      response = response.gsub("}\n{", "},{").prepend("[").concat("]")
+      original_response = response.dup
+      if response.include?("}\n{")
+        # Attempt to convert what looks like a multiline string of JSON objects to a JSON array.
+        response = response.gsub("}\n{", "},{").prepend("[").concat("]")
+      end
 
       JSON.parse(response)
+    rescue JSON::ParserError
+      original_response
     end
 
     # Given a proc, returns an outer proc that can be used to iterate over a JSON stream of chunks.

data/lib/openai/models.rb

@@ -11,5 +11,9 @@ module OpenAI
     def retrieve(id:)
       @client.get(path: "/models/#{id}")
     end
+
+    def delete(id:)
+      @client.delete(path: "/models/#{id}")
+    end
   end
 end

data/lib/openai/responses.rb

@@ -0,0 +1,23 @@
+module OpenAI
+  class Responses
+    def initialize(client:)
+      @client = client
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/responses", parameters: parameters)
+    end
+
+    def retrieve(response_id:)
+      @client.get(path: "/responses/#{response_id}")
+    end
+
+    def delete(response_id:)
+      @client.delete(path: "/responses/#{response_id}")
+    end
+
+    def input_items(response_id:, parameters: {})
+      @client.get(path: "/responses/#{response_id}/input_items", parameters: parameters)
+    end
+  end
+end

data/lib/openai/vector_stores.rb

@@ -23,5 +23,9 @@ module OpenAI
     def delete(id:)
       @client.delete(path: "/vector_stores/#{id}")
     end
+
+    def search(id:, parameters: {})
+      @client.json_post(path: "/vector_stores/#{id}/search", parameters: parameters)
+    end
   end
 end

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -1,12 +1,12 @@
 require "faraday"
-require "faraday/multipart"
-
+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"
 require_relative "openai/finetunes"
 require_relative "openai/images"
 require_relative "openai/models"
+require_relative "openai/responses"
 require_relative "openai/assistants"
 require_relative "openai/threads"
 require_relative "openai/messages"
@@ -31,12 +31,7 @@ module OpenAI
     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
@@ -72,25 +67,38 @@ module OpenAI
 
   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

data/lib/ruby/openai.rb

@@ -1,2 +1 @@
 require_relative "../openai"
-require_relative "../openai/compatibility"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Alex
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -91,7 +91,6 @@ files:
 - lib/openai/audio.rb
 - lib/openai/batches.rb
 - lib/openai/client.rb
-- lib/openai/compatibility.rb
 - lib/openai/files.rb
 - lib/openai/finetunes.rb
 - lib/openai/http.rb
@@ -99,6 +98,7 @@ files:
 - lib/openai/images.rb
 - lib/openai/messages.rb
 - lib/openai/models.rb
+- lib/openai/responses.rb
 - lib/openai/run_steps.rb
 - lib/openai/runs.rb
 - lib/openai/threads.rb

data/lib/openai/compatibility.rb

@@ -1,11 +0,0 @@
-module Ruby
-  module OpenAI
-    VERSION = ::OpenAI::VERSION
-
-    Error = ::OpenAI::Error
-    AuthenticationError = ::OpenAI::AuthenticationError
-    ConfigurationError = ::OpenAI::ConfigurationError
-    Configuration = ::OpenAI::Configuration
-    MiddlewareErrors = ::OpenAI::MiddlewareErrors
-  end
-end