Quality report (set)
quality_report_setAudit a set of SVG documents in one call: generate per-document quality reports, aggregate scores, and a cross-doc consistency verdict for health and consistency checks.
Instructions
Quality-report a SET of documents in one call: per-doc reports + aggregate + verdict.
When to use: auditing a whole multi-document system (e.g. a 12-icon set) for health AND
cross-doc consistency in one read-only call. For a SINGLE document use quality_report; to
actually strip the opportunities across the set use optimize_set.
Key params: doc_ids is a non-empty, duplicate-free set. Read-only — composes the single-doc
quality_report engine over the set, so NO snapshot / Operation Record is written for any
document. The whole set is rejected if ANY id is unknown or unparseable (no partial result).
Return shape: QualityReportSetResult — per_doc (the standard QualityReport per document),
all_ok, worst_score / mean_score and total_opportunities aggregated across the set, and
consistency — the structured cross-doc verdict over the set's viewBox / stroke-width /
id-naming conventions (the cross-doc audit a 12-icon system used to need a Bash/lxml loop for).
Example: quality_report_set(["d1","d2","d3"])
Risk class: low (read-only; no document mutated, no Operation Record / snapshot).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doc_ids | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all_ok | Yes | ||
| per_doc | Yes | ||
| mean_score | Yes | ||
| consistency | Yes | Structured cross-document consistency audit over a set. One :class:`ConsistencyProperty` per audited property (``viewBox``, ``stroke_width``, ``id_naming``). ``consistent`` is True iff EVERY audited property agrees across the set. Not prose: an agent reads ``properties`` to see precisely which property disagrees and which ``doc_ids`` carry which value. | |
| worst_score | Yes | ||
| total_opportunities | Yes |