Uses of Package
ai.nightfall.scan.model

Packages that use ai.nightfall.scan.model

Package	Description
ai.nightfall.scan
ai.nightfall.scan.model

Classes in ai.nightfall.scan.model used by ai.nightfall.scan

Class and Description
ScanFileRequest A container for a request to scan a file that was uploaded via the Nightfall API.
ScanFileResponse The object returned by the Nightfall API when an (asynchronous) file scan request was successfully triggered.
ScanTextRequest An object representing a request to scan inline plaintext with the Nightfall API.
ScanTextResponse The response object returned by a text scan request.

Classes in ai.nightfall.scan.model used by ai.nightfall.scan.model

Class and Description
BaseNightfallException The super class for all exceptions thrown by Nightfall.
Confidence Confidence describes the certainty that a piece of content matches a detector.
ConfidenceAdjustment Describes how to adjust confidence on a given finding.
ContextRule An object that describes how a regular expression may be used to adjust the confidence of a candidate finding.
DetectionRule An object that contains a set of detectors to be used when scanning content.
Detector An object that represents a data type or category of information.
DetectorMetadata A container for minimal information representing a detector.
ExclusionRule An object that describes a regular expression or list of keywords that may be used to disqualify a candidate finding from triggering a detector match.
Finding An object representing an occurrence of a configured detector (i.e.
Location An object representing where a finding was discovered in content.
Location.Range An object that contains references to the start and end of the eponymous range.
LogicalOp A modifier that is used to decide when a finding should be surfaced in the context of a detection rule.
NightfallErrorResponse The error model returned by Nightfall API requests that are unsuccessful.
Proximity An object representing a range of bytes to consider around a candidate finding.
Regex An object representing a regular expression to customize the behavior of a detector while Nightfall performs a scan.
ScanPolicy An object containing configuration that describes how to scan a file.
ScanTextConfig The configuration object to use when scanning inline plaintext with the Nightfall API.
WordList A list of words that can be used to customize the behavior of a detector while Nightfall performs a scan.