openai 0.89.0 → 0.91.0

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

@@ -739,8 +739,6 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_5_1_CODEX }
 
-          variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_5_1_MINI }
-
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_5_1_CHAT_LATEST }
 
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_5 }
@@ -801,6 +799,10 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_4O_2024_05_13 }
 
+          variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_AUDIO_MINI }
+
+          variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_AUDIO_MINI_2025_12_15 }
+
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_4O_AUDIO_PREVIEW }
 
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_4O_AUDIO_PREVIEW_2024_10_01 }
@@ -869,6 +871,8 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_3_5_TURBO_16K_0613 }
 
+          variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::GPT_5_1_MINI }
+
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::O1_PRO }
 
           variant const: -> { OpenAI::Models::Beta::ResponseCreateParams::Model::O1_PRO_2025_03_19 }
@@ -938,7 +942,6 @@ module OpenAI
           GPT_5_1 = :"gpt-5.1"
           GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
           GPT_5_1_CODEX = :"gpt-5.1-codex"
-          GPT_5_1_MINI = :"gpt-5.1-mini"
           GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
           GPT_5 = :"gpt-5"
           GPT_5_MINI = :"gpt-5-mini"
@@ -969,6 +972,8 @@ module OpenAI
           GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
           GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
           GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
+          GPT_AUDIO_MINI = :"gpt-audio-mini"
+          GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
           GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
           GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
           GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
@@ -1002,6 +1007,7 @@ module OpenAI
           GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
           GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
           GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
+          GPT_5_1_MINI = :"gpt-5.1-mini"
           O1_PRO = :"o1-pro"
           O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
           O3_PRO = :"o3-pro"
@@ -1180,6 +1186,13 @@ module OpenAI
           #   @return [Symbol, OpenAI::Models::Beta::ResponseCreateParams::PromptCacheOptions::Mode, nil]
           optional :mode, enum: -> { OpenAI::Beta::ResponseCreateParams::PromptCacheOptions::Mode }
 
+          # @!attribute prewarm
+          #   Prepares the prompt cache without generating output. Defaults to `false`. When
+          #   set to `true`, overrides the `generate` field to `false`.
+          #
+          #   @return [Boolean, nil]
+          optional :prewarm, OpenAI::Internal::Type::Boolean
+
           # @!attribute ttl
           #   The minimum lifetime applied to every implicit and explicit cache breakpoint
           #   written by the request. Defaults to `30m`, which is currently the only supported
@@ -1188,7 +1201,7 @@ module OpenAI
           #   @return [Symbol, OpenAI::Models::Beta::ResponseCreateParams::PromptCacheOptions::Ttl, nil]
           optional :ttl, enum: -> { OpenAI::Beta::ResponseCreateParams::PromptCacheOptions::Ttl }
 
-          # @!method initialize(comparison_response_id: nil, mode: nil, ttl: nil)
+          # @!method initialize(comparison_response_id: nil, mode: nil, prewarm: nil, ttl: nil)
           #   Options for prompt caching. Supported for `gpt-5.6` and later models. By
           #   default, OpenAI automatically chooses one implicit cache breakpoint. You can add
           #   explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each
@@ -1211,6 +1224,10 @@ module OpenAI
           #     latest four explicit breakpoints. If there are no explicit breakpoints, the
           #     request does not use prompt caching.
           #
