ruby-openai 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b77870afd356728570560cf1e2c7c703210f51db327c6d7e4c2d028d1979c12
-  data.tar.gz: f0b79c7776c0ff022f22f889923d3024f8a1d1894f47771105c9508c460739f3
+  metadata.gz: 2e2bdf19ad32b8eb492faca3e937614c30ab57817c374797362ca27ffff1cf7e
+  data.tar.gz: b3d31aaa13bec5bdeb08718c04afad99b528e9e5c1bfbd279a8111e4fa12739c
 SHA512:
-  metadata.gz: 99f138cc6d2e4593191ca5833e4b81e9cc4b8a9b039010e0f43eb24c999ae413b530e4cd017b9c6a325264c7e8771a293b43c6e35daef50dd49f7568f6b11197
-  data.tar.gz: 2fdfbc69cdb6ee7b16693421704e7f9dda8bd0d1cc4da2c14ec2fdf6f3c8e380b3643462c799c69affddfc7a9f3e66983bb58d9965ee01e187245def25d99eb4
+  metadata.gz: bf6f46dbb52890ff1468d727711681ad95bb82e26b77f092cf6a81be25dbdb7ef3b3a58626090160bfc927ec3585723c17a9c47005ff64b035a3af85ba887e51
+  data.tar.gz: cbe3a5d6c57757beee533c3b9c05aa43fb343f7da542af4fc58bf70223f84cc674900d032e824f1c34e19ef17a2ba0d366fe9353dae67db162ce435ef2f1a496

data/CHANGELOG.md

@@ -5,6 +5,14 @@ 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

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    ruby-openai (6.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)
 
@@ -18,7 +18,7 @@ GEM
       rexml
     diff-lcs (1.5.0)
     dotenv (2.8.1)
-    event_stream_parser (0.3.0)
+    event_stream_parser (1.0.0)
     faraday (2.7.11)
       base64
       faraday-net_http (>= 2.0, < 3.1)

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)
 
@@ -108,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:
@@ -217,6 +227,57 @@ 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
 
 You can describe and pass in functions and the model will intelligently choose to output a JSON object containing arguments to call those them. For example, if you want the model to use your method `get_current_weather` to get the current weather in a given location:

data/lib/openai/client.rb

@@ -11,14 +11,15 @@ 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: {})

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/http.rb

@@ -71,12 +71,17 @@ module OpenAI
     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:)

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -19,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,

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: 6.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-15 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