Polygraf

Polygraf offers a state-of-the-art PII Detection & Masking API designed to help identify and protect sensitive information in your text.

NeMo Guardrails provides a built-in integration with Polygraf which you can use to identify or mask PII on user input, bot output and/or retrieved documents.

Setup

First, you need an API key from Polygraf. Once you have it, set it as an environment variable:

export POLYGRAF_API_KEY="your-polygraf-api-key"

Also, you’ll need the endpoint where the Polygraf PII detection API is hosted. By default, it looks for http://localhost:8000/v1/pii/text-detect.

Configuration

To activate the Polygraf integration, you need to configure the polygraf block in config.yml and include the relevant flows.

To use it for PII detection, your config.yml should look like this:

rails:
  config:
    polygraf:
      server_endpoint: "http://localhost:8000/v1/pii/text-detect"
      input:
        entities:
          - EMAIL_ADDRESS
          - NAME
          - PHONE_NUMBER
      output:
        entities:
          - EMAIL_ADDRESS
          - NAME
          - PHONE_NUMBER

  input:
    flows:
      - polygraf detect pii on input

  output:
    flows:
      - polygraf detect pii on output

To use it for PII masking, use the polygraf mask pii ... flows instead:

rails:
  config:
    polygraf:
      server_endpoint: "http://localhost:8000/v1/pii/text-detect"
      input:
        entities:
          - EMAIL_ADDRESS
          - NAME
          - PHONE_NUMBER
      output:
        entities:
          - EMAIL_ADDRESS
          - NAME
          - PHONE_NUMBER

  input:
    flows:
      - polygraf mask pii on input

  output:
    flows:
      - polygraf mask pii on output

Entity Types

You can configure which entities to detect or mask by specifying them in the entities list. If you omit the entities list for detection, any detected PII will trigger the detection flow. For masking, if you omit the entities list, it will mask all detected PII.

Common entities you might want to detect/mask:

• NAME

• EMAIL_ADDRESS

• PHONE_NUMBER

• CREDIT_CARD_NUMBER

• PASSPORT_NUMBER

• SSN

• LOCATION

• ORGANIZATION

For a complete list of supported entity types, please refer to the Polygraf documentation.