Skip to content

Commit de78cd4

Browse files
authored
Update how-to-call.md with redaction policy examples
1 parent 46cb645 commit de78cd4

File tree

1 file changed

+4
-5
lines changed
  • articles/ai-services/language-service/personally-identifiable-information

1 file changed

+4
-5
lines changed

articles/ai-services/language-service/personally-identifiable-information/how-to-call.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,19 @@ By default, this feature uses the latest available AI model on your text. You ca
3333
When you submit documents to be processed, you can specify which of [the supported languages](language-support.md) they're written in. if you don't specify a language, extraction defaults to English. The API may return offsets in the response to support different [multilingual and emoji encodings](../concepts/multilingual-emoji-support.md).
3434

3535
### Redaction Policy (version 2024-11-5-preview only)
36-
37-
in version 2024-11-5-preview, you're able to define the `redactionPolicy` parameter to reflect the redaction policy to be used when redacting the document in the response. The policy field supports 3 policy types:
36+
In version 2024-11-5-preview, you're able to define the `redactionPolicy` parameter to reflect the redaction policy to be used when redacting text. The policy field supports 3 policy types:
3837

3938
- `DoNotRedact`
4039
- `MaskWithCharacter` (default)
4140
- `MaskWithEntityType`
4241

43-
The `DoNotRedact` policy allows the user to return the response without the `redactedText` field.
42+
The `DoNotRedact` policy allows the user to return the response without the `redactedText` field, i.e. “John Doe received a call from 424-878-9192”,.
4443

45-
The `MaskWithRedactionCharacter` policy allows the `redactedText` to be masked with a character, preserving the length and offset of the original text. This is the existing behavior.
44+
The `MaskWithRedactionCharacter` policy allows the `redactedText` to be masked with a character (such as "*"), preserving the length and offset of the original text, i.e. “******** received a call from ************. This is the existing behavior.
4645

4746
There is also an optional field called `redactionCharacter` where you can input the character to be used in redaction if you're using the `MaskWithCharacter` policy
4847

49-
The `MaskWithEntityType` policy allows you to mask the detected PII entity text with the detected entity type.
48+
The `MaskWithEntityType` policy allows you to mask the detected PII entity text with the detected entity type, i.e. “[PERSON_1] received a call from [PHONENUMBER_1].
5049

5150
## Submitting data
5251

0 commit comments

Comments
 (0)