openai 0.99.0 → 0.101.0

data/lib/openai/models/beta/beta_responses_server_event.rb

@@ -2467,6 +2467,13 @@ module OpenAI
                 }
               )
 
+              # @!attribute review_target
+              #   An opaque target for explicitly continuing this review, or null when
+              #   unavailable.
+              #
+              #   @return [String, nil]
+              optional :review_target, String, nil?: true
+
               # @!attribute steer
               #   An optional public continuation instruction.
               #
@@ -2476,13 +2483,17 @@ module OpenAI
                 -> { OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer }
               )
 
-              # @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
+              # @!method initialize(detailed_explanation: nil, error_type: nil, review_target: nil, steer: nil)
               #   @param detailed_explanation [String]
               #     The public explanation for this block.
               #
               #   @param error_type [String, Symbol, OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::ErrorType]
               #     An optional classification; clients must accept additional values.
               #
+              #   @param review_target [String, nil]
+              #     An opaque target for explicitly continuing this review, or null when
+              #     unavailable.
+              #
               #   @param steer [OpenAI::Models::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer]
               #     An optional public continuation instruction.
 

data/lib/openai/models/beta/beta_tool.rb

@@ -632,9 +632,10 @@ module OpenAI
           optional :background, enum: -> { OpenAI::Beta::BetaTool::ImageGeneration::Background }
 
           # @!attribute input_fidelity
