๐Ÿ”ฌ
Vigil: Documentation
GitHub Repo
  • ๐Ÿ›ก๏ธVigil
  • Overview
    • ๐Ÿ—๏ธRelease Blog
    • ๐Ÿ› ๏ธInstall Vigil
      • ๐Ÿ”ฅInstall PyTorch (optional)
    • ๐ŸงชUse Vigil
      • โš™๏ธConfiguration
        • ๐Ÿ”„Auto-updating vector database
      • ๐Ÿ—„๏ธLoad Datasets
      • ๐ŸŒWeb server
        • ๐ŸคAPI Endpoints
        • ๐ŸชWeb UI playground
      • ๐ŸPython library
      • ๐ŸŽฏScanners
        • ๐Ÿค—Transformer
        • โ•YARA / Heuristics
        • ๐Ÿ“‘Prompt-response Similarity
        • ๐Ÿ’พVector database
        • ๐ŸคCanary Tokens
    • ๐Ÿ›ก๏ธCustomize Detections
      • ๐ŸŒŸAdd custom YARA signatures
      • ๐Ÿ”ขAdd embeddings
      • ๐ŸCustom scanners
    • ๐Ÿช„Sample scan results
Powered by GitBook
On this page
  1. Overview
  2. Use Vigil
  3. Configuration

Auto-updating vector database

PreviousConfigurationNextLoad Datasets

Last updated 1 year ago

If enabled, Vigil can add submitted prompts back to the vector database for future detection purposes. When n number of scanners match on a prompt, that prompt will be indexed in the vector database.

Because each individual scanner is prone to false positives, it is recommended to set the threshold at 3 to require all input scanners (YARA, vector db, transformer) to match before auto-updating is invoked.

This is disabled by default but can be configured in the embedding section of the conf/server.conf file.

Example configuration

[embedding]
auto_update = true
update_threshold = 3

This configuration would require three different scanners to match against a submitted prompt before that prompt is indexed back in the database.

The following metadata is stored alongside the detected prompt:

{
     "uuid": scan uuid,
     "source": "auto-update",
     "timestamp": timestamp string,
     "threshold": update_threshold
 }

Once enabled, you will see log output similar to the screenshot below when the threshold is met:

๐Ÿงช
โš™๏ธ
๐Ÿ”„
Auto-update example log output