Skip to content

Fixing used_images usage in summary_json_system_prompt#1109

Merged
jamesbraza merged 2 commits intomainfrom
multimodal-fixes
Sep 26, 2025
Merged

Fixing used_images usage in summary_json_system_prompt#1109
jamesbraza merged 2 commits intomainfrom
multimodal-fixes

Conversation

@jamesbraza
Copy link
Copy Markdown
Collaborator

There were two problems being fixed here:

  • The JSON sample key "used_images" didn't have a value
  • "used_images" should only be present if you actually want to use this attribute, which most users won't care about

@jamesbraza jamesbraza self-assigned this Sep 26, 2025
@jamesbraza jamesbraza added the bug Something isn't working label Sep 26, 2025
Copilot AI review requested due to automatic review settings September 26, 2025 01:27
@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Sep 26, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Fixes two issues with the used_images attribute in the summary_json_system_prompt: corrects incomplete JSON sample and makes the attribute optional for users who don't need image tracking.

  • Separates standard and multimodal JSON prompts to handle used_images appropriately
  • Updates tests to use multimodal prompt and properly handle boolean conversion
  • Adds documentation for the optional multimodal prompt usage

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
src/paperqa/prompts.py Splits prompt into standard and multimodal versions, fixing JSON format
tests/test_paperqa.py Updates image tests to use multimodal prompt and fix boolean assertions
README.md Documents the optional multimodal prompt configuration

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@dosubot
Copy link
Copy Markdown

dosubot bot commented Sep 26, 2025

Related Documentation

1 document(s) may need updating based on files changed in this PR

How did I do? Any feedback?  Join Discord

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Sep 26, 2025
@jamesbraza jamesbraza merged commit 68af519 into main Sep 26, 2025
5 of 7 checks passed
@jamesbraza jamesbraza deleted the multimodal-fixes branch September 26, 2025 05:09
@dosubot
Copy link
Copy Markdown

dosubot bot commented Sep 26, 2025

Documentation Updates

Checked 1 published document(s). No updates required.

How did I do? Any feedback?  Join Discord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants