Skip to content

Commit c6a0ce1

Browse files
committed
correct typos
1 parent f63d7d5 commit c6a0ce1

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

docs/guardrails/copyright.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Copyrighted Content
77
Copyright Compliance in Agentic Systems
88
</div>
99

10-
It is important to ensure that content generated by agentic systems respects intellectual property rights and avoids the unauthorized use of copyrighted material. Copyright compliance is essential not only for legal and ethical reasons, but also to protect users and organizations from liability and reputational risk.
10+
It is important to ensure that content generated by agentic systems respects intellectual property rights and avoids the unauthorized use of copyrighted material. Copyright compliance is essential not only for legal and ethical reasons but also to protect users and organizations from liability and reputational risk.
1111

1212
Guardrails provides the `copyright` function to detect if any licenses are present in a given piece of text, to protect against exactly this.
1313

@@ -32,7 +32,7 @@ Detects copyrighted text material if it is in `data` and returns the detected li
3232
| `List[str]` | List of detected copyright types. For example, `["GNU_AGPL_V3", "MIT_LICENSE", ...]`|
3333

3434
### Detecting copyrighted content
35-
The simplest use-case of the `copyright` function is to apply it directly to messages, as seen below.
35+
The simplest use-case of the `copyright` function is to apply it to all messages, as seen below.
3636

3737
**Example:** Detecting copyrighted content
3838
```guardrail

docs/guardrails/images.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Secure images given to, or produced by, your agentic system.
66
# Images
77

88
<div class='subtitle'>
9-
Secure images given to, or produced by, your agentic system.
9+
Secure images given to, or produced by your agentic system.
1010
</div>
1111

1212
At the core of computer vision agents is the ability to perceive their environment through images, typically by taking screenshots to assess the current state. This visual perception allows agents to understand interfaces, identify interactive elements, and make decisions based on what they "see."
@@ -49,7 +49,7 @@ Given an image as input, this parser extracts and returns the text in the image
4949
| `List[str]` | A list of extracted pieces of text from `data`. |
5050

5151
### Analyzing Text in Images
52-
The `ocr` function is a <span class="parser-badge" size-mod="small"></span> so it returns the data found from parsing its content; in this case any text present in an image will be extracted. The extracted text can then be used for further detection, for example detecting a prompt injection in an image, like the example below.
52+
The `ocr` function is a <span class="parser-badge" size-mod="small"></span> so it returns the data found from parsing its content; in this case, any text present in an image will be extracted. The extracted text can then be used for further detection, for example detecting a prompt injection in an image, like the example below.
5353

5454
**Example:** Image Prompt Injection Detection.
5555
```python
@@ -100,7 +100,7 @@ raise "Found Prompt Injection" if:
100100
# Only check user messages
101101
msg.role == 'user'
102102

103-
# Use image function to get images
103+
# Use the image function to get images
104104
ocr_results := ocr(image(msg))
105105

106106
# Check both text and images

docs/guardrails/moderation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Detector which evaluates to true if the given data should be moderated.
3838

3939
| Name | Type | Description |
4040
|-------------|--------|----------------------------------------|
41-
| `data` | `Union[str, List[str]]` | A single message or a list of messages to detect prompt injections in. |
41+
| `data` | `Union[str, List[str]]` | A single message or a list of messages. |
4242
| `model` | `Union[str, List[str]]` | The model to use for moderation detection. |
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. |

docs/guardrails/pii.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ description: Detect and manage PII in traces.
88
Detect and manage PII in traces.
99
</div>
1010

11-
Personally Identifiable Information (PII) refers to sensitive information — like names, emails, or credit card numbers — that AI systems and agents need to handle carefully. When these systems work with user data, it is important to establish clear rules about how personal information can be handled, to ensure the sytem functions safely.
11+
Personally Identifiable Information (PII) refers to sensitive information — like names, emails, or credit card numbers — that AI systems and agents need to handle carefully. When these systems work with user data, it is important to establish clear rules about how personal information can be handled, to ensure the system functions safely.
1212

1313
<div class='risks'/>
1414
> **PII Risks**<br/>
1515
> Without safeguards, agents may:
1616
1717
> * **Log PII** in traces or internal tools
1818
>
19-
> * **Expose PII** to in unintentional or dangerous ways
19+
> * **Expose PII** in unintentional or dangerous ways
2020
>
2121
> * **Share PII** in responses or external tool calls
2222
@@ -29,13 +29,13 @@ def pii(
2929
entities: Optional[List[str]]
3030
) -> List[str]
3131
```
32-
Detector to find personally-identifiable information in text.
32+
Detector to find personally identifiable information in text.
3333

3434
**Parameters**
3535

3636
| Name | Type | Description |
3737
|-------------|--------|----------------------------------------|
38-
| `data` | `Union[str, List[str]]` | A single message or a list of messages to detect PII in. |
38+
| `data` | `Union[str, List[str]]` | A single message or a list of messages. |
3939
| `entities` | `Optional[List[str]]` | A list of [PII entity types](https://microsoft.github.io/presidio/supported_entities/) to detect. Defaults to detecting all types. |
4040

4141
**Returns**
@@ -172,7 +172,7 @@ raise "Found Credit Card information in message" if:
172172

173173

174174
### Preventing PII Leakage
175-
It is also possible to use the `pii` function in combination with other filters to get more complex behaviour. The example below shows how you can detect when an agent attempts to send emails outside of your organisation.
175+
It is also possible to use the `pii` function in combination with other filters to get more complex behavior. The example below shows how you can detect when an agent attempts to send emails outside of your organisation.
176176

177177
**Example:** Detecting PII Leakage in External Communications.
178178
```guardrail

docs/guardrails/secrets.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Secret Tokens and Credentials
77
Prevent agents from leaking sensitive keys, tokens, and credentials.
88
</div>
99

10-
Agentic systems often operate on user data, call APIs, or interface with tools and environments that require access credentials. If not properly guarded, these credentials — such as API keys, access tokens, or database secrets — can be accidentally exposed through system outputs, logs, or responses to user prompts.
10+
Agentic systems often operate on user data, call APIs, or interface with tools and environments that require access credentials. If not adequately guarded, these credentials — such as API keys, access tokens, or database secrets — can be accidentally exposed through system outputs, logs, or responses to user prompts.
1111

1212
This section describes how to detect and prevent the unintentional disclosure of secret tokens and credentials during agent execution.
1313

@@ -61,12 +61,12 @@ raise "Found Secrets" if:
6161
### Detecting specific secret types
6262
In some cases, you may want to detect only certain types of secrets—such as API keys for a particular service. Since the `secrets` detector returns a list of all matched secret types, you can check whether a specific type is present in the trace and handle it accordingly.
6363

64-
**Example:** Detecting a github token in messages
64+
**Example:** Detecting a GitHub token in messages
6565
```python
6666
from invariant.detectors import secrets
6767

6868
raise "Found Secrets" if:
6969
(msg: Message)
7070
"GITHUB_TOKEN" in secrets(msg)
7171
```
72-
<div class="code-caption">Specifically check for github tokens in any message.</div>
72+
<div class="code-caption">Specifically check for GitHub tokens in any message.</div>

0 commit comments

Comments
 (0)