Interface GuardrailContext

Lightweight description of the conversational context for guardrail decisions.

Provides identity and session information to help guardrails make context-aware decisions (e.g., different policies per user tier).

Example

const context: GuardrailContext = {
  userId: 'user-123',
  sessionId: 'session-abc',
  personaId: 'support-agent',
  metadata: { userTier: 'premium', region: 'EU' }
};
interface GuardrailContext {
    userId: string;
    sessionId: string;
    personaId?: string;
    conversationId?: string;
    mode?: string;
    metadata?: Record<string, unknown>;
}

Properties

userId sessionId personaId? conversationId? mode? metadata?

Properties

userId

userId: string

Unique identifier for the user making the request

sessionId

sessionId: string

Current session identifier

Optional personaId

personaId?: string

Active persona/agent identity (if applicable)

Optional conversationId

conversationId?: string

Conversation thread identifier

Optional mode

mode?: string

Operating mode (e.g., 'debug', 'production')

Optional metadata

metadata?: Record<string, unknown>

Additional context for guardrail evaluation

Settings

Member Visibility

Theme

On This Page

userIdsessionIdpersonaIdconversationIdmodemetadata