agent-engine-sdk-openai-agents 0.11.8__tar.gz

agent_engine_sdk_openai_agents-0.11.8/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 MongoDB, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

agent_engine_sdk_openai_agents-0.11.8/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.5
+Name: agent-engine-sdk-openai-agents
+Version: 0.11.8
+Summary: OpenAI Agents SDK adapter for Atlas Agent Engine
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: agent-engine-runner-shared[mongodb,tracing]==0.11.8
+Requires-Dist: agent-engine-sdk==0.11.8
+Requires-Dist: openai-agents==0.22.0
+Provides-Extra: dev
+Requires-Dist: pyright>=1.1.414; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=9.1.1; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Agent Engine SDK OpenAI Agents
+
+[![License](https://img.shields.io/badge/license-Apache-2.0-blue.svg)](LICENSE)
+
+OpenAI Agents SDK adapter for the MongoDB Atlas Agent Engine SDK.
+
+> **Status:** under construction. `framework: openai-agents` is not yet
+> accepted by the CLI or the build service.
+
+The adapter runs a native OpenAI Agents `Agent` through the SDK's own
+`Runner` while the Orchestration Engine owns durable execution. The adapter
+keeps no session database and never uses OpenAI Sessions, Conversations, or
+`previous_response_id` as continuation state.
+
+## Building an agent
+
+```python
+from agents import Agent, ModelSettings
+from agent_engine_sdk_openai_agents import App
+
+app = App(app_name="support")
+
+
+@app.tool()
+def lookup_order(order_id: str) -> str:
+    """Look up an order."""
+    ...
+
+
+@app.entrypoint
+def build() -> Agent:
+    return Agent(
+        name="support",
+        instructions="Help with orders.",
+        model=app.llm("gpt-4.1", settings=ModelSettings(temperature=0)),
+        tools=app.tools(),
+    )
+```
+
+Use the model returned by `app.llm(...)` and the tools returned by
+`app.tools()`; anything else fails the turn before any model or tool work.
+Pass a configured `agents.Model` to `app.llm` to use a custom OpenAI client.
+Tool parameters must be JSON values that can be passed by name (no
+positional-only or `*args` parameters, and none named `tool_call_id`), because remote tools receive their
+arguments as named JSON values. Set a tool's timeout with
+`@app.tool(timeout=...)`; a native `timeout_seconds` on an issued tool fails
+the turn. A non-string tool result, including nested models,
+dataclasses, enums, and datetimes, reaches the model as JSON text. The text is
+canonical, so a replayed turn sends the model the same text: keys are sorted
+and a whole-number float such as `164.0` is written `164`. An integer beyond
+2**53 in a tool's result or arguments fails the call, because the durable
+record cannot keep it exactly; pass such a value as a string.
+
+Each invocation runs one native `Runner` turn and commits it to the
+Orchestration Engine before returning the result. A failed tool call fails
+the turn with the error the platform's tool path reports, such as a tool
+execution error carrying the tool's message or a policy denial; a cancelled or
+user-stopped call fails it too. Nothing is committed in any of these cases.
+When the model calls several tools at once, they run concurrently. Each call
+keeps the Orchestration Engine activity of its call id, and their results reach
+the model in the order the model made the calls, whichever finishes first. If
+one of them waits for approval, the calls that ran before the wait keep their
+outputs ahead of the approved call's, as the SDK records them. When one call
+fails, the turn fails once the calls still running beside it have finished.
+MCP servers, guardrails, agent hooks, hosted prompts, dynamic instructions,
+and a custom `tool_use_behavior` are not supported yet.
+
+## Handoffs
+
+Use the SDK's own `handoffs=[...]`, with other agents or `agents.handoff(...)`.
+The runtime reads the whole agent graph the entrypoint returns before each
+turn and holds every reachable agent to the same rules as the first: its model
+comes from `app.llm(...)` (give each agent's model its own `llm_id`) and its
+tools from `app.tools()`, from which each agent can select its own by name.
+Agent names must be unique.
+
+A handoff changes which agent is active; the turn stays one execution. The
+committed state records the active agent, so the next turn, also after a
+restart, starts with the agent that ended the last one. An approval requested
+by a handed-off agent suspends and resumes in that agent.
+
+`agents.handoff(...)` may override the tool name and description. Agents may
+hand off to each other in a cycle. An `input_filter`, `nest_handoff_history`,
+an `on_handoff` callback, an `input_type`, a callable `is_enabled`, and a
+hand-built `Handoff` fail the turn before any model or tool work. So does a
+handoff on any agent whose tool name matches another handoff's or one of that
+agent's tools: the SDK would otherwise keep one and drop the other.
+
+## Agents as tools
+
+Use the SDK's own `Agent.as_tool(...)` and put the result in another agent's
+`tools`. The nested agent follows the same rules as every other agent in the
+graph. Each call runs the nested agent as its own operation: its model and
+tool calls are Orchestration Engine activities under a path named after the
+tool, and repeated or concurrent calls to the same agent tool stay distinct,
+in the order the model made them.
+
+The calling agent's model sees only the tool's answer, and only the calling
+conversation is committed; a replacement attempt replays the nested run from
+its recorded activities. The caller's stream carries the nested agent's text
+between `subagent_start` and `subagent_end` events, tagged with the tool name
+and the call id, apart from the calling agent's reply. A nested run that fails
+fails the turn.
+
+`max_turns`, `custom_output_extractor`, and structured input are supported. A
+replacement attempt calls the extractor and a structured input's
+`input_builder` again, so both must return the same value for the same input
+and have no side effects; OE fails the turn when a replayed model call differs
+from the recorded one.
+
+An `on_stream` callback, `hooks`, a `run_config`, a `session`, provider
+continuation ids, a callable `needs_approval` or `is_enabled`, tool guardrails,
+a native `timeout_seconds`, and an agent that can reach itself through its own
+agent tool fail the turn before any model or tool work. So does a tool that
+needs approval anywhere a nested agent can reach, which is not supported yet;
+approvals in the calling agent work as usual.
+
+## Approvals
+
+Register a tool with `@app.tool(needs_approval=True)` to have a person approve
+each call. The argument is the SDK's own `function_tool(needs_approval=...)`,
+passed through to the `FunctionTool` that `app.tools()` returns; setting
+`needs_approval` on that returned tool works too. When the model calls a tool
+that needs approval, the turn suspends: the invocation returns
+`status: suspended` with one interrupt per call waiting for approval, in the
+order the model made the calls, each naming the tool and its arguments. Calls
+in the same response that need no approval run first. Resume through the normal
+invoke endpoint on the same session, with `resume_map` answering every
+interrupt id at once:
+
+```json
+{"resume_map": {"<interrupt id>": {"confirmed": true}}}
+```
+
+`interrupts` lists every pending approval. `suspend_payload` carries only the
+first one's value, for callers that read a single payload.
+
+`{"confirmed": false, "rejection_message": "..."}` rejects the call; the model
+sees the rejection message instead of a tool result, as with the SDK's own
+`reject(..., rejection_message=...)`. Without a
+`rejection_message` the model sees the SDK's default rejection text; an empty
+one is refused. An approval
+carries no message. The Orchestration Engine records the wait
+and its answer. Resuming replays the turn from the recorded model calls, applies
+the answer through the SDK's own `RunState`, and runs only what remains, so a
+tool never runs before its approval, prefix output is not repeated, and a
+restart while waiting loses nothing. A resume that leaves any interrupt
+unanswered is refused; `needs_approval` must be `True` or `False`, not a
+callable.
+
+## Durable state
+
+Each committed turn stores the Runner's complete input list under the
+`__agent_engine_openai_agents__` state property, together with the app and
+session it belongs to and the name of the agent that ended the turn. The next
+turn continues from that list with that agent. Committed
+messages are an explicit-field projection for history readers; they are not
+read back.
+
+Supported items are text messages, function calls, and text function outputs.
+The calls one model response made come together, followed by exactly one
+output per call before anything else. Any other item, any state that belongs
+to a different app or session, and an active agent the app no longer has fail
+the turn before new model or tool work starts.
+
+## Model calls
+
+Every model call the native `Runner` makes becomes an Orchestration Engine
+LLM activity. The agent's model answers from the recorded activity, and the
+model itself runs in the Tool Pod. A replacement attempt replays the recorded
+response and gives the `Runner` identical output items.
+
+Only per-call settings the platform carries cross that boundary: `max_tokens`,
+`top_p`, `frequency_penalty`, `presence_penalty`, `timeout`,
+`parallel_tool_calls`, `reasoning.effort`, `verbosity`, and a named
+`tool_choice`. Provider settings such as `temperature` belong to the model you
+register, and the Tool Pod applies them. A registered model cannot carry a
+`tool_choice` or `timeout` (set them on the agent), or `extra_body` / `extra_args` fields that make the provider
+continue a stored conversation (`previous_response_id`, `conversation`,
+`conversation_id`, `prompt`) or that override what the adapter builds for
+each call (such as `tools`, `input`, `instructions`, or the output format), or that set
+`reasoning`, `reasoning_effort`, or `verbosity` as raw fields (use `ModelSettings.reasoning` and
+`ModelSettings.verbosity`). Native tracing, provider-hosted
+continuation, and stop sequences fail before the call is sent.
+
+### Reasoning
+
+Set `reasoning=Reasoning(effort=...)` and `verbosity` on the registered model,
+on the agent, or both; per-call values win over the registration. Prefer the
+registration. The SDK cannot tell an agent's explicit settings from its own
+defaults: when `Agent(model_settings=...)` equals the SDK's default settings
+(currently `Reasoning(effort="none")` with `verbosity="low"`), the SDK clears
+them at construction and the registered values apply. To use exactly that pair
+per call, assign it after construction (`agent.model_settings = ...`). Other
+reasoning settings, such as `reasoning.summary`, fail before the call is sent.
+Reasoning-token counts are reported in the model call's usage. Providers may
+limit these settings per model and API: for example, a Chat Completions
+reasoning model can refuse function tools unless the effort is `none`. The
+provider's refusal fails the model call.
+
+A durable run does not carry a model's hidden reasoning from one model call to
+the next. The provider's encrypted reasoning items are dropped in the Tool Pod
+and never stored, so each call, including each step of a tool loop, reasons
+from the durable conversation alone. If an agent needs a plan that persists
+across calls, it should record the plan explicitly, for example in its own
+messages or in Memory, rather than rely on the model's hidden reasoning.
+
+The Tool Pod retries transient provider failures before any output streams.
+The SDK's own `ModelSettings.retry` is rejected: on the agent it would make
+the `Runner` issue extra model activities, and on a registered model it would
+have no effect. A model stream that ends without a completed response fails
+the call rather than being recorded as a truncated answer.

agent_engine_sdk_openai_agents-0.11.8/README.md

@@ -0,0 +1,212 @@
+# Agent Engine SDK OpenAI Agents
+
+[![License](https://img.shields.io/badge/license-Apache-2.0-blue.svg)](LICENSE)
+
+OpenAI Agents SDK adapter for the MongoDB Atlas Agent Engine SDK.
+
+> **Status:** under construction. `framework: openai-agents` is not yet
+> accepted by the CLI or the build service.
+
+The adapter runs a native OpenAI Agents `Agent` through the SDK's own
+`Runner` while the Orchestration Engine owns durable execution. The adapter
+keeps no session database and never uses OpenAI Sessions, Conversations, or
+`previous_response_id` as continuation state.
+
+## Building an agent
+
+```python
+from agents import Agent, ModelSettings
+from agent_engine_sdk_openai_agents import App
+
+app = App(app_name="support")
+
+
+@app.tool()
+def lookup_order(order_id: str) -> str:
+    """Look up an order."""
+    ...
+
+
+@app.entrypoint
+def build() -> Agent:
+    return Agent(
+        name="support",
+        instructions="Help with orders.",
+        model=app.llm("gpt-4.1", settings=ModelSettings(temperature=0)),
+        tools=app.tools(),
+    )
+```
+
+Use the model returned by `app.llm(...)` and the tools returned by
+`app.tools()`; anything else fails the turn before any model or tool work.
+Pass a configured `agents.Model` to `app.llm` to use a custom OpenAI client.
+Tool parameters must be JSON values that can be passed by name (no
+positional-only or `*args` parameters, and none named `tool_call_id`), because remote tools receive their
+arguments as named JSON values. Set a tool's timeout with
+`@app.tool(timeout=...)`; a native `timeout_seconds` on an issued tool fails
+the turn. A non-string tool result, including nested models,
+dataclasses, enums, and datetimes, reaches the model as JSON text. The text is
+canonical, so a replayed turn sends the model the same text: keys are sorted
+and a whole-number float such as `164.0` is written `164`. An integer beyond
+2**53 in a tool's result or arguments fails the call, because the durable
+record cannot keep it exactly; pass such a value as a string.
+
+Each invocation runs one native `Runner` turn and commits it to the
+Orchestration Engine before returning the result. A failed tool call fails
+the turn with the error the platform's tool path reports, such as a tool
+execution error carrying the tool's message or a policy denial; a cancelled or
+user-stopped call fails it too. Nothing is committed in any of these cases.
+When the model calls several tools at once, they run concurrently. Each call
+keeps the Orchestration Engine activity of its call id, and their results reach
+the model in the order the model made the calls, whichever finishes first. If
+one of them waits for approval, the calls that ran before the wait keep their
+outputs ahead of the approved call's, as the SDK records them. When one call
+fails, the turn fails once the calls still running beside it have finished.
+MCP servers, guardrails, agent hooks, hosted prompts, dynamic instructions,
+and a custom `tool_use_behavior` are not supported yet.
+
+## Handoffs
+
+Use the SDK's own `handoffs=[...]`, with other agents or `agents.handoff(...)`.
+The runtime reads the whole agent graph the entrypoint returns before each
+turn and holds every reachable agent to the same rules as the first: its model
+comes from `app.llm(...)` (give each agent's model its own `llm_id`) and its
+tools from `app.tools()`, from which each agent can select its own by name.
+Agent names must be unique.
+
+A handoff changes which agent is active; the turn stays one execution. The
+committed state records the active agent, so the next turn, also after a
+restart, starts with the agent that ended the last one. An approval requested
+by a handed-off agent suspends and resumes in that agent.
+
+`agents.handoff(...)` may override the tool name and description. Agents may
+hand off to each other in a cycle. An `input_filter`, `nest_handoff_history`,
+an `on_handoff` callback, an `input_type`, a callable `is_enabled`, and a
+hand-built `Handoff` fail the turn before any model or tool work. So does a
+handoff on any agent whose tool name matches another handoff's or one of that
+agent's tools: the SDK would otherwise keep one and drop the other.
+
+## Agents as tools
+
+Use the SDK's own `Agent.as_tool(...)` and put the result in another agent's
+`tools`. The nested agent follows the same rules as every other agent in the
+graph. Each call runs the nested agent as its own operation: its model and
+tool calls are Orchestration Engine activities under a path named after the
+tool, and repeated or concurrent calls to the same agent tool stay distinct,
+in the order the model made them.
+
+The calling agent's model sees only the tool's answer, and only the calling
+conversation is committed; a replacement attempt replays the nested run from
+its recorded activities. The caller's stream carries the nested agent's text
+between `subagent_start` and `subagent_end` events, tagged with the tool name
+and the call id, apart from the calling agent's reply. A nested run that fails
+fails the turn.
+
+`max_turns`, `custom_output_extractor`, and structured input are supported. A
+replacement attempt calls the extractor and a structured input's
+`input_builder` again, so both must return the same value for the same input
+and have no side effects; OE fails the turn when a replayed model call differs
+from the recorded one.
+
+An `on_stream` callback, `hooks`, a `run_config`, a `session`, provider
+continuation ids, a callable `needs_approval` or `is_enabled`, tool guardrails,
+a native `timeout_seconds`, and an agent that can reach itself through its own
+agent tool fail the turn before any model or tool work. So does a tool that
+needs approval anywhere a nested agent can reach, which is not supported yet;
+approvals in the calling agent work as usual.
+
+## Approvals
+
+Register a tool with `@app.tool(needs_approval=True)` to have a person approve
+each call. The argument is the SDK's own `function_tool(needs_approval=...)`,
+passed through to the `FunctionTool` that `app.tools()` returns; setting
+`needs_approval` on that returned tool works too. When the model calls a tool
+that needs approval, the turn suspends: the invocation returns
+`status: suspended` with one interrupt per call waiting for approval, in the
+order the model made the calls, each naming the tool and its arguments. Calls
+in the same response that need no approval run first. Resume through the normal
+invoke endpoint on the same session, with `resume_map` answering every
+interrupt id at once:
+
+```json
+{"resume_map": {"<interrupt id>": {"confirmed": true}}}
+```
+
+`interrupts` lists every pending approval. `suspend_payload` carries only the
+first one's value, for callers that read a single payload.
+
+`{"confirmed": false, "rejection_message": "..."}` rejects the call; the model
+sees the rejection message instead of a tool result, as with the SDK's own
+`reject(..., rejection_message=...)`. Without a
+`rejection_message` the model sees the SDK's default rejection text; an empty
+one is refused. An approval
+carries no message. The Orchestration Engine records the wait
+and its answer. Resuming replays the turn from the recorded model calls, applies
+the answer through the SDK's own `RunState`, and runs only what remains, so a
+tool never runs before its approval, prefix output is not repeated, and a
+restart while waiting loses nothing. A resume that leaves any interrupt
+unanswered is refused; `needs_approval` must be `True` or `False`, not a
+callable.
+
+## Durable state
+
+Each committed turn stores the Runner's complete input list under the
+`__agent_engine_openai_agents__` state property, together with the app and
+session it belongs to and the name of the agent that ended the turn. The next
+turn continues from that list with that agent. Committed
+messages are an explicit-field projection for history readers; they are not
+read back.
+
+Supported items are text messages, function calls, and text function outputs.
+The calls one model response made come together, followed by exactly one
+output per call before anything else. Any other item, any state that belongs
+to a different app or session, and an active agent the app no longer has fail
+the turn before new model or tool work starts.
+
+## Model calls
+
+Every model call the native `Runner` makes becomes an Orchestration Engine
+LLM activity. The agent's model answers from the recorded activity, and the
+model itself runs in the Tool Pod. A replacement attempt replays the recorded
+response and gives the `Runner` identical output items.
+
+Only per-call settings the platform carries cross that boundary: `max_tokens`,
+`top_p`, `frequency_penalty`, `presence_penalty`, `timeout`,
+`parallel_tool_calls`, `reasoning.effort`, `verbosity`, and a named
+`tool_choice`. Provider settings such as `temperature` belong to the model you
+register, and the Tool Pod applies them. A registered model cannot carry a
+`tool_choice` or `timeout` (set them on the agent), or `extra_body` / `extra_args` fields that make the provider
+continue a stored conversation (`previous_response_id`, `conversation`,
+`conversation_id`, `prompt`) or that override what the adapter builds for
+each call (such as `tools`, `input`, `instructions`, or the output format), or that set
+`reasoning`, `reasoning_effort`, or `verbosity` as raw fields (use `ModelSettings.reasoning` and
+`ModelSettings.verbosity`). Native tracing, provider-hosted
+continuation, and stop sequences fail before the call is sent.
+
+### Reasoning
+
+Set `reasoning=Reasoning(effort=...)` and `verbosity` on the registered model,
+on the agent, or both; per-call values win over the registration. Prefer the
+registration. The SDK cannot tell an agent's explicit settings from its own
+defaults: when `Agent(model_settings=...)` equals the SDK's default settings
+(currently `Reasoning(effort="none")` with `verbosity="low"`), the SDK clears
+them at construction and the registered values apply. To use exactly that pair
+per call, assign it after construction (`agent.model_settings = ...`). Other
+reasoning settings, such as `reasoning.summary`, fail before the call is sent.
+Reasoning-token counts are reported in the model call's usage. Providers may
+limit these settings per model and API: for example, a Chat Completions
+reasoning model can refuse function tools unless the effort is `none`. The
+provider's refusal fails the model call.
+
+A durable run does not carry a model's hidden reasoning from one model call to
+the next. The provider's encrypted reasoning items are dropped in the Tool Pod
+and never stored, so each call, including each step of a tool loop, reasons
+from the durable conversation alone. If an agent needs a plan that persists
+across calls, it should record the plan explicitly, for example in its own
+messages or in Memory, rather than rely on the model's hidden reasoning.
+
+The Tool Pod retries transient provider failures before any output streams.
+The SDK's own `ModelSettings.retry` is rejected: on the agent it would make
+the `Runner` issue extra model activities, and on a registered model it would
+have no effect. A model stream that ends without a completed response fails
+the call rather than being recorded as a truncated answer.