Package ai.nightfall.scan.model

package ai.nightfall.scan.model
  • Class
    Description
    BaseNightfallException
    The super class for all exceptions thrown by Nightfall.
    CompleteFileUploadRequest
    The container object containing all parameters required to complete a file upload.
    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.
    FileScanWebhookNotification
    The request payload that is sent by Nightfall to a client-configured webhook URL to report the findings from an asynchronous file scan.
    FileUpload
    An object representing a file upload.
    Finding
    An object representing an occurrence of a configured detector (i.e.
    InitializeFileUploadRequest
    An object representing a request to upload a new file to Nightfall.
    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.
    NightfallAPIException
    The exception thrown when the Nightfall API returns an HTTP status code in the range [400, 599].
    NightfallClientException
    The exception thrown when the Nightfall client is unable to process a request due to an unexpected error.
    NightfallErrorResponse
    The error model returned by Nightfall API requests that are unsuccessful.
    NightfallRequestTimeoutException
    An exception that indicates that a timeout was exceeded while processing a request.
    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.
    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.
    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.
    ScanTextRequest
    An object representing a request to scan inline plaintext with the Nightfall API.
    ScanTextResponse
    The response object returned by a text scan request.
    UploadFileChunkRequest
    An object representing a request to upload a chunk of file data to the Nightfall API.
    WordList
    A list of words that can be used to customize the behavior of a detector while Nightfall performs a scan.