Note: The Custom Scanners feature is not available at all subscription levels.
The CalypsoAI platform enables Super Admins to create scanners tailored to specific business needs, use cases, or time-limited situations. Each scanner can be created, published, activated, and then used for as long as necessary to meet organizational needs. For example, a scanner created to detect the name of a confidential project, competitor, or acquisition can be activated and remain in use until the information is no longer considered confidential, at which time the scanner can be manually deleted or unpublished by a Super Admin. A different scanner, for example one created to detect specific company terminology, can be activated and remain activated for the system’s lifespan.
Scanners are created and tested in the CalypsoAI Playground to ensure they are fit for purpose and successfully detect the specified content. After testing and approval, they can be published and activated for use in the live or production environment.
This document contains instructions for using the CalypsoAI Playground to build, test, edit, duplicate, delete, and publish custom scanners, and for grouping custom scanners into a custom scanner package.
Using the CalypsoAI Playground
The CalypsoAI Playground page is a secure space for developing and experimenting with new scanners.
Click Playground in the navigation panel or click Build a custom scanner on the Scanners screen.
Build a Scanner
Scanners under development appear in the Custom Scanners panel. Click Build a custom scanner. The Build a Scanner window opens.
Enter the name of the scanner in the Scanner Name text box.
The Scanner text box shows placeholder text that provides examples of how the scanner instructions can be phrased. This text disappears when the user begins typing in the text box. Enter the text that the scanner will search for in the Scanner text box. The scanner description is limited to 200 characters.
Indicate that you want the scanner to review prompts only, responses only, or both prompts and responses from the drop-down list.
Optional: Click Upload a File to upload a .CSV list of terms you want to block.
When complete, click Save.
The new scanner appears as the first in the list of scanners.
Test a Scanner
Each new scanner must be tested to ensure it detects the identified content in line with the user’s intent and is fit for purpose. Select a scanner, then slide its Test toggle to the right.
The Prompt Input text box at the bottom of the screen is unlocked.
Enter a prompt that contains the information the scanner should detect. The structure, wording, and level of detail of both the scanner description and the prompt will affect the degree of sensitivity presented in the response.
Slide the Test toggle to the left to stop the test. The test prompts and scanner results are not saved.
Test a Scanner Against a Model
To test the scanner using a model, ensure the scanner is in Test mode, then slide the Test with a Model toggle to the right and then select a model from the drop-down list.
Enter a prompt and press Enter.
Edit a Scanner
To edit an existing scanner, click Edit below the scanner description. The scanner text box opens. Add to, alter, or delete the existing description in the Scanner text box.
Use the Prompts & Responses drop-down list to identify whether the scanner should review all prompts, all responses, or all prompts and all responses. This choice is indicated by the tilted arrow icons. The upward symbol indicates prompts will be scanned and downward arrow indicates responses will be scanned. The presence of both arrows indicates both prompts and responses will be scanned.
Optional: Enter a value in the Tag text box and click Enter. Adding tags to a scanner enables users to more easily group and search for scanners in the Playground.
After all updates have been made to the scanner, click Save.
Search for a Scanner
Enter the name or partial name of the scanner in the Search textbox and press Enter. Every scanner with the search term(s) in its name and/or tag will appear in a list. Click X in the search textbox to close the search. The custom scanner list returns to its previous order.
Filter Scanner List
Click the filter icon next to the three dots icon.
Select one or more filter options. Click Apply. Click Reset to return the list to its default state.
Delete a Scanner
Click the check box under Custom Scanners to select all scanners or click the check box next to a scanner name to identify individual custom scanner(s) to be deleted.
 |  |
Click the three dots icon next to the filter icon and select Delete from the drop-down list. A pop-up window appears, explaining the delete action is permanent. Click Cancel to retain the scanner or click to permanently remove the scanner.
Create a Scanner Package
Custom scanners can be combined into packages, allowing users to group similar scanners together. This simplifies the process of applying scanners to groups, since one package can be selected rather than selecting scanners individually.
Click the check box under Custom Scanners to select all scanners or click the check box to the left of a scanner name to identify individual custom scanner(s) to be included in a scanner package.
Click the three dots icon next to the filter icon and select Create Package from the drop-down list.
The selected scanners appear in a list. Enter a name for the scanner package. Click Create and Publish. The new scanner package will appear in the global list of custom scanners.
Duplicate or Delete a Scanner
Click the three dots icon under the scanner description.
Select Duplicate to create a copy of the scanner. The copy appears at the top of the list of scanners in the Playground.
Select Delete to permanently remove the scanner from the CalypsoAI Platform.
Publish a Custom Scanner
Click Publish to move the scanner from the Playground to the Scanners page, where it will appear at the top of the list of custom scanners.
Note: A published scanner must be configured and activated before it can be used in the live/production environment. Please see the Scanners: Overview document for information about configuring and activating scanners.