ruby-openai 5.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 996d39cd32c3c05c73efea0177c12d0751b5dda208b2855aaac440af7b2702d8
-  data.tar.gz: 65471a670e34f537fe4878322c87978f1c2beaf93336a7f2104baaa86b018c60
+  metadata.gz: 2e2bdf19ad32b8eb492faca3e937614c30ab57817c374797362ca27ffff1cf7e
+  data.tar.gz: b3d31aaa13bec5bdeb08718c04afad99b528e9e5c1bfbd279a8111e4fa12739c
 SHA512:
-  metadata.gz: deab41c7c7f4ee21b4ed1a17f289b147b2e4960b33fd12ce863d5bdb8c835a955215d01438890c1ab8d9a1c7026faba0e5b8359c1fe3d9139082f8de58dce616
-  data.tar.gz: 3309d1c3a68736816c4f3bd1d465021ee3f162b5f5c3dbb7915ed5ce6f3a8d7014f9f1c4b07cf630f3f90201bdbe0ec308f1dc00fb6b075f45546fe519afb553
+  metadata.gz: bf6f46dbb52890ff1468d727711681ad95bb82e26b77f092cf6a81be25dbdb7ef3b3a58626090160bfc927ec3585723c17a9c47005ff64b035a3af85ba887e51
+  data.tar.gz: cbe3a5d6c57757beee533c3b9c05aa43fb343f7da542af4fc58bf70223f84cc674900d032e824f1c34e19ef17a2ba0d366fe9353dae67db162ce435ef2f1a496

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).
 
