openai 0.92.0 → 0.93.0

data/lib/openai/models/admin/organization/external_storage_validate_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::ExternalStorage#validate
+        class ExternalStorageValidateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute external_storage_id
+          #
+          #   @return [String]
+          required :external_storage_id, String
+
+          # @!method initialize(external_storage_id:, request_options: {})
+          #   @param external_storage_id [String]
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,8 @@ module OpenAI
         optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
         # @!attribute multi_agent
-        #   Explicit configuration for creating and coordinating subagents.
+        #   Configuration for creating and coordinating subagents. Subagent tools are
+        #   disabled by default.
         #
         #   @return [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
         optional :multi_agent, -> { OpenAI::Beta::MultiAgentConfigParam }, nil?: true
@@ -41,19 +42,20 @@ module OpenAI
         optional :name, String, nil?: true
 
         # @!attribute reasoning
-        #   Reasoning configuration for the agent.
+        #   Configuration for model reasoning. Omission uses the model's default effort.
         #
         #   @return [OpenAI::Models::Beta::AgentReasoningParam, nil]
         optional :reasoning, -> { OpenAI::Beta::AgentReasoningParam }, nil?: true
 
         # @!attribute service_tier
-        #   The service tier used for model requests.
+        #   The service tier used for model requests. Defaults to `auto`.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentCreateParams::ServiceTier, nil]
         optional :service_tier, enum: -> { OpenAI::Beta::AgentCreateParams::ServiceTier }, nil?: true
 
         # @!attribute text
-        #   Configuration for text generated by the agent.
+        #   Configuration for generated text. Defaults to the `text` format and medium
+        #   verbosity.
         #
         #   @return [OpenAI::Models::Beta::AgentTextParam, nil]
         optional :text, -> { OpenAI::Beta::AgentTextParam }, nil?: true
@@ -81,26 +83,28 @@ module OpenAI
         #     characters. Omission or null defaults to an empty map.
         #
         #   @param multi_agent [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
-        #     Explicit configuration for creating and coordinating subagents.
+        #     Configuration for creating and coordinating subagents. Subagent tools are
+        #     disabled by default.
         #
         #   @param name [String, nil]
         #     A human-readable name for the agent. Omission or null leaves the agent unnamed.
         #
         #   @param reasoning [OpenAI::Models::Beta::AgentReasoningParam, nil]
-        #     Reasoning configuration for the agent.
+        #     Configuration for model reasoning. Omission uses the model's default effort.
         #
         #   @param service_tier [Symbol, OpenAI::Models::Beta::AgentCreateParams::ServiceTier, nil]
-        #     The service tier used for model requests.
+        #     The service tier used for model requests. Defaults to `auto`.
         #
         #   @param text [OpenAI::Models::Beta::AgentTextParam, nil]
-        #     Configuration for text generated by the agent.
+        #     Configuration for generated text. Defaults to the `text` format and medium
+        #     verbosity.
         #
         #   @param tools [Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
         #     Tools available to the agent. Defaults to an empty list.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
-        # The service tier used for model requests.
+        # The service tier used for model requests. Defaults to `auto`.
         module ServiceTier
           extend OpenAI::Internal::Type::Enum
 

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

@@ -5,13 +5,14 @@ module OpenAI
     module Beta
       class AgentReasoning < OpenAI::Internal::Type::BaseModel
         # @!attribute effort
-        #   The amount of reasoning effort used by an agent.
+        #   The requested reasoning effort, or `null` when the model selects its own
+        #   default.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentReasoning::Effort, nil]
         required :effort, enum: -> { OpenAI::Beta::AgentReasoning::Effort }, nil?: true
 
         # @!attribute summary
-        #   The reasoning summary format requested from an agent.
+        #   The requested reasoning summary format, or `null` when summaries are disabled.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentReasoning::Summary, nil]
         required :summary, enum: -> { OpenAI::Beta::AgentReasoning::Summary }, nil?: true
@@ -20,12 +21,14 @@ module OpenAI
         #   The reasoning configuration used by an agent.
         #
         #   @param effort [Symbol, OpenAI::Models::Beta::AgentReasoning::Effort, nil]
-        #     The amount of reasoning effort used by an agent.
+        #     The requested reasoning effort, or `null` when the model selects its own
+        #     default.
         #
         #   @param summary [Symbol, OpenAI::Models::Beta::AgentReasoning::Summary, nil]
-        #     The reasoning summary format requested from an agent.
+        #     The requested reasoning summary format, or `null` when summaries are disabled.
 
