Skip to content

Commit 3d91814

Browse files
tweaks
1 parent effa3d3 commit 3d91814

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/guardrails/moderation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Detector which evaluates to true if the given data should be moderated.
3939
| Name | Type | Description |
4040
|-------------|--------|----------------------------------------|
4141
| `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)). |
4343
| `default_threshhold` | `Optional[dict]` | The threshold for the model score above which text is considered to be moderated. |
4444
| `cat_threshhold` | `Optional[dict]` | A dictionary of [category-specific](https://platform.openai.com/docs/guides/moderation#quickstart) thresholds. |
4545

docs/guardrails/pii.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ Personally Identifiable Information (PII) refers to sensitive information — li
1212

1313
<div class='risks'/>
1414
> **PII Risks**<br/>
15-
> Without safeguards, agents may:
15+
> Without PII safeguards an insecure agent may:
1616
17-
> * **Log PII** in traces or internal tools
17+
> * **Log PII** in traces or internal tools, leading to data compliance violations.
1818
>
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).
2020
>
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.
2224
2325
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.
2426

@@ -36,7 +38,7 @@ Detector to find personally identifiable information in text.
3638
| Name | Type | Description |
3739
|-------------|--------|----------------------------------------|
3840
| `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. |
4042

4143
**Returns**
4244

0 commit comments

Comments
 (0)