openai_ruby 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a554ff0eded8ed64b9fd4d8fc07a5e5d0651dd35e111d6d80d724ed19651fca1
-  data.tar.gz: a91315b4f63e50ada7a9d90b372364b0c8e9068ea06de0e46570e4ac29b1be67
+  metadata.gz: c428b915e1985b7478318b5eee0938934ca406fec796bddab9f7499bbdc5feb6
+  data.tar.gz: d3e648abff19cd4bd266f05353500a4f8bcc1d221b376bb23ddbbd82eecdada7
 SHA512:
-  metadata.gz: 89b7a75816ea1ca6aea907013db339e3c192f24889011653829fb2d4937c5e33685efbf529c406b1ded3d3bdc3747e31e54d795286206712d642b02ff50ba9d7
-  data.tar.gz: 38b38f93be8a80d2b2341d06c73d9e93726aab9fb0f3961f6afebba42a9dbc98a109a19177152cd7902268655b115526fb6d1ae0afe8355d17b41102ec225cf3
+  metadata.gz: 2b4eaf9d508d7e904a21bec16456dd0dec8a36b2bb18d88111a61af91fcef67eecc94979c857bac14bf6f8cde9154b55ffd62e877bd766023fe1585ca2af82cb
+  data.tar.gz: 9bd6e7d5a8933e78abb8282fbbea3fb850952392247bb3fed6fb30423d4072a42e20f8673d7ffec760a6061e5e46eef64e8c584b6414cc0610eab813a90306af

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.5.5] - 2026-08-03
+
+- Avoid mutating request parameters in chat completion and speech requests, including frozen nested schemas.
+
 ## [0.1.0] - 2023-02-14
 
 - Initial release

data/Gemfile.lock

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

data/README.md

@@ -92,8 +92,57 @@ p response.dig("choices", 0, "text")  # "What is the date today?\n"
 
 ### Image
 
+https://platform.openai.com/docs/api-reference/images
+
+Generate an image:
+
 ```ruby
+require "base64"
+
+res = client.images.generate(
+  model: "gpt-image-2",
+  prompt: "A watercolor painting of a ruby gem on a desk",
+  size: "1024x1024"
+)
+
+response = JSON.parse(res.body)
+image_data = response.dig("data", 0, "b64_json")
+
+File.binwrite("ruby-gem.png", Base64.decode64(image_data)) if image_data
+```
 
+Edit one or more images:
+
+```ruby
+require "base64"
+
+File.open("ruby-gem.png", "rb") do |image|
+  res = client.images.edit(
+    model: "gpt-image-2",
+    image: image,
+    prompt: "Add a small OpenAI logo sticker to the desk",
+    size: "1024x1024"
+  )
+
+  response = JSON.parse(res.body)
+  image_data = response.dig("data", 0, "b64_json")
+
+  File.binwrite("ruby-gem-edited.png", Base64.decode64(image_data)) if image_data
+end
+```
+
+You can also pass multiple images when editing:
+
+```ruby
+File.open("image-1.png", "rb") do |image_1|
+  File.open("image-2.png", "rb") do |image_2|
+    client.images.edit(
+      model: "gpt-image-2",
+      image: [image_1, image_2],
+      prompt: "Combine these images into one cohesive scene"
+    )
+  end
+end
 ```
 
 ## Development

data/lib/openai_ruby/client.rb

@@ -23,8 +23,7 @@ module OpenAI
     def create_chat_completion(params = {})
       parser = EventStreamParser::Parser.new
 
-      params.deep_stringify_keys!
-      if params["stream"]
+      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|
@@ -52,7 +51,6 @@ module OpenAI
     end
 
     def create_speech(params = {})
-      params.deep_stringify_keys!
       connection.post("/v1/audio/speech", params.to_json)
     end
 
@@ -61,17 +59,15 @@ module OpenAI
     end
 
     def create_realtime_call(sdp_offer:, session: nil)
-      uri = "#{base_uri}/v1/realtime/calls"
-
       if session
         boundary, body = build_multipart_body(sdp_offer, session)
-        Faraday.post(uri) do |req|
+        connection.post("/v1/realtime/calls") do |req|
           req.headers["Authorization"] = "Bearer #{api_key}"
           req.headers["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
           req.body = body
         end
       else
-        Faraday.post(uri) do |req|
+        connection.post("/v1/realtime/calls") do |req|
           req.headers["Content-Type"] = "application/sdp"
           req.headers["Authorization"] = "Bearer #{api_key}"
           req.body = sdp_offer
@@ -100,6 +96,10 @@ module OpenAI
       default_value || maybe_json
     end
 
+    def streaming?(params)
+      params[:stream] || params["stream"]
+    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.3"
+  VERSION = "0.5.5"
 end

metadata

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