AI-310: document streaming in the TypeScript OpenAI Agents integration#4793
AI-310: document streaming in the TypeScript OpenAI Agents integration#4793xumaple wants to merge 5 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📖 Docs PR preview links
|
xumaple
force-pushed
the
maplexu/AI-310-openai-agents-streaming-docs
branch
from
199cbb6 to
4df24a9
Compare
xumaple
force-pushed
the
maplexu/AI-310-openai-agents-streaming-docs
branch
from
4df24a9 to
70f7dc5
Compare
Add a Streaming section covering run(agent, input, { stream: true }), hosting a
WorkflowStream in the Workflow, and subscribing to live model events from an
external client via WorkflowStreamClient. Fix the stale note that claimed
streaming was unsupported.
xumaple
force-pushed
the
maplexu/AI-310-openai-agents-streaming-docs
branch
from
70f7dc5 to
2012687
Compare
Drop the implementation mechanics (Activity returns the event list, Workflow consumes it instead of the live stream) in favor of a plain statement that streaming from within the Workflow is replay-safe.
Co-authored-by: David Hyde <DABH@users.noreply.github.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| | `@temporalio/openai-agents/otel` | Worker or Client | Replay-safe OpenTelemetry setup | | ||
| | `@temporalio/openai-agents/workflow-interceptor` | Worker bundling | Manual `workflowInterceptorModules` wiring without a plugin | | ||
|
|
||
| ## Create a Hello World Workflow |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Create a Hello World Workflow' should use sentence-style capitalization.
| Nested approval interruptions are not supported. If a nested run pauses for approval, the tool invocation fails with an | ||
| `ApplicationFailure` of type `NestedAgentInterruption`. | ||
|
|
||
| ## MCP servers |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'MCP servers' should use sentence-style capitalization.
| The integration supports stateless and stateful [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) | ||
| servers. | ||
|
|
||
| ### Stateless MCP servers |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Stateless MCP servers' should use sentence-style capitalization.
| } | ||
| ``` | ||
|
|
||
| ### Stateful MCP servers |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Stateful MCP servers' should use sentence-style capitalization.
| } | ||
| ``` | ||
|
|
||
| Dedicated Worker startup and heartbeat failures surface as an `ApplicationFailure` whose type is exported as |
There was a problem hiding this comment.
[Temporal.terms] Use 'Heartbeat' instead of 'heartbeat' when referring to a Temporal term.
|
|
||
|
|
||
| <!--SNIPSTART typescript-openai-agents-streaming-workflow --> | ||
| [openai-agents/src/streaming/workflows.ts](https://github.com/temporalio/samples-typescript/blob/main/openai-agents/src/streaming/workflows.ts) |
There was a problem hiding this comment.
[Temporal.terms] Use 'Workflows' instead of 'workflows' when referring to a Temporal term.
|
|
||
| ::: | ||
|
|
||
| ### OpenTelemetry |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'OpenTelemetry' should use sentence-style capitalization.
3 participants
Documents streaming in the TypeScript OpenAI Agents integration: a new Streaming section covering
run(agent, input, { stream: true }), hosting aWorkflowStream, and subscribing to live model events viaWorkflowStreamClient. Also fixes the stale note that claimed streaming was unsupported.┆Attachments: EDU-6620 AI-310: document streaming in the TypeScript OpenAI Agents integration