Skip to content

fix: metadata and vuln_id handling in AVID report export #1495

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

Merged
merged 2 commits into from
Dec 2, 2025
Merged

fix: metadata and vuln_id handling in AVID report export #1495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8dc3c64
fix(report): Update metadata access and default value for vuln_id
saichandrapandraju Nov 21, 2025
01cbbf5
Add tests for `garak/report.py`
saichandrapandraju Nov 21, 2025
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
21 changes: 15 additions & 6 deletions garak/report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def get_evaluations(self):
for record in self.records:
if record["entry_type"] == "eval":
evals.append(record)
elif record["entry_type"] == "config":
elif record["entry_type"] == "start_run setup":
self.metadata = record
if len(evals) == 0:
raise ValueError("No evaluations to report 🤷")
Expand Down Expand Up @@ -92,11 +92,11 @@ def export(self): # TODO: add html format
if self.metadata is not None:
report_template.affects = ac.Affects(
developer=[],
deployer=[self.metadata["target_type"]],
deployer=[self.metadata["plugins.target_type"]],
artifacts=[
ac.Artifact(
type=ae.ArtifactTypeEnum.model,
name=self.metadata["target_name"],
name=self.metadata["plugins.target_name"],
)
],
)
Expand All @@ -113,12 +113,20 @@ def export(self): # TODO: add html format
# now build all the reports
all_reports = []
for probe in self.scores.index:
report = report_template.copy()
report = report_template.model_copy() # replaced copy() with model_copy() to avoid deprecation warning
probe_data = self.evaluations.query(f"probe=='{probe}'")

description_value = f"A model was evaluated by the Garak LLM Vulnerability scanner using the probe `{probe}`."
if self.metadata is not None:
target_type = self.metadata.get("plugins.target_type")
target_name = self.metadata.get("plugins.target_name")

if target_name and target_type:
description_value = f"The model {target_name} from {target_type} was evaluated by the Garak LLM Vulnerability scanner using the probe `{probe}`."

report.description = ac.LangValue(
lang="eng",
value=f"The model {self.metadata['target_name']} from {self.metadata['target_type']} was evaluated by the Garak LLM Vunerability scanner using the probe `{probe}`.",
value=description_value,
)
report.problemtype = ac.Problemtype(
classof=ae.ClassEnum.llm,
Expand All @@ -143,6 +151,7 @@ def export(self): # TODO: add html format
] # supports only avid taxonomy for now
report.impact = ac.Impact(
avid=ac.AvidTaxonomy(
vuln_id=None,
risk_domain=pd.Series([tag[1].title() for tag in tags_split])
.drop_duplicates()
.tolist(), # unique values
Expand All @@ -156,4 +165,4 @@ def export(self): # TODO: add html format
# save final output
self.write_location = self.report_location.replace(".report", ".avid")
with open(self.write_location, "w", encoding="utf-8") as f:
f.writelines(r.json() + "\n" for r in all_reports)
f.writelines(r.model_dump_json() + "\n" for r in all_reports) # replaced json() with model_dump_json() to avoid deprecation warning
Loading