Class SemanticGuardrails

Index

Constructors

Methods

addBoundary addSteeringRule addToneRule addTopicRule check checkTurn getEnabledRuleCount getRules removeRule setRuleEnabled

Constructors

constructor

new SemanticGuardrails(config?: Partial<GuardrailConfig>): SemanticGuardrails
Parameters
- Optionalconfig: Partial<GuardrailConfig>
Returns SemanticGuardrails
- Defined in src/enforce/semanticGuardrails.ts:223

Methods

addBoundary

addBoundary(boundary: Omit<ContentBoundary, "id">): ContentBoundary
Add a content boundary
Parameters
- boundary: Omit<ContentBoundary, "id">
Returns ContentBoundary
- Defined in src/enforce/semanticGuardrails.ts:434

addSteeringRule

addSteeringRule(rule: Omit<SteeringRule, "id">): SteeringRule
Add a steering rule
Parameters
- rule: Omit<SteeringRule, "id">
Returns SteeringRule
- Defined in src/enforce/semanticGuardrails.ts:441

addToneRule

addToneRule(rule: Omit<ToneRule, "id">): ToneRule
Add a custom tone rule
Parameters
- rule: Omit<ToneRule, "id">
Returns ToneRule
- Defined in src/enforce/semanticGuardrails.ts:427

addTopicRule

addTopicRule(rule: Omit<TopicRule, "id">): TopicRule
Add a custom topic rule
Parameters
- rule: Omit<TopicRule, "id">
Returns TopicRule
- Defined in src/enforce/semanticGuardrails.ts:420

check

check(content: string): GuardrailResult
Check content (input or output) against all guardrails
Parameters
- content: string
Returns GuardrailResult
- Defined in src/enforce/semanticGuardrails.ts:236

checkTurn

checkTurn(
    input: string,
    output: string,
): {
    action: "pass" | GuardrailAction;
    inputResult: GuardrailResult;
    outputResult: GuardrailResult;
    overallPassed: boolean;
}
Check both input and output for a complete turn
Parameters
- input: string
- output: string
Returns {
    action: "pass" | GuardrailAction;
    inputResult: GuardrailResult;
    outputResult: GuardrailResult;
    overallPassed: boolean;
}
- Defined in src/enforce/semanticGuardrails.ts:375

getEnabledRuleCount

getEnabledRuleCount(): number
Get all enabled rules count

Returns number
- Defined in src/enforce/semanticGuardrails.ts:496

getRules

getRules(): {
    boundaries: ContentBoundary[];
    steeringRules: SteeringRule[];
    toneRules: ToneRule[];
    topicRules: TopicRule[];
}
Get all rules

Returns {
    boundaries: ContentBoundary[];
    steeringRules: SteeringRule[];
    toneRules: ToneRule[];
    topicRules: TopicRule[];
}
- Defined in src/enforce/semanticGuardrails.ts:481

removeRule

removeRule(ruleId: string): boolean
Remove a rule by ID
Parameters
- ruleId: string
Returns boolean
- Defined in src/enforce/semanticGuardrails.ts:465

setRuleEnabled

setRuleEnabled(ruleId: string, enabled: boolean): boolean
Enable/disable a rule by ID
Parameters
- ruleId: string
- enabled: boolean
Returns boolean
- Defined in src/enforce/semanticGuardrails.ts:448