openai 0.78.0 → 0.80.0

data/lib/openai/providers/bedrock.rb

@@ -4,8 +4,9 @@ module OpenAI
   module Providers
     # @api private
     module Bedrock
-      SERVICE = "bedrock-mantle"
-      CANONICAL_HOST = /\Abedrock-mantle\.([a-z0-9-]+)\.api\.aws\z/i
+      SERVICES = {mantle: "bedrock-mantle", runtime: "bedrock"}.freeze
+      AWS_REGION_PATTERN = /\A[a-z]{2,8}(?:-[a-z0-9]+)+-\d+\z/
+      AUTH_HEADERS = %w[authorization].freeze
       SIGNING_HEADERS = %w[authorization x-amz-content-sha256 x-amz-date x-amz-security-token].freeze
       BEARER_AUTH_MARKER = :openai_bedrock_bearer
       SIGV4_AUTH_MARKER = :openai_bedrock_sigv4
@@ -38,6 +39,7 @@ module OpenAI
         attr_reader :name
 
         def initialize(
+          endpoint:,
           region:,
           base_url:,
           bearer_provider:,
@@ -49,6 +51,7 @@ module OpenAI
           default_chain:
         )
           @name = "bedrock"
+          @endpoint = endpoint
           @region = region&.freeze
           @base_url = base_url&.freeze
           @bearer_provider = bearer_provider
@@ -62,14 +65,17 @@ module OpenAI
 
         def configure
           if @bearer_provider
-            base_url = Bedrock.resolve_base_url(@base_url, @region)
+            base_url = Bedrock.resolve_base_url(@base_url, @region, endpoint: @endpoint)
+            Bedrock.validate_canonical_endpoint!(base_url, @endpoint, @region)
             auth = BearerAuth.new(token_provider: @bearer_provider, base_url: base_url)
           else
             Bedrock.load_aws!
             region = @region || Bedrock.profile_region(@profile)
             raise ArgumentError, MISSING_REGION_MESSAGE if region.nil?
+            Bedrock.validate_region!(region)
 
-            base_url = Bedrock.resolve_base_url(@base_url, region)
+            base_url = Bedrock.resolve_base_url(@base_url, region, endpoint: @endpoint)
+            Bedrock.validate_canonical_endpoint!(base_url, @endpoint, region)
             credentials =
               if @access_key_id
                 Aws::Credentials.new(@access_key_id, @secret_access_key, @session_token)
