Skip to content

.Net: Example of prompt PII detection logic with Filters and Microsoft Presidio #6171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
May 10, 2024

Conversation

dmytrostruk
Copy link
Member

@dmytrostruk dmytrostruk commented May 9, 2024

Motivation and Context

This example shows how to implement Personal Identifiable Information (PII) detection logic with Filters using Microsoft Presidio service: https://github.com/microsoft/presidio.

Example contains two filters:

First filter is responsible for PII detection in prompt by using Presidio Text Analyzer. If PII is detected, then the prompt won't be sent to LLM and custom result will be returned after function invocation.

Example output:

Prompt: John Smith has a card 1111 2222 3333 4444
Entity type: CREDIT_CARD. Score: 1
Entity type: PERSON. Score: 0.85
Exception: Prompt contains PII information. Operation is canceled.

Second filter is responsible for PII detection in prompt and updating the prompt by following specified rules before sending it to LLM. This filter uses Presidio Text Analyzer and Presidio Text Anonymizer.

Example output:

LLM instructions: If prompt does not contain first and last name - return 'true'.
Prompt before anonymization : Hello world, my name is Jane Doe. My number is: 034453334
Prompt after anonymization : Hello world, my name is ANONYMIZED. My number is: 
Result: true

Contribution Checklist

@dmytrostruk dmytrostruk self-assigned this May 9, 2024
@dmytrostruk dmytrostruk requested a review from a team as a code owner May 9, 2024 04:12
@markwallace-microsoft markwallace-microsoft added .NET Issue or Pull requests regarding .NET code documentation labels May 9, 2024
Copy link
Member

@markwallace-microsoft markwallace-microsoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not for this PR but the following samples would be great:

  1. Detecting passwords or secrets in a prompt
  2. An image redaction sample

@dmytrostruk dmytrostruk added this pull request to the merge queue May 10, 2024
Merged via the queue into microsoft:main with commit f952e14 May 10, 2024
15 checks passed
@dmytrostruk dmytrostruk deleted the pii-detection-filters branch May 10, 2024 16:50
LudoCorporateShark pushed a commit to LudoCorporateShark/semantic-kernel that referenced this pull request Aug 25, 2024
…t Presidio (microsoft#6171)

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

This example shows how to implement Personal Identifiable Information
(PII) detection logic with Filters using Microsoft Presidio service:
https://github.com/microsoft/presidio.

Example contains two filters:

First filter is responsible for PII detection in prompt by using
Presidio Text Analyzer. If PII is detected, then the prompt won't be
sent to LLM and custom result will be returned after function
invocation.

Example output:
```
Prompt: John Smith has a card 1111 2222 3333 4444
Entity type: CREDIT_CARD. Score: 1
Entity type: PERSON. Score: 0.85
Exception: Prompt contains PII information. Operation is canceled.
```

Second filter is responsible for PII detection in prompt and updating
the prompt by following specified rules before sending it to LLM. This
filter uses Presidio Text Analyzer and Presidio Text Anonymizer.

Example output:
```
LLM instructions: If prompt does not contain first and last name - return 'true'.
Prompt before anonymization : Hello world, my name is Jane Doe. My number is: 034453334
Prompt after anonymization : Hello world, my name is ANONYMIZED. My number is: 
Result: true
```

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation .NET Issue or Pull requests regarding .NET code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants