run_stream docs are a little misleading

[thoraxe]

https://ai.pydantic.dev/api/agent/?h=run_stream#pydantic_ai.agent.Agent.run_stream

The example shown uses response.get_data() which doesn't result in data being streamed.

https://pydanticlogfire.slack.com/archives/C083V7PMHHA/p1736534340754989 has more details.

[samuelcolvin]

thanks.

[Kludex]

@thoraxe We implemented the Agent.iter(), which should be a bit more helpful in those situations. See https://ai.pydantic.dev/agents/#async-for-iteration.

I think we are planning on dropping Agent.run_stream. @dmontagu has more details.