feat: handle non serializable objects on RunResponse dict parsing (#3477)

- Updated RunResponse.to_dict() instead of .to_json() to try handling
non-serializable fields asap
- Added the cookbook I was using; maybe not relevant

Author: manuhortet

cookbook/observability/langfuse_via_openinference_response_model.py

@@ -0,0 +1,69 @@
+"""
+This example shows how to instrument your agno agent with OpenInference and send traces to Langfuse,
+using an Agent with a response model.
+
+1. Install dependencies: pip install openai langfuse opentelemetry-sdk opentelemetry-exporter-otlp openinference-instrumentation-agno
+2. Either self-host or sign up for an account at https://us.cloud.langfuse.com
+3. Set your Langfuse API key as an environment variables:
+  - export LANGFUSE_PUBLIC_KEY=<your-key>
+  - export LANGFUSE_SECRET_KEY=<your-key>
+"""
+
+import base64
+import os
+from enum import Enum
+
+from agno.agent import Agent
+from agno.models.openai import OpenAIChat
+from agno.tools.yfinance import YFinanceTools
+from openinference.instrumentation.agno import AgnoInstrumentor
+from opentelemetry import trace as trace_api
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import SimpleSpanProcessor
+from pydantic import BaseModel, Field
+
+LANGFUSE_AUTH = base64.b64encode(
+    f"{os.getenv('LANGFUSE_PUBLIC_KEY')}:{os.getenv('LANGFUSE_SECRET_KEY')}".encode()
+).decode()
+os.environ["OTEL_EXPORTER_OTLP_ENDPOINT"] = (
+    "https://us.cloud.langfuse.com/api/public/otel"  # 🇺🇸 US data region
+)
+# os.environ["OTEL_EXPORTER_OTLP_ENDPOINT"]="https://cloud.langfuse.com/api/public/otel" # 🇪🇺 EU data region
+# os.environ["OTEL_EXPORTER_OTLP_ENDPOINT"]="http://localhost:3000/api/public/otel" # 🏠 Local deployment (>= v3.22.0)
+
+os.environ["OTEL_EXPORTER_OTLP_HEADERS"] = f"Authorization=Basic {LANGFUSE_AUTH}"
+
+
+tracer_provider = TracerProvider()
+tracer_provider.add_span_processor(SimpleSpanProcessor(OTLPSpanExporter()))
+trace_api.set_tracer_provider(tracer_provider=tracer_provider)
+
+# Start instrumenting agno
+AgnoInstrumentor().instrument()
+
+
+class MarketArea(Enum):
+    USA = "USA"
+    UK = "UK"
+    EU = "EU"
+    ASIA = "ASIA"
+
+
+class StockPrice(BaseModel):
+    price: str = Field(description="The price of the stock")
+    symbol: str = Field(description="The symbol of the stock")
+    date: str = Field(description="Current day")
+    area: MarketArea
+
+
+agent = Agent(
+    name="Stock Price Agent",
+    model=OpenAIChat(id="gpt-4o-mini"),
+    tools=[YFinanceTools()],
+    instructions="You are a stock price agent. You check and return the current price of a stock.",
+    debug_mode=True,
+    response_model=StockPrice,
+)
+
+agent.print_response("What is the current price of Tesla?")

libs/agno/agno/run/response.py

@@ -177,7 +177,7 @@ def to_dict(self) -> Dict[str, Any]:
                 _dict["citations"] = self.citations
 
         if self.content and isinstance(self.content, BaseModel):
-            _dict["content"] = self.content.model_dump(exclude_none=True)
+            _dict["content"] = self.content.model_dump(exclude_none=True, mode="json")
 
         if self.tools is not None:
             _dict["tools"] = []

libs/agno/agno/run/team.py

@@ -81,7 +81,7 @@ def to_dict(self) -> Dict[str, Any]:
                 _dict["citations"] = self.citations
 
         if self.content and isinstance(self.content, BaseModel):
-            _dict["content"] = self.content.model_dump(exclude_none=True)
+            _dict["content"] = self.content.model_dump(exclude_none=True, mode="json")
 
         if self.tools is not None:
             _dict["tools"] = []

libs/agno/tests/unit/reader/test_url_reader.py

@@ -1,4 +1,4 @@
-from unittest.mock import AsyncMock, Mock, patch
+from unittest.mock import Mock, patch
 
 import httpx
 import pytest
@@ -82,9 +82,11 @@ def test_read_url_request_error():
 def test_read_url_http_error():
     """Test URL reading when fetch_with_retry raises HTTPStatusError"""
     url = "https://example.com"
-    
-    with patch("agno.document.reader.url_reader.fetch_with_retry", 
-               side_effect=httpx.HTTPStatusError("404 Not Found", request=Mock(), response=Mock())):
+
+    with patch(
+        "agno.document.reader.url_reader.fetch_with_retry",
+        side_effect=httpx.HTTPStatusError("404 Not Found", request=Mock(), response=Mock()),
+    ):
         reader = URLReader()
         with pytest.raises(httpx.HTTPStatusError):
             reader.read(url)
@@ -146,7 +148,7 @@ async def test_async_read_url_with_proxy(mock_response):
         call_args = mock_fetch.call_args
         assert call_args[0][0] == url  # First positional arg is url
         assert "client" in call_args[1]  # client should be in kwargs
-        
+
         assert len(documents) == 1
         assert documents[0].content == "Hello, World!"
 
@@ -156,8 +158,9 @@ async def test_async_read_url_request_error():
     """Test async URL reading when async_fetch_with_retry raises RequestError"""
     url = "https://example.com"
 
-    with patch("agno.document.reader.url_reader.async_fetch_with_retry", 
-               side_effect=httpx.RequestError("Connection failed")):
+    with patch(
+        "agno.document.reader.url_reader.async_fetch_with_retry", side_effect=httpx.RequestError("Connection failed")
+    ):
         reader = URLReader()
         with pytest.raises(httpx.RequestError):
             await reader.async_read(url)
@@ -168,8 +171,10 @@ async def test_async_read_url_http_error():
     """Test async URL reading when async_fetch_with_retry raises HTTPStatusError"""
     url = "https://example.com"
 
-    with patch("agno.document.reader.url_reader.async_fetch_with_retry",
-               side_effect=httpx.HTTPStatusError("404 Not Found", request=Mock(), response=Mock())):
+    with patch(
+        "agno.document.reader.url_reader.async_fetch_with_retry",
+        side_effect=httpx.HTTPStatusError("404 Not Found", request=Mock(), response=Mock()),
+    ):
         reader = URLReader()
         with pytest.raises(httpx.HTTPStatusError):
             await reader.async_read(url)