-          #   Controls fidelity to the original input image(s). This parameter is supported
-          #   for GPT image models that support input fidelity. `gpt-image-2` and
-          #   `gpt-image-2-2026-04-21` ignore this parameter.
+          #   Control how much effort the model will exert to match the style and features,
+          #   especially facial features, of input images. Supports `high` and `low` on
+          #   `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
+          #   `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
           #
           #   @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::InputFidelity, nil]
           optional(
@@ -730,9 +731,10 @@ module OpenAI
           #     set the output format to `png` or `webp`.
           #
           #   @param input_fidelity [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::InputFidelity, nil]
-          #     Controls fidelity to the original input image(s). This parameter is supported
-          #     for GPT image models that support input fidelity. `gpt-image-2` and
-          #     `gpt-image-2-2026-04-21` ignore this parameter.
+          #     Control how much effort the model will exert to match the style and features,
+          #     especially facial features, of input images. Supports `high` and `low` on
+          #     `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
+          #     `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
           #
           #   @param input_image_mask [OpenAI::Models::Beta::BetaTool::ImageGeneration::InputImageMask]
           #     Optional mask for inpainting. Contains `image_url` (string, optional) and
@@ -816,9 +818,10 @@ module OpenAI
             #   @return [Array<Symbol>]
           end
 
-          # Controls fidelity to the original input image(s). This parameter is supported
-          # for GPT image models that support input fidelity. `gpt-image-2` and
-          # `gpt-image-2-2026-04-21` ignore this parameter.
+          # Control how much effort the model will exert to match the style and features,
+          # especially facial features, of input images. Supports `high` and `low` on
+          # `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
+          # `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
           #
           # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#input_fidelity
           module InputFidelity

data/lib/openai/models/beta/beta_tool_search_output_namespace_tool.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaToolSearchOutputNamespaceTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute description
+        #   A description of the namespace shown to the model.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   The namespace name used in tool calls (for example, `crm`).
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute tools
+        #   The function/custom tools loaded inside this namespace.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaToolSearchOutputNamespaceTool::Tool::Function, OpenAI::Models::Beta::BetaCustomTool>]
+        required(
+          :tools,
+          -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaToolSearchOutputNamespaceTool::Tool] }
+        )
+
+        # @!attribute type
+        #   The type of the tool. Always `namespace`.
+        #
+        #   @return [Symbol, :namespace]
+        required :type, const: :namespace
+
+        # @!method initialize(description:, name:, tools:, type: :namespace)
+        #   Groups function/custom tools under a shared namespace.
+        #
+        #   @param description [String]
+        #     A description of the namespace shown to the model.
+        #
+        #   @param name [String]
+        #     The namespace name used in tool calls (for example, `crm`).
+        #
+        #   @param tools [Array<OpenAI::Models::Beta::BetaToolSearchOutputNamespaceTool::Tool::Function, OpenAI::Models::Beta::BetaCustomTool>]
+        #     The function/custom tools loaded inside this namespace.
+        #
+        #   @param type [Symbol, :namespace]
+        #     The type of the tool. Always `namespace`.
+
+        # A function or custom tool loaded into a namespace by tool search.
+        module Tool
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :function, -> { OpenAI::Beta::BetaToolSearchOutputNamespaceTool::Tool::Function }
+
+          # A custom tool that processes input using a specified format. Learn more about   [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)
+          variant :custom, -> { OpenAI::Beta::BetaCustomTool }
+
+          class Function < OpenAI::Internal::Type::BaseModel
+            # @!attribute name
+            #   The name of the loaded function tool.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :function]
+            required :type, const: :function
+
+            # @!attribute allowed_callers
+            #   The tool invocation context(s).
+            #
+            #   @return [Array<Symbol, OpenAI::Models::Beta::BetaToolSearchOutputNamespaceTool::Tool::Function::AllowedCaller>, nil]
+            optional(
+              :allowed_callers,
+              -> {
+                OpenAI::Internal::Type::ArrayOf[
+                  enum: OpenAI::Beta::BetaToolSearchOutputNamespaceTool::Tool::Function::AllowedCaller
+                ]
+              },
+              nil?: true
+            )
+
+            # @!attribute async
+            #   Whether the tool response can be returned asynchronously versus immediately
+            #   returned on next response creation.
+            #
+            #   @return [Boolean, nil]
+            optional :async, OpenAI::Internal::Type::Boolean
+
+            # @!attribute defer_loading
+            #   Whether this function should be deferred and discovered via tool search.
+            #
+            #   @return [Boolean, nil]
+            optional :defer_loading, OpenAI::Internal::Type::Boolean
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String, nil?: true
+
+            # @!attribute output_schema
+            #   A JSON Schema describing the JSON value encoded in string outputs for this
+            #   function tool. This does not describe content-array outputs.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional(
+              :output_schema,
+              OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
+              nil?: true
+            )
+
+            # @!attribute parameters
+            #
+            #   @return [Object, nil]
+            optional :parameters, OpenAI::Internal::Type::Unknown, nil?: true
+
+            # @!attribute strict
+            #   Whether to enforce strict parameter validation. If omitted, Responses attempts
+            #   to use strict validation when the schema is compatible, and falls back to
+            #   non-strict validation otherwise.
+            #
+            #   @return [Boolean, nil]
+            optional :strict, OpenAI::Internal::Type::Boolean, nil?: true
+
+            # @!method initialize(name:, allowed_callers: nil, async: nil, defer_loading: nil, description: nil, output_schema: nil, parameters: nil, strict: nil, type: :function)
+            #   @param name [String]
+            #     The name of the loaded function tool.
+            #
+            #   @param allowed_callers [Array<Symbol, OpenAI::Models::Beta::BetaToolSearchOutputNamespaceTool::Tool::Function::AllowedCaller>, nil]
+            #     The tool invocation context(s).
+            #
+            #   @param async [Boolean]
+            #     Whether the tool response can be returned asynchronously versus immediately
+            #     returned on next response creation.
+            #
+            #   @param defer_loading [Boolean]
+            #     Whether this function should be deferred and discovered via tool search.
+            #
+            #   @param description [String, nil]
+            #
+            #   @param output_schema [Hash{Symbol=>Object}, nil]
+            #     A JSON Schema describing the JSON value encoded in string outputs for this
+            #     function tool. This does not describe content-array outputs.
+            #
+            #   @param parameters [Object, nil]
+            #
+            #   @param strict [Boolean, nil]
+            #     Whether to enforce strict parameter validation. If omitted, Responses attempts
+            #     to use strict validation when the schema is compatible, and falls back to
+            #     non-strict validation otherwise.
+            #
+            #   @param type [Symbol, :function]
+
+            module AllowedCaller
+              extend OpenAI::Internal::Type::Enum
+
+              DIRECT = :direct
+              PROGRAMMATIC = :programmatic
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaToolSearchOutputNamespaceTool::Tool::Function, OpenAI::Models::Beta::BetaCustomTool)]
+        end
+      end
+    end
+
+    BetaToolSearchOutputNamespaceTool = Beta::BetaToolSearchOutputNamespaceTool
+  end
+end

data/lib/openai/models/beta/environment_param.rb

@@ -83,8 +83,8 @@ module OpenAI
           )
 
           # @!attribute network
