TrustInsights

operationCategory

get operationCategory(): InsightEvaluator_OperationCategory

var operationCategory: InsightEvaluator.OperationCategory

Type of operation that the evaluation is being requested for. Information based on this may be presented in the transparency log showing the usage of this system by each app

operationCategory

set operationCategory(value: InsightEvaluator_OperationCategory)

var operationCategory: InsightEvaluator.OperationCategory

Type of operation that the evaluation is being requested for. Information based on this may be presented in the transparency log showing the usage of this system by each app

requestID

get requestID(): (string) | null

var requestID: String?

Optionally provide a unique identifier to strongly tie the assessment to the transaction Recommended to use a server generated identifier and then to verifify that it is included in the evaluation result to have strong evidence that the result was produced in response to the particular request

requestID

set requestID(value: (string) | null)

var requestID: String?

Optionally provide a unique identifier to strongly tie the assessment to the transaction Recommended to use a server generated identifier and then to verifify that it is included in the evaluation result to have strong evidence that the result was produced in response to the particular request

modelVersion

get modelVersion(): InsightEvaluator_ModelVersion

let modelVersion: InsightEvaluator.ModelVersion

Model version requested

schemaVersion

get schemaVersion(): IsLikelyBeingCoachedInsight_SchemaVersion

var schemaVersion: InsightType.SchemaVersion

schemaVersion

set schemaVersion(value: IsLikelyBeingCoachedInsight_SchemaVersion)

var schemaVersion: InsightType.SchemaVersion

schemaVersionNumber

get schemaVersionNumber(): number

var schemaVersionNumber: Int { get }

Schema version requested

insightTypeIdentifier

get insightTypeIdentifier(): string

var insightTypeIdentifier: String { get }

The identifer for the type of insight requested

signedPayload

get signedPayload(): ArrayBuffer

final let signedPayload: Data

Full signed response in [CBOR](https://www.rfc-editor.org/rfc/rfc8152) format. This is intended for server side validation and processing. Details of the format can be found at: URLToBeDefined

additionalInfo

get additionalInfo(): Record<string, string>

final let additionalInfo: [String : String]

Server may provide additional information will be described on the documentation website

serverTimestamp

get serverTimestamp(): globalThis.Date

final let serverTimestamp: Date

Timestamp at which the server validated the result

reportConsumption

reportConsumptionInsightsUsed(status: InsightEvaluationConsumptionStatus, insightsUsed?: Array<SDKHandle>): void

final func reportConsumption(_ status: InsightEvaluationConsumptionStatus, insightsUsed: [any TrustInsight] = [])

Before releasing an ``InsightEvaluation`` this should be called on it to report how the results have been used. This may be presented in the transparency reporting and it also helps with model improvement. - Parameters: - status: Label indicating how the provided insights were consumed in the application context - insightsUsed: Optionally, the specific insights that were used in making the decision Failure to call report consumption before deinit of the InsightEvaluation may lead to fault logs, and will be reported as such; this may lead to rate-limiting the application.

reportConsumption

reportConsumptionInsightIDsUsed(status: InsightEvaluationConsumptionStatus, insightIDsUsed: Array<string>): void

final func reportConsumption(_ status: InsightEvaluationConsumptionStatus, insightIDsUsed: [String])

Before releasing an ``InsightEvaluation`` this should be called on it to report how the results have been used. This may be presented in the transparency reporting and it also helps with model improvement. - Parameters: - status: Label indicating how the provided insights were consumed in the application context - insightIDsUsed: Optionally, the insights IDs that were used in making the decision Failure to call report consumption before deinit of the InsightEvaluation may lead to fault logs, and will be reported as such; this may lead to rate-limiting the application.

generationTimestamp

get generationTimestamp(): globalThis.Date

final let generationTimestamp: Date

Timestamp at which the on device part of the assessment was created

eventID

get eventID(): string

final var eventID: String { get }

Identifier for this evaluation result that can be recorded with other transaction records so that in the event that fraud or abuse is later discovered associated with the transaction it can be reported to Apple as Offline feedback via Apple Business Register

requestID

get requestID(): (string) | null

final var requestID: String? { get }

App defined identifier provided as the ``InsightEvaluator/InsightContext/requestID`` in the ``InsightEvaluator/InsightContext`` for the evaluation request If provided in the context this will be non-nil and should match that included in the context for the request. Any mismatch would indicate that the payload should not be trusted and may have been injected by an attacker in some way. It can also be used by an app to link request or a wider app specific ID for the active operation.