Update README.md

README.md

@@ -98,6 +98,27 @@ benign identifier-like text can be over-redacted. Precision-sensitive users
 should add deterministic filters, tune thresholds where applicable, or
 finetune on representative local negatives.
 
+## Supported Label Spans
+
+The adapter emits these span labels. `O` is the background token label and is
+not returned as a detected span.
+
+| Label | Detects | Example |
+| --- | --- | --- |
+| `account_number` | Nigerian bank account/NUBAN-style account numbers when context indicates an account | `6318826391` |
+| `private_address` | Street, city, state, or postal address spans tied to a person or record | `42 Unity Road, Ikeja, Lagos 100271` |
+| `private_bvn` | Nigerian Bank Verification Number references and values | `22334455667` |
+| `private_date` | Dates tied to a person, record, document, or event in a private workflow | `12 April 1988` |
+| `private_drivers_license_number` | Nigerian driver license identifiers | `K2BHY7F6FEA0` |
+| `private_email` | Email addresses | `amina.yusuf@example.ng` |
+| `private_nin` | Nigerian National Identification Number references and values | `12345678901` |
+| `private_passport_number` | Nigerian passport identifiers | `B05995318` |
+| `private_person` | Person names and name-like references | `Amina Yusuf` |
+| `private_phone` | Nigerian local and international phone-number formats | `+234 802 111 3344` |
+| `private_url` | URLs tied to private records, claims, documents, or workflows | `https://claims.example/record/1234` |
+| `private_voters_card_number` | Nigerian voter card identifiers | `ABCD 1234 5678 9012 345` |
+| `secret` | Known-format credentials, authorization codes, session tokens, and similar secrets | `S3cure!9037Ops` |
+
 ## How To Use
 
 > **Note on the classifier head.** This adapter ships a resized token-
@@ -130,6 +151,25 @@ uv run python main.py \
   "Amina Yusuf can be reached at +234 802 111 3344."
 ```
 
+### Example result
+
+For the adapter command above, the cleaned output should contain:
+
+| Field | Value |
+| --- | --- |
+| Status | `PII detected` |
+| Detected spans | `2` |
+| Mode | `cleaned` |
+| Adapter | `iamSamurai/privacy-filter-nigeria` |
+
+| Label | Text | Start | End |
+| --- | --- | ---: | ---: |
+| `private_person` | `Amina Yusuf` | 0 | 11 |
+| `private_phone` | `+234 802 111 3344` | 30 | 47 |
+
+Confidence scores are model outputs and are not privacy, security, or
+compliance guarantees.
+
 ### REST API
 
 ```bash
@@ -188,12 +228,7 @@ real-world domain samples. Direct identifiers and sensitive fields were
 annotated and redacted from model-use fields. Source materials and derived
 artifacts remain private and are not distributed.
 
-Label space includes Nigerian-domain PII types such as `private_nin`,
-`private_bvn`, `account_number`, `private_passport_number`,
-`private_voters_card_number`, and `private_drivers_license_number`,
-alongside generic PII labels: `private_person`, `private_email`,
-`private_phone`, `private_address`, `private_date`, `private_url`, and
-`secret`.
+Supported span labels are listed in [Supported Label Spans](#supported-label-spans).
 
 The committed public examples are **synthetic**. The private v5 mix is broader
 and includes reviewed non-synthetic source material after direct identifiers
@@ -330,4 +365,4 @@ artifact commit in experiment reports so results are reproducible.
 
 This adapter is released under the Apache License, Version 2.0. The base
 model `openai/privacy-filter` is governed by its own license; consult the
-upstream model card for terms.
+upstream model card for terms.