Creating custom scanners

In addition to the scanners provided with CalypsoAI, you can also create and configure your own custom scanners, tailored to your specific use cases and business needs.

You can create the following three types of custom scanners:

• GenAI scanners
• Regex scanners
• Keyword scanners

GenAI scanners

GenAI scanners use natural language instructions to intelligently block or flag unauthorized content by understanding both the intent of the scanner and the content of the prompt or response.

To create a custom GenAI scanner:

1. Log in to CalypsoAI.
2. From the menu, in the Configuration section, select Playground.
3. Select Build a custom scanner > GenAI scanner.
   The GenAI scanner window is displayed.
   
   
4. In Name, enter a name for your scanner.
5. In Description, enter the input for which you want the scanner to scan.
   OR
   Select Upload a file, and upload a CSV file with your input. 
6. From the Scan list, select the direction of the scan.
   

   You can choose from the following options:

   • Prompts: only the prompt is scanned.
   • Responses: only the LLM response is scanned.
   • Prompts & Responses: both the prompt and response are scanned.
7. In Add tags, enter a tag for your scanner, and press Enter.
   ℹ️Tags are optional, and you can enter more than one tag. 
8. Select Save.
   The Save new version window is displayed. 
9. In Version, enter a name for your scanner version.
10. In What’s new (optional), enter a summary of the changes introduced in this version.
11. Select Save version.
    Your custom GenAI scanner is saved, and you can find it in the Playground tab, at the top of the Custom scanners list. 

Regex scanners

Regex scanners use regular expressions to scan text, and block, flag, or redact content based on a regex pattern you can configure.

To create a custom regex scanner:

1. Log in to CalypsoAI.
2. From the menu, in the Configuration section, select Playground.
3. Select Build a custom scanner > Regex scanner.
   The Regex scanner window is displayed. 
   
   
4. In Name, enter a name for your scanner.
5. In Regular expression, enter your regular expression.
6. In Test string, to make sure your regular expression is functioning correctly, enter a value to test.
7. From the Scan list, select the direction of the scan.
   

   You can choose from the following options:

   • Prompts: only the prompt is scanned.
   • Responses: only the LLM response is scanned.
   • Prompts & Responses: both the prompt and response are scanned.
8. In Add tags, enter a tag for your scanner, and press Enter.
   ℹ️Tags are optional, and you can enter more than one tag.
9. Select Save.
   The Save new version window is displayed. 
10. In Version, enter a name for your scanner version.
11. In What’s new (optional), enter a summary of the changes introduced in this version.
12. Select Save version.
    Your custom regex scanner is saved, and you can find it in the Playground tab, at the top of the Custom scanners list. 

Keyword scanners

Keyword scanners scan text, and block, flag, or redact any content that contains specific keywords you can configure.

For an end-to-end tutorial on creating a keyword scanner for a specific use case, see Creating a custom keyword scanner.

To create a custom keyword scanner:

1. Log in to CalypsoAI.
2. From the menu, in the Configuration section, select Playground.
3. Select Build a custom scanner > Keyword scanner.
   The Keyword scanner window is displayed. 
   
   
4. In Name, enter a name for your scanner.
5. In Keywords, enter the keyword for which you want the scanner to scan, and press Enter.
   You can enter more than one keyword. 
6. From the Scan list, select the direction of the scan.
   

   You can choose from the following options:

   • Prompts: only the prompt is scanned.
   • Responses: only the LLM response is scanned.
   • Prompts & Responses: both the prompt and response are scanned.
7. In Add tags, enter a tag for your scanner, and press Enter.
   ℹ️Tags are optional, and you can enter more than one tag.
8. Select Save.
   The Save new version window is displayed. 
9. In Version, enter a name for your scanner version.
10. In What’s new (optional), enter a summary of the changes introduced in this version.
11. Select Save version.
    Your custom keyword scanner is saved, and you can find it in the Playground tab, at the top of the Custom scanners list.