You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`data`|`Union[str, List[str]]`| A single message or a list of messages. |
42
-
|`model`|`Union[str, List[str]]`| The model to use for moderation detection. |
42
+
|`model`|`Union[str, List[str]]`| The model to use for moderation detection (`KoalaAI/Text-Moderation`or`openai`for the OpenAI [Moderations API](https://platform.openai.com/docs/guides/moderation)). |
43
43
|`default_threshhold`|`Optional[dict]`| The threshold for the model score above which text is considered to be moderated. |
44
44
|`cat_threshhold`|`Optional[dict]`| A dictionary of [category-specific](https://platform.openai.com/docs/guides/moderation#quickstart) thresholds. |
Copy file name to clipboardExpand all lines: docs/guardrails/pii.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,15 @@ Personally Identifiable Information (PII) refers to sensitive information — li
12
12
13
13
<divclass='risks'/>
14
14
> **PII Risks**<br/>
15
-
> Without safeguards, agents may:
15
+
> Without PII safeguards an insecure agent may:
16
16
17
-
> ***Log PII** in traces or internal tools
17
+
> ***Log PII** in traces or internal tools, leading to data compliance violations.
18
18
>
19
-
> ***Expose PII** in unintentional or dangerous ways
19
+
> ***Expose PII** in unintentional or dangerous way (e.g. when sending an internal or external email).
20
20
>
21
-
> ***Share PII** in responses or external tool calls
21
+
> ***Store PII** in databases or other storage systems, that may not be qualified for storing sensitive information.
22
+
>
23
+
> * Generally, **violate local and international laws and regulations (e.g. GDPR, CCPA, etc.)** with respect to data protection and governance.
22
24
23
25
The `pii` function helps prevent these issues by scanning messages for PII, thus acting as a safeguard that lets you detect and block sensitive data before it’s stored, surfaced, or shared.
24
26
@@ -36,7 +38,7 @@ Detector to find personally identifiable information in text.
|`data`|`Union[str, List[str]]`| A single message or a list of messages. |
39
-
|`entities`|`Optional[List[str]]`| A list of [PII entity types](https://microsoft.github.io/presidio/supported_entities/) to detect. Defaults to detecting all types. |
41
+
|`entities`|`Optional[List[str]]`| A list of [PII entity types of the Presidio library](https://microsoft.github.io/presidio/supported_entities/) to detect. Defaults to detecting all types. |
0 commit comments