feat(azure): add structured output support for AzureAIChatCompletionClient - #8223
Open
Abhinav (abhnvgrg) wants to merge 1 commit into
Open
feat(azure): add structured output support for AzureAIChatCompletionClient#8223Abhinav (abhnvgrg) wants to merge 1 commit into
Abhinav (abhnvgrg) wants to merge 1 commit into
Conversation
Author
|
@microsoft-github-policy-service agree |
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
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 structured output support for
AzureAIChatCompletionClientCloses #5957
What
Adds support for passing a Pydantic
BaseModelsubclass asjson_outputto
AzureAIChatCompletionClient.create()andcreate_stream(), enablingstructured output for models hosted on Azure AI Foundry and GitHub Models.
Approach
model_json_schema()and passes it as
JsonSchemaFormat(name=..., schema=..., strict=True)inthe
response_formatparameter to the Azure AI Inference SDK'sclient.complete()model_validate_json()after receiving the completioncreate()andcreate_stream()pathsmodel_info["structured_output"]and raises a clear error whenthe model doesn't support it
OpenAIChatCompletionClientinPR feat: add structured output to model clients #5936
Files changed
python/packages/autogen-ext/src/autogen_ext/models/azure/_azure_ai_client.py— core implementation
python/packages/autogen-ext/src/autogen_ext/models/azure/config/__init__.py— type updates (if needed)
python/packages/autogen-ext/tests/models/test_azure_ai_model_client.py— unit tests with mocked Azure SDK
Tests
create()— validates Pydantic parsingcreate_stream()— validates streamed JSON parsingstructured_outputis FalseJsonSchemaFormatis passed to SDKLocal validation
uv run pytest packages/autogen-ext/tests/models/test_azure_ai_model_client.py -v
25 passed
uv run ruff check --select E9,F63,F7,F82 packages/autogen-ext/
All checks passed!