Prompt Security Integration

Prompt Security AI allows you to protect LLM interaction. This integration enables NeMo Guardrails to use Prompt Security to protect input and output flows.

You’ll need to set the following env variables to work with Prompt Security:

1. PS_PROTECT_URL - This is the URL of the protect endpoint given by Prompt Security. This will look like https://[REGION].prompt.security/api/protect where REGION is eu, useast or apac
2. PS_APP_ID - This is the application ID given by Prompt Security (similar to an API key). You can get it from admin portal at https://[REGION].prompt.security/ where REGION is eu, useast or apac

Setup

1. Ensure that you have access to Prompt Security API server (SaaS or on-prem).

2. Update your config.yml file to include the Prompt Security settings:

   1
   rails:
   2
     input:
   3
       flows:
   4
         - protect prompt
   5
     output:
   6
       flows:
   7
         - protect response

Don’t forget to set the PS_PROTECT_URL and PS_APP_ID environment variables.

Usage

Once configured, the Prompt Security integration will automatically:

1. Protect prompts before they are processed by the LLM.
2. Protect LLM outputs before they are sent back to the user.

The protect_text action in nemoguardrails/library/prompt_security/actions.py handles the protection process.

Error Handling

If the Prompt Security API request fails, it’s operating in a fail-open mode (not blocking the prompt/response).

Notes

For more information on Prompt Security and capabilities, please refer to the Prompt Security documentation.