Add polite guard #1223

Ankur-singh · 2025-01-23T23:58:02Z

Description

Integrates Intel's Polite Guard model as one of the guardrail component/microservice.

Issues

n/a

Type of change

List the type of change like below. Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds new functionality)
Breaking change (fix or feature that would break existing design and interface)
Others (enhancement, documentation, validation, etc.)

Dependencies

No new dependency

Tests

Describe the tests that you ran to verify your changes.

I successfully tested the microservice by running it both as Python script and as Docker microservice. Both methods worked as expected, and I was able to verify the functionality of the component with different inputs.

letonghan · 2025-02-10T07:56:46Z

Hi @Ankur-singh , please check the failure of Compose file and dockerfile path checking. This polite guard needs to be added in .github/workflows/docker/compose/guardrails-compose.yaml file for release image building.

Also, please add a test scirpt here and follow the naming schema. Thanks!

Ankur-singh · 2025-02-11T06:59:41Z

Hi @letonghan, thank you for your help. I have made the requested changes. Fingers crossed, all checks should pass.

Ankur-singh · 2025-02-19T19:47:23Z

Hi @letonghan can you please help me with the failed checks? I see that docker containers is created but the curl request fails. Other two services (llamaguard and hallucination_detection) are also failing. But I'm unable to figure out why, is it because of overlapping port usage? Are these services running in parallel?

Sorry about polluting the PR. Is there a way to run these workflows locally? I'll clear the next commit.

xiguiw · 2025-02-25T09:46:36Z

@Ankur-singh

Are you still working on this?

The environments variables are not set.
Please set them in test script.
You can refer to other test scripts.

docker compose up guardrails-polite-guard-server -d
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "SAFETY_GUARD_ENDPOINT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "SAFETY_GUARD_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "vLLM_ENDPOINT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "no_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "https_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "http_proxy" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_MODEL_ID" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "host_ip" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="The "LLM_ENDPOINT_PORT" variable is not set. Defaulting to a blank string."
time="2025-02-20T20:05:52Z" level=warning msg="Found orphan containers ([gpt-sovits-service]) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up."
Container guardrails-polite-guard-server Creating
Container guardrails-polite-guard-server Created
Container guardrails-polite-guard-server Starting
Container guardrails-polite-guard-server Started
sleep 15
echo 'Microservice started'
validate_microservice
echo 'Validate microservice started'
Microservice started
Validate microservice started
echo 'test 1 - Impolite'
++ curl localhost:11301/v1/polite -X POST -d '{"text":"He is stupid"}' -H 'Content-Type: application/json'
test 1 - Impolite
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed

0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
100 23 0 0 100 23 0 47131 --:--:-- --:--:-- --:--:-- 23000
curl: (56) Recv failure: Connection reset by peer
result=
[[ '' == \V\i\o\l\a\t\e\d ]]
docker logs guardrails-polite-guard-server
exit 1
Error: Process completed with exit code 1.

Ankur-singh · 2025-02-28T01:01:26Z

Yes, still working on it. Sorry for the delay though.

Ankur-singh · 2025-02-28T19:54:26Z

@xiguiw looks like ENV VARs were not the problem. Checked the log for other services (successful) and saw the same warning messages.

Tried to run bash ./guardrails/test_guardrails_polite_guard.sh locally and got the same error. After some digging, found out that the service takes more than 15 secs to start. Updated the script to check for application start, refer this. This solves the problem.

PS: @letonghan I believe, we should add similar checks for other services as well.

Update: Getting the following error, https://github.com/opea-project/GenAIComps/actions/runs/13624534401/job/38079510858?pr=1223#step:5:938

Are these tests executed in parallel? Does each service need to have an unique port number?

xiguiw · 2025-03-26T02:19:29Z

Remind
rebase and trigger the CI

Signed-off-by: Ankur-singh <[email protected]> Signed-off-by: Ankur Singh <[email protected]>

for more information, see https://pre-commit.ci Signed-off-by: Ankur-singh <[email protected]> Signed-off-by: Ankur Singh <[email protected]>

Signed-off-by: Ankur-singh <[email protected]> Signed-off-by: Ankur Singh <[email protected]>

Signed-off-by: Ankur Singh <[email protected]>

ZePan110 · 2025-06-04T03:29:33Z

tests/guardrails/test_guardrails_polite_guard.sh

+set -x
+
+WORKPATH=$(dirname "$PWD")
+ip_address=$(hostname -I | awk '{print $1}')


"ip_address" unreferenced

joshuayao · 2025-08-14T03:19:32Z

Hi @Ankur-singh could you please check the CI failures? Thanks.

Ankur-singh requested review from letonghan and lvliang-intel as code owners January 23, 2025 23:58

Ankur-singh force-pushed the add-polite-guard branch 3 times, most recently from 3510bf5 to c561c25 Compare January 28, 2025 22:22

