RestorationResult#

class scikitplot.cleanprompt.RestorationResult(text, restored, unknown=(), unused=(), repaired=())[source]#

Output of a restoration pass.

Parameters:
textstr

The text with placeholders replaced by their original values.

restoredtuple of str

Labels that were found and replaced, in first-appearance order.

unknowntuple of str

Labels that matched the placeholder grammar but were not in the vault. Empty unless restoration ran in non-strict mode.

unusedtuple of str

Vault labels that did not appear in the text.

repairedtuple of tuple of str

(as the reply spelled it, the label it was taken to mean) for every placeholder that had to be matched leniently, in first-appearance order. Empty when the reply came back with its labels intact.

Parameters:

Notes

User notes. A non-empty unknown means the reply referred to a placeholder this vault never issued; the model may have invented it. A non-empty unused is normal: a summary need not mention every entity.

repaired is worth reading. It lists the places where the model rewrote a placeholder and restoration matched it anyway — [EMAIL_1] taken to mean [EMAIL-1]. The substitution happened, and the entry says so rather than leaving you to notice.

property complete: bool#

True when every placeholder found was resolved.

Type:

bool

repaired: tuple[tuple[str, str], ...] = ()#
restored: tuple[str, ...][source]#
text: str[source]#
unknown: tuple[str, ...] = ()#
unused: tuple[str, ...] = ()#