Skip to content

Add response_schema parameter to Docs's aquery response generation #1202

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −0
Open

Add response_schema parameter to Docs's aquery response generation #1202

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
2 changes: 2 additions & 0 deletions src/paperqa/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -780,6 +780,7 @@ async def aquery(
summary_llm_model: LLMModel | None = None,
embedding_model: EmbeddingModel | None = None,
partitioning_fn: Callable[[Embeddable], int] | None = None,
response_schema: BaseModel | None = None,
Copy link
Collaborator

@jamesbraza jamesbraza Nov 14, 2025

Choose a reason for hiding this comment

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

I think this should be output_type: type[BaseModel] | TypeAdapter | JSONSchema | None = None, are you sure it works?

Can you add or expand a unit test in tests/test_paperqa.py confirming this?

) -> PQASession:
query_settings = get_settings(settings)
answer_config = query_settings.answer
Expand Down Expand Up @@ -862,6 +863,7 @@ async def aquery(
messages=messages,
callbacks=callbacks,
name="answer",
response_format=response_schema,
)
answer_text = cast("str", answer_result.text)
answer_reasoning = answer_result.reasoning_content
Expand Down
Loading