add tracing support for structured output agent creation #44192
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
M-Hietala
requested review from
dargilco,
glharper,
howieleung,
kingernupur,
nick863,
trangevi and
trrwilson
as code owners
Copilot finished reviewing on behalf of
M-Hietala
November 26, 2025 20:00
nick863
approved these changes
Nov 26, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds tracing support for structured output in agent creation. When agents are created with a JSON schema for structured output (using ResponseTextFormatConfigurationJsonSchema), the schema is now captured in telemetry events alongside any instructions, enabling better observability of agent configuration.
Key Changes
- Enhanced the
_add_instructions_eventmethod to accept and serialize response schemas - Modified
start_create_agent_spanto extract schemas from the text parameter's format configuration - Added comprehensive test coverage for all combinations of instructions/schema presence and content recording settings
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/ai/azure-ai-projects/azure/ai/projects/telemetry/_ai_project_instrumentor.py | Modified _add_instructions_event to handle response schemas; updated start_create_agent_span to extract and pass schema from text.format.schema |
| sdk/ai/azure-ai-projects/tests/agents/telemetry/test_ai_agents_instrumentor_async.py | Added 4 async test cases covering structured output scenarios with/without instructions and content recording enabled/disabled |
| sdk/ai/azure-ai-projects/tests/agents/telemetry/test_ai_agents_instrumentor.py | Added 4 sync test cases mirroring the async tests for comprehensive coverage |
| sdk/ai/azure-ai-projects/CHANGELOG.md | Documented new tracing feature for structured output agents |
| sdk/ai/azure-ai-projects/assets.json | Updated asset tag reference for test recordings |
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add tracing support for structured output agent creation