"""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"

#{page['rank']} · Page ID {page['corpus_id']}

" + ("

Cited by the answer

" if cited else "") + f"

Document: {escape(page['source_file_name'])}
" f"Page in document: {page['page_number_in_doc']}
" f"License: {escape(page['license'])}

" f"

Source URL: {escape(page['source_url'])}

" f'
' f"

Supplied page text

"
            f"{escape(text or '(No supplied markdown for this page.)')}
" "
" ) write_json( root / "results.json", { "query": query, "method": method, "created_at": created.isoformat(), "dataset": source, "pages": pages, **( {"generated_answer": {k: v for k, v in answer.items() if k != "pages"}} if answer else {} ), }, ) report = root / "report.html" answer_html = ( "

Generated answer

" f"
{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( '' '' "Retrieval report

Retrieval report

" f"

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()}

" + answer_html + "

Compare each image with the query; supplied text can differ from the image.

" + "".join(sections) + "\n", encoding="utf-8", ) return report