From c57ecbf356cf4dbb7746a44d4de93fe0a10a28c4 Mon Sep 17 00:00:00 2001 From: markstuart-oai <323302876+markstuart-oai@users.noreply.github.com> Date: Wed, 18 Nov 2026 04:55:21 +0000 Subject: [PATCH] fix(api): hide Managed Agents session budget controls and events Castiron-Internal-PR: https://github.com/openai/openai-python-internal/pull/437 Castiron-Source-SHA: 085ea987f0fd30f7f2a3ab85fe0b0940a25a9a65 Castiron-Public-Base-SHA: f56a67f1f0c844135261ece304a90d2ec2571d4b --- .castiron.stats.yml | 12 +-- api.md | 1 - api_reference/openapi.transformed.yml | 84 ------------------- scripts/castiron/generated-files.json | 22 ++--- src/openai/lib/beta/agents/_result.py | 22 +++-- src/openai/lib/streaming/agents/_streams.py | 16 ++-- .../beta/agents/sessions/sessions.py | 20 ----- src/openai/types/beta/__init__.py | 1 - src/openai/types/beta/agent_session.py | 27 +----- .../agent_session_budget_reached_event.py | 25 ------ src/openai/types/beta/agent_session_event.py | 2 - .../beta/agents/session_create_params.py | 17 ---- .../beta/agents/session_update_params.py | 19 +---- src/openai/types/beta/session_turn_error.py | 2 - .../beta/agents/test_sessions.py | 6 -- tests/test_agents_budget_events.py | 52 ++++++++---- tests/test_agents_error_events.py | 77 +++++++++++++++++ 17 files changed, 153 insertions(+), 252 deletions(-) delete mode 100644 src/openai/types/beta/agent_session_budget_reached_event.py create mode 100644 tests/test_agents_error_events.py diff --git a/.castiron.stats.yml b/.castiron.stats.yml index 245201d8ed..6bb90eac43 100644 --- a/.castiron.stats.yml +++ b/.castiron.stats.yml @@ -1,7 +1,7 @@ schema_version: 1 -generation_id: e0db1179-fe12-4bb2-bd87-8631bb67d669 -openapi_spec_hash: c09a996bda1329932cb3cdbc62ac2bc4 -openapi_transformed_spec_hash: 877730e5c258cc3abc2cc03f2b864cbe -config_hash: 75d0b851f817c2f6384c562a88468286 -codegen_sha: 4f825036970380029f250cf929e9cc688cf3f0ad -codegen_hash: 397c8644ff0580d3d2b9b974979b1679fa1fa52b0063bd2dfe2c2fe6254a88a7 +generation_id: dee76378-e67c-4e39-b545-9f257df8b231 +openapi_spec_hash: d28f1e5c39423153f8057ba11f157c2a +openapi_transformed_spec_hash: cab15e06e8c85cd4cb16654debd28726 +config_hash: 00b2193b69f1fff70da44589b70736d0 +codegen_sha: 09fa53f79de260a84b688f5f9740015a539c3c28 +codegen_hash: 9d14309c72f055635e0c8ec84418f8da52a0b5205cb31d274c247d5416cc11bc diff --git a/api.md b/api.md index 1268482889..3e24aa4f47 100644 --- a/api.md +++ b/api.md @@ -550,7 +550,6 @@ from openai.types.beta import ( AgentSendSubagentInputCallItem, AgentSession, AgentSessionAssistantMessage, - AgentSessionBudgetReachedEvent, AgentSessionCreatedEvent, AgentSessionDeleted, AgentSessionEnvironmentConnectedEvent, diff --git a/api_reference/openapi.transformed.yml b/api_reference/openapi.transformed.yml index cce877f050..e65f2f8a4d 100644 --- a/api_reference/openapi.transformed.yml +++ b/api_reference/openapi.transformed.yml @@ -91510,7 +91510,6 @@ components: enum: - context_length_exceeded - max_output_tokens - - session_budget_exceeded - usage_limit_exceeded - project_spend_limit_exceeded - organization_spend_limit_exceeded @@ -91535,7 +91534,6 @@ components: x-enumDescriptions: - The request exceeds the model's context window. - The model reached its output token limit before finishing the response. - - The session has reached its usage budget. - The organization has reached a usage, plan, or billing limit. - The project has reached its enforced spend limit. - The organization has reached its enforced spend limit. @@ -93042,13 +93040,11 @@ components: - in_progress - requires_action - failed - - budget_reached x-enumDescriptions: - The session has no turn in progress and is ready for input. A hosted environment may still be provisioning. - The session is processing a turn. - The session is waiting for one or more required actions. - The session failed. - - The session is paused because its spending limit was reached. description: The current status of a session. McpApprovalRequestResourceMcpToolCall: type: object @@ -93574,9 +93570,6 @@ components: - $ref: '#/components/schemas/TokenUsageResource' - type: 'null' description: Best-effort token usage for the session, or null if unknown. Recorded usage may change. - spend_control: - $ref: '#/components/schemas/SessionBudgetControlResource' - description: Spending limit and best-effort consumption, in USD cents. Present when spending-control visibility is enabled; limit is null without a cap. Older server responses may omit this object. required: - metadata - id @@ -93735,11 +93728,6 @@ components: stream_options: $ref: '#/components/schemas/SessionStreamOptionsParam' description: Options for the event stream. Only allowed when `stream` is `true`. - spend_control: - anyOf: - - $ref: '#/components/schemas/SessionBudgetControlParams' - - type: 'null' - description: Optional spending limit in USD cents. Omission or null creates an unlimited session. required: - environment additionalProperties: false @@ -95381,7 +95369,6 @@ components: agent.session.turn.output_text.delta: '#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta' agent.session.turn.output_text.done: '#/components/schemas/SessionEventAgentSessionTurnOutputTextDone' agent.session.turn.reasoning_summary_part.added: '#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded' - agent.session.budget_reached: '#/components/schemas/SessionEventAgentSessionBudgetReached' x-oai-discriminator-values: - error - agent.session.environment.ready @@ -95397,7 +95384,6 @@ components: - agent.session.turn.cancelled - agent.session.turn.item.added - agent.session.idle - - agent.session.budget_reached - agent.session.in_progress - agent.session.requires_action - agent.session.failed @@ -95432,7 +95418,6 @@ components: - $ref: '#/components/schemas/SessionEventAgentSessionTurnCancelled' - $ref: '#/components/schemas/SessionEventAgentSessionTurnItemAdded' - $ref: '#/components/schemas/SessionEventAgentSessionIdle' - - $ref: '#/components/schemas/SessionEventAgentSessionBudgetReached' - $ref: '#/components/schemas/SessionEventAgentSessionInProgress' - $ref: '#/components/schemas/SessionEventAgentSessionRequiresAction' - $ref: '#/components/schemas/SessionEventAgentSessionFailed' @@ -95520,11 +95505,6 @@ components: minProperties: 0 maxProperties: 16 description: Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it. Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters. - spend_control: - anyOf: - - $ref: '#/components/schemas/SessionBudgetControlParams' - - type: 'null' - description: Omit to retain the limit; null or a null limit removes it without resetting spend. additionalProperties: false description: Fields to update on an existing session. DeletedSessionResource: @@ -113372,70 +113352,6 @@ components: - soonest - 2h - 8h - SessionEventAgentSessionBudgetReached: - type: object - properties: - type: - type: string - enum: - - agent.session.budget_reached - default: agent.session.budget_reached - x-stainless-const: true - description: The type of the object. Always `agent.session.budget_reached`. - event_id: - type: string - minLength: 0 - description: The unique ID of the event. - session: - $ref: '#/components/schemas/SessionResource' - description: The paused session. - obfuscation: - type: string - minLength: 0 - description: Random alphanumeric padding. Present when stream obfuscation is enabled. - required: - - type - - event_id - - session - additionalProperties: false - description: Emitted when a session pauses because its spending limit was reached. - SessionBudgetControlParams: - type: object - properties: - limit: - type: - - integer - - 'null' - format: int64 - minimum: 1 - maximum: 4503599627370495 - description: Positive USD cents, or null to remove the limit. - required: - - limit - additionalProperties: false - description: Sets the session-wide limit without changing recorded spend. - SessionBudgetControlResource: - type: object - properties: - limit: - type: - - integer - - 'null' - format: int64 - minimum: 1 - maximum: 4503599627370495 - description: The configured positive limit in USD cents, or null when unlimited. - consumed: - type: - - integer - - 'null' - minimum: 0 - description: Best-effort recorded spend floored to whole USD cents, or null when unavailable. - required: - - limit - - consumed - additionalProperties: false - description: Session-wide spending limit and best-effort consumption, including unlimited sessions. LiveMCPToolFilterParam: type: object properties: diff --git a/scripts/castiron/generated-files.json b/scripts/castiron/generated-files.json index 7665223870..476048dc5a 100644 --- a/scripts/castiron/generated-files.json +++ b/scripts/castiron/generated-files.json @@ -3,7 +3,7 @@ "files": { "api.md": { "mode": "100644", - "sha256": "6474a963c5d360eb6e63a3e4c4b305a0d2508afcc85a730a552df8666fe658f3" + "sha256": "9b8076604c5fa4ab278804b9893edfed16206861f4f93e67e7a4dc503f132c5d" }, "src/openai/__init__.py": { "mode": "100644", @@ -303,7 +303,7 @@ }, "src/openai/resources/beta/agents/sessions/sessions.py": { "mode": "100644", - "sha256": "d7b1d7b3e97f28f73634ed36ab83a2fdc9bf3a2c1c7e85e4607cca49f841db5a" + "sha256": "7f4393866730e2d79a254c46559561e36674de90e102c4a3ff516fd89b8d6109" }, "src/openai/resources/beta/agents/sessions/subagents/__init__.py": { "mode": "100644", @@ -1659,7 +1659,7 @@ }, "src/openai/types/beta/__init__.py": { "mode": "100644", - "sha256": "5b71c93740ed29812ef583e270b14bcfa799b5634bd76c1f98fa31150de42ed4" + "sha256": "7db7f38a689e6256dae3ff5227510e053f915a5782454b3adde9095264afb499" }, "src/openai/types/beta/agent.py": { "mode": "100644", @@ -1775,16 +1775,12 @@ }, "src/openai/types/beta/agent_session.py": { "mode": "100644", - "sha256": "4871b70ba64d8ffc00a27a1fbebad8de1fa079525f2b06ba4309098dd889c83e" + "sha256": "d7112cb67c59fbb1c993d666ea4ca8bea709de9c4c3b2738cd16d395744bc072" }, "src/openai/types/beta/agent_session_assistant_message.py": { "mode": "100644", "sha256": "cd658ea7c56193403b7188950c00702190c929a72fc3d0be0e7853d710c4f57a" }, - "src/openai/types/beta/agent_session_budget_reached_event.py": { - "mode": "100644", - "sha256": "d4a4be2e3366b97aa8d9256c53b2278a6cbebafb0004fc5f49951bc7d05d437a" - }, "src/openai/types/beta/agent_session_created_event.py": { "mode": "100644", "sha256": "ece7da18f956751a79a28098a8297f87c0adc9db4b8cf36b7528941a08fa5b1e" @@ -1835,7 +1831,7 @@ }, "src/openai/types/beta/agent_session_event.py": { "mode": "100644", - "sha256": "2b42487182e4ba75a2a865f66f646c8f02cfad3597ec4ab897917d6f8fc569f6" + "sha256": "96b07cffe33f0ec960eeb92b317018f05c5f0a633d0f4b01e741073c085fdb5e" }, "src/openai/types/beta/agent_session_failed_event.py": { "mode": "100644", @@ -2095,7 +2091,7 @@ }, "src/openai/types/beta/agents/session_create_params.py": { "mode": "100644", - "sha256": "44261a235f763e718d5c71de57cc87eb7c2e502ada26c350c62e7b1d2c73bdf6" + "sha256": "32b7560fe3a117d1cd50ea68affa615b4c35dd17cb845dc2ec4f5dc1cd3b7682" }, "src/openai/types/beta/agents/session_list_params.py": { "mode": "100644", @@ -2103,7 +2099,7 @@ }, "src/openai/types/beta/agents/session_update_params.py": { "mode": "100644", - "sha256": "22f0f47d3b8158bb9aa9a588bec6944171432cddbb757aaeaf8c0602a2b232a6" + "sha256": "a3d82223cbaeff336175539efebf8998d6bc5193bcabcc82c1f11a724176f05d" }, "src/openai/types/beta/agents/sessions/__init__.py": { "mode": "100644", @@ -3535,7 +3531,7 @@ }, "src/openai/types/beta/session_turn_error.py": { "mode": "100644", - "sha256": "0509a933cb578c18a49dd1abf2d689bf4da1c6e8bb8b7e80d5d024c22b41042e" + "sha256": "5c001662a8a2ba24efe4d7d42a4c37ba70e9c45e095ebfd3c973fa32af48ad7e" }, "src/openai/types/beta/setup_command_param.py": { "mode": "100644", @@ -7815,7 +7811,7 @@ }, "tests/api_resources/beta/agents/test_sessions.py": { "mode": "100644", - "sha256": "8f3c9a080fa915a1febed855312d597184431105e4227c1f4acfd24a42dd8ee9" + "sha256": "1bda32e69765f37c574631637155008a86e4e66973581112e8a4aaa37ba21e44" }, "tests/api_resources/beta/agents/test_vaults.py": { "mode": "100644", diff --git a/src/openai/lib/beta/agents/_result.py b/src/openai/lib/beta/agents/_result.py index ed849cf1f5..047a529a2f 100644 --- a/src/openai/lib/beta/agents/_result.py +++ b/src/openai/lib/beta/agents/_result.py @@ -174,13 +174,21 @@ def accept(self, event: AgentSessionEvent) -> None: self.session_id = event.session.id self.session_failed = True self.boundary = True - elif event.type == "agent.session.budget_reached" and self.turn is None: - if self.session_id in (None, event.session.id): - self.session_id = event.session.id - self.boundary = True - elif event.type == "agent.session.idle" or ( - event.type == "agent.session.budget_reached" and event.session.id == self.session_id - ): + elif getattr(event, "type", None) == "agent.session.budget_reached": + snapshot = getattr(event, "session", None) + snapshot_id = snapshot.get("id") if isinstance(snapshot, dict) else getattr(snapshot, "id", None) + if isinstance(snapshot_id, str) and snapshot_id: + if self.turn is None and self.session_id in (None, snapshot_id): + self.session_id = snapshot_id + self.boundary = True + elif ( + self.turn is not None + and snapshot_id == self.session_id + and self.turn.status in ("completed", "failed", "cancelled") + ): + self.required_actions = [] + self.boundary = True + elif event.type == "agent.session.idle": if self.turn is not None and self.turn.status in ("completed", "failed", "cancelled"): self.required_actions = [] self.boundary = True diff --git a/src/openai/lib/streaming/agents/_streams.py b/src/openai/lib/streaming/agents/_streams.py index a72342dbb3..b436679816 100644 --- a/src/openai/lib/streaming/agents/_streams.py +++ b/src/openai/lib/streaming/agents/_streams.py @@ -83,15 +83,17 @@ def accept(self, event: AgentSessionEvent) -> bool: return True def terminal(self, event: AgentSessionEvent, session_id: str) -> bool: - return ( - event.type == "agent.session.failed" - or ( - event.type == "agent.session.budget_reached" - and event.session.id == session_id + # Private lifecycle frames can outlive their generated public union variant. + if getattr(event, "type", None) == "agent.session.budget_reached": + snapshot = getattr(event, "session", None) + snapshot_id = snapshot.get("id") if isinstance(snapshot, dict) else getattr(snapshot, "id", None) + return ( + isinstance(snapshot_id, str) + and bool(snapshot_id) + and snapshot_id == session_id and (self.turn_id is None or self.turn_ended) ) - or (event.type == "agent.session.idle" and self.turn_ended) - ) + return event.type == "agent.session.failed" or (event.type == "agent.session.idle" and self.turn_ended) class AgentSessionStream(Generic[OutputT]): diff --git a/src/openai/resources/beta/agents/sessions/sessions.py b/src/openai/resources/beta/agents/sessions/sessions.py index f60c56d8ea..652a498e2a 100644 --- a/src/openai/resources/beta/agents/sessions/sessions.py +++ b/src/openai/resources/beta/agents/sessions/sessions.py @@ -166,7 +166,6 @@ def create( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_create_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_create_params.SpendControl] | Omit = omit, stream: Literal[False] | Omit = omit, stream_options: session_create_params.StreamOptions | Omit = omit, vault_ids: Optional[SequenceNotStr[str]] | Omit = omit, @@ -190,7 +189,6 @@ def create( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_create_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_create_params.SpendControl] | Omit = omit, stream_options: session_create_params.StreamOptions | Omit = omit, vault_ids: Optional[SequenceNotStr[str]] | Omit = omit, extra_headers: Headers | None = None, @@ -213,7 +211,6 @@ def create( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_create_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_create_params.SpendControl] | Omit = omit, stream_options: session_create_params.StreamOptions | Omit = omit, vault_ids: Optional[SequenceNotStr[str]] | Omit = omit, extra_headers: Headers | None = None, @@ -235,7 +232,6 @@ def create( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_create_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_create_params.SpendControl] | Omit = omit, stream: Literal[False] | Literal[True] | Omit = omit, stream_options: session_create_params.StreamOptions | Omit = omit, vault_ids: Optional[SequenceNotStr[str]] | Omit = omit, @@ -256,7 +252,6 @@ def create( "metadata": metadata, "prompt_cache_options": prompt_cache_options, "review": review, - "spend_control": spend_control, "stream_options": stream_options, "vault_ids": vault_ids, }, @@ -336,7 +331,6 @@ def update( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_update_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_update_params.SpendControl] | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -367,9 +361,6 @@ def update( - `auto_review` - Review eligible actions automatically. Deny manual approval fallbacks. - spend_control: Omit to retain the limit; null or a null limit removes it without resetting - spend. - extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -389,7 +380,6 @@ def update( "metadata": metadata, "prompt_cache_options": prompt_cache_options, "review": review, - "spend_control": spend_control, }, session_update_params.SessionUpdateParams, ), @@ -605,7 +595,6 @@ async def create( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_create_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_create_params.SpendControl] | Omit = omit, stream: Literal[False] | Omit = omit, stream_options: session_create_params.StreamOptions | Omit = omit, vault_ids: Optional[SequenceNotStr[str]] | Omit = omit, @@ -629,7 +618,6 @@ async def create( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_create_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_create_params.SpendControl] | Omit = omit, stream_options: session_create_params.StreamOptions | Omit = omit, vault_ids: Optional[SequenceNotStr[str]] | Omit = omit, extra_headers: Headers | None = None, @@ -652,7 +640,6 @@ async def create( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_create_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_create_params.SpendControl] | Omit = omit, stream_options: session_create_params.StreamOptions | Omit = omit, vault_ids: Optional[SequenceNotStr[str]] | Omit = omit, extra_headers: Headers | None = None, @@ -674,7 +661,6 @@ async def create( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_create_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_create_params.SpendControl] | Omit = omit, stream: Literal[False] | Literal[True] | Omit = omit, stream_options: session_create_params.StreamOptions | Omit = omit, vault_ids: Optional[SequenceNotStr[str]] | Omit = omit, @@ -695,7 +681,6 @@ async def create( "metadata": metadata, "prompt_cache_options": prompt_cache_options, "review": review, - "spend_control": spend_control, "stream_options": stream_options, "vault_ids": vault_ids, }, @@ -775,7 +760,6 @@ async def update( metadata: Optional[Dict[str, str]] | Omit = omit, prompt_cache_options: Optional[session_update_params.PromptCacheOptions] | Omit = omit, review: Literal["none", "auto_review"] | Omit = omit, - spend_control: Optional[session_update_params.SpendControl] | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -806,9 +790,6 @@ async def update( - `auto_review` - Review eligible actions automatically. Deny manual approval fallbacks. - spend_control: Omit to retain the limit; null or a null limit removes it without resetting - spend. - extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -828,7 +809,6 @@ async def update( "metadata": metadata, "prompt_cache_options": prompt_cache_options, "review": review, - "spend_control": spend_control, }, session_update_params.SessionUpdateParams, ), diff --git a/src/openai/types/beta/__init__.py b/src/openai/types/beta/__init__.py index cf918769f5..310e8daa97 100644 --- a/src/openai/types/beta/__init__.py +++ b/src/openai/types/beta/__init__.py @@ -236,7 +236,6 @@ from .beta_response_steer_pending_event import BetaResponseSteerPendingEvent as BetaResponseSteerPendingEvent from .beta_responses_client_event_param import BetaResponsesClientEventParam as BetaResponsesClientEventParam from .agent_interrupt_subagent_call_item import AgentInterruptSubagentCallItem as AgentInterruptSubagentCallItem -from .agent_session_budget_reached_event import AgentSessionBudgetReachedEvent as AgentSessionBudgetReachedEvent from .agent_session_turn_cancelled_event import AgentSessionTurnCancelledEvent as AgentSessionTurnCancelledEvent from .agent_session_turn_completed_event import AgentSessionTurnCompletedEvent as AgentSessionTurnCompletedEvent from .agent_session_turn_item_done_event import AgentSessionTurnItemDoneEvent as AgentSessionTurnItemDoneEvent diff --git a/src/openai/types/beta/agent_session.py b/src/openai/types/beta/agent_session.py index 426e48b4fe..b16f807929 100644 --- a/src/openai/types/beta/agent_session.py +++ b/src/openai/types/beta/agent_session.py @@ -31,7 +31,6 @@ "RequiredActionSessionRequiredActionResourceFunctionCall", "RequiredActionSessionRequiredActionResourceEnvironmentConnection", "PromptCacheOptions", - "SpendControl", ] @@ -266,21 +265,6 @@ class PromptCacheOptions(BaseModel): ttl: Literal["30m", "12h"] -class SpendControl(BaseModel): - """Spending limit and best-effort consumption, in USD cents. - - Present when spending-control visibility is enabled; limit is null without a cap. Older server responses may omit this object. - """ - - consumed: Optional[int] = None - """ - Best-effort recorded spend floored to whole USD cents, or null when unavailable. - """ - - limit: Optional[int] = None - """The configured positive limit in USD cents, or null when unlimited.""" - - class AgentSession(BaseModel): """A Managed Agents session.""" @@ -311,7 +295,7 @@ class AgentSession(BaseModel): required_actions: List[RequiredAction] """Actions that must be completed before the session can continue.""" - status: Literal["idle", "in_progress", "requires_action", "failed", "budget_reached"] + status: Literal["idle", "in_progress", "requires_action", "failed"] """The current status of the session. - `idle` - The session has no turn in progress and is ready for input. A hosted @@ -319,8 +303,6 @@ class AgentSession(BaseModel): - `in_progress` - The session is processing a turn. - `requires_action` - The session is waiting for one or more required actions. - `failed` - The session failed. - - `budget_reached` - The session is paused because its spending limit was - reached. """ usage: Optional[TokenUsage] = None @@ -341,10 +323,3 @@ class AgentSession(BaseModel): Omitted when review is none and automatic review is not enabled. Omission means none. """ - - spend_control: Optional[SpendControl] = None - """Spending limit and best-effort consumption, in USD cents. - - Present when spending-control visibility is enabled; limit is null without a - cap. Older server responses may omit this object. - """ diff --git a/src/openai/types/beta/agent_session_budget_reached_event.py b/src/openai/types/beta/agent_session_budget_reached_event.py deleted file mode 100644 index 2ac525fdb7..0000000000 --- a/src/openai/types/beta/agent_session_budget_reached_event.py +++ /dev/null @@ -1,25 +0,0 @@ -# File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details. - -from typing import Optional -from typing_extensions import Literal - -from ..._models import BaseModel -from .agent_session import AgentSession - -__all__ = ["AgentSessionBudgetReachedEvent"] - - -class AgentSessionBudgetReachedEvent(BaseModel): - """Emitted when a session pauses because its spending limit was reached.""" - - event_id: str - """The unique ID of the event.""" - - session: AgentSession - """The paused session.""" - - type: Literal["agent.session.budget_reached"] - """The type of the object. Always `agent.session.budget_reached`.""" - - obfuscation: Optional[str] = None - """Random alphanumeric padding. Present when stream obfuscation is enabled.""" diff --git a/src/openai/types/beta/agent_session_event.py b/src/openai/types/beta/agent_session_event.py index 790fd555cf..382bf3035a 100644 --- a/src/openai/types/beta/agent_session_event.py +++ b/src/openai/types/beta/agent_session_event.py @@ -11,7 +11,6 @@ from .agent_session_in_progress_event import AgentSessionInProgressEvent from .agent_session_turn_failed_event import AgentSessionTurnFailedEvent from .agent_session_turn_created_event import AgentSessionTurnCreatedEvent -from .agent_session_budget_reached_event import AgentSessionBudgetReachedEvent from .agent_session_turn_cancelled_event import AgentSessionTurnCancelledEvent from .agent_session_turn_completed_event import AgentSessionTurnCompletedEvent from .agent_session_turn_item_done_event import AgentSessionTurnItemDoneEvent @@ -57,7 +56,6 @@ AgentSessionTurnCancelledEvent, AgentSessionTurnItemAddedEvent, AgentSessionIdleEvent, - AgentSessionBudgetReachedEvent, AgentSessionInProgressEvent, AgentSessionRequiresActionEvent, AgentSessionFailedEvent, diff --git a/src/openai/types/beta/agents/session_create_params.py b/src/openai/types/beta/agents/session_create_params.py index 6df9304ed8..55154035e6 100644 --- a/src/openai/types/beta/agents/session_create_params.py +++ b/src/openai/types/beta/agents/session_create_params.py @@ -20,7 +20,6 @@ "AgentCompaction", "AgentExperimental", "PromptCacheOptions", - "SpendControl", "StreamOptions", "SessionCreateParamsNonStreaming", "SessionCreateParamsStreaming", @@ -73,12 +72,6 @@ class SessionCreateParamsBase(TypedDict, total=False): fallbacks. """ - spend_control: Optional[SpendControl] - """Optional spending limit in USD cents. - - Omission or null creates an unlimited session. - """ - stream_options: StreamOptions """Options for the event stream. Only allowed when `stream` is `true`.""" @@ -183,16 +176,6 @@ class PromptCacheOptions(TypedDict, total=False): """Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.""" -class SpendControl(TypedDict, total=False): - """Optional spending limit in USD cents. - - Omission or null creates an unlimited session. - """ - - limit: Required[Optional[int]] - """Positive USD cents, or null to remove the limit.""" - - class StreamOptions(TypedDict, total=False): """Options for the event stream. Only allowed when `stream` is `true`.""" diff --git a/src/openai/types/beta/agents/session_update_params.py b/src/openai/types/beta/agents/session_update_params.py index fd73196694..d6f804ad92 100644 --- a/src/openai/types/beta/agents/session_update_params.py +++ b/src/openai/types/beta/agents/session_update_params.py @@ -3,11 +3,11 @@ from __future__ import annotations from typing import Dict, Iterable, Optional -from typing_extensions import Literal, Required, TypedDict +from typing_extensions import Literal, TypedDict from ..agent_tool_param import AgentToolParam -__all__ = ["SessionUpdateParams", "Agent", "AgentReasoning", "PromptCacheOptions", "SpendControl"] +__all__ = ["SessionUpdateParams", "Agent", "AgentReasoning", "PromptCacheOptions"] class SessionUpdateParams(TypedDict, total=False): @@ -37,12 +37,6 @@ class SessionUpdateParams(TypedDict, total=False): fallbacks. """ - spend_control: Optional[SpendControl] - """ - Omit to retain the limit; null or a null limit removes it without resetting - spend. - """ - class AgentReasoning(TypedDict, total=False): """Reasoning settings to update. Omit to keep the current effort.""" @@ -88,12 +82,3 @@ class PromptCacheOptions(TypedDict, total=False): ttl: Literal["30m", "12h"] """Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.""" - - -class SpendControl(TypedDict, total=False): - """ - Omit to retain the limit; null or a null limit removes it without resetting spend. - """ - - limit: Required[Optional[int]] - """Positive USD cents, or null to remove the limit.""" diff --git a/src/openai/types/beta/session_turn_error.py b/src/openai/types/beta/session_turn_error.py index 3d30ec179c..6f20cb931a 100644 --- a/src/openai/types/beta/session_turn_error.py +++ b/src/openai/types/beta/session_turn_error.py @@ -13,7 +13,6 @@ class SessionTurnError(BaseModel): code: Literal[ "context_length_exceeded", "max_output_tokens", - "session_budget_exceeded", "usage_limit_exceeded", "project_spend_limit_exceeded", "organization_spend_limit_exceeded", @@ -41,7 +40,6 @@ class SessionTurnError(BaseModel): - `context_length_exceeded` - The request exceeds the model's context window. - `max_output_tokens` - The model reached its output token limit before finishing the response. - - `session_budget_exceeded` - The session has reached its usage budget. - `usage_limit_exceeded` - The organization has reached a usage, plan, or billing limit. - `project_spend_limit_exceeded` - The project has reached its enforced spend diff --git a/tests/api_resources/beta/agents/test_sessions.py b/tests/api_resources/beta/agents/test_sessions.py index 5bd876c048..b116579437 100644 --- a/tests/api_resources/beta/agents/test_sessions.py +++ b/tests/api_resources/beta/agents/test_sessions.py @@ -63,7 +63,6 @@ def test_method_create_with_all_params_overload_1(self, client: OpenAI) -> None: metadata={"foo": "string"}, prompt_cache_options={"ttl": "30m"}, review="none", - spend_control={"limit": 1}, stream=False, stream_options={"include_obfuscation": True}, vault_ids=["string"], @@ -141,7 +140,6 @@ def test_method_create_with_all_params_overload_2(self, client: OpenAI) -> None: metadata={"foo": "string"}, prompt_cache_options={"ttl": "30m"}, review="none", - spend_control={"limit": 1}, stream_options={"include_obfuscation": True}, vault_ids=["string"], ) @@ -241,7 +239,6 @@ def test_method_update_with_all_params(self, client: OpenAI) -> None: metadata={"foo": "string"}, prompt_cache_options={"ttl": "30m"}, review="none", - spend_control={"limit": 1}, ) assert_matches_type(AgentSession, session, path=["response"]) @@ -401,7 +398,6 @@ async def test_method_create_with_all_params_overload_1(self, async_client: Asyn metadata={"foo": "string"}, prompt_cache_options={"ttl": "30m"}, review="none", - spend_control={"limit": 1}, stream=False, stream_options={"include_obfuscation": True}, vault_ids=["string"], @@ -479,7 +475,6 @@ async def test_method_create_with_all_params_overload_2(self, async_client: Asyn metadata={"foo": "string"}, prompt_cache_options={"ttl": "30m"}, review="none", - spend_control={"limit": 1}, stream_options={"include_obfuscation": True}, vault_ids=["string"], ) @@ -579,7 +574,6 @@ async def test_method_update_with_all_params(self, async_client: AsyncOpenAI) -> metadata={"foo": "string"}, prompt_cache_options={"ttl": "30m"}, review="none", - spend_control={"limit": 1}, ) assert_matches_type(AgentSession, session, path=["response"]) diff --git a/tests/test_agents_budget_events.py b/tests/test_agents_budget_events.py index fe115f862f..074a39906f 100644 --- a/tests/test_agents_budget_events.py +++ b/tests/test_agents_budget_events.py @@ -6,7 +6,7 @@ import pytest from openai import OpenAI, AsyncOpenAI -from openai.types.beta import AgentSessionErrorEvent, AgentSessionBudgetReachedEvent +from openai.types.beta import AgentSessionErrorEvent from openai.lib.beta.agents import AgentTurnResultError from tests.lib.streaming.agents.test_results import ResultServer, collect, message, creation as creation from tests.lib.streaming.agents.test_streams import EventBody, sdk as sdk, session, turn_event @@ -17,6 +17,12 @@ def server() -> ResultServer: return ResultServer() +@pytest.fixture(autouse=True) +def private_wire_events(sdk: OpenAI | AsyncOpenAI) -> None: + # Match default client behavior for private frames outside the public union. + sdk._strict_response_validation = False + + def budget(session_id: str = "session_test") -> dict[str, object]: resource = session("budget_reached") resource["id"] = session_id @@ -33,26 +39,23 @@ def __iter__(self) -> Iterator[bytes]: @pytest.mark.parametrize("creation", [False, True]) @pytest.mark.parametrize("named", [False, True]) @pytest.mark.parametrize("preceding_error", [False, True]) -@pytest.mark.parametrize("limit", [None, 731]) -async def test_typed_budget_on_agents_entrypoints( +async def test_private_budget_on_agents_entrypoints( sdk: OpenAI | AsyncOpenAI, server: ResultServer, creation: bool, named: bool, preceding_error: bool, - limit: int | None, ) -> None: error_payload = { - "type": "budget_exceeded", - "code": "session_budget_reached", - "message": "Synthetic session spending limit reached", - "param": "spend_control", + "type": "server_error", + "code": "internal_error", + "message": "Synthetic domain failure", + "param": "input", } events: list[dict[str, object]] = [] if preceding_error: events.append({"type": "error", "session_id": "session_test", "error": error_payload}) resource = session("budget_reached") - resource["spend_control"] = {"limit": limit, "consumed": 419} events.append({"type": "agent.session.budget_reached", "session": resource}) server.body = (NamedEventBody if named else EventBody)(events) if isinstance(sdk, AsyncOpenAI): @@ -84,14 +87,9 @@ async def test_typed_budget_on_agents_entrypoints( assert isinstance(error, AgentSessionErrorEvent) assert error.session_id == "session_test" assert error.error.model_dump() == error_payload - assert isinstance(received[-1], AgentSessionBudgetReachedEvent) - assert received[-1].session.id == "session_test" - assert received[-1].session.status == "budget_reached" - spend_control = received[-1].session.spend_control - assert spend_control is not None - assert spend_control.limit == limit - assert "limit" in spend_control.model_fields_set - assert spend_control.consumed == 419 + snapshot = getattr(received[-1], "session", None) + assert snapshot is not None + assert (snapshot["id"] if isinstance(snapshot, dict) else snapshot.id) == "session_test" assert server.body.read_count == len(events) assert server.body.closed @@ -161,7 +159,7 @@ async def test_budget_before_root_turn_stops_result_collection( { "type": "error", "session_id": "session_test", - "error": {"type": "budget_exceeded", "message": "Budget exceeded"}, + "error": {"type": "server_error", "message": "Budget exceeded"}, }, budget(), {"type": "agent.session.failed", "session": session("failed")}, @@ -175,3 +173,21 @@ async def test_budget_before_root_turn_stops_result_collection( assert exc.value.turn is None assert server.body.read_count == len(events) - 1 assert server.body.closed + + +@pytest.mark.parametrize("snapshot", [None, {}, {"id": None}, {"id": ""}, {"id": 123}]) +async def test_malformed_private_budget_snapshot_is_not_a_boundary( + sdk: OpenAI | AsyncOpenAI, server: ResultServer, creation: bool, snapshot: object +) -> None: + server.body = EventBody( + [ + {"type": "agent.session.budget_reached", "session": snapshot}, + {"type": "agent.session.failed", "session": session("failed")}, + ] + ) + with pytest.raises(AgentTurnResultError) as exc: + await collect(sdk, creation) + assert exc.value.reason == "failed" + assert exc.value.session_id == "session_test" + assert server.body.read_count == 2 + assert server.body.closed diff --git a/tests/test_agents_error_events.py b/tests/test_agents_error_events.py new file mode 100644 index 0000000000..8946d81c0a --- /dev/null +++ b/tests/test_agents_error_events.py @@ -0,0 +1,77 @@ +from __future__ import annotations + +from typing import Iterator +from typing_extensions import override + +import pytest + +from openai import OpenAI, AsyncOpenAI +from openai.types.beta import AgentSessionIdleEvent, AgentSessionErrorEvent +from tests.lib.streaming.agents.test_results import ResultServer +from tests.lib.streaming.agents.test_streams import EventBody, sdk as sdk, session + + +@pytest.fixture +def server() -> ResultServer: + return ResultServer() + + +class NamedEventBody(EventBody): + @override + def __iter__(self) -> Iterator[bytes]: + for chunk, event in zip(super().__iter__(), self.events, strict=True): + yield f"event: {event['type']}\n".encode() + chunk + + +@pytest.mark.parametrize("creation", [False, True]) +@pytest.mark.parametrize("named", [False, True]) +async def test_typed_error_on_agents_entrypoints( + sdk: OpenAI | AsyncOpenAI, + server: ResultServer, + creation: bool, + named: bool, +) -> None: + sdk._strict_response_validation = False + error_payload = { + "type": "server_error", + "code": "internal_error", + "message": "Synthetic domain failure", + "param": "input", + } + events: list[dict[str, object]] = [ + {"type": "error", "session_id": "session_test", "error": error_payload}, + {"type": "agent.session.future_state", "session": {"id": "session_test"}}, + {"type": "agent.session.idle", "session": session("idle")}, + ] + server.body = (NamedEventBody if named else EventBody)(events) + if isinstance(sdk, AsyncOpenAI): + stream = ( + await sdk.beta.agents.sessions.create( + agent={"model": "test-model"}, environment={"type": "none"}, input="Question", stream=True + ) + if creation + else await sdk.beta.agents.sessions.events.stream("session_test") + ) + async with stream: + received = [event async for event in stream] + else: + stream = ( + sdk.beta.agents.sessions.create( + agent={"model": "test-model"}, environment={"type": "none"}, input="Question", stream=True + ) + if creation + else sdk.beta.agents.sessions.events.stream("session_test") + ) + with stream: + received = list(stream) + assert [event.type for event in received] == ["error", "agent.session.future_state", "agent.session.idle"] + assert [event.event_id for event in received] == [str(index) for index in range(len(events))] + error = received[0] + assert isinstance(error, AgentSessionErrorEvent) + assert error.session_id == "session_test" + assert error.error.model_dump() == error_payload + assert isinstance(received[-1], AgentSessionIdleEvent) + assert received[-1].session.id == "session_test" + assert received[-1].session.status == "idle" + assert server.body.read_count == len(events) + assert server.body.closed