openai 0.91.0 → 0.93.0

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(
 

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

@@ -51,7 +51,9 @@ module OpenAI
             sig { returns(T.nilable(String)) }
             attr_accessor :name
 
-            # Network access for an OpenAI-hosted environment.
+            # Network access available after setup completes. Omit to preserve the current
+            # policy, or pass `null` to reset to disabled for GA requests or enabled for
+            # alpha/beta requests.
             sig { returns(T.nilable(OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Network)) }
             attr_reader :network
 
@@ -60,7 +62,7 @@ module OpenAI
             }
             attr_writer :network
 
-            # Packages to install in an OpenAI-hosted environment.
+            # Packages installed before the runtime network policy applies.
             sig { returns(T.nilable(OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Packages)) }
             attr_reader :packages
 
@@ -147,10 +149,12 @@ module OpenAI
               # A replacement human-readable display name, or `null` to clear the name.
               name: nil,
 
-              # Network access for an OpenAI-hosted environment.
+              # Network access available after setup completes. Omit to preserve the current
+              # policy, or pass `null` to reset to disabled for GA requests or enabled for
+              # alpha/beta requests.
               network: nil,
 
-              # Packages to install in an OpenAI-hosted environment.
+              # Packages installed before the runtime network policy applies.
               packages: nil,
 
               # Replacement plugin configuration installed for each new session.
@@ -213,7 +217,9 @@ module OpenAI
               sig { returns(T.nilable(T::Array[String])) }
               attr_accessor :allowed_domains
 
-              # Network access for an OpenAI-hosted environment.
+              # Network access available after setup completes. Omit to preserve the current
+              # policy, or pass `null` to reset to disabled for GA requests or enabled for
+              # alpha/beta requests.
               sig do
                 params(
 
@@ -254,7 +260,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::TemplateUpdateParams::Network::Access::TaggedSymbol
@@ -302,7 +308,7 @@ module OpenAI
               sig { returns(T.nilable(T::Array[String])) }
               attr_accessor :system_
 
-              # Packages to install in an OpenAI-hosted environment.
+              # Packages installed before the runtime network policy applies.
               sig do
                 params(
 

data/rbi/openai/models/beta/agents/session_create_params.rbi

@@ -47,7 +47,10 @@ module OpenAI
           sig { params(agent_id: String).void }
           attr_writer :agent_id
 
-          # Initial input submitted when creating a session.
+          # Initial input to submit when the session is created. A string is shorthand for a
+          # single user message. Required when `environment.type` is `none`, or when
+          # `stream` is `true` for an environment that is not `self_hosted`; optional for
+          # self-hosted and non-streaming execution environments.
           sig { returns(T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Input::Variants)) }
           attr_accessor :input
 
@@ -96,7 +99,10 @@ module OpenAI
             # unchanged.
             agent_id: nil,
 
-            # Initial input submitted when creating a session.
+            # Initial input to submit when the session is created. A string is shorthand for a
+            # single user message. Required when `environment.type` is `none`, or when
+            # `stream` is `true` for an environment that is not `self_hosted`; optional for
+            # self-hosted and non-streaming execution environments.
             input: nil,
 
             # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
@@ -150,14 +156,15 @@ 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
 
             sig { params(multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam::OrHash)).void }
             attr_writer :multi_agent
 
-            # 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
 
@@ -233,10 +240,11 @@ 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,
 
-              # 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.
@@ -309,7 +317,10 @@ module OpenAI
             end
           end
 
-          # Initial input submitted when creating a session.
+          # Initial input to submit when the session is created. A string is shorthand for a
+          # single user message. Required when `environment.type` is `none`, or when
+          # `stream` is `true` for an environment that is not `self_hosted`; optional for
+          # self-hosted and non-streaming execution environments.
           module Input
             extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/beta/agents/session_update_params.rbi

@@ -99,7 +99,7 @@ module OpenAI
             sig { params(reasoning: OpenAI::Beta::Agents::SessionUpdateParams::Agent::Reasoning::OrHash).void }
             attr_writer :reasoning
 
-            # The service tier used for model requests.
+            # Omit to keep the current tier. Null resets it to auto.
             sig { returns(T.nilable(OpenAI::Beta::Agents::SessionUpdateParams::Agent::ServiceTier::OrSymbol)) }
             attr_accessor :service_tier
 
@@ -123,7 +123,7 @@ module OpenAI
               # Reasoning settings to update. Omit to keep the current effort.
               reasoning: nil,
 
