ai.nightfall.scan.model

Class ScanTextResponse

java.lang.Object

ai.nightfall.scan.model.ScanTextResponse

public class ScanTextResponse
extends Object

The response object returned by a text scan request. Each index i in the field findings corresponds one-to-one with the input request payload, so all findings stored in a given sub-list refer to matches that occurred in the ith index of the request payload.

Constructor Summary

Constructors

Constructor and Description
ScanTextResponse()

Method Summary

Modifier and Type	Method and Description
List<List<Finding>>	getFindings() Get the findings.
List<String>	getRedactedPayload() Return the original request content with the configured redactions applied.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScanTextResponse

public ScanTextResponse()

Method Detail

getFindings

public List<List<Finding>> getFindings()

Get the findings.

Returns:

the findings

getRedactedPayload

public List<String> getRedactedPayload()

Return the original request content with the configured redactions applied. If redaction was not applied for a given input string, the string at a given index in the array will be empty.

Returns:

the original content with the configured redactions applied

toString

public String toString()

Overrides:

toString in class Object