results

results

Classes:

Name	Description
AnonymizerResult	Result returned by full anonymization runs.
PreviewResult	Result returned by preview runs.

AnonymizerResult(dataframe, trace_dataframe, resolved_text_column, failed_records) dataclass

Bases: _DisplayMixin

Result returned by full anonymization runs.

Attributes:

Name	Type	Description
dataframe	DataFrame	User-facing columns only (text, replaced/rewritten text, scores).
trace_dataframe	DataFrame	Full pipeline trace including all internal columns.
resolved_text_column	str	Name of the user-facing text column. Equals the user's requested text_column unless the reader had to rename it to avoid colliding with an Anonymizer output column, in which case it is the post-rename identifier (e.g. "final_entities__input").
failed_records	list[FailedRecord]	Records that failed during pipeline processing.

PreviewResult(dataframe, trace_dataframe, resolved_text_column, failed_records, preview_num_records) dataclass

Bases: _DisplayMixin

Result returned by preview runs.

Attributes:

Name	Type	Description
dataframe	DataFrame	User-facing columns only (text, replaced/rewritten text, scores).
trace_dataframe	DataFrame	Full pipeline trace including all internal columns.
resolved_text_column	str	Name of the user-facing text column. Equals the user's requested text_column unless the reader had to rename it to avoid colliding with an Anonymizer output column, in which case it is the post-rename identifier (e.g. "final_entities__input").
failed_records	list[FailedRecord]	Records that failed during pipeline processing.
preview_num_records	int	Number of records requested for the preview.