Prompt Sentinel Documentation
Welcome to the Prompt Sentinel documentation! This guide will help you understand how to install, configure, and use Prompt Sentinel to protect sensitive data during interactions with language models (LLMs).
Table of Contents
- Introduction: Overview of Prompt Sentinel and its features.
- Installation Instructions: Steps to install Prompt Sentinel.
- Usage Guide: Examples of how to integrate Prompt Sentinel into your projects.
- API Reference: Detailed reference for the available functions and classes.
- Detectors: Information about the built-in detectors and how to create custom ones.
- Custom Prompts: Guide to creating and using custom prompts with
LLMSecretDetector. - Sentinel Options: Configuration options for the
@sentineldecorator and related functions. - Local Hugging Face Detector: Example of using a local Hugging Face model for detection.
- License Information: Licensing details for Prompt Sentinel.
Getting Started
To get started, check out the Installation Instructions and Introduction sections.
For advanced usage, explore the Usage Guide and API Reference.