ai-infra / API Reference

ProgressStream

from ai_infra.tools import ProgressStream

ai_infra.tools

Stream for sending progress updates from tools. This class is injected into progress-enabled tools as the `stream` parameter. Tools can call `await stream.update()` to send progress updates.

python

@progress
    async def my_tool(input: str, stream) -> str:
        await stream.update("Starting...", percent=0)
        # ... do work ...
        await stream.update("Halfway there!", percent=50)
        # ... more work ...
        await stream.update("Done!", percent=100)
        return "result"

Constructor

ProgressStream(tool_name: str, callback: Callable[[ProgressEvent], Any] | None = None)

Parameter	Type	Default	Description
`tool_name`required	`str`	—	Name of the tool this stream belongs to
`callback`	`Callable[[ProgressEvent], Any] \|None`	None	Function to call with progress events. Can be sync or async.

ProgressStream

Methods

ProgressStream

Methods