Skip to content

Commit 5ab53ef

Browse files
authored
AI-310: document where the streaming topic is configured (#5006)
Set modelParams.streamingTopic on the Client's OpenAIAgentsPlugin, not the Worker's, and drop a demonstrative that pointed at a snipsync'd snippet line.
1 parent 1b65a3f commit 5ab53ef

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/develop/typescript/integrations/openai-agents.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,6 +513,8 @@ that produced the serialized state.
513513

514514
`run` supports streaming with `{ stream: true }`. The streaming model Activity publishes each model event to a [Workflow Stream](/workflow-streams) topic as the model produces it, so an external client can observe a run live while it stays durable. Streaming is experimental.
515515

516+
Set the topic name in `modelParams.streamingTopic` on the Client's `OpenAIAgentsPlugin`, not the Worker's; `run` fails with a `StreamingTopicNotConfigured` error if no topic is configured.
517+
516518
Streaming requires the `@temporalio/workflow-streams` package:
517519

518520

@@ -531,7 +533,7 @@ export async function streamingChat(prompt: string): Promise<string> {
531533
```
532534
<!--SNIPEND-->
533535

534-
Streaming from within the Workflow like this is replay-safe. Subscribe from an external client with `WorkflowStreamClient` from `@temporalio/workflow-streams/client`; see the [`@temporalio/workflow-streams`](https://github.com/temporalio/sdk-typescript/tree/main/contrib/workflow-streams) docs for the subscriber API.
536+
Streaming from within the Workflow is replay-safe. Subscribe from an external client with `WorkflowStreamClient` from `@temporalio/workflow-streams/client`; see the [`@temporalio/workflow-streams`](https://github.com/temporalio/sdk-typescript/tree/main/contrib/workflow-streams) docs for the subscriber API.
535537

536538
## Tracing
537539

0 commit comments

Comments
 (0)