-              # The service tier used for model requests.
+              # Omit to keep the current tier. Null resets it to auto.
 
               service_tier: nil
             )
@@ -149,7 +149,7 @@ module OpenAI
                 )
               end
 
-              # The amount of reasoning effort the model should use.
+              # Omit to keep the current effort. Null selects the model's default effort.
               sig { returns(T.nilable(OpenAI::Beta::Agents::SessionUpdateParams::Agent::Reasoning::Effort::OrSymbol)) }
               attr_accessor :effort
 
@@ -163,7 +163,7 @@ module OpenAI
               end
               def self.new(
 
-                # The amount of reasoning effort the model should use.
+                # Omit to keep the current effort. Null selects the model's default effort.
 
                 effort: nil
               )
@@ -177,7 +177,7 @@ module OpenAI
               def to_hash
               end
 
-              # The amount of reasoning effort the model should use.
+              # Omit to keep the current effort. Null selects the model's default effort.
               module Effort
                 extend OpenAI::Internal::Type::Enum
 
@@ -210,7 +210,7 @@ module OpenAI
               end
             end
 
-            # The service tier used for model requests.
+            # Omit to keep the current tier. Null resets it to auto.
             module ServiceTier
               extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/beta/agents/sessions/turn.rbi

@@ -36,7 +36,7 @@ module OpenAI
             sig { returns(Integer) }
             attr_accessor :created_at
 
-            # A customer-safe error describing why a session request failed.
+            # A customer-safe error. Non-null only for a failed turn.
             sig { returns(T.nilable(OpenAI::Beta::SessionTurnError)) }
             attr_reader :error
 
@@ -63,7 +63,8 @@ module OpenAI
             sig { returns(T.nilable(String)) }
             attr_accessor :subagent_id
 
-            # Recorded token usage for a session or turn. Usage is best effort and may change.
+            # Best-effort token usage for the turn, or null if unknown. Recorded usage may
+            # change.
             sig { returns(T.nilable(OpenAI::Beta::TokenUsage)) }
             attr_reader :usage
 
@@ -114,7 +115,7 @@ module OpenAI
               # subagent opening time when the preceding timestamps are unavailable.
               created_at:,
 
-              # A customer-safe error describing why a session request failed.
+              # A customer-safe error. Non-null only for a failed turn.
               error:,
 
               # The ID of the session that owns the turn.
@@ -129,7 +130,8 @@ module OpenAI
               # The ID of the subagent that ran the turn, if applicable.
               subagent_id:,
 
-              # Recorded token usage for a session or turn. Usage is best effort and may change.
+              # Best-effort token usage for the turn, or null if unknown. Recorded usage may
+              # change.
               usage:,
 
               # The object type. Always `agent.session.turn`.

data/rbi/openai/models/beta/agents/vault.rbi

@@ -37,8 +37,7 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :object
 
-          # A collection of credentials that agent tools can use to authenticate to MCP
-          # servers.
+          # A collection of credentials for MCP servers and OpenAI-hosted environments.
           sig do
             params(
 

data/rbi/openai/models/beta/agents/vaults/credential.rbi

@@ -22,7 +22,7 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :id
 
-            # The authentication method and non-secret configuration for the MCP server.
+            # The authentication method and non-secret configuration of the credential.
             sig { returns(OpenAI::Beta::Agents::Vaults::CredentialAuth::Variants) }
             attr_accessor :auth
 
@@ -46,7 +46,7 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :vault_id
 
-            # Metadata for a stored MCP server credential. Secret values are never returned.
+            # Metadata for a stored credential. Secret values are never returned.
             sig do
               params(
 
@@ -54,7 +54,8 @@ module OpenAI
 
                 auth: T.any(
                   OpenAI::Beta::Agents::Vaults::CredentialAuth::McpOauth::OrHash,
-                  OpenAI::Beta::Agents::Vaults::CredentialAuth::StaticBearer::OrHash
+                  OpenAI::Beta::Agents::Vaults::CredentialAuth::StaticBearer::OrHash,
+                  OpenAI::Beta::Agents::Vaults::CredentialAuth::EnvironmentVariable::OrHash
                 ),
 
                 created_at: Integer,
@@ -74,7 +75,7 @@ module OpenAI
               # The ID of the credential.
               id:,
 
-              # The authentication method and non-secret configuration for the MCP server.
+              # The authentication method and non-secret configuration of the credential.
               auth:,
 
               # The Unix timestamp, in seconds, when the credential was created.