Skip to content

docstring fixes to final_answer_parsed for structured outputs #98

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 2 commits into from
Jul 27, 2026
Merged

docstring fixes to final_answer_parsed for structured outputs #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
275323a
docstring fixes to final_answer_parsed
dannyjameswilliams Jul 27, 2026
f0c4f99
bump version to 1.7.1
dannyjameswilliams Jul 27, 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 pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "weaviate-agents"
version = "1.7.0"
version = "1.7.1"
description = "The official sub-package for the Weaviate Agents project."
readme = "README.md"
requires-python = ">=3.9"
Expand Down
34 changes: 15 additions & 19 deletions weaviate_agents/query/query_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -822,13 +822,13 @@ def ask(
output_format: The structured output format to return. Either `None` (default, no structured output), a `BaseModel` subclass, or a dictionary.
This enforces the output format of the final answer to be of this schema.
The LLM will conform to the output format specified.
The `final_answer` output field in the response will also be of the type specified.
The `final_answer_parsed` output field in the response will also be of the type specified.
When passing a `dict`, the dictionary must conform to the Draft 2020-12 JSON Schema specification.
Defaults to `str`.

Returns:
An instance of :class:`~weaviate_agents.query.classes.response.AskModeResponse` which contains the final answer, sources,
and other metadata such as the searches performed, usage and total time.
An instance of :class:`~weaviate_agents.query.classes.response.AskModeResponse` (or [:class:`~weaviate_agents.query.classes.response.ParsedAskModeResponse`]
if ``output_format`` is not ``None``) which contains the final answer, sources, and other metadata such as the searches performed, usage and total time.

Examples:
>>> from weaviate_agents import QueryAgent
Expand All @@ -853,7 +853,7 @@ def ask(
... collections=["FinancialContracts"],
... )
>>> result = agent.ask("What contracts were signed by Jane Doe in 2024? What were they about?", output_format=AnswerWithSources)
>>> print(type(result.final_answer))
>>> print(type(result.final_answer_parsed))
<class 'AnswerWithSources'>
"""
request_body = self._prepare_request_body(
Expand Down Expand Up @@ -1131,20 +1131,18 @@ def ask_stream(
output_format: The structured output format to return. Either `None` (default, no structured output), a `BaseModel` subclass, or a dictionary.
This enforces the output format of the final answer to be of this schema.
The LLM will conform to the output format specified.
The `final_answer` output field in the response will also be of the type specified.
The `final_answer_parsed` output field in the response will also be of the type specified.
When passing a `dict`, the dictionary must conform to the Draft 2020-12 JSON Schema specification.
Whilst streaming, the :class:`~weaviate_agents.query.classes.response.StreamedTokens` will return delta text
tokens on the final answer as it is being constructed as raw string tokens, not a JSON object.
When the final answer is complete, the :class:`~weaviate_agents.query.classes.response.AskModeResponse` will be parsed
and the `final_answer` field will be of the type specified.
Defaults to `str`.
When the final answer is complete, the :class:`~weaviate_agents.query.classes.response.ParsedAskModeResponse` will be returned if ``include_final_state`` is ``True``.

Returns:
A generator of the response stream.
The generator will yield the following types:

- [:class:`~weaviate_agents.query.classes.response.ProgressMessage`]: Informational messages about the progress of the agent's search (if ``include_progress`` is ``True``).
- [:class:`~weaviate_agents.query.classes.response.AskModeResponse`]: The final response class that will be the last item in the stream (if ``include_final_state`` is ``True``).
- [:class:`~weaviate_agents.query.classes.response.AskModeResponse`] (or [:class:`~weaviate_agents.query.classes.response.ParsedAskModeResponse`] if ``output_format`` is not ``None``): The final response class that will be the last item in the stream (if ``include_final_state`` is ``True``).
- [:class:`~weaviate_agents.query.classes.response.StreamedTokens`]: Token deltas from the agent's response.

Examples:
Expand Down Expand Up @@ -1180,7 +1178,7 @@ def ask_stream(
... "What contracts were signed by Jane Doe in 2024? What were they about?",
... output_format=AnswerWithSources
... ):
... if isinstance(result, AskModeResponse):
... if isinstance(result, AskModeResponse): # this will also find ParsedAskModeResponse
... result.display()
... elif isinstance(result, StreamedTokens):
... print(result.delta, end='', flush=True)
Expand Down Expand Up @@ -1673,12 +1671,12 @@ async def ask(
output_format: The structured output format to return. Either `None` (default, no structured output), a `BaseModel` subclass, or a dictionary.
This enforces the output format of the final answer to be of this schema.
The LLM will conform to the output format specified.
The `final_answer` output field in the response will also be of the type specified.
The `final_answer_parsed` output field in the response will also be of the type specified.
When passing a `dict`, the dictionary must conform to the Draft 2020-12 JSON Schema specification.
Defaults to `str`.

Returns:
An instance of :class:`~weaviate_agents.query.classes.response.AskModeResponse` which contains the final answer, sources,
An instance of :class:`~weaviate_agents.query.classes.response.AskModeResponse` (or [:class:`~weaviate_agents.query.classes.response.ParsedAskModeResponse`] if ``output_format`` is not ``None``) which contains the final answer, sources,
and other metadata such as the searches performed, usage and total time.

Examples:
Expand All @@ -1704,7 +1702,7 @@ async def ask(
... collections=["FinancialContracts"],
... )
>>> result = await agent.ask("What contracts were signed by Jane Doe in 2024? What were they about?", output_format=AnswerWithSources)
>>> print(type(result.final_answer))
>>> print(type(result.final_answer_parsed))
<class 'AnswerWithSources'>
"""
request_body = self._prepare_request_body(
Expand Down Expand Up @@ -1986,20 +1984,18 @@ async def ask_stream(
output_format: The structured output format to return. Either `None` (default, no structured output), a `BaseModel` subclass, or a dictionary.
This enforces the output format of the final answer to be of this schema.
The LLM will conform to the output format specified.
The `final_answer` output field in the response will also be of the type specified.
The `final_answer_parsed` output field in the response will also be of the type specified.
When passing a `dict`, the dictionary must conform to the Draft 2020-12 JSON Schema specification.
Whilst streaming, the :class:`~weaviate_agents.query.classes.response.StreamedTokens` will return delta text
tokens on the final answer as it is being constructed as raw string tokens, not a JSON object.
When the final answer is complete, the :class:`~weaviate_agents.query.classes.response.AskModeResponse` will be parsed
and the `final_answer` field will be of the type specified.
Defaults to `str`.
When the final answer is complete, the :class:`~weaviate_agents.query.classes.response.ParsedAskModeResponse` will be returned if ``include_final_state`` is ``True``.

Returns:
A generator of the response stream.
The generator will yield the following types:

- [:class:`~weaviate_agents.query.classes.response.ProgressMessage`]: Informational messages about the progress of the agent's search (if ``include_progress`` is ``True``).
- [:class:`~weaviate_agents.query.classes.response.AskModeResponse`]: The final response class that will be the last item in the stream (if ``include_final_state`` is ``True``).
- [:class:`~weaviate_agents.query.classes.response.AskModeResponse`] (or [:class:`~weaviate_agents.query.classes.response.ParsedAskModeResponse`] if ``output_format`` is not ``None``): The final response class that will be the last item in the stream (if ``include_final_state`` is ``True``).
- [:class:`~weaviate_agents.query.classes.response.StreamedTokens`]: Token deltas from the agent's response.

Examples:
Expand Down Expand Up @@ -2035,7 +2031,7 @@ async def ask_stream(
... "What contracts were signed by Jane Doe in 2024? What were they about?",
... output_format=AnswerWithSources
... ):
... if isinstance(result, AskModeResponse):
... if isinstance(result, AskModeResponse): # this will also find ParsedAskModeResponse
... result.display()
... elif isinstance(result, StreamedTokens):
... print(result.delta, end='', flush=True)
Expand Down
Loading