PII redactor¶

Before you begin¶

Follow the steps in the Install with Helm topic to run F5 AI Gateway.

Overview¶

The F5 Personally Identifiable Information Redactor (PII) processor runs in the AI Gateway container. This processor will redact any detected PII from the user prompt or LLM response.

Configuration¶

Direction	Supported
Input	Yes
Response	Yes

processors:
  - name: pii-redactor
    type: external
    config:
      endpoint: http://aigw-processors-f5.ai-gateway.svc.cluster.local
      namespace: f5
      version: 1
    params:
      allow_rewrite: false
      allowset: []
      denyset: []
      threshold: 0.2

Parameters¶

Parameters	Description	Type	Required	Defaults	Examples
`allow_rewrite`	If set to true will replace any detected PII with a redacted placeholder. If set to false the request will be rejected.	bool	No	`false`	`true`, `false`
`allowset`	A unique set of allowed types. Anything in this set will not be redacted or rejected in the request or response. By default all PII is rejected or redacted.	List of unique PII Types	No	[]	`["FIRSTNAME","LASTNAME"]`
`denyset`	A unique set of denied types. Anything in this set will be redacted or rejected in the request or response.	List of unique PII Types	No	[]	`["FIRSTNAME","LASTNAME"]`
`placeholder`	Placeholder that will be used as replacement for PII while redacting.	string	No	`*****`
`placeholder_map`	Map of specific PII type placeholder values. If a type is not found in map then “placeholder” value will be used.	object	No		`{"USERNAME":"Username"}`
`threshold`	A float value that sets the threshold for PII prediction confidence.	float in the range [0, 1]	No	0.2	0.5

PII types¶

PII Types
PREFIX	FIRSTNAME	MIDDLENAME
LASTNAME	JOBTITLE	COMPANY_NAME
JOBAREA	EMAIL	TIME
DATE	URL	BITCOINADDRESS
ETHEREUMADDRESS	ACCOUNTNAME	IBAN
ACCOUNTNUMBER	BIC	IPV4
STREETADDRESS	CITY	ZIPCODE
USERNAME	IPV6	CREDITCARDNUMBER
VEHICLEVIN	SUFFIX	AMOUNT
CURRENCY	PASSWORD	JOBTYPE
STATE	BUILDINGNUMBER	VEHICLEVRM
PHONEIMEI	JOBAREA	COUNTY
CURRENCYNAME	CURRENCYSYMBOL	MASKEDNUMBER
PHONE_NUMBER	SECONDARYADDRESS	SSN
CURRENCYCODE	LITECOINADDRESS	MAC
CREDITCARDISSUER	CREDITCARDCVV	USERAGENT
IP	SEX	STREET
PIN	FULLNAME	NAME
GENDER	NUMBER	NEARBYGPSCOORDINATE
DISPLAYNAME	SEXTYPE	ORDINALDIRECTION

Previous Next