+          #   @param prewarm [Boolean]
+          #     Prepares the prompt cache without generating output. Defaults to `false`. When
+          #     set to `true`, overrides the `generate` field to `false`.
+          #
           #   @param ttl [Symbol, OpenAI::Models::Beta::ResponseCreateParams::PromptCacheOptions::Ttl]
           #     The minimum lifetime applied to every implicit and explicit cache breakpoint
           #     written by the request. Defaults to `30m`, which is currently the only supported

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class SessionError < OpenAI::Internal::Type::BaseModel
+        # @!attribute code
+        #   The machine-readable error code, if any.
+        #
+        #   @return [String, nil]
+        required :code, String, nil?: true
+
+        # @!attribute message
+        #   A customer-safe explanation of the error.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute param
+        #   The request parameter associated with the error, if any.
+        #
+        #   @return [String, nil]
+        required :param, String, nil?: true
+
+        # @!attribute type
+        #   The error type.
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!method initialize(code:, message:, param:, type:)
+        #   An error payload with the same public fields as Responses API streaming errors.
+        #
+        #   @param code [String, nil]
+        #     The machine-readable error code, if any.
+        #
+        #   @param message [String]
+        #     A customer-safe explanation of the error.
+        #
+        #   @param param [String, nil]
+        #     The request parameter associated with the error, if any.
+        #
+        #   @param type [String]
+        #     The error type.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class SessionTurnError < OpenAI::Internal::Type::BaseModel
+        # @!attribute code
+        #   A stable, machine-readable failure category.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::SessionTurnError::Code]
+        required :code, enum: -> { OpenAI::Beta::SessionTurnError::Code }
+
+        # @!attribute message
+        #   A customer-safe explanation of the failure.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!method initialize(code:, message:)
+        #   A customer-safe error describing why a session request failed.
+        #
+        #   @param code [Symbol, OpenAI::Models::Beta::SessionTurnError::Code]
+        #     A stable, machine-readable failure category.
+        #
+        #   @param message [String]
+        #     A customer-safe explanation of the failure.
+
+        # A stable, machine-readable failure category.
+        #
+        # @see OpenAI::Models::Beta::SessionTurnError#code
+        module Code
+          extend OpenAI::Internal::Type::Enum
+
+          # The request exceeds the model's context window.
+          CONTEXT_LENGTH_EXCEEDED = :context_length_exceeded
+
+          # The session has reached its usage budget.
+          SESSION_BUDGET_EXCEEDED = :session_budget_exceeded
+
+          # The organization has reached a usage, plan, or billing limit.
+          USAGE_LIMIT_EXCEEDED = :usage_limit_exceeded
+
+          # The organization has no API credits remaining.
+          CREDIT_BALANCE_EXHAUSTED = :credit_balance_exhausted
+
+          # The request exceeds the available rate limit.
+          RATE_LIMIT_EXCEEDED = :rate_limit_exceeded
+
+          # The model service is temporarily overloaded.
+          SERVER_OVERLOADED = :server_overloaded
+
+          # The request was rejected by a safety policy.
+          CYBER_POLICY = :cyber_policy
+
+          # The request could not connect to the model service.
+          CONNECTION_FAILED = :connection_failed
+
+          # The model service encountered an unexpected error.
+          SERVER_ERROR = :server_error
+
+          # The API credentials are invalid or lack the required access.
+          AUTHENTICATION_ERROR = :authentication_error
+
+          # The request contains invalid input or configuration.
+          INVALID_REQUEST = :invalid_request
+
+          # The requested model or resource is unavailable.
+          RESOURCE_NOT_FOUND = :resource_not_found
+
+          # The request could not complete in its execution environment.
+          SANDBOX_ERROR = :sandbox_error
+
+          # The executor must be upgraded before it can run this turn.
+          EXECUTOR_VERSION_INCOMPATIBLE = :executor_version_incompatible
+
+          # The session cannot accept additional input while a request is running.
+          ACTIVE_TURN_NOT_STEERABLE = :active_turn_not_steerable
+
+          # The request timed out before the model service responded.
+          REQUEST_TIMEOUT = :request_timeout
+
+          # An unexpected internal error prevented the session request from completing.
+          INTERNAL_ERROR = :internal_error
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class SetupCommandParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute command
+        #   The shell command to execute.
+        #
+        #   @return [String]
+        required :command, String
+
+        # @!attribute cwd
+        #   The absolute working directory. Defaults to `/workspace`.
+        #
+        #   @return [String, nil]
+        optional :cwd, String, nil?: true
+
+        # @!method initialize(command:, cwd: nil)
+        #   A confidential setup command executed before the hosted agent starts.
+        #
+        #   @param command [String]
+        #     The shell command to execute.
+        #
+        #   @param cwd [String, nil]
+        #     The absolute working directory. Defaults to `/workspace`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class Subagent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the subagent.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute closed_at
+        #   The Unix timestamp, in seconds, when the subagent was closed. Null while active,
+        #   including after resume.
+        #
+        #   @return [Integer, nil]
+        required :closed_at, Integer, nil?: true
+
+        # @!attribute instructions
+        #   Initial task content, or null when unavailable. Text may contain placeholders
+        #   for images or audio when only a preview is available.
+        #
+        #   @return [Array<OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent>, nil]
+        required(
+          :instructions,
+          -> {
+            OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentContent]
+          },
+          nil?: true
+        )
+
+        # @!attribute name
+        #   The runner-assigned nickname, or null when unavailable.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute object
+        #   The object type. Always `agent.session.subagent`.
+        #
+        #   @return [Symbol, :"agent.session.subagent"]
+        required :object, const: :"agent.session.subagent"
+
+        # @!attribute opened_at
+        #   The Unix timestamp, in seconds, when the subagent was first opened. Resuming
+        #   does not change it.
+        #
+        #   @return [Integer]
+        required :opened_at, Integer
+
+        # @!attribute parent_agent_id
+        #   The ID of the agent that created this subagent.
+        #
+        #   @return [String]
+        required :parent_agent_id, String
+
+        # @!attribute session_id
+        #   The ID of the session that owns the subagent.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute status
+        #   The current status of the subagent.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::Subagent::Status]
+        required :status, enum: -> { OpenAI::Beta::Subagent::Status }
+
+        # @!method initialize(id:, closed_at:, instructions:, name:, opened_at:, parent_agent_id:, session_id:, status:, object: :"agent.session.subagent")
+        #   A subagent created within a session.
+        #
+        #   @param id [String]
+        #     The ID of the subagent.
+        #
+        #   @param closed_at [Integer, nil]
+        #     The Unix timestamp, in seconds, when the subagent was closed. Null while active,
+        #     including after resume.
+        #
+        #   @param instructions [Array<OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent>, nil]
+        #     Initial task content, or null when unavailable. Text may contain placeholders
+        #     for images or audio when only a preview is available.
+        #
+        #   @param name [String, nil]
+        #     The runner-assigned nickname, or null when unavailable.
+        #
+        #   @param opened_at [Integer]
+        #     The Unix timestamp, in seconds, when the subagent was first opened. Resuming
+        #     does not change it.
+        #
+        #   @param parent_agent_id [String]
+        #     The ID of the agent that created this subagent.
+        #
+        #   @param session_id [String]
+        #     The ID of the session that owns the subagent.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::Subagent::Status]
+        #     The current status of the subagent.
+        #
+        #   @param object [Symbol, :"agent.session.subagent"]
+        #     The object type. Always `agent.session.subagent`.
+
+        # The current status of the subagent.
+        #
+        # @see OpenAI::Models::Beta::Subagent#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          # The subagent remains available, including while idle between turns.
+          ACTIVE = :active
+
+          # The subagent is closed.
+          CLOSED = :closed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class SummaryText < OpenAI::Internal::Type::BaseModel
+        # @!attribute text
+        #   The reasoning summary text.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The content type. Always `summary_text`.
+        #
+        #   @return [Symbol, :summary_text]
+        required :type, const: :summary_text
+
+        # @!method initialize(text:, type: :summary_text)
+        #   A reasoning summary content part.
+        #
+        #   @param text [String]
+        #     The reasoning summary text.
+        #
+        #   @param type [Symbol, :summary_text]
+        #     The content type. Always `summary_text`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The effective output format for generated text.
+      module TextFormat
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Generates ordinary text without a structured-output constraint.
+        variant :text, -> { OpenAI::Beta::TextFormat::Text }
+
+        # Constrains generated text to a JSON Schema.
+        variant :json_schema, -> { OpenAI::Beta::TextFormat::JSONSchema }
+
+        class Text < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `text`.
+          #
+          #   @return [Symbol, :text]
+          required :type, const: :text
+
+          # @!method initialize(type: :text)
+          #   Generates ordinary text without a structured-output constraint.
+          #
+          #   @param type [Symbol, :text]
+          #     The type of the object. Always `text`.
+        end
+
+        class JSONSchema < OpenAI::Internal::Type::BaseModel
+          # @!attribute schema
+          #   The JSON Schema that generated text must match.
+          #
+          #   @return [Hash{Symbol=>Object}]
+          required :schema, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+          # @!attribute type
+          #   The type of the object. Always `json_schema`.
+          #
+          #   @return [Symbol, :json_schema]
+          required :type, const: :json_schema
+
+          # @!method initialize(schema:, type: :json_schema)
+          #   Constrains generated text to a JSON Schema.
+          #
+          #   @param schema [Hash{Symbol=>Object}]
+          #     The JSON Schema that generated text must match.
+          #
+          #   @param type [Symbol, :json_schema]
+          #     The type of the object. Always `json_schema`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::TextFormat::Text, OpenAI::Models::Beta::TextFormat::JSONSchema)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The output format for generated text.
+      module TextFormatParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Generates ordinary text without a structured-output constraint.
+        variant :text, -> { OpenAI::Beta::TextFormatParam::Text }
+
+        # Constrains generated text to a JSON Schema.
+        variant :json_schema, -> { OpenAI::Beta::TextFormatParam::JSONSchema }
+
+        class Text < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `text`.
+          #
+          #   @return [Symbol, :text]
+          required :type, const: :text
+
+          # @!method initialize(type: :text)
+          #   Generates ordinary text without a structured-output constraint.
+          #
+          #   @param type [Symbol, :text]
+          #     The type of the object. Always `text`.
+        end
+
+        class JSONSchema < OpenAI::Internal::Type::BaseModel
+          # @!attribute schema
+          #   The JSON Schema that generated text must match.
+          #
+          #   @return [Hash{Symbol=>Object}]
+          required :schema, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+          # @!attribute type
+          #   The type of the object. Always `json_schema`.
+          #
+          #   @return [Symbol, :json_schema]
+          required :type, const: :json_schema
+
+          # @!method initialize(schema:, type: :json_schema)
+          #   Constrains generated text to a JSON Schema.
+          #
+          #   @param schema [Hash{Symbol=>Object}]
+          #     The JSON Schema that generated text must match.
+          #
+          #   @param type [Symbol, :json_schema]
+          #     The type of the object. Always `json_schema`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::TextFormatParam::Text, OpenAI::Models::Beta::TextFormatParam::JSONSchema)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class TokenUsage < OpenAI::Internal::Type::BaseModel
+        # @!attribute input_tokens
+        #   The number of input tokens used by the agent.
+        #
+        #   @return [Integer]
+        required :input_tokens, Integer
+
+        # @!attribute input_tokens_details
+        #   A breakdown of the agent's input token usage.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage::InputTokensDetails]
+        required :input_tokens_details, -> { OpenAI::Beta::TokenUsage::InputTokensDetails }
+
+        # @!attribute output_tokens
+        #   The number of output tokens generated by the agent.
+        #
+        #   @return [Integer]
+        required :output_tokens, Integer
+
+        # @!attribute output_tokens_details
+        #   A breakdown of the agent's output token usage.
+        #
+        #   @return [OpenAI::Models::Beta::TokenUsage::OutputTokensDetails]
+        required :output_tokens_details, -> { OpenAI::Beta::TokenUsage::OutputTokensDetails }
+
+        # @!attribute total_tokens
+        #   The total number of input and output tokens used by the agent.
+        #
+        #   @return [Integer]
+        required :total_tokens, Integer
+
+        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
+        #   Recorded token usage for a session or turn. Usage is best effort and may change.
+        #
+        #   @param input_tokens [Integer]
+        #     The number of input tokens used by the agent.
+        #
+        #   @param input_tokens_details [OpenAI::Models::Beta::TokenUsage::InputTokensDetails]
+        #     A breakdown of the agent's input token usage.
+        #
+        #   @param output_tokens [Integer]
+        #     The number of output tokens generated by the agent.
+        #
+        #   @param output_tokens_details [OpenAI::Models::Beta::TokenUsage::OutputTokensDetails]
+        #     A breakdown of the agent's output token usage.
+        #
+        #   @param total_tokens [Integer]
+        #     The total number of input and output tokens used by the agent.
+
+        # @see OpenAI::Models::Beta::TokenUsage#input_tokens_details
+        class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute cached_tokens
+          #   The number of input tokens retrieved from the prompt cache.
+          #
+          #   @return [Integer]
+          required :cached_tokens, Integer
+
+          # @!method initialize(cached_tokens:)
+          #   A breakdown of the agent's input token usage.
+          #
+          #   @param cached_tokens [Integer]
+          #     The number of input tokens retrieved from the prompt cache.
+        end
+
+        # @see OpenAI::Models::Beta::TokenUsage#output_tokens_details
+        class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute reasoning_tokens
+          #   The number of output tokens used for reasoning.
+          #
+          #   @return [Integer]
+          required :reasoning_tokens, Integer
+
+          # @!method initialize(reasoning_tokens:)
+          #   A breakdown of the agent's output token usage.
+          #
+          #   @param reasoning_tokens [Integer]
+          #     The number of output tokens used for reasoning.
+        end
+      end
+    end
+  end
+end