Merge branch 'next' into ruby-3.2

Author: ms-jpq

.github/workflows/ci.yml

@@ -1,17 +1,19 @@
 name: CI
 on:
   push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-      - next
+    branches-ignore:
+      - 'generated'
+      - 'codegen/**'
+      - 'integrated/**'
+      - 'stl-preview-head/**'
+      - 'stl-preview-base/**'
 
 jobs:
   lint:
+    timeout-minutes: 10
     name: lint
-    runs-on: ubuntu-latest
+    runs-on: ${{ github.repository == 'stainless-sdks/openai-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+
     steps:
       - uses: actions/checkout@v4
       - name: Set up Ruby
@@ -25,8 +27,9 @@ jobs:
       - name: Run lints
         run: ./scripts/lint
   test:
+    timeout-minutes: 10
     name: test
-    runs-on: ubuntu-latest
+    runs-on: ${{ github.repository == 'stainless-sdks/openai-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
     steps:
       - uses: actions/checkout@v4
       - name: Set up Ruby

.github/workflows/create-releases.yml

@@ -25,16 +25,17 @@ jobs:
           stainless-api-key: ${{ secrets.STAINLESS_API_KEY }}
 
       - name: Set up Ruby
-	if: ${{ steps.release.outputs.releases_created }}
+        if: ${{ steps.release.outputs.releases_created }}
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: false
           ruby-version: '3.2'
-      - run: |-
+
+      - run: |
           bundle install
 
       - name: Publish to RubyGems.org
-	if: ${{ steps.release.outputs.releases_created }}
+        if: ${{ steps.release.outputs.releases_created }}
         run: |
           bash ./bin/publish-gem
         env:

.rubocop.yml

@@ -64,11 +64,19 @@ Layout/MultilineMethodParameterLineBreaks:
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
+Lint/BooleanSymbol:
+  Enabled: false
+
 # This option occasionally mangles identifier names
 Lint/DeprecatedConstants:
   Exclude:
     - "**/*.rbi"
 
+# We use pattern assertion in tests to ensure correctness.
+Lint/DuplicateMatchPattern:
+  Exclude:
+    - "test/**/*"
+
 # Fairly useful in tests for pattern assertions.
 Lint/EmptyInPattern:
   Exclude:
@@ -119,6 +127,9 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Naming/AccessorMethodName:
+  Enabled: false
+
 # Need to preserve block identifier for documentation.
 Naming/BlockForwarding:
   Enabled: false

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 95
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-5633633cc38734869cf7d993f7b549bb8e4d10e0ec45381ec2cd91507cd8eb8f.yml
-openapi_spec_hash: c855121b2b2324b99499c9244c21d24d
-config_hash: d20837393b73efdb19cd08e04c1cc9a1
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-8b68ae6b807dca92e914da1dd9e835a20f69b075e79102a264367fd7fddddb33.yml
+openapi_spec_hash: b6ade5b1a6327339e6669e1134de2d03
+config_hash: b597cd9a31e9e5ec709e2eefb4c54122

.yardopts

@@ -1,4 +1,5 @@
 --type-name-tag generic:Generic
+--default-return void
 --markup markdown
 --markup-provider redcarpet
 --exclude /rbi

CONTRIBUTING.md

@@ -14,7 +14,7 @@ This will install all the required dependencies.
 
 ## Modifying/Adding code
 
-Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents `examples/` directory.
+Most of the SDK is generated code. Modifications to code will be persisted between generations, but may result in merge conflicts between manual patches and changes from the generator. The generator will never modify the contents of `lib/openai/helpers/` and `examples/` directory.
 
 ## Adding and running examples
 

Gemfile

@@ -23,6 +23,7 @@ group :development, :test do
   gem "minitest-hooks"
   gem "minitest-proveit"
   gem "minitest-rg"
+  gem "webmock"
 end
 
 group :development, :docs do

Gemfile.lock

@@ -29,6 +29,8 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.3)
     async (2.23.1)
       console (~> 1.29)
@@ -45,6 +47,9 @@ GEM
       fiber-annotation
       fiber-local (~> 1.1)
       json
+    crack (1.0.0)
+      bigdecimal
+      rexml
     csv (3.3.3)
     drb (2.2.1)
     erubi (1.13.1)
@@ -54,6 +59,7 @@ GEM
       fiber-storage
     fiber-storage (1.0.0)
     fileutils (1.7.3)
+    hashdiff (1.1.2)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     io-event (1.10.0)
@@ -82,6 +88,7 @@ GEM
       racc
     prettier_print (1.2.1)
     prism (1.4.0)
+    public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
@@ -96,6 +103,7 @@ GEM
       logger
     redcarpet (3.6.1)
     regexp_parser (2.10.0)
+    rexml (3.4.1)
     rubocop (1.75.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -165,6 +173,10 @@ GEM
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
     uri (1.0.3)
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.9.1)
     yard (0.9.37)
     yard-sorbet (0.9.0)
@@ -191,6 +203,7 @@ DEPENDENCIES
   syntax_tree
   syntax_tree-rbs!
   tapioca
+  webmock
   webrick
   yard
 

README.md

@@ -33,7 +33,7 @@ openai = OpenAI::Client.new(
 )
 
 chat_completion = openai.chat.completions.create(
-  messages: [{role: :user, content: "Say this is a test"}],
+  messages: [{role: "user", content: "Say this is a test"}],
   model: :"gpt-4.1"
 )
 
@@ -48,7 +48,7 @@ When using sorbet, it is recommended to use model classes as below. This provide
 
 ```ruby
 openai.chat.completions.create(
-  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: :user, content: "Say this is a test")],
+  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 ```
@@ -80,7 +80,7 @@ We provide support for streaming responses using Server-Sent Events (SSE).
 
 ```ruby
 stream = openai.chat.completions.stream_raw(
-  messages: [{role: :user, content: "Say this is a test"}],
+  messages: [{role: "user", content: "Say this is a test"}],
   model: :"gpt-4.1"
 )
 
@@ -97,11 +97,11 @@ Request parameters that correspond to file uploads can be passed as `StringIO`,
 require "pathname"
 
 # using `Pathname`, the file will be lazily read, without reading everything in to memory
-file_object = openai.files.create(file: Pathname("input.jsonl"), purpose: :"fine-tune")
+file_object = openai.files.create(file: Pathname("input.jsonl"), purpose: "fine-tune")
 
 file = File.read("input.jsonl")
 # using `StringIO`, useful if you already have the data in memory
-file_object = openai.files.create(file: StringIO.new(file), purpose: :"fine-tune")
+file_object = openai.files.create(file: StringIO.new(file), purpose: "fine-tune")
 
 puts(file_object.id)
 ```
@@ -150,7 +150,7 @@ openai = OpenAI::Client.new(
 
 # Or, configure per-request:
 openai.chat.completions.create(
-  messages: [{role: :user, content: "How can I get the name of the current day in JavaScript?"}],
+  messages: [{role: "user", content: "How can I get the name of the current day in JavaScript?"}],
   model: :"gpt-4.1",
   request_options: {max_retries: 5}
 )
@@ -172,7 +172,7 @@ openai = OpenAI::Client.new(
 
 # Or, configure per-request:
 openai.chat.completions.create(
-  messages: [{role: :user, content: "How can I list all files in a directory using Python?"}],
+  messages: [{role: "user", content: "How can I list all files in a directory using Python?"}],
   model: :"gpt-4.1",
   request_options: {timeout: 5}
 )
@@ -189,13 +189,13 @@ In all places where a `BaseModel` type is specified, vanilla Ruby `Hash` can als
 ```ruby
 # This has tooling readability, for auto-completion, static analysis, and goto definition with supported language services
 params = OpenAI::Models::Chat::CompletionCreateParams.new(
-  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: :user, content: "Say this is a test")],
+  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 
 # This also works
 params = {
-  messages: [{role: :user, content: "Say this is a test"}],
+  messages: [{role: "user", content: "Say this is a test"}],
   model: :"gpt-4.1"
 }
 ```
@@ -257,7 +257,7 @@ It is possible to pass a compatible model / parameter class to a method that exp
 
 ```ruby
 params = OpenAI::Models::Chat::CompletionCreateParams.new(
-  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: :user, content: "Say this is a test")],
+  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 openai.chat.completions.create(**params)

Rakefile

@@ -31,15 +31,21 @@ multitask(:test) do
     .map { "require_relative(#{_1.dump});" }
     .join
 
-  ruby(*%w[-w -e], rb, verbose: false) { fail unless _1 }
+  ruby(*%w[-e], rb, verbose: false) { fail unless _1 }
 end
 
 rubo_find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0]
 xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --]
 
 desc("Lint `*.rb(i)`")
 multitask(:"lint:rubocop") do
-  lint = xargs + %w[rubocop --fail-level E] + (ENV.key?("CI") ? %w[--format github] : [])
+  rubocop = %w[rubocop --fail-level E]
+  rubocop += %w[--format github] if ENV.key?("CI")
+
+  # some lines cannot be shortened
+  rubocop += %w[--except Lint/RedundantCopDisableDirective,Layout/LineLength]
+
+  lint = xargs + rubocop
   sh("#{rubo_find.shelljoin} | #{lint.shelljoin}")
 end
 
@@ -135,5 +141,5 @@ end
 
 desc("Release ruby gem")
 multitask(release: [:"build:gem"]) do
-  sh(*%w[gem push], *FileList["openai-*.gem"])
+  sh(*%w[gem push], *FileList["*.gem"])
 end

Steepfile

@@ -2,7 +2,7 @@
 
 require "yaml"
 
-target :lib do
+target(:lib) do
   configure_code_diagnostics(Steep::Diagnostic::Ruby.strict)
 
   signature("sig")

lib/openai.rb

@@ -31,7 +31,7 @@
 require_relative "openai/internal/type/converter"
 require_relative "openai/internal/type/unknown"
 require_relative "openai/internal/type/boolean"
-require_relative "openai/internal/type/io_like"
+require_relative "openai/internal/type/file_input"
 require_relative "openai/internal/type/enum"
 require_relative "openai/internal/type/union"
 require_relative "openai/internal/type/array_of"
@@ -42,6 +42,7 @@
 require_relative "openai/internal/type/request_parameters"
 require_relative "openai/internal"
 require_relative "openai/request_options"
+require_relative "openai/file_part"
 require_relative "openai/errors"
 require_relative "openai/internal/transport/base_client"
 require_relative "openai/internal/transport/pooled_net_requester"
@@ -363,6 +364,10 @@
 require_relative "openai/models/responses/response_output_refusal"
 require_relative "openai/models/responses/response_output_text"
 require_relative "openai/models/responses/response_reasoning_item"
+require_relative "openai/models/responses/response_reasoning_summary_part_added_event"
+require_relative "openai/models/responses/response_reasoning_summary_part_done_event"
+require_relative "openai/models/responses/response_reasoning_summary_text_delta_event"
+require_relative "openai/models/responses/response_reasoning_summary_text_done_event"
 require_relative "openai/models/responses/response_refusal_delta_event"
 require_relative "openai/models/responses/response_refusal_done_event"
 require_relative "openai/models/responses/response_retrieve_params"

lib/openai/client.rb

@@ -101,10 +101,10 @@ def initialize(
       organization: ENV["OPENAI_ORG_ID"],
       project: ENV["OPENAI_PROJECT_ID"],
       base_url: ENV["OPENAI_BASE_URL"],
-      max_retries: DEFAULT_MAX_RETRIES,
-      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY
+      max_retries: OpenAI::Client::DEFAULT_MAX_RETRIES,
+      timeout: OpenAI::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: OpenAI::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: OpenAI::Client::DEFAULT_MAX_RETRY_DELAY
     )
       base_url ||= "https://api.openai.com/v1"