Class SensitiveContentFinding

Namespace

MailFathom.Application.SensitiveContent.Detection

Assembly

MailFathom.Application.dll

One region of analyzed text a scanner reported as sensitive.

public sealed record SensitiveContentFinding : IEquatable<SensitiveContentFinding>

Inheritance

object

SensitiveContentFinding

Implements

IEquatable<SensitiveContentFinding>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A finding never carries the detected value. It names the rule that matched and the kind of material that rule looks for, where it sits, how sure the detector was, and what produced it — everything a consumer needs in order to redact, to count, and to attribute, and nothing that would recreate the leak in a log line, an audit record, or a stored attribution.

The detector and its revision travel with the finding rather than being read from the deployment, because redaction is only reproducible against a stated corpus: the same text under a newer rule set is a different result, and a consumer that stored one has to be able to say which one it stored.

Properties

Category

Gets the kind of sensitive material found, which is what the placeholder replacing it names.

Confidence

Gets how sure the detector was, from 0 to 1 inclusive.

DetectedAt

Gets when the scan that produced the finding evaluated the text.

Detector

Gets what produced the finding, and the corpus or profile revision it ran under.

Rule

Gets the corpus entry that matched, which is the name a suppression would silence.

Span

Gets the region of the analyzed text the finding covers.

Methods

Create(SensitiveContentRule, SensitiveContentSpan, double, SensitiveContentDetector, DateTimeOffset)

Creates a finding.