-          #   Network access policy for the environment. Defaults to disabled for GA requests
-          #   and enabled for beta requests.
+          #   Network access policy for the environment. If omitted, the API version
+          #   determines whether network access is enabled or disabled.
           #
           #   @return [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network, nil]
           optional :network, -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network }, nil?: true
@@ -154,8 +154,8 @@ module OpenAI
           #     Files available before the agent starts. Defaults to an empty list.
           #
           #   @param network [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network, nil]
-          #     Network access policy for the environment. Defaults to disabled for GA requests
-          #     and enabled for beta requests.
+          #     Network access policy for the environment. If omitted, the API version
+          #     determines whether network access is enabled or disabled.
           #
           #   @param packages [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Packages, nil]
           #     Packages to install in the environment. Defaults to empty package lists.
@@ -226,8 +226,8 @@ module OpenAI
             optional :blocked_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
 
             # @!method initialize(access:, allowed_domains: nil, blocked_domains: nil)
-            #   Network access policy for the environment. Defaults to disabled for GA requests
-            #   and enabled for beta requests.
+            #   Network access policy for the environment. If omitted, the API version
+            #   determines whether network access is enabled or disabled.
             #
             #   @param access [Symbol, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network::Access]
             #     The environment's network access mode.

data/lib/openai/models/beta/session_turn_error.rb

@@ -40,6 +40,15 @@ module OpenAI
           # The organization has reached a usage, plan, or billing limit.
           USAGE_LIMIT_EXCEEDED = :usage_limit_exceeded
 
+          # The project has reached its enforced spend limit.
+          PROJECT_SPEND_LIMIT_EXCEEDED = :project_spend_limit_exceeded
+
+          # The organization has reached its enforced spend limit.
+          ORGANIZATION_SPEND_LIMIT_EXCEEDED = :organization_spend_limit_exceeded
+
+          # The organization has reached its OpenAI-assigned usage limit.
+          ORGANIZATION_USAGE_LIMIT_EXCEEDED = :organization_usage_limit_exceeded
+
           # The organization has no API credits remaining.
           CREDIT_BALANCE_EXHAUSTED = :credit_balance_exhausted
 

data/lib/openai/models/chat/chat_completion_chunk.rb

@@ -172,21 +172,30 @@ module OpenAI
         #     The object type, which is always `chat.completion.chunk`.
         class Choice < OpenAI::Internal::Type::BaseModel
           # @!attribute delta
-          #   A chat completion delta generated by streamed model responses.
+          #   A chat completion delta generated by streamed model responses. Streamed audio
+          #   can arrive in partial updates with an ID, base64 data, or transcript text. The
+          #   final audio update contains only its expiry timestamp.
           #
           #   @return [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta]
           required :delta, -> { OpenAI::Chat::ChatCompletionChunk::Choice::Delta }
 
+          # @!attribute index
+          #   The index of the choice in the list of choices.
+          #
+          #   @return [Integer]
+          required :index, Integer
+
           # @!attribute finish_reason
           #   The reason the model stopped generating tokens. This will be `stop` if the model
           #   hit a natural stop point or a provided stop sequence, `length` if the maximum
           #   number of tokens specified in the request was reached, `content_filter` if
           #   content was omitted due to a flag from our content filters, `tool_calls` if the
           #   model called a tool, or `function_call` (deprecated) if the model called a
-          #   function.
+          #   function. Omitted from the final audio update containing only
+          #   `delta.audio.expires_at`.
           #
           #   @return [Symbol, OpenAI::Models::Chat::ChatCompletionChunk::Choice::FinishReason, nil]
