Skip to content

Report

from rag_audit.report.models import AuditReport
from rag_audit.report.renderer import ReportRenderer

AuditReport

Pydantic model produced by AuditRunner.run().

Field Type Description
pipeline_id str Pipeline identifier
faithfulness FaithfulnessResult Hallucination detection result
retrieval RetrievalResult Retrieval metrics result

ReportRenderer

Serializes an AuditReport to JSON or Markdown.

renderer = ReportRenderer()

# Markdown
md: str = renderer.to_markdown(report)

# JSON
json_str: str = renderer.to_json(report)