openai 0.92.0 → 0.94.0

data/rbi/openai/models/beta/agent_reasoning_param.rbi

@@ -14,11 +14,12 @@ module OpenAI
           )
         end
 
-        # The amount of reasoning effort the model should use.
+        # The amount of reasoning effort the model should use. Omission lets the model
+        # select it.
         sig { returns(T.nilable(OpenAI::Beta::AgentReasoningParam::Effort::OrSymbol)) }
         attr_accessor :effort
 
-        # The reasoning summary format requested from the model.
+        # Controls whether the response includes a reasoning summary.
         sig { returns(T.nilable(OpenAI::Beta::AgentReasoningParam::Summary::OrSymbol)) }
         attr_accessor :summary
 
@@ -34,10 +35,11 @@ module OpenAI
         end
         def self.new(
 
-          # The amount of reasoning effort the model should use.
+          # The amount of reasoning effort the model should use. Omission lets the model
+          # select it.
           effort: nil,
 
-          # The reasoning summary format requested from the model.
+          # Controls whether the response includes a reasoning summary.
 
           summary: nil
         )
@@ -54,7 +56,8 @@ module OpenAI
         def to_hash
         end
 
-        # The amount of reasoning effort the model should use.
+        # The amount of reasoning effort the model should use. Omission lets the model
+        # select it.
         module Effort
           extend OpenAI::Internal::Type::Enum
 
@@ -74,7 +77,7 @@ module OpenAI
           end
         end
 
-        # The reasoning summary format requested from the model.
+        # Controls whether the response includes a reasoning summary.
         module Summary
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/beta/agent_session.rbi

@@ -57,7 +57,8 @@ module OpenAI
         sig { returns(OpenAI::Beta::AgentSession::Status::TaggedSymbol) }
         attr_accessor :status
 
-        # Recorded token usage for a session or turn. Usage is best effort and may change.
+        # Best-effort token usage for the session, or null if unknown. Recorded usage may
+        # change.
         sig { returns(T.nilable(OpenAI::Beta::TokenUsage)) }
         attr_reader :usage
 
@@ -136,7 +137,8 @@ module OpenAI
           # The current status of the session.
           status:,
 
-          # Recorded token usage for a session or turn. Usage is best effort and may change.
+          # Best-effort token usage for the session, or null if unknown. Recorded usage may
+          # change.
           usage:,
 
           # The IDs of vaults made available to the session.

data/rbi/openai/models/beta/agent_session_assistant_message.rbi

@@ -22,7 +22,7 @@ module OpenAI
         sig { returns(T::Array[OpenAI::Beta::OutputText]) }
         attr_accessor :content
 
-        # The phase of an assistant message.
+        # The phase of the assistant message.
         sig { returns(T.nilable(OpenAI::Beta::AgentSessionAssistantMessage::Phase::TaggedSymbol)) }
         attr_accessor :phase
 
@@ -70,7 +70,7 @@ module OpenAI
           # The content of the message.
           content:,
 
-          # The phase of an assistant message.
+          # The phase of the assistant message.
           phase:,
 
           # The status of the message.
@@ -104,7 +104,7 @@ module OpenAI
         def to_hash
         end
 
