Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Agentium 4.0.0 · Upgrade from 3.x.
Public pii guards signatures and configuration in @agentium/core 4.0.0.
@agentium/core. Read the pii guards guide for setup and behavior, or return to the package reference.
A ? marks an optional field. These are declarations for lookup; run the examples in the linked guide. Follow related-type links for Agentium types and source links for imported dependency types.
export declare class PiiGuard {
constructor(config: PiiGuardConfig);
scrub(text: string): string;
rehydrate(text: string): string;
scrubMessages(messages: ChatMessage[]): ChatMessage[];
getMapping(): ReadonlyMap<string, string>;
reset(): void;
/**
* Create an InputGuardrail that scrubs PII from user input.
* When action is "redact", the guardrail blocks and returns the scrubbed version in the reason.
* When action is "placeholder" or "hash", the guardrail passes but modifies the input.
*/
toInputGuardrail(): InputGuardrail;
/**
* Create a beforeLLMCall hook that scrubs PII from all messages on every roundtrip.
*/
toBeforeLLMCallHook(): (messages: ChatMessage[], roundtrip: number) => Promise<ChatMessage[] | void>;
/**
* Create an afterToolExec hook that scrubs PII from tool results.
*/
toAfterToolExecHook(): (toolName: string, result: string) => Promise<string | void>;
}
ChatMessage, InputGuardrail, PiiGuardConfig.
export interface PiiGuardConfig {
patterns?: PiiPattern[];
builtIn?: PiiType[];
action: "redact" | "hash" | "placeholder";
rehydrate?: boolean;
customDetector?: (text: string) => Array<{
start: number;
end: number;
type: string;
}>;
}
PiiPattern, PiiType.
export interface PiiPattern {
name: string;
regex: RegExp;
}
export type PiiType = "email" | "phone" | "ssn" | "creditCard" | "ipAddress" | "name";