Python: [BREAKING] Make response_format validation errors visible to users (#3274)

* Make response_format validation errors visible to users

* Small fix

* Addressed comments

python/samples/getting_started/agents/azure_ai/azure_ai_with_response_format.py

@@ -41,12 +41,13 @@ async def main() -> None:
         print(f"User: {query}")
         result = await agent.run(query)
 
-        if isinstance(result.value, ReleaseBrief):
-            release_brief = result.value
+        if release_brief := result.try_parse_value(ReleaseBrief):
             print("Agent:")
             print(f"Feature: {release_brief.feature}")
             print(f"Benefit: {release_brief.benefit}")
             print(f"Launch date: {release_brief.launch_date}")
+        else:
+            print(f"Failed to parse response: {result.text}")
 
 
 if __name__ == "__main__":

python/samples/getting_started/agents/azure_ai_agent/azure_ai_with_response_format.py

@@ -56,13 +56,14 @@ async def main() -> None:
 
         result1 = await agent.run(query1)
 
-        if isinstance(result1.value, WeatherInfo):
-            weather = result1.value
+        if weather := result1.try_parse_value(WeatherInfo):
             print("Agent:")
             print(f"  Location: {weather.location}")
             print(f"  Temperature: {weather.temperature}")
             print(f"  Conditions: {weather.conditions}")
             print(f"  Recommendation: {weather.recommendation}")
+        else:
+            print(f"Failed to parse response: {result1.text}")
 
         # Request 2: Override response_format at runtime with CityInfo
         print("\n--- Request 2: Runtime override with CityInfo ---")
@@ -71,12 +72,13 @@ async def main() -> None:
 
         result2 = await agent.run(query2, options={"response_format": CityInfo})
 
-        if isinstance(result2.value, CityInfo):
-            city = result2.value
+        if city := result2.try_parse_value(CityInfo):
             print("Agent:")
             print(f"  City: {city.city_name}")
             print(f"  Population: {city.population}")
             print(f"  Country: {city.country}")
+        else:
+            print(f"Failed to parse response: {result2.text}")
 
 
 if __name__ == "__main__":

python/samples/getting_started/agents/openai/openai_assistants_with_response_format.py

@@ -59,13 +59,14 @@ async def main() -> None:
 
             result1 = await agent.run(query1)
 
-            if isinstance(result1.value, WeatherInfo):
-                weather = result1.value
+            if weather := result1.try_parse_value(WeatherInfo):
                 print("Agent:")
                 print(f"  Location: {weather.location}")
                 print(f"  Temperature: {weather.temperature}")
                 print(f"  Conditions: {weather.conditions}")
                 print(f"  Recommendation: {weather.recommendation}")
+            else:
+                print(f"Failed to parse response: {result1.text}")
 
             # Request 2: Override response_format at runtime with CityInfo
             print("\n--- Request 2: Runtime override with CityInfo ---")
@@ -74,12 +75,13 @@ async def main() -> None:
 
             result2 = await agent.run(query2, options={"response_format": CityInfo})
 
-            if isinstance(result2.value, CityInfo):
-                city = result2.value
+            if city := result2.try_parse_value(CityInfo):
                 print("Agent:")
                 print(f"  City: {city.city_name}")
                 print(f"  Population: {city.population}")
                 print(f"  Country: {city.country}")
+            else:
+                print(f"Failed to parse response: {result2.text}")
         finally:
             await client.beta.assistants.delete(agent.id)
 

python/samples/getting_started/agents/openai/openai_responses_client_with_structured_output.py

@@ -37,14 +37,13 @@ async def non_streaming_example() -> None:
     # Get structured response from the agent using response_format parameter
     result = await agent.run(query, options={"response_format": OutputStruct})
 
-    # Access the structured output directly from the response value
-    if result.value:
-        structured_data: OutputStruct = result.value  # type: ignore
-        print("Structured Output Agent (from result.value):")
+    # Access the structured output using try_parse_value for safe parsing
+    if structured_data := result.try_parse_value(OutputStruct):
+        print("Structured Output Agent (from result.try_parse_value):")
         print(f"City: {structured_data.city}")
         print(f"Description: {structured_data.description}")
     else:
-        print("Error: No structured data found in result.value")
+        print(f"Failed to parse response: {result.text}")
 
 
 async def streaming_example() -> None:
@@ -67,14 +66,13 @@ async def streaming_example() -> None:
         output_format_type=OutputStruct,
     )
 
-    # Access the structured output directly from the response value
-    if result.value:
-        structured_data: OutputStruct = result.value  # type: ignore
+    # Access the structured output using try_parse_value for safe parsing
+    if structured_data := result.try_parse_value(OutputStruct):
         print("Structured Output (from streaming with AgentResponse.from_agent_response_generator):")
         print(f"City: {structured_data.city}")
         print(f"Description: {structured_data.description}")
     else:
-        print("Error: No structured data found in result.value")
+        print(f"Failed to parse response: {result.text}")
 
 
 async def main() -> None: