Installation
Install the swarms package using pip:Basic Setup
- First, set up your environment variables:
Step by Step
-
Install and put your keys in
.env -
Turn on streaming in
Agent()withstreaming_on=True -
print_on=True(the default) renders the tokens in a live panel;print_on=Falsestreams silently and only returns the final text
Code
Send tokens to your own function
streaming_callback receives each token as a string. It only fires on streamed calls, so keep streaming_on=True:
Iterate over tokens
run_stream() yields tokens as a generator, and arun_stream() is its async version. Both turn streaming on for the call, so you do not need streaming_on=True:
run_stream() and arun_stream() run the agent through run() on a background thread. With max_loops="auto" they enter the autonomous loop, and tokens from every LLM turn, including turns that follow tool calls, come through the same stream. Exceptions raised in the run are re-raised once the stream ends.
See Agent Configuration for arun_stream() and the detailed stream=True mode, and Token usage for what agent.usage reports.