GuardrailFinding interface

Package:

@microsoft/opentelemetry

Represents a single security finding detected during guardian evaluation. Multiple findings may be emitted for a single guardrail span.

Properties

policyDecisionType	The decision type for this specific policy finding.
policyId	Identifier of the policy that triggered the finding.
policyName	Human-readable name of the triggered policy.
policyVersion	Version of the policy.
riskCategory	The category of security risk detected (required).
riskMetadata	Non-content metadata about the detected risk (MUST NOT contain PII). Example values: "field:bcc", "pattern:ssn", "count:3".
riskScore	Numeric risk/confidence score (0.0 to 1.0).
riskSeverity	The severity level of the detected risk (required).

Property Details

policyDecisionType

The decision type for this specific policy finding.

policyDecisionType?: string

Property Value

string

policyId

Identifier of the policy that triggered the finding.

policyId?: string

Property Value

string

policyName

Human-readable name of the triggered policy.

policyName?: string

Property Value

string

policyVersion

Version of the policy.

policyVersion?: string

Property Value

string

riskCategory

The category of security risk detected (required).

riskCategory: string

Property Value

string

riskMetadata

Non-content metadata about the detected risk (MUST NOT contain PII). Example values: "field:bcc", "pattern:ssn", "count:3".

riskMetadata?: string[]

Property Value

string[]

riskScore

Numeric risk/confidence score (0.0 to 1.0).

riskScore?: number

Property Value

number

riskSeverity

The severity level of the detected risk (required).

riskSeverity: string

Property Value

string