openai_ruby 0.3.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62f0b226a7ae9602b425e0e72149e058dd6d122ed54fd325a1799d7ec493daee
-  data.tar.gz: 8e3fa3d8842917acbbff93f0bff58b07fd953b11616d2e3b64508dab91351327
+  metadata.gz: 44aa28c19d62f59334f0a7de177963fb8dd7cc25a92b402d8b37a2e89e9cfe00
+  data.tar.gz: 1793600ba3bd77d66efbae21f9af9a9b08a7072c652eaf9dbbd1f1903059f594
 SHA512:
-  metadata.gz: f70d3f04b8d1983186cc95870f6961b1ad88465123c3c2b0d83c0ba4cd9ccf5a254772a2586416b1374acd13291b4a456a088c463114f3b9e89b271b80bc776f
-  data.tar.gz: cab463d49f2a5ce6487e8e9b4ebb1a3ed0f5a270aa3697c56a6520ba72d4a808de356d38d9f9b48e8805fd0621ed498368d61117ffae996c20c8e5b757d5108a
+  metadata.gz: f4740f041c58594e3a09a8aaefaa598906123314068253694c96e2d4f092a4fc5d05f9627c5b6093c1aaf656dc98780526b5f2d84c83d356af5d906e5c5bf348
+  data.tar.gz: 72ec3ffe01751c395d689e56cac0947231e2f5022371e7d79dbf113a1abd5df7b9f17072cfbb88171fd79fe499860e3e0e067ba09c7a40e09e6575b80565c886

data/Gemfile

@@ -10,3 +10,4 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.12"
 
 gem "rubocop", "~> 1.45"
+gem "event_stream_parser"

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    openai_ruby (0.3.8)
+    openai_ruby (0.4.0)
+      event_stream_parser (~> 1.0)
       faraday (~> 2.7)
 
 GEM
@@ -9,6 +10,7 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
+    event_stream_parser (1.0.0)
     faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
@@ -56,6 +58,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  event_stream_parser
   openai_ruby!
   rake (~> 13.0)
   rspec (~> 3.12)

data/README.md

@@ -71,15 +71,8 @@ If you set `stream` param to `true`, a block will be called with the chunk data:
 #   temperature: 1,
 #   stream: true,
 # }
-res = client.create_chat_completion(params) do |chunk, overall_received_bytes, env|
-  data = chunk[/data: (.*)\n\n$/, 1]
-  p data # {"id":"chatcmpl-6xcOWMQcilJUwJiosi7Rht6Fvuu3D","object":"chat.completion.chunk","created":1679666960,"model":"gpt-3.5-turbo-0301","choices":[{"delta":{"content":"Hello"},"index":0,"finish_reason":null}]}
-  if data == "[DONE]"
-    # the stream is end
-  else
-    response = JSON.parse(data)
-    p response.dig("choices", 0, "text")  # "Hello"
-  end
+res = client.create_chat_completion(params) do |data|
+  p data.dig("choices", 0, "delta", "content") # "Hello"
 end
 ```
 

data/lib/openai_ruby/client.rb

@@ -6,7 +6,7 @@ module OpenAI
 
     attr_reader :api_key, :options
 
-    def initialize(api_key, options)
+    def initialize(api_key, options = {})
       @api_key = api_key
       @options = options
     end
@@ -20,12 +20,21 @@ module OpenAI
     end
 
     def create_chat_completion(params = {})
+      parser = EventStreamParser::Parser.new
+
       params.deep_stringify_keys!
       if params["stream"]
         connection.post("/v1/chat/completions") do |req|
           req.body = params.to_json
           req.options.on_data = proc do |chunk, overall_received_bytes, env|
-            yield(chunk, overall_received_bytes, env) if block_given?
+            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
@@ -54,8 +63,14 @@ module OpenAI
     def headers
       {
         "Content-Type" => "application/json",
-        "Authorization" => "Bearer #{api_key}",
+        "Authorization" => "Bearer #{api_key}"
       }
     end
+
+    def try_parse_json(maybe_json, default_value = nil)
+      JSON.parse(maybe_json)
+    rescue JSON::ParserError
+      default_value || maybe_json
+    end
   end
 end

data/lib/openai_ruby/version.rb

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

data/lib/openai_ruby.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "event_stream_parser"
 require "openai_ruby/client"
 require "openai_ruby/images"
 require "openai_ruby/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors:
 - Renny Ren
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: event_stream_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description:
 email:
 - rennyrjh@gmail.com