"""Save a search as a portable report for reviewing retrieved evidence."""
from datetime import UTC, datetime
from html import escape
from pathlib import Path
from shutil import copyfile
from visual_doc_rag.data import write_json
def export_search(
query: str,
method: str,
source: dict,
results: list[dict],
corpus,
*,
answer: dict | None = None,
) -> Path:
created = datetime.now(UTC)
root = Path("runs/search") / created.strftime("%Y%m%dT%H%M%S.%fZ")
(root / "images").mkdir(parents=True, exist_ok=False)
selected = {page["corpus_id"] for page in results}
markdown = {
row["corpus_id"]: row["markdown"] or ""
for row in corpus.remove_columns("image")
if row["corpus_id"] in selected
}
pages, sections = [], []
for page in results:
image = f"images/{page['corpus_id']}.png"
copyfile(page["image_path"], root / image)
text = markdown[page["corpus_id"]]
pages.append({**page, "image_path": image, "markdown": text})
cited = answer is not None and page["corpus_id"] in answer["cited_pages"]
sections.append(
f" Cited by the answer Document: {escape(page['source_file_name'])} Source URL: {escape(page['source_url'])}#{page['rank']} · Page ID {page['corpus_id']}
"
+ ("
"
f"Page in document: {page['page_number_in_doc']}
"
f"License: {escape(page['license'])}
{escape(answer['answer'])}"
f"Abstain: {answer['abstain']} · Cited page IDs: {escape(str(answer['cited_pages']))}
"
f"Model: {escape(answer['model'])} · Cached: {answer['cached']}
Answer quality has not been evaluated. Check the cited images.
" if answer else "Retrieved evidence and supplied dataset text. No generated answer or relevance " "judgment is included.
" ) report.write_text( '' '' "Query: {escape(query)}
" f"Method: {escape(method)} · Returned pages: {len(results)}
"
f"Dataset: {escape(source['repo_id'])} · Revision: {escape(source['revision'])}
"
f"Created: {created.isoformat()}
Compare each image with the query; supplied text can differ from the image.
" + "".join(sections) + "\n", encoding="utf-8", ) return report