added examples and updated the docs !

pull/938/head
harshalmore31 2 months ago
parent 2bae025b25
commit f18facb050

@ -46,6 +46,71 @@ response = agent.run("Tell me a detailed story about humanity colonizing the sta
print(response)
```
## Streaming with Tools Execution
Swarms also supports real-time streaming while executing tools, providing immediate feedback on both the thinking process and tool execution results:
```python
from swarms import Agent
def get_weather(location: str, units: str = "celsius") -> str:
"""
Get the current weather for a location.
Args:
location (str): The city/location to get weather for
units (str): Temperature units (celsius or fahrenheit)
Returns:
str: Weather information
"""
weather_data = {
"New York": {"temperature": "22°C", "condition": "sunny", "humidity": "65%"},
"London": {"temperature": "15°C", "condition": "cloudy", "humidity": "80%"},
"Tokyo": {"temperature": "28°C", "condition": "rainy", "humidity": "90%"},
}
location_key = location.title()
if location_key in weather_data:
data = weather_data[location_key]
temp = data["temperature"]
if units == "fahrenheit" and "°C" in temp:
celsius = int(temp.replace("°C", ""))
fahrenheit = (celsius * 9/5) + 32
temp = f"{fahrenheit}°F"
return f"Weather in {location}: {temp}, {data['condition']}, humidity: {data['humidity']}"
else:
return f"Weather data not available for {location}"
# Create agent with streaming and tool support
agent = Agent(
model_name="gpt-4o",
max_loops=1,
verbose=True,
streaming_on=True, # Enable streaming
print_on=True, # Enable pretty printing
tools=[get_weather], # Add tools
)
# This will stream both the reasoning and tool execution results
agent.run("What is the weather in Tokyo? ")
```
### Key Features of Streaming with Tools:
- **Real-time tool execution**: See tool calls happen as they're invoked
- **Streaming responses**: Get immediate feedback on the agent's reasoning
- **Tool result integration**: Watch how tools results are incorporated into the final response
- **Interactive debugging**: Monitor the complete workflow from thought to action
### Best Practices:
1. **Set appropriate max_loops**: Use `max_loops=1` for simple tasks or higher values for complex multi-step operations
2. **Enable verbose mode**: Use `verbose=True` to see detailed tool execution logs
3. **Use print_on for UI**: Enable `print_on=True` for better visual streaming experience
4. **Monitor performance**: Streaming with tools may be slower due to real-time processing
## Connect With Us
If you'd like technical support, join our Discord below and stay updated on our Twitter for new updates!

@ -0,0 +1,44 @@
from swarms import Agent
def get_weather(location: str, units: str = "celsius") -> str:
"""
Get the current weather for a location.
Args:
location (str): The city/location to get weather for
units (str): Temperature units (celsius or fahrenheit)
Returns:
str: Weather information
"""
# Simulated weather data
weather_data = {
"New York": {"temperature": "22°C", "condition": "sunny", "humidity": "65%"},
"London": {"temperature": "15°C", "condition": "cloudy", "humidity": "80%"},
"Tokyo": {"temperature": "28°C", "condition": "rainy", "humidity": "90%"},
}
location_key = location.title()
if location_key in weather_data:
data = weather_data[location_key]
temp = data["temperature"]
if units == "fahrenheit" and "°C" in temp:
# Convert to Fahrenheit for demo
celsius = int(temp.replace("°C", ""))
fahrenheit = (celsius * 9/5) + 32
temp = f"{fahrenheit}°F"
return f"Weather in {location}: {temp}, {data['condition']}, humidity: {data['humidity']}"
else:
return f"Weather data not available for {location}"
agent = Agent(
model_name="gpt-4o",
max_loops=1,
verbose=True,
streaming_on=True,
print_on=True,
tools=[get_weather],
)
agent.run("What is the weather in Tokyo? ")
Loading…
Cancel
Save