Prediction Guard Guardrails components #677

sharanshirodkar7 · 2024-09-11T19:11:13Z

Description

This PR introduces new guardrail components for Prediction Guard (PG) to enhance the safety and reliability of AI interactions. The following guardrails have been added:

1.	Factuality Detection
2.	Toxicity Detection
3.	Prompt Injection Detection
4.	PII detection

Issues

n/a

Type of change

New feature (non-breaking change which adds new functionality)

Dependencies

PREDICTIONGUARD_API_KEY needs to be added to CI/CD to test the microservice.

Tests

The following tests were conducted to verify the functionality and integration of the new guardrail components:

•	Unit tests for each guardrail component to validate detection accuracy and reliability.
•	Integration tests to ensure smooth operation alongside existing Prediction Guard components.
•	Performance tests to verify the guardrails do not introduce significant latency or performance overhead.

All tests have passed, confirming the effective integration of the guardrail components.

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

…pace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 · 2024-09-11T19:13:55Z

@chensuyue PG guardrails comp ready for review.

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

lvliang-intel · 2024-09-14T06:03:47Z

@sharanshirodkar7,

Please fix the pre-commit issue.

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

…pace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 · 2024-09-16T14:04:28Z

@lvliang-intel updated.

sharanshirodkar7 · 2024-09-17T13:49:47Z

@letonghan @lvliang-intel ready for review.

chensuyue · 2024-09-18T06:55:13Z

What's the relationship between those 2 dockerfile, if they belong to 2 different implementation for the service, then the original one should be package into a folder. Based on the new structure, the path with Dockerfile* will be recognized as the service path belong to a single service. That means the CI recognize comps/guardrails/pii_detection/predictionguard belong to comps/guardrails/pii_detection. I think that's not what you want.

sharanshirodkar7 · 2024-09-18T14:29:57Z

@chensuyue so those files already exist in the repo main right now outside of any folder within toxicity detection. I created a folder predictionguard and added our files there. I was not sure if I have to move the files not related to our service as it might affect some links in examples repo too. Let me know what we should do here.

Signed-off-by: Lianhao Lu <lianhao.lu@intel.com>

sharanshirodkar7 · 2024-09-19T14:33:26Z

@letonghan ready for review and merge.

comps/guardrails/factuality/predictionguard/README.md

comps/guardrails/factuality/predictionguard/factuality_predictionguard.py

comps/guardrails/factuality/predictionguard/requirements.txt

comps/guardrails/pii_detection/predictionguard/pii_predictionguard.py

letonghan · 2024-09-20T09:27:51Z

Can you explain the relationship of prediction guard and other four implementations (Factuality Detection, Toxicity Detection, ...)? So we can discuss how to reorg your new components folders.
After that, remember to update the README of GenAIComps\comps\guardrails\README.md. Thanks : )

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 · 2024-09-20T12:42:19Z

@lvliang-intel, thanks for your feedback. I’m working on addressing your suggestions.
@letonghan, sure so Prediction Guard is an end-to-end GenAI platform that provides access to the latest open models from Hugging Face, including LLMs, LVMs, and embeddings (these three microservices have already been merged into OPEA). The platform’s key value proposition is its focus on privacy and security features, such as PII detection, prompt injection checks, factuality, and toxicity checks. These services are integral to Prediction Guard, which is why I created dedicated folders for predictionguard and added the corresponding code.

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

codecov · 2024-09-20T12:58:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines	Coverage Δ
comps/cores/proto/docarray.py	`99.34% <100.00%> (+0.05%)`	⬆️

... and 1 file with indirect coverage changes

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

…pace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 · 2024-09-20T19:32:31Z

@lvliang-intel @XuhuiRen updated.

* added files for PG guardrails components Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * Fix pre-commit issues: end-of-file, requirements.txt, trailing whitespace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * added package Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * added package Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * added package Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * file structure updated to latest Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * Fix pre-commit issues: end-of-file, requirements.txt, trailing whitespace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * Add .DS_Store to .gitignore Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * updated readme,requirements+changes based on feedback Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * references classes in init.py Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * fix readme link error Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * fix readme link error Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * fix readme link error Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * fix readme link error Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * fix readme link error Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * fix readme link error Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * Fix pre-commit issues: end-of-file, requirements.txt, trailing whitespace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * removed duplicatesa Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> * removed added readme content Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com> --------- Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

Signed-off-by: Lianhao Lu <lianhao.lu@intel.com>

added files for PG guardrails components

01da0a5

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 requested review from letonghan and lvliang-intel as code owners September 11, 2024 19:11