-        # The amount of reasoning effort used by an agent.
+        # The requested reasoning effort, or `null` when the model selects its own
+        # default.
         #
         # @see OpenAI::Models::Beta::AgentReasoning#effort
         module Effort
@@ -43,7 +46,7 @@ module OpenAI
           #   @return [Array<Symbol>]
         end
 
-        # The reasoning summary format requested from an agent.
+        # The requested reasoning summary format, or `null` when summaries are disabled.
         #
         # @see OpenAI::Models::Beta::AgentReasoning#summary
         module Summary

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

@@ -11,7 +11,7 @@ module OpenAI
         required :id, String
 
         # @!attribute status
-        #   The status of an agent output item.
+        #   The status of the reasoning item.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus, nil]
         required :status, enum: -> { OpenAI::Beta::AgentOutputItemStatus }, nil?: true
@@ -41,7 +41,7 @@ module OpenAI
         #     The ID of the reasoning item.
         #
         #   @param status [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus, nil]
-        #     The status of an agent output item.
+        #     The status of the reasoning item.
         #
         #   @param summary [Array<OpenAI::Models::Beta::SummaryText>]
         #     The reasoning summaries produced by the agent.

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

@@ -5,13 +5,14 @@ module OpenAI
     module Beta
       class AgentReasoningParam < OpenAI::Internal::Type::BaseModel
         # @!attribute effort
-        #   The amount of reasoning effort the model should use.
+        #   The amount of reasoning effort the model should use. Omission lets the model
+        #   select it.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentReasoningParam::Effort, nil]
         optional :effort, enum: -> { OpenAI::Beta::AgentReasoningParam::Effort }, nil?: true
 
         # @!attribute summary
-        #   The reasoning summary format requested from the model.
+        #   Controls whether the response includes a reasoning summary.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentReasoningParam::Summary, nil]
         optional :summary, enum: -> { OpenAI::Beta::AgentReasoningParam::Summary }, nil?: true
@@ -20,12 +21,14 @@ module OpenAI
         #   Reasoning configuration for the agent.
         #
         #   @param effort [Symbol, OpenAI::Models::Beta::AgentReasoningParam::Effort, nil]
-        #     The amount of reasoning effort the model should use.
+        #     The amount of reasoning effort the model should use. Omission lets the model
+        #     select it.
         #
         #   @param summary [Symbol, OpenAI::Models::Beta::AgentReasoningParam::Summary, nil]
-        #     The reasoning summary format requested from the model.
+        #     Controls whether the response includes a reasoning summary.
 
-        # The amount of reasoning effort the model should use.
+        # The amount of reasoning effort the model should use. Omission lets the model
+        # select it.
         #
         # @see OpenAI::Models::Beta::AgentReasoningParam#effort
         module Effort
@@ -43,7 +46,7 @@ module OpenAI
           #   @return [Array<Symbol>]
         end
 
-        # The reasoning summary format requested from the model.
+        # Controls whether the response includes a reasoning summary.
         #
         # @see OpenAI::Models::Beta::AgentReasoningParam#summary
         module Summary

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

@@ -68,7 +68,8 @@ module OpenAI
         required :status, enum: -> { OpenAI::Beta::AgentSession::Status }
 
         # @!attribute usage
-        #   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.
         #
         #   @return [OpenAI::Models::Beta::TokenUsage, nil]
         required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
@@ -110,7 +111,8 @@ module OpenAI
         #     The current status of the session.
         #
         #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
-        #     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.
         #
         #   @param vault_ids [Array<String>]
         #     The IDs of vaults made available to the session.

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

@@ -17,7 +17,7 @@ module OpenAI
         required :content, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::OutputText] }
 
         # @!attribute phase
-        #   The phase of an assistant message.
+        #   The phase of the assistant message.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentSessionAssistantMessage::Phase, nil]
         required :phase, enum: -> { OpenAI::Beta::AgentSessionAssistantMessage::Phase }, nil?: true
@@ -56,7 +56,7 @@ module OpenAI
         #     The content of the message.
         #
         #   @param phase [Symbol, OpenAI::Models::Beta::AgentSessionAssistantMessage::Phase, nil]
-        #     The phase of an assistant message.
+        #     The phase of the assistant message.
         #
         #   @param status [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus]
         #     The status of the message.
@@ -70,7 +70,7 @@ module OpenAI
         #   @param type [Symbol, :message]
         #     The item type. Always `message`.
 
