nemo-relay-node/pii_redaction

View as Markdown

Generated from crates/node/pii_redaction.d.ts.

Import from nemo-relay-node/pii_redaction.

Declarations exported by nemo-relay-node/pii_redaction.

Interfaces

ConfigPolicy

1export interface ConfigPolicy {
2 unknown_component?: 'ignore' | 'warn' | 'error' | string;
3 unknown_field?: 'ignore' | 'warn' | 'error' | string;
4 unsupported_value?: 'ignore' | 'warn' | 'error' | string;
5}

BuiltinConfig

1export interface BuiltinConfig {
2 action?: 'remove' | 'redact' | 'regex_replace' | 'hash' | 'mask' | string;
3 target_paths?: string[];
4 pattern?: string;
5 detector?: string;
6 replacement?: string;
7 mask_char?: string;
8 unmasked_prefix?: number;
9 unmasked_suffix?: number;
10}

LocalModelConfig

1export interface LocalModelConfig {
2 backend?: string;
3 model_id?: string;
4 detector_profile?: string;
5 allow_network?: boolean;
6 max_latency_ms?: number;
7}

Config

1export interface Config {
2 version?: number;
3 mode?: 'builtin' | 'local_model' | string;
4 input?: boolean;
5 output?: boolean;
6 tool_input?: boolean;
7 tool_output?: boolean;
8 priority?: number;
9 codec?: 'openai_chat' | 'openai_responses' | 'anthropic_messages' | string;
10 builtin?: BuiltinConfig;
11 local?: LocalModelConfig;
12 policy?: ConfigPolicy;
13}

ComponentSpec interface

1export interface ComponentSpec {
2 kind: 'pii_redaction';
3 enabled?: boolean;
4 config: Config;
5}

Functions

defaultConfig

Create a default PII redaction component config.

1export declare function defaultConfig(): Config;

builtinConfig

Create deterministic built-in redaction backend settings with defaults applied.

1export declare function builtinConfig(config?: BuiltinConfig): BuiltinConfig;

localModelConfig

Create future local-model backend settings with defaults applied.

1export declare function localModelConfig(config?: LocalModelConfig): LocalModelConfig;

ComponentSpec function

Wrap PII redaction config as a top-level plugin component.

1export declare function ComponentSpec(
2 config: Config,
3 options?: {
4 enabled?: boolean;

Constants

PII_REDACTION_PLUGIN_KIND

Top-level plugin kind used by the built-in PII redaction component.

1export declare const PII_REDACTION_PLUGIN_KIND: 'pii_redaction';

Re-exports

  • ConfigDiagnostic
  • ConfigReport