GuardrailDetails interface

Package:

@microsoft/opentelemetry

Details of a guardrail evaluation for security operations tracing.

Properties

contentInputHash	Hash of the input content for forensic correlation.
contentModified	Whether content was modified by the guardrail.
decisionCode	Machine-readable decision code.
decisionReason	Human-readable explanation for the decision.
decisionType	The decision made by the guardian (required).
externalEventId	External correlation identifier for SIEM systems.
guardianId	Unique identifier of the guardian.
guardianName	Human-readable name of the guardian.
guardianProviderName	Provider of the guardian service (e.g., azure.ai.content_safety).
guardianVersion	Version of the guardian.
policyId	Identifier of the policy that triggered the decision.
policyName	Human-readable name of the policy.
policyVersion	Version of the policy.
targetId	Identifier of the target being guarded.
targetType	The type of content or action the guardrail is applied to (required).

Property Details

contentInputHash

Hash of the input content for forensic correlation.

contentInputHash?: string

Property Value

string

contentModified

Whether content was modified by the guardrail.

contentModified?: boolean

Property Value

boolean

decisionCode

Machine-readable decision code.

decisionCode?: string

Property Value

string

decisionReason

Human-readable explanation for the decision.

decisionReason?: string

Property Value

string

decisionType

The decision made by the guardian (required).

decisionType: GuardrailDecisionType

Property Value

GuardrailDecisionType

externalEventId

External correlation identifier for SIEM systems.

externalEventId?: string

Property Value

string

guardianId

Unique identifier of the guardian.

guardianId?: string

Property Value

string

guardianName

Human-readable name of the guardian.

guardianName?: string

Property Value

string

guardianProviderName

Provider of the guardian service (e.g., azure.ai.content_safety).

guardianProviderName?: string

Property Value

string

guardianVersion

Version of the guardian.

guardianVersion?: string

Property Value

string

policyId

Identifier of the policy that triggered the decision.

policyId?: string

Property Value

string

policyName

Human-readable name of the policy.

policyName?: string

Property Value

string

policyVersion

Version of the policy.

policyVersion?: string

Property Value

string

targetId

Identifier of the target being guarded.

targetId?: string

Property Value

string

targetType

The type of content or action the guardrail is applied to (required).

targetType: string

Property Value

string