-        # The phase of an assistant message.
+        # The phase of the assistant message.
         #
         # @see OpenAI::Models::Beta::AgentSessionAssistantMessage#phase
         module Phase

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentSessionEnvironmentResetEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute environment_id
+        #   The stable environment ID, retained across sandbox replacements.
+        #
+        #   @return [String]
+        required :environment_id, String
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute reset_count
+        #   Monotonically increasing reset number. Repeated notifications share this number.
+        #
+        #   @return [Integer]
+        required :reset_count, Integer
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The associated turn, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.session.environment.reset`.
+        #
+        #   @return [Symbol, :"agent.session.environment.reset"]
+        required :type, const: :"agent.session.environment.reset"
+
+        # @!method initialize(environment_id:, event_id:, reset_count:, session_id:, turn_id:, type: :"agent.session.environment.reset")
+        #   Emitted after a hosted sandbox is replaced. Conversation history survives;
+        #   changes to the previous sandbox's files and processes do not.
+        #
+        #   @param environment_id [String]
+        #     The stable environment ID, retained across sandbox replacements.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param reset_count [Integer]
+        #     Monotonically increasing reset number. Repeated notifications share this number.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The associated turn, when applicable.
+        #
+        #   @param type [Symbol, :"agent.session.environment.reset"]
+        #     The type of the object. Always `agent.session.environment.reset`.
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module OpenAI
         required :id, String
 
         # @!attribute error
-        #   An error reported while preparing a session environment.
+        #   The error reported while preparing the environment, if any.
         #
         #   @return [OpenAI::Models::Beta::AgentSessionEnvironmentState::Error, nil]
         required :error, -> { OpenAI::Beta::AgentSessionEnvironmentState::Error }, nil?: true
@@ -35,7 +35,7 @@ module OpenAI
         #     The public ID of the environment.
         #
         #   @param error [OpenAI::Models::Beta::AgentSessionEnvironmentState::Error, nil]
-        #     An error reported while preparing a session environment.
+        #     The error reported while preparing the environment, if any.
         #
         #   @param status [Symbol, OpenAI::Models::Beta::AgentSessionEnvironmentState::Status]
         #     The environment's connection status.
@@ -64,7 +64,7 @@ module OpenAI
           required :type, String
 
           # @!method initialize(code:, message:, type:)
-          #   An error reported while preparing a session environment.
+          #   The error reported while preparing the environment, if any.
           #
           #   @param code [String]
           #     A machine-readable error code.

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

@@ -15,6 +15,9 @@ module OpenAI
         # Emitted when a hosted session environment is ready to connect.
         variant :"agent.session.environment.ready", -> { OpenAI::Beta::AgentSessionEnvironmentReadyEvent }
 
+        # Emitted after a hosted sandbox is replaced. Conversation history survives; changes to the previous sandbox's files and processes do not.
+        variant :"agent.session.environment.reset", -> { OpenAI::Beta::AgentSessionEnvironmentResetEvent }
+
         # Emitted when command execution produces an output delta.
         variant(
           :"agent.output.command_execution_output.delta",
@@ -121,7 +124,7 @@ module OpenAI
         )
 
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Beta::AgentSessionErrorEvent, OpenAI::Models::Beta::AgentSessionEnvironmentReadyEvent, OpenAI::Models::Beta::AgentOutputCommandExecutionOutputDeltaEvent, OpenAI::Models::Beta::AgentSessionCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnInProgressEvent, OpenAI::Models::Beta::AgentSessionTurnCompletedEvent, OpenAI::Models::Beta::AgentSessionTurnFailedEvent, OpenAI::Models::Beta::AgentSessionTurnCancelledEvent, OpenAI::Models::Beta::AgentSessionTurnItemAddedEvent, OpenAI::Models::Beta::AgentSessionIdleEvent, OpenAI::Models::Beta::AgentSessionInProgressEvent, OpenAI::Models::Beta::AgentSessionRequiresActionEvent, OpenAI::Models::Beta::AgentSessionFailedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentPendingEvent, OpenAI::Models::Beta::AgentSessionEnvironmentConnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentDisconnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentFailedEvent, OpenAI::Models::Beta::AgentSessionSubagentCreatedEvent, OpenAI::Models::Beta::AgentSessionSubagentActiveEvent, OpenAI::Models::Beta::AgentSessionSubagentClosedEvent, OpenAI::Models::Beta::AgentSessionTurnItemDoneEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDoneEvent)]
+        #   @return [Array(OpenAI::Models::Beta::AgentSessionErrorEvent, OpenAI::Models::Beta::AgentSessionEnvironmentReadyEvent, OpenAI::Models::Beta::AgentSessionEnvironmentResetEvent, OpenAI::Models::Beta::AgentOutputCommandExecutionOutputDeltaEvent, OpenAI::Models::Beta::AgentSessionCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnInProgressEvent, OpenAI::Models::Beta::AgentSessionTurnCompletedEvent, OpenAI::Models::Beta::AgentSessionTurnFailedEvent, OpenAI::Models::Beta::AgentSessionTurnCancelledEvent, OpenAI::Models::Beta::AgentSessionTurnItemAddedEvent, OpenAI::Models::Beta::AgentSessionIdleEvent, OpenAI::Models::Beta::AgentSessionInProgressEvent, OpenAI::Models::Beta::AgentSessionRequiresActionEvent, OpenAI::Models::Beta::AgentSessionFailedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentPendingEvent, OpenAI::Models::Beta::AgentSessionEnvironmentConnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentDisconnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentFailedEvent, OpenAI::Models::Beta::AgentSessionSubagentCreatedEvent, OpenAI::Models::Beta::AgentSessionSubagentActiveEvent, OpenAI::Models::Beta::AgentSessionSubagentClosedEvent, OpenAI::Models::Beta::AgentSessionTurnItemDoneEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDoneEvent)]
       end
     end
   end

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

@@ -96,7 +96,7 @@ module OpenAI
           optional :error, String, nil?: true
 
           # @!attribute output
-          #   A function result represented as text or supported model-input content.
+          #   The function result when the call succeeded.
           #
           #   @return [String, Array<OpenAI::Models::Beta::InputContentParam::InputText, OpenAI::Models::Beta::InputContentParam::InputImage>, nil]
           optional :output, union: -> { OpenAI::Beta::AgentFunctionCallOutputParam }, nil?: true
@@ -117,7 +117,7 @@ module OpenAI
           #     The error message when the call failed.
           #
           #   @param output [String, Array<OpenAI::Models::Beta::InputContentParam::InputText, OpenAI::Models::Beta::InputContentParam::InputImage>, nil]
-          #     A function result represented as text or supported model-input content.
+          #     The function result when the call succeeded.
           #
           #   @param type [Symbol, :"agent.session.input.tool_result"]
           #     The type of the object. Always `agent.session.input.tool_result`.

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

@@ -71,7 +71,7 @@ module OpenAI
           required :error, String, nil?: true
 
           # @!attribute output
-          #   The text or model-input content supplied as a function result.
+          #   The function result, if the call succeeded.
           #
           #   @return [String, Array<OpenAI::Models::Beta::InputContent::InputText, OpenAI::Models::Beta::InputContent::InputImage>, nil]
           required :output, union: -> { OpenAI::Beta::AgentFunctionCallOutput }, nil?: true
@@ -107,7 +107,7 @@ module OpenAI
           #     The error message, if the call failed.
           #
           #   @param output [String, Array<OpenAI::Models::Beta::InputContent::InputText, OpenAI::Models::Beta::InputContent::InputImage>, nil]
-          #     The text or model-input content supplied as a function result.
+          #     The function result, if the call succeeded.
           #
           #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
           #     The status of the function call.

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

@@ -18,7 +18,7 @@ module OpenAI
         required :content, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentSessionMessageContent] }
 
         # @!attribute phase
-        #   The phase of an assistant message.
+        #   The phase of an assistant message. Null for user messages.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentSessionMessage::Phase, nil]
         required :phase, enum: -> { OpenAI::Beta::AgentSessionMessage::Phase }, nil?: true
@@ -58,7 +58,7 @@ module OpenAI
         #     assistant messages contain output text.
         #
         #   @param phase [Symbol, OpenAI::Models::Beta::AgentSessionMessage::Phase, nil]
-        #     The phase of an assistant message.
+        #     The phase of an assistant message. Null for user messages.
         #
         #   @param role [Symbol, OpenAI::Models::Beta::AgentSessionMessage::Role]
         #     The role of the message author.
@@ -72,7 +72,7 @@ module OpenAI
         #   @param type [Symbol, :message]
         #     The item type. Always `message`.
 
-        # The phase of an assistant message.
+        # The phase of an assistant message. Null for user messages.
         #
         # @see OpenAI::Models::Beta::AgentSessionMessage#phase
         module Phase

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

@@ -35,7 +35,7 @@ module OpenAI
         required :type, const: :"agent.session.turn.cancelled"
 
         # @!attribute usage
-        #   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.
         #
         #   @return [OpenAI::Models::Beta::TokenUsage, nil]
         required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
@@ -56,7 +56,7 @@ module OpenAI
         #     The ID of the turn associated with the event.
         #
         #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
-        #     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.
         #
         #   @param type [Symbol, :"agent.session.turn.cancelled"]
         #     The type of the object. Always `agent.session.turn.cancelled`.

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

@@ -35,7 +35,7 @@ module OpenAI
         required :type, const: :"agent.session.turn.completed"
 
         # @!attribute usage
-        #   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.
         #
         #   @return [OpenAI::Models::Beta::TokenUsage, nil]
         required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
@@ -56,7 +56,7 @@ module OpenAI
         #     The ID of the turn associated with the event.
         #
         #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
-        #     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.
         #
         #   @param type [Symbol, :"agent.session.turn.completed"]
         #     The type of the object. Always `agent.session.turn.completed`.

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

@@ -35,7 +35,7 @@ module OpenAI
         required :type, const: :"agent.session.turn.failed"
 
         # @!attribute usage
-        #   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.
         #
         #   @return [OpenAI::Models::Beta::TokenUsage, nil]
         required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
@@ -56,7 +56,7 @@ module OpenAI
         #     The ID of the turn associated with the event.
         #
         #   @param usage [OpenAI::Models::Beta::TokenUsage, nil]
-        #     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.
         #
         #   @param type [Symbol, :"agent.session.turn.failed"]
         #     The type of the object. Always `agent.session.turn.failed`.

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

@@ -5,13 +5,14 @@ module OpenAI
     module Beta
       class AgentTextParam < OpenAI::Internal::Type::BaseModel
         # @!attribute format_
-        #   The output format for generated text.
+        #   The output format. Omission uses ordinary text (`{"type": "text"}`).
         #
         #   @return [OpenAI::Models::Beta::TextFormatParam::Text, OpenAI::Models::Beta::TextFormatParam::JSONSchema, nil]
         optional :format_, union: -> { OpenAI::Beta::TextFormatParam }, api_name: :format, nil?: true
 
         # @!attribute verbosity
-        #   The amount of text the model should produce.
+        #   The amount of text the model should produce. Defaults to `medium`, matching
+        #   Responses.
         #
         #   @return [Symbol, OpenAI::Models::Beta::AgentTextParam::Verbosity, nil]
         optional :verbosity, enum: -> { OpenAI::Beta::AgentTextParam::Verbosity }, nil?: true
@@ -20,12 +21,14 @@ module OpenAI
         #   Configuration for text generated by the agent.
         #
         #   @param format_ [OpenAI::Models::Beta::TextFormatParam::Text, OpenAI::Models::Beta::TextFormatParam::JSONSchema, nil]
-        #     The output format for generated text.
+        #     The output format. Omission uses ordinary text (`{"type": "text"}`).
         #
         #   @param verbosity [Symbol, OpenAI::Models::Beta::AgentTextParam::Verbosity, nil]
-        #     The amount of text the model should produce.
+        #     The amount of text the model should produce. Defaults to `medium`, matching
+        #     Responses.
 
-        # The amount of text the model should produce.
+        # The amount of text the model should produce. Defaults to `medium`, matching
+        # Responses.
         #
         # @see OpenAI::Models::Beta::AgentTextParam#verbosity
         module Verbosity

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

@@ -200,7 +200,7 @@ module OpenAI
           required :context_size, enum: -> { OpenAI::Beta::AgentTool::WebSearch::ContextSize }
 
           # @!attribute location
-          #   Approximate user location used to localize web search results.
+          #   Approximate location used to localize search results, if provided.
           #
           #   @return [OpenAI::Models::Beta::AgentTool::WebSearch::Location, nil]
           required :location, -> { OpenAI::Beta::AgentTool::WebSearch::Location }, nil?: true
@@ -227,7 +227,7 @@ module OpenAI
           #     The amount of search context made available to the model. Defaults to `medium`.
           #
           #   @param location [OpenAI::Models::Beta::AgentTool::WebSearch::Location, nil]
-          #     Approximate user location used to localize web search results.
+          #     Approximate location used to localize search results, if provided.
           #
           #   @param mode [Symbol, OpenAI::Models::Beta::AgentTool::WebSearch::Mode]
           #     The source used for web search results.
@@ -276,7 +276,7 @@ module OpenAI
             required :timezone, String, nil?: true
 
             # @!method initialize(city:, country:, region:, timezone:)
-            #   Approximate user location used to localize web search results.
+            #   Approximate location used to localize search results, if provided.
             #
             #   @param city [String, nil]
             #     The city name.