-          required(
+          optional(
             :finish_reason,
             enum: -> {
               OpenAI::Chat::ChatCompletionChunk::Choice::FinishReason
@@ -194,21 +203,20 @@ module OpenAI
             nil?: true
           )
 
-          # @!attribute index
-          #   The index of the choice in the list of choices.
-          #
-          #   @return [Integer]
-          required :index, Integer
-
           # @!attribute logprobs
           #   Log probability information for the choice.
           #
           #   @return [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Logprobs, nil]
           optional :logprobs, -> { OpenAI::Chat::ChatCompletionChunk::Choice::Logprobs }, nil?: true
 
-          # @!method initialize(delta:, finish_reason:, index:, logprobs: nil)
+          # @!method initialize(delta:, index:, finish_reason: nil, logprobs: nil)
           #   @param delta [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta]
-          #     A chat completion delta generated by streamed model responses.
+          #     A chat completion delta generated by streamed model responses. Streamed audio
+          #     can arrive in partial updates with an ID, base64 data, or transcript text. The
+          #     final audio update contains only its expiry timestamp.
+          #
+          #   @param index [Integer]
+          #     The index of the choice in the list of choices.
           #
           #   @param finish_reason [Symbol, OpenAI::Models::Chat::ChatCompletionChunk::Choice::FinishReason, nil]
           #     The reason the model stopped generating tokens. This will be `stop` if the model
@@ -216,16 +224,21 @@ module OpenAI
           #     number of tokens specified in the request was reached, `content_filter` if
           #     content was omitted due to a flag from our content filters, `tool_calls` if the
           #     model called a tool, or `function_call` (deprecated) if the model called a
-          #     function.
-          #
-          #   @param index [Integer]
-          #     The index of the choice in the list of choices.
+          #     function. Omitted from the final audio update containing only
+          #     `delta.audio.expires_at`.
           #
           #   @param logprobs [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Logprobs, nil]
           #     Log probability information for the choice.
 
           # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice#delta
           class Delta < OpenAI::Internal::Type::BaseModel
+            # @!attribute audio
+            #   A partial audio response. Audio chunks may carry an ID, base64 data, or
+            #   transcript text; the final audio update contains only its expiry timestamp.
+            #
+            #   @return [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::Audio, nil]
+            optional :audio, -> { OpenAI::Chat::ChatCompletionChunk::Choice::Delta::Audio }
+
             # @!attribute content
             #   The contents of the chunk message.
             #
@@ -261,8 +274,14 @@ module OpenAI
               -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall] }
             )
 
-            # @!method initialize(content: nil, function_call: nil, refusal: nil, role: nil, tool_calls: nil)
-            #   A chat completion delta generated by streamed model responses.
+            # @!method initialize(audio: nil, content: nil, function_call: nil, refusal: nil, role: nil, tool_calls: nil)
+            #   A chat completion delta generated by streamed model responses. Streamed audio
+            #   can arrive in partial updates with an ID, base64 data, or transcript text. The
+            #   final audio update contains only its expiry timestamp.
+            #
+            #   @param audio [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::Audio]
+            #     A partial audio response. Audio chunks may carry an ID, base64 data, or
+            #     transcript text; the final audio update contains only its expiry timestamp.
             #
             #   @param content [String, nil]
             #     The contents of the chunk message.
@@ -279,6 +298,53 @@ module OpenAI
             #
             #   @param tool_calls [Array<OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::ToolCall>]
 
+            # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta#audio
+            class Audio < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   Unique identifier for this audio response.
+              #
+              #   @return [String, nil]
+              optional :id, String
+
+              # @!attribute data
+              #   Base64 encoded audio bytes generated by the model, in the format specified in
+              #   the request.
+              #
+              #   @return [String, nil]
+              optional :data, String
+
+              # @!attribute expires_at
+              #   The Unix timestamp (in seconds) for when this audio response will no longer be
+              #   accessible on the server for use in multi-turn conversations.
+              #
+              #   @return [Integer, nil]
+              optional :expires_at, Integer
+
+              # @!attribute transcript
+              #   Transcript text from this audio chunk.
+              #
+              #   @return [String, nil]
+              optional :transcript, String
+
+              # @!method initialize(id: nil, data: nil, expires_at: nil, transcript: nil)
+              #   A partial audio response. Audio chunks may carry an ID, base64 data, or
+              #   transcript text; the final audio update contains only its expiry timestamp.
+              #
+              #   @param id [String]
+              #     Unique identifier for this audio response.
+              #
+              #   @param data [String]
+              #     Base64 encoded audio bytes generated by the model, in the format specified in
+              #     the request.
+              #
+              #   @param expires_at [Integer]
+              #     The Unix timestamp (in seconds) for when this audio response will no longer be
+              #     accessible on the server for use in multi-turn conversations.
+              #
+              #   @param transcript [String]
+              #     Transcript text from this audio chunk.
+            end
+
             # @deprecated
             #
             # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta#function_call
@@ -409,7 +475,8 @@ module OpenAI
           # number of tokens specified in the request was reached, `content_filter` if
           # content was omitted due to a flag from our content filters, `tool_calls` if the
           # model called a tool, or `function_call` (deprecated) if the model called a
-          # function.
+          # function. Omitted from the final audio update containing only
+          # `delta.audio.expires_at`.
           #
           # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice#finish_reason
           module FinishReason