Skip to content

Add structured outputs to Ask Mode #95

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
dannyjameswilliams merged 7 commits into from
Jul 7, 2026
Merged

Add structured outputs to Ask Mode #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d83398a
feat: added parsing of structured outputs
dannyjameswilliams Jun 17, 2026
97d467a
output_format can be dict, updated parse_ask_result, typing of final …
dannyjameswilliams Jun 18, 2026
38269e8
overload city
dannyjameswilliams Jun 19, 2026
7c4de2c
change default from str to None
dannyjameswilliams Jun 19, 2026
444e22c
Merge branch 'main' into feat/structured_output
dannyjameswilliams Jun 22, 2026
20be91e
refactor: move parse_ask_response to inside parse_sse
dannyjameswilliams Jun 23, 2026
fa5a87e
Merge branch 'feat/structured_output' of https://github.com/weaviate/…
dannyjameswilliams Jun 23, 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: 2 additions & 0 deletions weaviate_agents/query/classes/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
IsNullPropertyFilter,
ModelUnitUsage,
NumericMetrics,
ParsedAskModeResponse,
ProgressDetails,
ProgressMessage,
QueryAgentResponse,
Expand Down Expand Up @@ -79,6 +80,7 @@
"GeoPropertyFilter",
"UnknownPropertyAggregation",
"UnknownPropertyFilter",
"ParsedAskModeResponse",
"ProgressDetails",
"ProgressMessage",
"QueryWithCollection",
Expand Down
9 changes: 8 additions & 1 deletion weaviate_agents/query/classes/response.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
)
from uuid import UUID

from pydantic import BaseModel, ConfigDict, Field, field_validator
from pydantic import BaseModel, ConfigDict, Field, SerializeAsAny, field_validator
from typing_extensions import TypedDict
from weaviate.outputs.query import QueryReturn

Expand Down Expand Up @@ -479,6 +479,13 @@ def display(self) -> None:
return None


T = TypeVar("T", bound=Union[dict, BaseModel])


class ParsedAskModeResponse(AskModeResponse, Generic[T]):
final_answer_parsed: SerializeAsAny[T]

@CShorten CShorten Jun 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dannyjameswilliams can you help me understand this?

You say the bound of the type is a dict or any BaseModel? What does that do?

@dannyjameswilliams dannyjameswilliams Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late response. The bound lets a users own model flow through with their own fields intact, rather than just being a generic BaseModel/dict

So if the user inputs a basemodel, e.g.

class MyResponse(BaseModel):
    my_answer: str
    used_sources: list[UUID]
    
res = qa.ask(..., output_format=MyResponse)

then type checkers know to expect those fields in the response, so doing e.g.

res.final_answer_parsed.my_answer
res.final_answer_parsed.used_sources[0]

will be recognised as their respective types and so on.

@CShorten CShorten Jul 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah got it! Thanks so much! 🧠



class ResearchModeResponse(BaseModel):
output_type: Literal["final_state"] = "final_state"

Expand Down
Loading
Loading