@@ -81,6 +87,7 @@ module OpenAI
                 DefaultCredentialsProvider.new
               end
             auth = SigV4Auth.new(
+              endpoint: @endpoint,
               region: region,
               base_url: base_url,
               credentials_provider: credentials,
@@ -91,7 +98,8 @@ module OpenAI
           OpenAI::Internal::Provider::Runtime.new(
             name: name,
             base_url: base_url,
-            prepare_request: auth.method(:prepare_request)
+            prepare_request: auth.method(:prepare_request),
+            authentication_headers: AUTH_HEADERS
           )
         end
       end
@@ -128,12 +136,13 @@ module OpenAI
       end
 
       class SigV4Auth
-        def initialize(region:, base_url:, credentials_provider:, default_chain:)
+        def initialize(endpoint:, region:, base_url:, credentials_provider:, default_chain:)
+          @endpoint = endpoint
           @region = region
           @base_url = URI(base_url)
           @default_chain = default_chain
           @signer = Aws::Sigv4::Signer.new(
-            service: SERVICE,
+            service: SERVICES.fetch(endpoint),
             region: region,
             credentials_provider: credentials_provider
           )
@@ -142,7 +151,7 @@ module OpenAI
         def prepare_request(request)
           url = request.fetch(:url)
           Bedrock.validate_origin!(url, @base_url, action: "sign")
-          Bedrock.validate_endpoint_region!(url, @region)
+          Bedrock.validate_endpoint_region!(url, @region, endpoint: @endpoint)
           body = request[:body]
           unless body.nil? || body.is_a?(String)
             raise OpenAI::Errors::Error, NON_REPLAYABLE_BODY_MESSAGE
@@ -261,10 +270,86 @@ module OpenAI
           raise OpenAI::Errors::Error.new(MISSING_DEPENDENCY_MESSAGE), cause: e
         end
 
-        def resolve_base_url(base_url, region)
+        def resolve_base_url(base_url, region, endpoint:)
           return base_url if base_url
           raise ArgumentError, MISSING_REGION_MESSAGE if region.nil?
-          "https://bedrock-mantle.#{region}.api.aws/v1"
+
+          if endpoint == :runtime
+            suffix, = runtime_dns_suffixes(region)
+            "https://bedrock-runtime.#{region}.#{suffix}/openai/v1"
+          else
+            "https://bedrock-mantle.#{region}.api.aws/v1"
+          end
+        end
+
+        def runtime_dns_suffixes(region)
+          case region
+          when /\Acn-/
+            ["amazonaws.com.cn", "api.amazonwebservices.com.cn"]
+          when /\Aeusc-/
+            ["amazonaws.eu", "api.amazonwebservices.eu"]
+          when /\Aus-iso-/
+            ["c2s.ic.gov", "api.aws.ic.gov"]
+          when /\Aus-isob-/
+            ["sc2s.sgov.gov", "api.aws.scloud"]
+          when /\Aeu-isoe-/
+            ["cloud.adc-e.uk", "api.cloud-aws.adc-e.uk"]
+          when /\Aus-isof-/
+            ["csp.hci.ic.gov", "api.aws.hci.ic.gov"]
+          else
+            ["amazonaws.com", "api.aws"]
+          end
+        end
+
+        def parse_endpoint_hostname(hostname)
+          service, region, *suffix_parts = hostname.delete_suffix(".").downcase.split(".")
+          suffix = suffix_parts.join(".")
+
+          if service == "bedrock-mantle" && region&.match?(/\A[a-z0-9-]+\z/) && suffix == "api.aws"
+            return {endpoint: :mantle, region: region}
+          end
+
+          if %w[bedrock-runtime bedrock-runtime-fips].include?(service) && region &&
+             runtime_dns_suffixes(region).include?(suffix)
+            return {endpoint: :runtime, region: region}
+          end
+
+          nil
+        end
+
+        def validate_canonical_endpoint!(base_url, endpoint, region)
+          uri = URI(base_url)
+          canonical = parse_endpoint_hostname(uri.host)
+          return unless canonical
+
+          unless uri.is_a?(URI::HTTPS)
+            raise ArgumentError, "Canonical Amazon Bedrock endpoints require HTTPS."
+          end
+          if canonical.fetch(:endpoint) != endpoint
+            raise ArgumentError,
+                  "The Bedrock #{canonical.fetch(:endpoint)} hostname does not match the " \
+                  "selected `#{endpoint}` endpoint."
+          end
+          return if region.nil? || canonical.fetch(:region) == region
+
+          raise ArgumentError,
+                "The Bedrock endpoint region `#{canonical.fetch(:region)}` does not match the " \
+                "configured AWS region `#{region}`."
+        end
+
+        def validate_region!(region)
+          return if AWS_REGION_PATTERN.match?(region)
+
+          raise ArgumentError,
+                "The Bedrock AWS `region` is invalid. Use a standard AWS region such as `us-east-1`."
+        end
+
+        def normalize_endpoint(endpoint)
+          return nil if endpoint.nil?
+          return endpoint.to_sym if endpoint == "mantle" || endpoint == "runtime"
+          return endpoint if endpoint == :mantle || endpoint == :runtime
+
+          raise ArgumentError, "The Bedrock `endpoint` must be either `mantle` or `runtime`."
         end
 
         def normalize_base_url(base_url)
@@ -308,9 +393,18 @@ module OpenAI
                 message
         end
 
-        def validate_endpoint_region!(url, region)
-          endpoint_region = CANONICAL_HOST.match(url.host)&.[](1)
-          return if endpoint_region.nil? || endpoint_region == region
+        def validate_endpoint_region!(url, region, endpoint:)
+          canonical = parse_endpoint_hostname(url.host)
+          return unless canonical
+
+          if canonical.fetch(:endpoint) != endpoint
+            raise OpenAI::Errors::Error,
+                  "The Bedrock #{canonical.fetch(:endpoint)} hostname does not match the " \
+                  "selected `#{endpoint}` endpoint."
+          end
+
+          endpoint_region = canonical.fetch(:region)
+          return if endpoint_region == region
           message =
             "The Bedrock endpoint region `#{endpoint_region}` does not match the SigV4 " \
             "region `#{region}`."
@@ -340,16 +434,19 @@ module OpenAI
     end
 
     class << self
-      # Configure the standard OpenAI client for Amazon Bedrock Mantle.
+      # Configure the standard OpenAI client for Amazon Bedrock Mantle or Runtime.
       #
       # Authentication precedence is an explicit bearer or AWS mode, then
       # AWS_BEARER_TOKEN_BEDROCK, then the standard AWS credential chain.
       #
+      # @param endpoint [String, Symbol, nil] Bedrock endpoint family. Defaults to
+      #   Mantle unless a canonical Runtime `base_url` is supplied.
+      #
       # @param region [String, nil] AWS signing region. Defaults to `AWS_REGION`,
       #   `AWS_DEFAULT_REGION`, or the selected profile's configured region.
       #
       # @param base_url [String, nil] Bedrock API root. Defaults to
-      #   `AWS_BEDROCK_BASE_URL` or the regional Bedrock Mantle endpoint.
+      #   `AWS_BEDROCK_BASE_URL` or the selected regional Bedrock endpoint.
       #
       # @param api_key [String, nil] Explicit Bedrock bearer credential. Passing
       #   `nil` explicitly skips the `AWS_BEARER_TOKEN_BEDROCK` fallback.
@@ -372,6 +469,7 @@ module OpenAI
       #
       # @return [OpenAI::Provider]
       def bedrock(
+        endpoint: nil,
         region: nil,
         base_url: OpenAI::Internal::OMIT,
         api_key: OpenAI::Internal::OMIT,
@@ -382,12 +480,12 @@ module OpenAI
         profile: nil,
         credentials_provider: nil
       )
+        normalized_endpoint = Bedrock.normalize_endpoint(endpoint)
         normalized_region = Bedrock.normalize_optional_string(region)
         if !region.nil? && normalized_region.nil?
           raise ArgumentError, "The Bedrock AWS `region` must not be empty."
         end
-        normalized_region ||= Bedrock.normalize_optional_string(ENV["AWS_REGION"]) ||
-                              Bedrock.normalize_optional_string(ENV["AWS_DEFAULT_REGION"])
+        Bedrock.validate_region!(normalized_region) if normalized_region
 
         normalized_profile = Bedrock.normalize_optional_string(profile)
         if !profile.nil? && normalized_profile.nil?
@@ -405,6 +503,10 @@ module OpenAI
             normalized
           end
         configured_base_url = Bedrock.normalize_base_url(configured_base_url) if configured_base_url
+        canonical_endpoint = if configured_base_url
+          Bedrock.parse_endpoint_hostname(URI(configured_base_url).host)
+        end
+        resolved_endpoint = normalized_endpoint || canonical_endpoint&.fetch(:endpoint) || :mantle
 
         has_access_key = !access_key_id.nil?
         has_secret_key = !secret_access_key.nil?
@@ -467,11 +569,22 @@ module OpenAI
             end
           end
 
+        if normalized_region.nil? && (bearer_provider.nil? || configured_base_url.nil?)
+          normalized_region = Bedrock.normalize_optional_string(ENV["AWS_REGION"]) ||
+                              Bedrock.normalize_optional_string(ENV["AWS_DEFAULT_REGION"])
+          Bedrock.validate_region!(normalized_region) if normalized_region
+        end
+
+        if configured_base_url
+          Bedrock.validate_canonical_endpoint!(configured_base_url, resolved_endpoint, normalized_region)
+        end
+
         if bearer_provider && configured_base_url.nil? && normalized_region.nil?
           raise ArgumentError, Bedrock::MISSING_REGION_MESSAGE
         end
 
         definition = Bedrock::Definition.new(
+          endpoint: resolved_endpoint,
           region: normalized_region,
           base_url: configured_base_url,
           bearer_provider: bearer_provider,

data/lib/openai/resources/admin/organization/projects/groups/roles.rb

@@ -97,11 +97,11 @@ module OpenAI
               # @see OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams
               def list(group_id, params)
                 parsed, options = OpenAI::Admin::Organization::Projects::Groups::RoleListParams.dump_request(params)
-                query = OpenAI::Internal::Util.encode_query_params(parsed)
                 project_id =
                   parsed.delete(:project_id) do
                     raise ArgumentError.new("missing required path argument #{_1}")
                   end
+                query = OpenAI::Internal::Util.encode_query_params(parsed)
                 @client.request(
                   method: :get,
                   path: ["projects/%1$s/groups/%2$s/roles", project_id, group_id],

data/lib/openai/resources/admin/organization/projects/groups.rb

@@ -53,11 +53,11 @@ module OpenAI
             # @see OpenAI::Models::Admin::Organization::Projects::GroupRetrieveParams
             def retrieve(group_id, params)
               parsed, options = OpenAI::Admin::Organization::Projects::GroupRetrieveParams.dump_request(params)
-              query = OpenAI::Internal::Util.encode_query_params(parsed)
               project_id =
                 parsed.delete(:project_id) do
                   raise ArgumentError.new("missing required path argument #{_1}")
                 end
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
               @client.request(
                 method: :get,
                 path: ["organization/projects/%1$s/groups/%2$s", project_id, group_id],

data/lib/openai/resources/admin/organization/projects/users/roles.rb

@@ -97,11 +97,11 @@ module OpenAI
               # @see OpenAI::Models::Admin::Organization::Projects::Users::RoleListParams
               def list(user_id, params)
                 parsed, options = OpenAI::Admin::Organization::Projects::Users::RoleListParams.dump_request(params)
-                query = OpenAI::Internal::Util.encode_query_params(parsed)
                 project_id =
                   parsed.delete(:project_id) do
                     raise ArgumentError.new("missing required path argument #{_1}")
                   end
+                query = OpenAI::Internal::Util.encode_query_params(parsed)
                 @client.request(
                   method: :get,
                   path: ["projects/%1$s/users/%2$s/roles", project_id, user_id],

data/lib/openai/resources/admin/organization/projects.rb

@@ -182,7 +182,8 @@ module OpenAI
           def initialize(client:)
             @client = client
             @users = OpenAI::Resources::Admin::Organization::Projects::Users.new(client: client)
-            @service_accounts = OpenAI::Resources::Admin::Organization::Projects::ServiceAccounts.new(client: client)
+            @service_accounts =
+              OpenAI::Resources::Admin::Organization::Projects::ServiceAccounts.new(client: client)
             @api_keys = OpenAI::Resources::Admin::Organization::Projects::APIKeys.new(client: client)
             @rate_limits = OpenAI::Resources::Admin::Organization::Projects::RateLimits.new(client: client)
             @model_permissions =
@@ -191,7 +192,8 @@ module OpenAI
               OpenAI::Resources::Admin::Organization::Projects::HostedToolPermissions.new(client: client)
             @groups = OpenAI::Resources::Admin::Organization::Projects::Groups.new(client: client)
             @roles = OpenAI::Resources::Admin::Organization::Projects::Roles.new(client: client)
-            @data_retention = OpenAI::Resources::Admin::Organization::Projects::DataRetention.new(client: client)
+            @data_retention =
+              OpenAI::Resources::Admin::Organization::Projects::DataRetention.new(client: client)
             @spend_limit = OpenAI::Resources::Admin::Organization::Projects::SpendLimit.new(client: client)
             @spend_alerts = OpenAI::Resources::Admin::Organization::Projects::SpendAlerts.new(client: client)
             @certificates = OpenAI::Resources::Admin::Organization::Projects::Certificates.new(client: client)

data/lib/openai/resources/audio/transcriptions.rb

@@ -16,6 +16,10 @@ module OpenAI
         # Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
         # format, or a stream of transcript events.
         #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
+        #
         # @overload create(file:, model:, chunking_strategy: nil, include: nil, keywords: nil, known_speaker_names: nil, known_speaker_references: nil, language: nil, languages: nil, prompt: nil, response_format: nil, temperature: nil, timestamp_granularities: nil, request_options: {})
         #
         # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) to transcribe, in one of these formats: fl
@@ -77,6 +81,10 @@ module OpenAI
         # Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
         # format, or a stream of transcript events.
         #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
+        #
         # @overload create_streaming(file:, model:, chunking_strategy: nil, include: nil, keywords: nil, known_speaker_names: nil, known_speaker_references: nil, language: nil, languages: nil, prompt: nil, response_format: nil, temperature: nil, timestamp_granularities: nil, request_options: {})
         #
         # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) to transcribe, in one of these formats: fl

data/lib/openai/resources/audio/translations.rb

@@ -10,6 +10,10 @@ module OpenAI
         #
         # Translates audio into English.
         #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
+        #
         # @overload create(file:, model:, prompt: nil, response_format: nil, temperature: nil, request_options: {})
         #
         # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) translate, in one of these formats: flac,

data/lib/openai/resources/beta/responses.rb

@@ -301,12 +301,12 @@ module OpenAI
         def retrieve_streaming(response_id, params = {})
           query_params = [:include, :include_obfuscation, :starting_after, :stream]
           parsed, options = OpenAI::Beta::ResponseRetrieveParams.dump_request(params)
-          query = OpenAI::Internal::Util.encode_query_params(parsed.slice(*query_params))
           unless parsed.fetch(:stream, true)
             message = "Please use `#retrieve` for the non-streaming use case."
             raise ArgumentError.new(message)
           end
           parsed.store(:stream, true)
+          query = OpenAI::Internal::Util.encode_query_params(parsed.slice(*query_params))
           @client.request(
             method: :get,
             path: ["responses/%1$s?beta=true", response_id],

data/lib/openai/resources/beta/threads/runs/steps.rb

@@ -33,7 +33,6 @@ module OpenAI
             # @see OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams
             def retrieve(step_id, params)
               parsed, options = OpenAI::Beta::Threads::Runs::StepRetrieveParams.dump_request(params)
-              query = OpenAI::Internal::Util.encode_query_params(parsed)
               thread_id =
                 parsed.delete(:thread_id) do
                   raise ArgumentError.new("missing required path argument #{_1}")
@@ -42,6 +41,7 @@ module OpenAI
                 parsed.delete(:run_id) do
                   raise ArgumentError.new("missing required path argument #{_1}")
                 end
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
               @client.request(
                 method: :get,
                 path: ["threads/%1$s/runs/%2$s/steps/%3$s", thread_id, run_id, step_id],
@@ -82,11 +82,11 @@ module OpenAI
             # @see OpenAI::Models::Beta::Threads::Runs::StepListParams
             def list(run_id, params)
               parsed, options = OpenAI::Beta::Threads::Runs::StepListParams.dump_request(params)
-              query = OpenAI::Internal::Util.encode_query_params(parsed)
               thread_id =
                 parsed.delete(:thread_id) do
                   raise ArgumentError.new("missing required path argument #{_1}")
                 end
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
               @client.request(
                 method: :get,
                 path: ["threads/%1$s/runs/%2$s/steps", thread_id, run_id],

data/lib/openai/resources/containers/files.rb

@@ -15,6 +15,10 @@ module OpenAI
         # You can send either a multipart/form-data request with the raw file content, or
         # a JSON request with a file ID.
         #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
+        #
         # @overload create(container_id, file: nil, file_id: nil, request_options: {})
         #
         # @param container_id [String]

data/lib/openai/resources/content_provenance_checks.rb

@@ -13,6 +13,10 @@ module OpenAI
       # signals were available. Content could also still be AI-generated by another
       # company's model, which the tool currently does not detect.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload create(file:, request_options: {})
       #
       # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The image or audio file to check for supported OpenAI provenance signals.

data/lib/openai/resources/conversations/items.rb

@@ -58,11 +58,11 @@ module OpenAI
         # @see OpenAI::Models::Conversations::ItemRetrieveParams
         def retrieve(item_id, params)
           parsed, options = OpenAI::Conversations::ItemRetrieveParams.dump_request(params)
-          query = OpenAI::Internal::Util.encode_query_params(parsed)
           conversation_id =
             parsed.delete(:conversation_id) do
               raise ArgumentError.new("missing required path argument #{_1}")
             end
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["conversations/%1$s/items/%2$s", conversation_id, item_id],

data/lib/openai/resources/evals/runs/output_items.rb

@@ -66,11 +66,11 @@ module OpenAI
           # @see OpenAI::Models::Evals::Runs::OutputItemListParams
           def list(run_id, params)
             parsed, options = OpenAI::Evals::Runs::OutputItemListParams.dump_request(params)
-            query = OpenAI::Internal::Util.encode_query_params(parsed)
             eval_id =
               parsed.delete(:eval_id) do
                 raise ArgumentError.new("missing required path argument #{_1}")
               end
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["evals/%1$s/runs/%2$s/output_items", eval_id, run_id],

data/lib/openai/resources/files.rb

@@ -36,6 +36,10 @@ module OpenAI
       # Please [contact us](https://help.openai.com/) if you need to increase these
       # storage limits.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload create(file:, purpose:, expires_after: nil, request_options: {})
       #
       # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The File object (not file name) to be uploaded.
@@ -138,7 +142,7 @@ module OpenAI
         )
       end
 
-      # Returns the contents of the specified file.
+      # Returns a response containing the contents of the specified file.
       #
       # @overload content(file_id, request_options: {})
       #

data/lib/openai/resources/images.rb

@@ -9,6 +9,10 @@ module OpenAI
       #
       # Creates a variation of a given image. This endpoint only supports `dall-e-2`.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload create_variation(image:, model: nil, n: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart] The image to use as the basis for the variation(s). Must be a valid PNG file, le
@@ -50,6 +54,10 @@ module OpenAI
       # prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`,
       # `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload edit(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>] The image(s) to edit. Must be a supported image file or an array of images.
@@ -111,6 +119,10 @@ module OpenAI
       # prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`,
       # `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload edit_stream_raw(image:, prompt:, background: nil, input_fidelity: nil, mask: nil, model: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, user: nil, request_options: {})
       #
       # @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>] The image(s) to edit. Must be a supported image file or an array of images.

data/lib/openai/resources/responses.rb

@@ -407,12 +407,12 @@ module OpenAI
       # @see OpenAI::Models::Responses::ResponseRetrieveParams
       def retrieve_streaming(response_id, params = {})
         parsed, options = OpenAI::Responses::ResponseRetrieveParams.dump_request(params)
-        query = OpenAI::Internal::Util.encode_query_params(parsed)
         unless parsed.fetch(:stream, true)
           message = "Please use `#retrieve` for the non-streaming use case."
           raise ArgumentError.new(message)
         end
         parsed.store(:stream, true)
+        query = OpenAI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["responses/%1$s", response_id],
@@ -662,7 +662,8 @@ module OpenAI
               tool_models.store(name, params)
               tool[:function][:parameters] = params.to_json_schema
               tool
-            in {type: _, function: Hash => func} if func[:parameters].is_a?(Class) && func[:parameters] < OpenAI::Internal::Type::BaseModel
+            in {type: _, function: Hash => func} if func[:parameters].is_a?(Class) &&
+              func[:parameters] < OpenAI::Internal::Type::BaseModel
               params = func[:parameters]
               name = func[:name] || params.name.split("::").last
               tool_models.store(name, params)

data/lib/openai/resources/skills/versions.rb

@@ -9,6 +9,10 @@ module OpenAI
 
         # Create a new immutable skill version.
         #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
+        #
         # @overload create(skill_id, default: nil, files: nil, request_options: {})
         #
         # @param skill_id [String] The identifier of the skill to version.

data/lib/openai/resources/skills.rb

@@ -11,6 +11,10 @@ module OpenAI
 
       # Create a new skill.
       #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
+      #
       # @overload create(files: nil, request_options: {})
       #
       # @param files [Array<Pathname, StringIO, IO, String, OpenAI::FilePart>, Pathname, StringIO, IO, String, OpenAI::FilePart] Skill files to upload (directory upload) or a single zip file.

data/lib/openai/resources/uploads/parts.rb

@@ -20,6 +20,10 @@ module OpenAI
         # order of the Parts when you
         # [complete the Upload](https://platform.openai.com/docs/api-reference/uploads/complete).
         #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
+        #
         # @overload create(upload_id, data:, request_options: {})
         #
         # @param upload_id [String] The ID of the Upload.

data/lib/openai/resources/vector_stores/file_batches.rb

@@ -123,11 +123,11 @@ module OpenAI
         # @see OpenAI::Models::VectorStores::FileBatchListFilesParams
         def list_files(batch_id, params)
           parsed, options = OpenAI::VectorStores::FileBatchListFilesParams.dump_request(params)
-          query = OpenAI::Internal::Util.encode_query_params(parsed)
           vector_store_id =
             parsed.delete(:vector_store_id) do
               raise ArgumentError.new("missing required path argument #{_1}")
             end
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["vector_stores/%1$s/file_batches/%2$s/files", vector_store_id, batch_id],