Fix pre-commit issues: end-of-file, requirements.txt, trailing whites…

e248466

…pace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 added 3 commits September 11, 2024 15:53

added package

0093ef2

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

added package

58debb6

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

added package

48ddb45

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 added 2 commits September 16, 2024 10:01

file structure updated to latest

26a22ef

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

Fix pre-commit issues: end-of-file, requirements.txt, trailing whites…

645e653

…pace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from dd8d8f4 to 645e653 Compare September 16, 2024 14:03

Merge branch 'main' into guardrails-comp

5e265d5

sharanshirodkar7 added 2 commits September 17, 2024 09:25

Merge branch 'main' into guardrails-comp

4e71684

Merge branch 'main' into guardrails-comp

8155ddb

Merge branch 'main' into guardrails-comp

e222f4b

lvliang-intel approved these changes Sep 18, 2024

View reviewed changes

Merge branch 'main' into guardrails-comp

93a24a9

lkk12014402 pushed a commit that referenced this pull request Sep 19, 2024

watch more docker compose files' changes (#677)

4b0bc26

Signed-off-by: Lianhao Lu <lianhao.lu@intel.com>

Merge branch 'main' into guardrails-comp

e77514f

letonghan reviewed Sep 20, 2024

View reviewed changes

Add .DS_Store to .gitignore

dd9342b

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

updated readme,requirements+changes based on feedback

2cd76c0

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 requested a review from XuhuiRen as a code owner September 20, 2024 12:55

references classes in init.py

9488d27

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from 7670c4b to 9488d27 Compare September 20, 2024 13:13

fix readme link error

94519e1

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from 3b1f565 to 94519e1 Compare September 20, 2024 13:19

fix readme link error

ed10234

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from 0e3600d to ed10234 Compare September 20, 2024 13:24

fix readme link error

9b6db87

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from 6ecdfe6 to 9b6db87 Compare September 20, 2024 13:54

fix readme link error

b8d016f

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from 8df4dd8 to b8d016f Compare September 20, 2024 14:00

fix readme link error

911419b

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from b87cdbe to 911419b Compare September 20, 2024 14:05

fix readme link error

b69a601

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from ed49c74 to b69a601 Compare September 20, 2024 14:32

Fix pre-commit issues: end-of-file, requirements.txt, trailing whites…

ba679ce

…pace, imports, and formatting Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

sharanshirodkar7 force-pushed the guardrails-comp branch from 228789b to ba679ce Compare September 20, 2024 14:37

sharanshirodkar7 and others added 3 commits September 20, 2024 10:37

Merge branch 'main' into guardrails-comp

610b0a2

removed duplicatesa

49aecff

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

removed added readme content

51748ba

Signed-off-by: sharanshirodkar7 <ssharanshirodkar7@gmail.com>

letonghan approved these changes Sep 23, 2024

View reviewed changes

lvliang-intel merged commit 4bbc7a2 into opea-project:main Sep 23, 2024

joshuayao added this to the v1.1 milestone Nov 7, 2024

joshuayao assigned sharanshirodkar7 Nov 7, 2024

joshuayao added feature New feature or request r1.1 labels Nov 7, 2024

WenjiaoYue pushed a commit that referenced this pull request Jul 7, 2025

watch more docker compose files' changes (#677)

a4f4a6c

Signed-off-by: Lianhao Lu <lianhao.lu@intel.com>

Prediction Guard Guardrails components #677

Prediction Guard Guardrails components #677

Uh oh!

Conversation

sharanshirodkar7 commented Sep 11, 2024

Description

Issues

Type of change

Dependencies

Tests

Uh oh!

sharanshirodkar7 commented Sep 11, 2024

Uh oh!

lvliang-intel commented Sep 14, 2024

Uh oh!

sharanshirodkar7 commented Sep 16, 2024

Uh oh!

sharanshirodkar7 commented Sep 17, 2024

Uh oh!

chensuyue commented Sep 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sharanshirodkar7 commented Sep 18, 2024

Uh oh!

sharanshirodkar7 commented Sep 19, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

letonghan commented Sep 20, 2024

Uh oh!

sharanshirodkar7 commented Sep 20, 2024

Uh oh!

codecov bot commented Sep 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sharanshirodkar7 commented Sep 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

chensuyue commented Sep 18, 2024 •

edited

Loading

codecov bot commented Sep 20, 2024 •

edited

Loading

sharanshirodkar7 commented Sep 20, 2024 •

edited

Loading