Add structured outputs to Ask Mode#95
Merged
Merged
Conversation
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
danmichaeljones
approved these changes
Jun 24, 2026
CShorten
reviewed
Jun 26, 2026
|
|
||
|
|
||
| class ParsedAskModeResponse(AskModeResponse, Generic[T]): | ||
| final_answer_parsed: SerializeAsAny[T] |
Member
There was a problem hiding this comment.
@dannyjameswilliams can you help me understand this?
You say the bound of the type is a dict or any BaseModel? What does that do?
Contributor
Author
There was a problem hiding this comment.
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.
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
4 participants
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.
Related to PR #1000 on the backend
Adds
output_formatparameter to.ask()and.ask_stream()methods to support structured responses.