+## [6.3.0] - 2023-11-26
+
+### Added
+
+- Add ability to pass [Faraday middleware](https://lostisland.github.io/faraday/#/middleware/index) to the client in a block, eg. to enable verbose logging - shout out to [@obie](https://github.com/obie) for pushing for this.
+- Add better error logging to the client by default.
+- Bump Event Source to v1, thank you [@atesgoral](https://github.com/atesgoral) @ Shopify!
+
+## [6.2.0] - 2023-11-15
+
+### Added
+
+- Add text-to-speech! Thank you [@codergeek121](https://github.com/codergeek121)
+
+## [6.1.0] - 2023-11-14
+
+### Added
+
+- Add support for Assistants, Threads, Messages and Runs. Thank you [@Haegin](https://github.com/Haegin) for the excellent work on this PR, and many reviewers for their contributions!
+
+## [6.0.1] - 2023-11-07
+
+### Fix
+
+- Gracefully handle the case where an HTTP error response may not have valid JSON in its body. Thank you [@atesgoral](https://github.com/atesgoral)!
+
+## [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 were 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,24 +1,26 @@
 PATH
   remote: .
   specs:
-    ruby-openai (5.2.0)
-      event_stream_parser (>= 0.3.0, < 1.0.0)
+    ruby-openai (6.3.0)
+      event_stream_parser (>= 0.3.0, < 2.0.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
 
 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)
+    event_stream_parser (1.0.0)
+    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

@@ -1,6 +1,6 @@
 # Ruby OpenAI
 
-[![Gem Version](https://badge.fury.io/rb/ruby-openai.svg)](https://badge.fury.io/rb/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)
 
@@ -8,9 +8,7 @@ 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...
 
-🚢 Based in the UK and want to hire me? Now you can! [railsai.com](https://railsai.com?utm_source=ruby-openai&utm_medium=readme&utm_id=26072023)
-
-[🎮 Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD) | [🐦 Twitter](https://twitter.com/alexrudall) | [🧠 Anthropic Gem](https://github.com/alexrudall/anthropic) | [🚂 Midjourney Gem](https://github.com/alexrudall/midjourney)
+[🚢 Hire me](https://peaceterms.com?utm_source=ruby-openai&utm_medium=readme&utm_id=26072023) | [🎮 Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD) | [🐦 Twitter](https://twitter.com/alexrudall) | [🧠 Anthropic Gem](https://github.com/alexrudall/anthropic) | [🚂 Midjourney Gem](https://github.com/alexrudall/midjourney)
 
 ### Bundler
 
@@ -110,6 +108,16 @@ OpenAI.configure do |config|
 end
 ```
 
+#### Verbose Logging
+
+You can pass [Faraday middleware](https://lostisland.github.io/faraday/#/middleware/index) to the client in a block, eg. to enable verbose logging with Ruby's [Logger](https://ruby-doc.org/3.2.2/stdlibs/logger/Logger.html):
+
+```ruby
+  client = OpenAI::Client.new do |f|
+    f.response :logger, Logger.new($stdout), bodies: true
+  end
+```
+
 #### Azure
 
 To use the [Azure OpenAI Service](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/) API, you can configure the gem like this:
@@ -149,7 +157,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 +169,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 +184,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 +203,80 @@ 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.
+
+#### Vision
+
+You can use the GPT-4 Vision model to generate a description of an image:
+
+```ruby
+messages = [
+  { "type": "text", "text": "What’s in this image?"},
+  { "type": "image_url",
+    "image_url": {
+      "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg",
+    },
+  }
+]
+response = client.chat(
+    parameters: {
+        model: "gpt-4-vision-preview", # Required.
+        messages: [{ role: "user", content: messages}], # Required.
+    })
+puts response.dig("choices", 0, "message", "content")
+# => "The image depicts a serene natural landscape featuring a long wooden boardwalk extending straight ahead"
+```
+
+#### JSON Mode
+
+You can set the response_format to ask for responses in JSON (at least for `gpt-3.5-turbo-1106`):
+
+```ruby
+  response = client.chat(
+    parameters: {
+        model: "gpt-3.5-turbo-1106",
+        response_format: { type: "json_object" },
+        messages: [{ role: "user", content: "Hello! Give me some JSON please."}],
+        temperature: 0.7,
+    })
+    puts response.dig("choices", 0, "message", "content")
+    {
+      "name": "John",
+      "age": 30,
+      "city": "New York",
+      "hobbies": ["reading", "traveling", "hiking"],
+      "isStudent": false
+    }
+```
+
+You can stream it as well!
+
+```ruby
+  response = client.chat(
+    parameters: {
+      model: "gpt-3.5-turbo-1106",
+      messages: [{ role: "user", content: "Can I have some JSON please?"}],
+        response_format: { type: "json_object" },
+        stream: proc do |chunk, _bytesize|
+          print chunk.dig("choices", 0, "delta", "content")
+        end
+  })
+  {
+    "message": "Sure, please let me know what specific JSON data you are looking for.",
+    "JSON_data": {
+      "example_1": {
+        "key_1": "value_1",
+        "key_2": "value_2",
+        "key_3": "value_3"
+      },
+      "example_2": {
+        "key_4": "value_4",
+        "key_5": "value_5",
+        "key_6": "value_6"
+      }
+    }
+  }
+```
 
 ### Functions
 
@@ -257,21 +338,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 +389,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 +435,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 +521,34 @@ puts response["text"]
 # => "Transcription of the text"
 ```
 
+#### Speech
+
+The speech API takes as input the text and a voice and returns the content of an audio file you can listen to.
+
+```ruby
+response = client.audio.speech(
+  parameters: {
+    model: "tts-1",
+    input: "This is a speech test!",
+    voice: "alloy"
+  }
+)
+File.binwrite('demo.mp3', response)
+# => mp3 file that plays: "This is a speech test!"
+```
+
+### 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/assistants.rb

@@ -0,0 +1,27 @@
+module OpenAI
+  class Assistants
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list
+      @client.get(path: "/assistants")
+    end
+
+    def retrieve(id:)
+      @client.get(path: "/assistants/#{id}")
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/assistants", parameters: parameters)
+    end
+
+    def modify(id:, parameters: {})
+      @client.json_post(path: "/assistants/#{id}", parameters: parameters)
+    end
+
+    def delete(id:)
+      @client.delete(path: "/assistants/#{id}")
+    end
+  end
+end

data/lib/openai/audio.rb

@@ -11,5 +11,9 @@ module OpenAI
     def translate(parameters: {})
       @client.multipart_post(path: "/audio/translations", parameters: parameters)
     end
+
+    def speech(parameters: {})
+      @client.json_post(path: "/audio/speech", parameters: parameters)
+    end
   end
 end

data/lib/openai/client.rb

@@ -11,24 +11,21 @@ module OpenAI
       request_timeout
       extra_headers
     ].freeze
-    attr_reader *CONFIG_KEYS
+    attr_reader *CONFIG_KEYS, :faraday_middleware
 
-    def initialize(config = {})
+    def initialize(config = {}, &faraday_middleware)
       CONFIG_KEYS.each do |key|
         # Set instance variables like api_type & access_token. Fall back to global config
         # if not present.
         instance_variable_set("@#{key}", config[key] || OpenAI.configuration.send(key))
       end
+      @faraday_middleware = faraday_middleware
     end
 
     def chat(parameters: {})
       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
@@ -57,6 +54,26 @@ module OpenAI
       @models ||= OpenAI::Models.new(client: self)
     end
 
+    def assistants
+      @assistants ||= OpenAI::Assistants.new(client: self)
+    end
+
+    def threads
+      @threads ||= OpenAI::Threads.new(client: self)
+    end
+
+    def messages
+      @messages ||= OpenAI::Messages.new(client: self)
+    end
+
+    def runs
+      @runs ||= OpenAI::Runs.new(client: self)
+    end
+
+    def run_steps
+      @run_steps ||= OpenAI::RunSteps.new(client: self)
+    end
+
     def moderations(parameters: {})
       json_post(path: "/moderations", parameters: parameters)
     end
@@ -64,5 +81,11 @@ module OpenAI
     def azure?
       @api_type&.to_sym == :azure
     end
+
+    def beta(apis)
+      dup.tap do |client|
+        client.add_headers("OpenAI-Beta": apis.map { |k, v| "#{k}=#{v}" }.join(";"))
+      end
+    end
   end
 end

data/lib/openai/compatibility.rb

@@ -5,5 +5,6 @@ module Ruby
     Error = ::OpenAI::Error
     ConfigurationError = ::OpenAI::ConfigurationError
     Configuration = ::OpenAI::Configuration
+    MiddlewareErrors = ::OpenAI::MiddlewareErrors
   end
 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

@@ -1,57 +1,58 @@
 require "event_stream_parser"
 
+require_relative "http_headers"
+
 module OpenAI
   module HTTP
+    include HTTPHeaders
+
     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
-
+    def post(path:)
+      parse_jsonl(conn.post(uri(path: path)) do |req|
         req.headers = headers
-        req.body = parameters.to_json
       end&.body)
     end
 
+    def json_post(path:, parameters:)
+      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,26 +60,28 @@ 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: try_parse_json(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|
+      connection = Faraday.new do |f|
         f.options[:timeout] = @request_timeout
         f.request(:multipart) if multipart
+        f.use MiddlewareErrors
+        f.response :raise_error
+        f.response :json
       end
+
+      @faraday_middleware&.call(connection)
+
+      connection
     end
 
     def uri(path:)
@@ -90,29 +93,6 @@ module OpenAI
       end
     end
 
-    def headers
-      if azure?
-        azure_headers
-      else
-        openai_headers
-      end.merge(@extra_headers || {})
-    end
-
-    def openai_headers
-      {
-        "Content-Type" => "application/json",
-        "Authorization" => "Bearer #{@access_token}",
-        "OpenAI-Organization" => @organization_id
-      }
-    end
-
-    def azure_headers
-      {
-        "Content-Type" => "application/json",
-        "api-key" => @access_token
-      }
-    end
-
     def multipart_parameters(parameters)
       parameters&.transform_values do |value|
         next value unless value.respond_to?(:close) # File or IO object.
@@ -123,5 +103,25 @@ 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
+
+    def try_parse_json(maybe_json)
+      JSON.parse(maybe_json)
+    rescue JSON::ParserError
+      maybe_json
+    end
   end
 end

data/lib/openai/http_headers.rb

@@ -0,0 +1,36 @@
+module OpenAI
+  module HTTPHeaders
+    def add_headers(headers)
+      @extra_headers = extra_headers.merge(headers.transform_keys(&:to_s))
+    end
+
+    private
+
+    def headers
+      if azure?
+        azure_headers
+      else
+        openai_headers
+      end.merge(extra_headers)
+    end
+
+    def openai_headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{@access_token}",
+        "OpenAI-Organization" => @organization_id
+      }
+    end
+
+    def azure_headers
+      {
+        "Content-Type" => "application/json",
+        "api-key" => @access_token
+      }
+    end
+
+    def extra_headers
+      @extra_headers ||= {}
+    end
+  end
+end

data/lib/openai/messages.rb

@@ -0,0 +1,23 @@
+module OpenAI
+  class Messages
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list(thread_id:)
+      @client.get(path: "/threads/#{thread_id}/messages")
+    end
+
+    def retrieve(thread_id:, id:)
+      @client.get(path: "/threads/#{thread_id}/messages/#{id}")
+    end
+
+    def create(thread_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/messages", parameters: parameters)
+    end
+
+    def modify(id:, thread_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/messages/#{id}", parameters: parameters)
+    end
+  end
+end

data/lib/openai/run_steps.rb

@@ -0,0 +1,15 @@
+module OpenAI
+  class RunSteps
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list(thread_id:, run_id:)
+      @client.get(path: "/threads/#{thread_id}/runs/#{run_id}/steps")
+    end
+
+    def retrieve(thread_id:, run_id:, id:)
+      @client.get(path: "/threads/#{thread_id}/runs/#{run_id}/steps/#{id}")
+    end
+  end
+end

data/lib/openai/runs.rb

@@ -0,0 +1,32 @@
+module OpenAI
+  class Runs
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list(thread_id:)
+      @client.get(path: "/threads/#{thread_id}/runs")
+    end
+
+    def retrieve(thread_id:, id:)
+      @client.get(path: "/threads/#{thread_id}/runs/#{id}")
+    end
+
+    def create(thread_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/runs", parameters: parameters)
+    end
+
+    def modify(id:, thread_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/runs/#{id}", parameters: parameters)
+    end
+
+    def cancel(id:, thread_id:)
+      @client.post(path: "/threads/#{thread_id}/runs/#{id}/cancel")
+    end
+
+    def submit_tool_outputs(thread_id:, run_id:, parameters: {})
+      @client.json_post(path: "/threads/#{thread_id}/runs/#{run_id}/submit_tool_outputs",
+                        parameters: parameters)
+    end
+  end
+end

data/lib/openai/threads.rb

@@ -0,0 +1,27 @@
+module OpenAI
+  class Threads
+    def initialize(client:)
+      @client = client.beta(assistants: "v1")
+    end
+
+    def list
+      @client.get(path: "/threads")
+    end
+
+    def retrieve(id:)
+      @client.get(path: "/threads/#{id}")
+    end
+
+    def create(parameters: {})
+      @client.json_post(path: "/threads", parameters: parameters)
+    end
+
+    def modify(id:, parameters: {})
+      @client.json_post(path: "/threads/#{id}", parameters: parameters)
+    end
+
+    def delete(id:)
+      @client.delete(path: "/threads/#{id}")
+    end
+  end
+end

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -7,6 +7,11 @@ require_relative "openai/files"
 require_relative "openai/finetunes"
 require_relative "openai/images"
 require_relative "openai/models"
+require_relative "openai/assistants"
+require_relative "openai/threads"
+require_relative "openai/messages"
+require_relative "openai/runs"
+require_relative "openai/run_steps"
 require_relative "openai/audio"
 require_relative "openai/version"
 
@@ -14,6 +19,22 @@ module OpenAI
   class Error < StandardError; end
   class ConfigurationError < Error; end
 
+  class MiddlewareErrors < Faraday::Middleware
+    def call(env)
+      @app.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])
+
+      raise e
+    end
+  end
+
   class Configuration
     attr_writer :access_token
     attr_accessor :api_type, :api_version, :organization_id, :uri_base, :request_timeout,
@@ -30,7 +51,7 @@ module OpenAI
       @organization_id = nil
       @uri_base = DEFAULT_URI_BASE
       @request_timeout = DEFAULT_REQUEST_TIMEOUT
-      @extra_headers = nil
+      @extra_headers = {}
     end
 
     def access_token

data/ruby-openai.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "event_stream_parser", ">= 0.3.0", "< 1.0.0"
+  spec.add_dependency "event_stream_parser", ">= 0.3.0", "< 2.0.0"
   spec.add_dependency "faraday", ">= 1"
   spec.add_dependency "faraday-multipart", ">= 1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -19,7 +19,7 @@ dependencies:
         version: 0.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +87,20 @@ files:
 - bin/console
 - bin/setup
 - lib/openai.rb
+- lib/openai/assistants.rb
 - lib/openai/audio.rb
 - lib/openai/client.rb
 - lib/openai/compatibility.rb
 - lib/openai/files.rb
 - lib/openai/finetunes.rb
 - lib/openai/http.rb
+- lib/openai/http_headers.rb
 - lib/openai/images.rb
+- lib/openai/messages.rb
 - lib/openai/models.rb
+- lib/openai/run_steps.rb
+- lib/openai/runs.rb
+- lib/openai/threads.rb
 - lib/openai/version.rb
 - lib/ruby/openai.rb
 - pull_request_template.md