Ankur-singh force-pushed the add-polite-guard branch 2 times, most recently from 3b6569b to be910a0 Compare February 3, 2025 15:55

ftian1 approved these changes Feb 5, 2025

View reviewed changes

Ankur-singh force-pushed the add-polite-guard branch from be910a0 to 6b591e7 Compare February 5, 2025 15:49

Ankur-singh force-pushed the add-polite-guard branch from 6b591e7 to 6114a76 Compare February 11, 2025 06:50

Ankur-singh requested review from ZePan110 and chensuyue as code owners February 11, 2025 06:50

Ankur-singh force-pushed the add-polite-guard branch 2 times, most recently from c37de4b to db947de Compare February 11, 2025 06:55

Ankur-singh force-pushed the add-polite-guard branch from c12e9f3 to 72efdf2 Compare February 11, 2025 19:03

Ankur-singh force-pushed the add-polite-guard branch from 72efdf2 to d4fa6e5 Compare February 20, 2025 20:02

Ankur-singh force-pushed the add-polite-guard branch from d4fa6e5 to b1b1849 Compare February 28, 2025 19:45

Ankur-singh changed the title ~~[WIP] Add polite guard~~ Add polite guard Feb 28, 2025

Ankur-singh force-pushed the add-polite-guard branch from b1b1849 to 4267539 Compare March 3, 2025 06:08

Ankur-singh force-pushed the add-polite-guard branch from 4267539 to 87dc4f1 Compare March 12, 2025 01:35

Ankur-singh force-pushed the add-polite-guard branch 3 times, most recently from bd25a5a to 792993e Compare March 28, 2025 15:39

Ankur-singh and others added 6 commits April 15, 2025 12:01

integrate polite guard component

f09746b

Signed-off-by: Ankur-singh <[email protected]> Signed-off-by: Ankur Singh <[email protected]>

add polite guard microservice readme

ebb1161

Signed-off-by: Ankur-singh <[email protected]> Signed-off-by: Ankur Singh <[email protected]>

[pre-commit.ci] auto fixes from pre-commit.com hooks

d9be607

for more information, see https://pre-commit.ci Signed-off-by: Ankur-singh <[email protected]> Signed-off-by: Ankur Singh <[email protected]>

Update README.md with corrected curl command and improved Python example

a5a7696

Signed-off-by: Ankur-singh <[email protected]> Signed-off-by: Ankur Singh <[email protected]>

add polite_guard to tests, workflows, and service

1501a7f

Signed-off-by: Ankur-singh <[email protected]> Signed-off-by: Ankur Singh <[email protected]>

Add retry logic for service startup in test script

09b44f9

Signed-off-by: Ankur Singh <[email protected]>

Ankur-singh force-pushed the add-polite-guard branch from d2cb957 to 09b44f9 Compare April 15, 2025 19:01

joshuayao added this to OPEA Apr 29, 2025

joshuayao added this to the v1.4 milestone Apr 29, 2025

joshuayao moved this to In review in OPEA May 14, 2025

ZePan110 reviewed Jun 4, 2025

View reviewed changes

Merge branch 'main' into add-polite-guard

6cfa924

xiguiw requested review from lkk12014402, minmin-intel and rbrugaro as code owners June 12, 2025 02:17

Merge branch 'main' into add-polite-guard

79efc16

joshuayao moved this from In review to In progress in OPEA Aug 14, 2025

chensuyue modified the milestones: v1.4, v1.5 Aug 22, 2025

joshuayao moved this from In progress to In review in OPEA Oct 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add polite guard #1223

Add polite guard #1223

Uh oh!

Ankur-singh commented Jan 23, 2025

Uh oh!

letonghan commented Feb 10, 2025 •

edited

Loading

Uh oh!

Ankur-singh commented Feb 11, 2025

Uh oh!

Ankur-singh commented Feb 19, 2025

Uh oh!

xiguiw commented Feb 25, 2025

Uh oh!

Ankur-singh commented Feb 28, 2025

Uh oh!

Ankur-singh commented Feb 28, 2025 •

edited

Loading

Uh oh!

xiguiw commented Mar 26, 2025

Uh oh!

ZePan110 Jun 4, 2025

Uh oh!

joshuayao commented Aug 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Add polite guard #1223

Are you sure you want to change the base?

Add polite guard #1223

Uh oh!

Conversation

Ankur-singh commented Jan 23, 2025

Description

Issues

Type of change

Dependencies

Tests

Uh oh!

letonghan commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ankur-singh commented Feb 11, 2025

Uh oh!

Ankur-singh commented Feb 19, 2025

Uh oh!

xiguiw commented Feb 25, 2025

Uh oh!

Ankur-singh commented Feb 28, 2025

Uh oh!

Ankur-singh commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xiguiw commented Mar 26, 2025

Uh oh!

ZePan110 Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

joshuayao commented Aug 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

letonghan commented Feb 10, 2025 •

edited

Loading

Ankur-singh commented Feb 28, 2025 •

edited

Loading