-        # The phase of an assistant message.
+        # The phase of the assistant message.
         module Phase
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/beta/agent_session_environment_reset_event.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentSessionEnvironmentResetEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentSessionEnvironmentResetEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The stable environment ID, retained across sandbox replacements.
+        sig { returns(String) }
+        attr_accessor :environment_id
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :event_id
+
+        # Monotonically increasing reset number. Repeated notifications share this number.
+        sig { returns(Integer) }
+        attr_accessor :reset_count
+
+        # The ID of the session associated with the event.
+        sig { returns(String) }
+        attr_accessor :session_id
+
+        # The associated turn, when applicable.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :turn_id
+
+        # The type of the object. Always `agent.session.environment.reset`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Emitted after a hosted sandbox is replaced. Conversation history survives;
+        # changes to the previous sandbox's files and processes do not.
+        sig do
+          params(
+
+            environment_id: String,
+
+            event_id: String,
+
+            reset_count: Integer,
+
+            session_id: String,
+
+            turn_id: T.nilable(String),
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The stable environment ID, retained across sandbox replacements.
+          environment_id:,
+
+          # The unique ID of the event.
+          event_id:,
+
+          # Monotonically increasing reset number. Repeated notifications share this number.
+          reset_count:,
+
+          # The ID of the session associated with the event.
+          session_id:,
+
+          # The associated turn, when applicable.
+          turn_id:,
+
+          # The type of the object. Always `agent.session.environment.reset`.
+
+          type: :"agent.session.environment.reset"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              environment_id: String,
+              event_id: String,
+              reset_count: Integer,
+              session_id: String,
+              turn_id: T.nilable(String),
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_session_environment_state.rbi

@@ -18,7 +18,7 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :id
 
-        # An error reported while preparing a session environment.
+        # The error reported while preparing the environment, if any.
         sig { returns(T.nilable(OpenAI::Beta::AgentSessionEnvironmentState::Error)) }
         attr_reader :error
 
@@ -52,7 +52,7 @@ module OpenAI
           # The public ID of the environment.
           id:,
 
-          # An error reported while preparing a session environment.
+          # The error reported while preparing the environment, if any.
           error:,
 
           # The environment's connection status.
@@ -97,7 +97,7 @@ module OpenAI
           sig { returns(String) }
           attr_accessor :type
 
-          # An error reported while preparing a session environment.
+          # The error reported while preparing the environment, if any.
           sig do
             params(
 

data/rbi/openai/models/beta/agent_session_event.rbi

@@ -13,6 +13,7 @@ module OpenAI
           T.any(
             OpenAI::Beta::AgentSessionErrorEvent,
             OpenAI::Beta::AgentSessionEnvironmentReadyEvent,
+            OpenAI::Beta::AgentSessionEnvironmentResetEvent,
             OpenAI::Beta::AgentOutputCommandExecutionOutputDeltaEvent,
             OpenAI::Beta::AgentSessionCreatedEvent,
             OpenAI::Beta::AgentSessionTurnCreatedEvent,

data/rbi/openai/models/beta/agent_session_input_param.rbi

@@ -130,7 +130,7 @@ module OpenAI
           sig { returns(T.nilable(String)) }
           attr_accessor :error
 
-          # A function result represented as text or supported model-input content.
+          # The function result when the call succeeded.
           sig {
             returns(
               T.nilable(
@@ -187,7 +187,7 @@ module OpenAI
             # The error message when the call failed.
             error: nil,
 
-            # A function result represented as text or supported model-input content.
+            # The function result when the call succeeded.
             output: nil,
 
             # The type of the object. Always `agent.session.input.tool_result`.

data/rbi/openai/models/beta/agent_session_item.rbi

@@ -48,7 +48,7 @@ module OpenAI
           sig { returns(T.nilable(String)) }
           attr_accessor :error
 
-          # The text or model-input content supplied as a function result.
+          # The function result, if the call succeeded.
           sig { returns(T.nilable(OpenAI::Beta::AgentFunctionCallOutput::Variants)) }
           attr_accessor :output
 
@@ -102,7 +102,7 @@ module OpenAI
             # The error message, if the call failed.
             error:,
 
-            # The text or model-input content supplied as a function result.
+            # The function result, if the call succeeded.
             output:,
 
             # The status of the function call.

data/rbi/openai/models/beta/agent_session_message.rbi

@@ -23,7 +23,7 @@ module OpenAI
         sig { returns(T::Array[OpenAI::Beta::AgentSessionMessageContent::Variants]) }
         attr_accessor :content
 
-        # The phase of an assistant message.
+        # The phase of an assistant message. Null for user messages.
         sig { returns(T.nilable(OpenAI::Beta::AgentSessionMessage::Phase::TaggedSymbol)) }
         attr_accessor :phase
 
@@ -78,7 +78,7 @@ module OpenAI
           # assistant messages contain output text.
           content:,
 
-          # The phase of an assistant message.
+          # The phase of an assistant message. Null for user messages.
           phase:,
 
           # The role of the message author.
@@ -112,7 +112,7 @@ module OpenAI
         def to_hash
         end
 
-        # The phase of an assistant message.
+        # The phase of an assistant message. Null for user messages.
         module Phase
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/beta/agent_session_turn_cancelled_event.rbi

@@ -37,7 +37,7 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Recorded token usage for a session or turn. Usage is best effort and may change.
+        # Token usage by the root agent during the turn, when available.
         sig { returns(T.nilable(OpenAI::Beta::TokenUsage)) }
         attr_reader :usage
 
@@ -76,7 +76,7 @@ module OpenAI
           # The ID of the turn associated with the event.
           turn_id:,
 
-          # Recorded token usage for a session or turn. Usage is best effort and may change.
+          # Token usage by the root agent during the turn, when available.
           usage:,
 
           # The type of the object. Always `agent.session.turn.cancelled`.

data/rbi/openai/models/beta/agent_session_turn_completed_event.rbi

@@ -37,7 +37,7 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Recorded token usage for a session or turn. Usage is best effort and may change.
+        # Token usage by the root agent during the turn, when available.
         sig { returns(T.nilable(OpenAI::Beta::TokenUsage)) }
         attr_reader :usage
 
@@ -76,7 +76,7 @@ module OpenAI
           # The ID of the turn associated with the event.
           turn_id:,
 
-          # Recorded token usage for a session or turn. Usage is best effort and may change.
+          # Token usage by the root agent during the turn, when available.
           usage:,
 
           # The type of the object. Always `agent.session.turn.completed`.

data/rbi/openai/models/beta/agent_session_turn_failed_event.rbi

@@ -37,7 +37,7 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Recorded token usage for a session or turn. Usage is best effort and may change.
+        # Token usage by the root agent during the turn, when available.
         sig { returns(T.nilable(OpenAI::Beta::TokenUsage)) }
         attr_reader :usage
 
@@ -76,7 +76,7 @@ module OpenAI
           # The ID of the turn associated with the event.
           turn_id:,
 
-          # Recorded token usage for a session or turn. Usage is best effort and may change.
+          # Token usage by the root agent during the turn, when available.
           usage:,
 
           # The type of the object. Always `agent.session.turn.failed`.

data/rbi/openai/models/beta/agent_text_param.rbi

@@ -14,13 +14,14 @@ module OpenAI
           )
         end
 
-        # The output format for generated text.
+        # The output format. Omission uses ordinary text (`{"type": "text"}`).
         sig {
           returns(T.nilable(T.any(OpenAI::Beta::TextFormatParam::Text, OpenAI::Beta::TextFormatParam::JSONSchema)))
         }
         attr_accessor :format_
 
-        # The amount of text the model should produce.
+        # The amount of text the model should produce. Defaults to `medium`, matching
+        # Responses.
         sig { returns(T.nilable(OpenAI::Beta::AgentTextParam::Verbosity::OrSymbol)) }
         attr_accessor :verbosity
 
@@ -38,10 +39,11 @@ module OpenAI
         end
         def self.new(
 
-          # The output format for generated text.
+          # The output format. Omission uses ordinary text (`{"type": "text"}`).
           format_: nil,
 
-          # The amount of text the model should produce.
+          # The amount of text the model should produce. Defaults to `medium`, matching
+          # Responses.
 
           verbosity: nil
         )
@@ -58,7 +60,8 @@ module OpenAI
         def to_hash
         end
 
-        # The amount of text the model should produce.
+        # The amount of text the model should produce. Defaults to `medium`, matching
+        # Responses.
         module Verbosity
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/beta/agent_tool.rbi

@@ -287,7 +287,7 @@ module OpenAI
           sig { returns(OpenAI::Beta::AgentTool::WebSearch::ContextSize::TaggedSymbol) }
           attr_accessor :context_size
 
-          # Approximate user location used to localize web search results.
+          # Approximate location used to localize search results, if provided.
           sig { returns(T.nilable(OpenAI::Beta::AgentTool::WebSearch::Location)) }
           attr_reader :location
 
@@ -326,7 +326,7 @@ module OpenAI
             # The amount of search context made available to the model. Defaults to `medium`.
             context_size:,
 
-            # Approximate user location used to localize web search results.
+            # Approximate location used to localize search results, if provided.
             location:,
 
             # The source used for web search results.
@@ -392,7 +392,7 @@ module OpenAI
             sig { returns(T.nilable(String)) }
             attr_accessor :timezone
 
-            # Approximate user location used to localize web search results.
+            # Approximate location used to localize search results, if provided.
             sig do
               params(
 

data/rbi/openai/models/beta/agent_tool_param.rbi

@@ -216,7 +216,9 @@ module OpenAI
           sig { returns(T.nilable(T::Array[String])) }
           attr_accessor :allowed_tools
 
-          # Where outbound MCP HTTP connections originate.
+          # Selects where outbound MCP HTTP connections originate. Omitted or `service` uses
+          # the Managed Agents service network; `environment` uses the session's selected
+          # environment.
           sig { returns(T.nilable(OpenAI::Beta::AgentToolParam::Mcp::ConnectionOrigin::OrSymbol)) }
           attr_accessor :connection_origin
 
@@ -273,7 +275,9 @@ module OpenAI
             # The MCP tools the agent may call. All server tools are allowed when omitted.
             allowed_tools: nil,
 
-            # Where outbound MCP HTTP connections originate.
+            # Selects where outbound MCP HTTP connections originate. Omitted or `service` uses
+            # the Managed Agents service network; `environment` uses the session's selected
+            # environment.
             connection_origin: nil,
 
             # The attached vault credential used to authenticate this MCP server. Optional
@@ -310,7 +314,9 @@ module OpenAI
           def to_hash
           end
 
-          # Where outbound MCP HTTP connections originate.
+          # Selects where outbound MCP HTTP connections originate. Omitted or `service` uses
+          # the Managed Agents service network; `environment` uses the session's selected
+          # environment.
           module ConnectionOrigin
             extend OpenAI::Internal::Type::Enum
 
@@ -345,18 +351,18 @@ module OpenAI
           sig { returns(T.nilable(T::Array[String])) }
           attr_accessor :allowed_domains
 
-          # The amount of web search context made available to the model.
+          # The amount of search context made available to the model. Defaults to `medium`.
           sig { returns(T.nilable(OpenAI::Beta::AgentToolParam::WebSearch::ContextSize::OrSymbol)) }
           attr_accessor :context_size
 
-          # Approximate user location used to localize web search results.
+          # Approximate location used to localize search results.
           sig { returns(T.nilable(OpenAI::Beta::AgentToolParam::WebSearch::Location)) }
           attr_reader :location
 
           sig { params(location: T.nilable(OpenAI::Beta::AgentToolParam::WebSearch::Location::OrHash)).void }
           attr_writer :location
 
-          # The source used for web search results.
+          # The source used for web search results. Defaults to `live`.
           sig { returns(T.nilable(OpenAI::Beta::AgentToolParam::WebSearch::Mode::OrSymbol)) }
           attr_accessor :mode
 
@@ -381,13 +387,13 @@ module OpenAI
             # Domains the search may include.
             allowed_domains: nil,
 
-            # The amount of web search context made available to the model.
+            # The amount of search context made available to the model. Defaults to `medium`.
             context_size: nil,
 
-            # Approximate user location used to localize web search results.
+            # Approximate location used to localize search results.
             location: nil,
 
-            # The source used for web search results.
+            # The source used for web search results. Defaults to `live`.
             mode: nil,
 
             # The type of the object. Always `web_search`.
@@ -410,7 +416,7 @@ module OpenAI
           def to_hash
           end
 
-          # The amount of web search context made available to the model.
+          # The amount of search context made available to the model. Defaults to `medium`.
           module ContextSize
             extend OpenAI::Internal::Type::Enum
 
@@ -450,7 +456,7 @@ module OpenAI
             sig { returns(T.nilable(String)) }
             attr_accessor :timezone
 
-            # Approximate user location used to localize web search results.
+            # Approximate location used to localize search results.
             sig do
               params(
 
@@ -496,7 +502,7 @@ module OpenAI
 
           end
 
-          # The source used for web search results.
+          # The source used for web search results. Defaults to `live`.
           module Mode
             extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/beta/agent_update_params.rbi

@@ -38,7 +38,7 @@ module OpenAI
         sig { params(model: String).void }
         attr_writer :model
 
-        # Explicit configuration for creating and coordinating subagents.
+        # Configuration for creating and coordinating subagents.
         sig { returns(T.nilable(OpenAI::Beta::MultiAgentConfigParam)) }
         attr_reader :multi_agent
 
@@ -49,7 +49,8 @@ module OpenAI
         sig { returns(T.nilable(String)) }
         attr_accessor :name
 
-        # Reasoning configuration for the agent.
+        # Configuration for model reasoning. Omit to keep the current settings; pass
+        # `null` to reset to the model's default effort.
         sig { returns(T.nilable(OpenAI::Beta::AgentReasoningParam)) }
         attr_reader :reasoning
 
@@ -138,13 +139,14 @@ module OpenAI
           # The model to use for the agent. The requested model name is preserved.
           model: nil,
 
-          # Explicit configuration for creating and coordinating subagents.
+          # Configuration for creating and coordinating subagents.
           multi_agent: nil,
 
           # A replacement name. Omit to leave unchanged, or pass null to clear it.
           name: nil,
 
-          # Reasoning configuration for the agent.
+          # Configuration for model reasoning. Omit to keep the current settings; pass
+          # `null` to reset to the model's default effort.
           reasoning: nil,
 
           # The service tier used for model requests.

data/rbi/openai/models/beta/agent_web_search_call_item.rbi

@@ -18,7 +18,7 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :id
 
-        # An action performed by the web search tool.
+        # The action performed by the web search tool.
         sig { returns(T.nilable(OpenAI::Beta::WebSearchAction::Variants)) }
         attr_accessor :action
 
@@ -62,7 +62,7 @@ module OpenAI
           # The ID of the web search call.
           id:,
 
-          # An action performed by the web search tool.
+          # The action performed by the web search tool.
           action:,
 
           # The status of the web search call.

data/rbi/openai/models/beta/agents/environments/template_create_params.rbi

@@ -49,7 +49,8 @@ module OpenAI
             sig { returns(T.nilable(String)) }
             attr_accessor :name
 
-            # Network access for an OpenAI-hosted environment.
+            # Network access policy for the environment. Defaults to disabled for GA requests
+            # and enabled for alpha/beta requests.
             sig { returns(T.nilable(OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network)) }
             attr_reader :network
 
@@ -58,7 +59,7 @@ module OpenAI
             }
             attr_writer :network
 
-            # Packages to install in an OpenAI-hosted environment.
+            # Packages to install in the environment. Defaults to empty package lists.
             sig { returns(T.nilable(OpenAI::Beta::Agents::Environments::TemplateCreateParams::Packages)) }
             attr_reader :packages
 
@@ -143,10 +144,11 @@ module OpenAI
               # An optional human-readable display name for the template.
               name: nil,
 
-              # Network access for an OpenAI-hosted environment.
+              # Network access policy for the environment. Defaults to disabled for GA requests
+              # and enabled for alpha/beta requests.
               network: nil,
 
-              # Packages to install in an OpenAI-hosted environment.
+              # Packages to install in the environment. Defaults to empty package lists.
               packages: nil,
 
               # Plugins provided as inline ZIP archives. Defaults to an empty list.
@@ -209,7 +211,8 @@ module OpenAI
               sig { returns(T.nilable(T::Array[String])) }
               attr_accessor :allowed_domains
 
-              # Network access for an OpenAI-hosted environment.
+              # Network access policy for the environment. Defaults to disabled for GA requests
+              # and enabled for alpha/beta requests.
               sig do
                 params(
 
@@ -250,7 +253,7 @@ module OpenAI
                 }
                 OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-                # Allows unrestricted network access, matching an omitted network policy.
+                # Allows unrestricted network access.
                 ENABLED = T.let(
                   :enabled,
                   OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network::Access::TaggedSymbol
@@ -298,7 +301,7 @@ module OpenAI
               sig { returns(T.nilable(T::Array[String])) }
               attr_accessor :system_
 
-              # Packages to install in an OpenAI-hosted environment.
+              # Packages to install in the environment. Defaults to empty package lists.
               sig do
                 params(