openai_ruby 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c428b915e1985b7478318b5eee0938934ca406fec796bddab9f7499bbdc5feb6
-  data.tar.gz: d3e648abff19cd4bd266f05353500a4f8bcc1d221b376bb23ddbbd82eecdada7
+  metadata.gz: a95f09a2242c8a67613fb0589cc480d8fd36f17b4fbf42d52a4f7969626e0427
+  data.tar.gz: e8be0ae8f3cffc9e163f47768d6e70750972f38af1b1aaae08b0f518d0c7c52e
 SHA512:
-  metadata.gz: 2b4eaf9d508d7e904a21bec16456dd0dec8a36b2bb18d88111a61af91fcef67eecc94979c857bac14bf6f8cde9154b55ffd62e877bd766023fe1585ca2af82cb
-  data.tar.gz: 9bd6e7d5a8933e78abb8282fbbea3fb850952392247bb3fed6fb30423d4072a42e20f8673d7ffec760a6061e5e46eef64e8c584b6414cc0610eab813a90306af
+  metadata.gz: 29fb10ed072c4b71cc5cd159903fa2a17c1cff924327837a9aabdd3e59c7733c72c19383a4b5a1a91ce2ae1824abcfde98a2de1738ac633efdca5b6cbd9d8e37
+  data.tar.gz: 4e799005b2565d0c51795ae4e0fec54658df56b962d065200f33044a06f2f7e22bb90288e0544247e1c140a284bed60462b716ca65d01f240a1cdce6456eec74

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.6.0] - 2026-08-20
+
+- Add non-streaming and SSE streaming support for the Responses API through `OpenAI::Client#create_response`.
+
+## [0.5.6] - 2026-08-15
+
+- Preserve complete error response bodies when streamed HTTP errors arrive in multiple chunks.
+
 ## [0.5.5] - 2026-08-03
 
 - Avoid mutating request parameters in chat completion and speech requests, including frozen nested schemas.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openai_ruby (0.5.5)
+    openai_ruby (0.6.0)
       event_stream_parser (~> 1.0)
       faraday (~> 2.7)
       faraday-multipart (~> 1.1)

data/README.md

@@ -76,6 +76,21 @@ res = client.create_chat_completion(params) do |data|
 end
 ```
 
+### Responses
+
+Use `create_response` for the Responses API. When `stream` is true, the block receives each parsed SSE event:
+
+```ruby
+res = client.create_response(
+  model: "gpt-5.6-terra",
+  input: "Explain why the answer is correct.",
+  store: false,
+  stream: true
+) do |event|
+  print event["delta"] if event["type"] == "response.output_text.delta"
+end
+```
+
 ### Edit
 
 https://platform.openai.com/docs/api-reference/edits

data/lib/openai_ruby/client.rb

@@ -20,26 +20,16 @@ module OpenAI
       )
     end
 
-    def create_chat_completion(params = {})
-      parser = EventStreamParser::Parser.new
+    def create_chat_completion(params = {}, &block)
+      return connection.post("/v1/chat/completions", params.to_json) unless streaming?(params)
 
-      if streaming?(params)
-        connection.post("/v1/chat/completions") do |req|
-          req.body = params.to_json
-          req.options.on_data = proc do |chunk, _overall_received_bytes, env|
-            if env && env.status != 200
-              raise_error = Faraday::Response::RaiseError.new
-              raise_error.on_complete(env.merge(body: try_parse_json(chunk)))
-            end
-
-            parser.feed(chunk) do |_type, data|
-              yield(JSON.parse(data)) if block_given? && data != "[DONE]"
-            end
-          end
-        end
-      else
-        connection.post("/v1/chat/completions", params.to_json)
-      end
+      create_streaming_request("/v1/chat/completions", params, &block)
+    end
+
+    def create_response(params = {}, &block)
+      return connection.post("/v1/responses", params.to_json) unless streaming?(params)
+
+      create_streaming_request("/v1/responses", params, &block)
     end
 
     def create_edit(params = {})
@@ -100,6 +90,33 @@ module OpenAI
       params[:stream] || params["stream"]
     end
 
+    def create_streaming_request(path, params, &block)
+      parser = EventStreamParser::Parser.new
+      error_body = +""
+      response = connection.post(path) do |req|
+        req.body = params.to_json
+        req.options.on_data = proc do |chunk, _overall_received_bytes, env|
+          handle_streaming_chunk(parser, error_body, chunk, env, &block)
+        end
+      end
+
+      raise_streaming_response_error(response, error_body) unless response.status == 200
+      response
+    end
+
+    def handle_streaming_chunk(parser, error_body, chunk, env)
+      return error_body << chunk unless env&.status == 200
+
+      parser.feed(chunk) do |_type, data|
+        yield(JSON.parse(data)) if block_given? && data != "[DONE]"
+      end
+    end
+
+    def raise_streaming_response_error(response, body)
+      error_env = response.env.merge(body: try_parse_json(body))
+      Faraday::Response::RaiseError.new.on_complete(error_env)
+    end
+
     def build_multipart_body(sdp_offer, session)
       boundary = "----RubyFormBoundary#{SecureRandom.hex(16)}"
       parts = [

data/lib/openai_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.5.5"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai_ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Renny Ren