Working with scanner versions

In CalypsoAI, the custom scanners you create are versioned. Custom scanner versioning is a feature that allows you to create and iterate over scanner versions.

Learn more about scanner versioning

To get familiar with scanner versioning, this section will walk you through the following:

1. Creating scanner versions
2. Testing scanner versions
3. Publishing scanner versions
4. Updating scanner versions
5. Downgrading to a previous scanner version

Creating scanner versions

A new scanner version is created each time you create a new scanner or update an existing scanner.

In this scenario, we are going to create the first version of a custom scanner.

To create a scanner version:

1. Log in to CalypsoAI.
2. From the menu, in the Configuration section, select Playground.
3. Select Build a custom scanner, and from the list, select an option.
   
   

   Learn how to create a custom scanner

4. Configure the scanner, and select Save.
   

   The Save new version window is displayed.

   
5. In Version, enter a name for your scanner version.
6. In What’s new (optional), enter a summary of the changes introduced in this version.
7. Select Save version.
   

   Your custom scanner is saved, and you can find it in the Playground tab, at the top of the Custom scanners list.

Testing scanner versions

After creating a new scanner version, you can test it to make sure it functions as configured.

To test a scanner version:

1. Log in to CalypsoAI.
2. From the menu, in the Configuration section, select Playground. 
3. In the Custom scanners list, find the scanner you want to test.
4. From the Test more versions list, select the scanner version you want to test, and select Select.
   

   ℹ️You can select more than one scanner version, or even versions of different scanners, to test against each other.

5. Select Test.
   

   The test chat box is enabled.

6. If you want to test the scanner with a specific model, select Test with a model, and from the list, select a model.
   ℹ️If a scanner version is configured to scan responses, it must be tested with a model.
7. In the chat box, enter your prompt and press Enter.
   

   Depending on the configuration of your scanner version, the scanner scans:

   • The prompt
   • The response
   • Both the prompt and the response
8. Analyze the results, and, if required, update your scanner configuration based on your findings.

Publishing scanner versions

Publishing a scanner version makes it available for scanning prompts and scan requests, and for use in your projects and scanner packages.

To publish a scanner version:

1. Log in to CalypsoAI.
2. From the menu, in the Configuration section, select Playground.
3. In the Custom scanners list, find your scanner, and select .
4. In the Version history list, hover over the scanner version you want to publish, and select Publish.
   A confirmation window is displayed, with the following options:
   
   • Push to projects: Force pushes the scanner version to the projects in which the scanner is included, enabling the version automatically.
   • Allow opt in: Adds the scanner version to the projects in which the scanner is included but doesn’t enable it.
     This option lets project admins update the individual projects with the new scanner version themselves, at their preferred time, ensuring an uninterrupted service in case of problems with the new scanner version.
5. Select  an option.
   The scanner version is published.
   

 

Updating scanner versions

To change a scanner’s configuration, you can update the version of an existing scanner.

Learn more about updating scanner versions

To update a scanner version:

1. Log in to CalypsoAI.
2. From the menu, in the Configuration section, select Playground.
3. In the Custom scanners list, find the scanner you want to update, and select .
   

   The Edit menu is displayed.

4. In the Version history list, select the version you want to update.
5. In the Edit menu, update the configuration of the scanner, and select Save.
   

   The Save new version window is displayed.

6. In Version, enter a name for your scanner version.
7. In What’s new (optional), enter a summary of the changes introduced in this version.
8. Select Save version.
   

   The scanner version is saved, and you can find it at the top of the Version history list.

 

Downgrading to a previous scanner version

If you want to use a previously published scanner version, you can downgrade to it.

To downgrade to a previous scanner version:

1. Log in to CalypsoAI.
2. From the menu, in the Configuration section, select Scanners.
3. In the Custom scanners list, find and select your scanner.
4. In the version list, hover over the version to which you want to downgrade, and select Downgrade.
   

   The Downgrade version window is displayed.

5. Select Update.
   

   Your selected scanner version is set as active.