Interface: PhraseListGuardrailOptions

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:71

How a phrase-list guard is built: its id, its list, the judge behind onMatch: 'judge', the stages it runs on, the replacement a block carries.

Properties

id

id: string

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:72

---

judge?

optional judge: PhraseJudge

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:75

Required when any entry is judge.

---

judgeThreshold?

optional judgeThreshold: number

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:77

A judge's block counts only at or above this confidence; a lower one blocks all the same (fail closed). Default 0.7.

---

replacementText?

optional replacementText: string

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:81

The reply a block is answered with when no rule's own replacement applies.

---

source

source: PhraseListSource

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:73

---

stages?

optional stages: ("output" | "input")[]

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:79

The stages the guard evaluates. Default both.

---

timeoutMs?

optional timeoutMs: number

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:85

The deadline for one evaluation, judge included. Default 8 seconds.

Methods

normalize()?

optional normalize(text): string

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:87

Replaces the built-in normalisation.

Parameters

text

string

Returns

string

---

replacementFor()?

optional replacementFor(ruleId): string | undefined

Defined in: packages/agentos/src/safety/guardrails/builtin/PhraseListGuardrail.ts:83

The reply for a rule's block.

Parameters

ruleId

string

Returns

string | undefined