Class AIGuardEvaluateAttributesResponse

The evaluation result with the recommended action and detected threat information.

Hierarchy

  • AIGuardEvaluateAttributesResponse

Constructors

Properties

The recommended action for the evaluated conversation.

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
globalProb?: number

The global threat probability, between 0 and 1. Included only when computed.

isBlockingEnabled: boolean

Whether blocking is enabled for the organization.

reason: string

The explanation for the recommended action, for logging rather than user-facing display.

redactionReplacements?: AIGuardRedactionReplacement[]

The redacted replacements computed for the request. Included only when redaction applies.

scfwFindings?: AIGuardScfwFindings

The Supply Chain Firewall verdict for the version-pinned install packages found in the request. Evaluation requires Supply Chain Firewall to be enabled for the organization and the caller to have the appsec_vm_read permission. Without that permission, Supply Chain Firewall evaluation is skipped; the AI Guard evaluation request itself is not rejected. Findings are omitted when Supply Chain Firewall does not produce a result. The recommended action combines the package outcomes. Confirmation support is inferred from the evaluator profile, not from a separate confirmation-capability flag. By default, a non-empty meta.coding_agent selects the coding-agent profile, which assumes the caller can ask for confirmation and retains WARN in recommended_action. Omitting meta.coding_agent or setting it to an empty string selects the default profile, which assumes the caller cannot ask for confirmation and returns ALLOW instead of WARN in recommended_action. Package outcomes still retain WARN, and BLOCK is never changed to ALLOW by this rule.

sdsFindings?: AIGuardSdsFinding[]

The sensitive data findings from the Sensitive Data Scanner. Included only when findings exist.

tagProbs: null | {
    [key: string]: number;
}

The detection confidence for each threat tag, between 0 and 1. May be null when the evaluation does not produce per-category scores.

tags: string[]

The threat tags detected in the conversation.

Generated using TypeDoc