chore(internal): codegen related update

Author: stainless-app[bot]

.github/workflows/ci.yml

@@ -13,6 +13,40 @@ on:
       - 'stl-preview-base/**'
 
 jobs:
+  build:
+    timeout-minutes: 10
+    name: build
+    permissions:
+      contents: read
+      id-token: write
+    runs-on: ${{ github.repository == 'stainless-sdks/openai-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: |-
+      github.repository == 'stainless-sdks/openai-ruby' &&
+      (github.event_name == 'push' || github.event.pull_request.head.repo.fork)
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: false
+      - run: |-
+          bundle install
+
+      - name: Get GitHub OIDC Token
+        if: github.repository == 'stainless-sdks/openai-ruby'
+        id: github-oidc
+        uses: actions/github-script@v8
+        with:
+          script: core.setOutput('github_token', await core.getIDToken());
+
+      - name: Build and upload gem artifacts
+        if: github.repository == 'stainless-sdks/openai-ruby'
+        env:
+          URL: https://pkg.stainless.com/s
+          AUTH: ${{ steps.github-oidc.outputs.github_token }}
+          SHA: ${{ github.sha }}
+          PACKAGE_NAME: openai
+        run: ./scripts/utils/upload-artifact.sh
   lint:
     timeout-minutes: 10
     name: lint

lib/openai/client.rb

@@ -27,27 +27,37 @@ class Client < OpenAI::Internal::Transport::BaseClient
     # @return [String, nil]
     attr_reader :webhook_secret
 
+    # Given a prompt, the model will return one or more predicted completions, and can
+    # also return the probabilities of alternative tokens at each position.
     # @return [OpenAI::Resources::Completions]
     attr_reader :completions
 
     # @return [OpenAI::Resources::Chat]
     attr_reader :chat
 
+    # Get a vector representation of a given input that can be easily consumed by
+    # machine learning models and algorithms.
     # @return [OpenAI::Resources::Embeddings]
     attr_reader :embeddings
 
+    # Files are used to upload documents that can be used with features like
+    # Assistants and Fine-tuning.
     # @return [OpenAI::Resources::Files]
     attr_reader :files
 
+    # Given a prompt and/or an input image, the model will generate a new image.
     # @return [OpenAI::Resources::Images]
     attr_reader :images
 
     # @return [OpenAI::Resources::Audio]
     attr_reader :audio
 
+    # Given text and/or image inputs, classifies if those inputs are potentially
+    # harmful.
     # @return [OpenAI::Resources::Moderations]
     attr_reader :moderations
 
+    # List and describe the various models available in the API.
     # @return [OpenAI::Resources::Models]
     attr_reader :models
 
@@ -66,9 +76,11 @@ class Client < OpenAI::Internal::Transport::BaseClient
     # @return [OpenAI::Resources::Beta]
     attr_reader :beta
 
+    # Create large batches of API requests to run asynchronously.
     # @return [OpenAI::Resources::Batches]
     attr_reader :batches
 
+    # Use Uploads to upload large files in multiple parts.
     # @return [OpenAI::Resources::Uploads]
     attr_reader :uploads
 
@@ -78,9 +90,11 @@ class Client < OpenAI::Internal::Transport::BaseClient
     # @return [OpenAI::Resources::Realtime]
     attr_reader :realtime
 
+    # Manage conversations and conversation items.
     # @return [OpenAI::Resources::Conversations]
     attr_reader :conversations
 
+    # Manage and run evals in the OpenAI platform.
     # @return [OpenAI::Resources::Evals]
     attr_reader :evals
 

lib/openai/internal/util.rb

@@ -490,6 +490,37 @@ def writable_enum(&blk)
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection["#{key}[]"] = element.map(&:to_s)
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]

lib/openai/resources/audio.rb

@@ -3,12 +3,15 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       # @return [OpenAI::Resources::Audio::Transcriptions]
       attr_reader :transcriptions
 
+      # Turn audio into text or text into audio.
       # @return [OpenAI::Resources::Audio::Translations]
       attr_reader :translations
 
+      # Turn audio into text or text into audio.
       # @return [OpenAI::Resources::Audio::Speech]
       attr_reader :speech
 

lib/openai/resources/audio/speech.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Speech
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Audio::SpeechCreateParams} for more details.

lib/openai/resources/audio/transcriptions.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Transcriptions
         # See {OpenAI::Resources::Audio::Transcriptions#create_streaming} for streaming
         # counterpart.

lib/openai/resources/audio/translations.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Translations
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Audio::TranslationCreateParams} for more details.

lib/openai/resources/batches.rb

@@ -2,6 +2,7 @@
 
 module OpenAI
   module Resources
+    # Create large batches of API requests to run asynchronously.
     class Batches
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::BatchCreateParams} for more details.
@@ -68,10 +69,11 @@ def retrieve(batch_id, params = {})
       # @see OpenAI::Models::BatchListParams
       def list(params = {})
         parsed, options = OpenAI::BatchListParams.dump_request(params)
+        query = OpenAI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "batches",
-          query: parsed,
+          query: query,
           page: OpenAI::Internal::CursorPage,
           model: OpenAI::Batch,
           options: options

lib/openai/resources/beta.rb

@@ -6,9 +6,11 @@ class Beta
       # @return [OpenAI::Resources::Beta::ChatKit]
       attr_reader :chatkit
 
+      # Build Assistants that can call models and use tools.
       # @return [OpenAI::Resources::Beta::Assistants]
       attr_reader :assistants
 
+      # Build Assistants that can call models and use tools.
       # @return [OpenAI::Resources::Beta::Threads]
       attr_reader :threads
 

lib/openai/resources/beta/assistants.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Beta
+      # Build Assistants that can call models and use tools.
       class Assistants
         # @deprecated
         #
@@ -146,10 +147,11 @@ def update(assistant_id, params = {})
         # @see OpenAI::Models::Beta::AssistantListParams
         def list(params = {})
           parsed, options = OpenAI::Beta::AssistantListParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: "assistants",
-            query: parsed,
+            query: query,
             page: OpenAI::Internal::CursorPage,
             model: OpenAI::Beta::Assistant,
             options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}