Skip to content

Fix #5957 - Add structured output support for AzureAIChatCompletionClient #7861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Whning0513 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix #5957 - Add structured output support for AzureAIChatCompletionClient #7861

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions python/packages/autogen-ext/src/autogen_ext/models/azure/_azure_ai_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
ImageContentItem,
ImageDetailLevel,
ImageUrl,
JsonSchemaFormat,
StreamingChatChoiceUpdate,
StreamingChatCompletionsUpdate,
TextContentItem,
Expand Down Expand Up @@ -344,9 +345,19 @@ def _validate_model_info(
if self.model_info["json_output"] is False and json_output is True:
raise ValueError("Model does not support JSON output")

if isinstance(json_output, type):
# TODO: we should support this in the future.
raise ValueError("Structured output is not currently supported for AzureAIChatCompletionClient")
if isinstance(json_output, type) and issubclass(json_output, BaseModel):
if self.model_info["structured_output"] is False:
raise ValueError("Model does not support structured output.")
# Use the JsonSchemaFormat for structured output via the Azure AI Inference SDK.
schema = json_output.model_json_schema()
if "response_format" in create_args:
# Remove any existing response_format to avoid conflicts.
del create_args["response_format"]
create_args["response_format"] = JsonSchemaFormat(
name=schema.get("title", "response_format"),
schema=schema,
strict=True,
)

if json_output is True and "response_format" not in create_args:
create_args["response_format"] = "json_object"
Expand Down