Skip to content

fix: AzureOpenAIChatGenerator.to_dict() crashes when response_format is a plain dict #12407

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

Merged
sjrl merged 3 commits into from
Aug 20, 2026
+20 −2
Merged

fix: AzureOpenAIChatGenerator.to_dict() crashes when response_format is a plain dict #12407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
234987a
fix: fix AzureOpenAIChatGenerator.to_dict when response_format is a dict
rautaditya2606 Aug 19, 2026
45980f8
fix(releasenotes): use double backticks for inline code
rautaditya2606 Aug 19, 2026
8f0db66
Apply suggestion from @sjrl
sjrl Aug 20, 2026
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
2 changes: 1 addition & 1 deletion haystack/components/generators/chat/azure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ def to_dict(self) -> dict[str, Any]:
# If it's already a json schema, it's left as is
generation_kwargs = self.generation_kwargs.copy()
response_format = generation_kwargs.get("response_format")
if response_format and issubclass(response_format, BaseModel):
if response_format and isinstance(response_format, type) and issubclass(response_format, BaseModel):
json_schema = {
"type": "json_schema",
"json_schema": {
Expand Down
4 changes: 4 additions & 0 deletions releasenotes/notes/fix-azure-chat-generator-to-dict-response-format-1b844d5eaadcbd81.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
fixes:
- |
Fix crash in ``AzureOpenAIChatGenerator.to_dict()`` when ``response_format`` is passed as a dictionary.
16 changes: 15 additions & 1 deletion test/components/generators/chat/test_azure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,8 +335,22 @@ def test_to_dict_with_parameters(self, monkeypatch: pytest.MonkeyPatch, calendar
},
}

def test_from_dict(self, monkeypatch: pytest.MonkeyPatch) -> None:
@pytest.mark.parametrize(
"rf",
[
{"type": "json_object"},
{"type": "json_schema", "json_schema": {"name": "MySchema", "strict": True, "schema": {}}},
],
)
def test_to_dict_with_dict_response_format(self, monkeypatch: pytest.MonkeyPatch, rf: dict[str, Any]) -> None:
monkeypatch.setenv("AZURE_OPENAI_API_KEY", "test-api-key")
component = AzureOpenAIChatGenerator(
azure_endpoint="some-non-existing-endpoint", generation_kwargs={"response_format": rf}
)
data = component.to_dict()
assert data["init_parameters"]["generation_kwargs"]["response_format"] == rf

def test_from_dict(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("AZURE_OPENAI_API_KEY", "test-api-key")
monkeypatch.setenv("AZURE_OPENAI_AD_TOKEN", "test-ad-token")
data = {
Expand Down
Loading