README.md

LLM Guard - The Security Toolkit for LLM Interactions

LLM Guard by Protect AI is a comprehensive tool designed to fortify the security of Large Language Models (LLMs).

Documentation | Playground | Changelog

What is LLM Guard?

By offering sanitization, detection of harmful language, prevention of data leakage, and resistance against prompt injection attacks, LLM-Guard ensures that your interactions with LLMs remain safe and secure.

Installation

Begin your journey with LLM Guard by downloading the package:

pip install llm-guard

Getting Started

Important Notes:

• LLM Guard is designed for easy integration and deployment in production environments. While it's ready to use out-of-the-box, please be informed that we're constantly improving and updating the repository.
• Base functionality requires a limited number of libraries. As you explore more advanced features, necessary libraries will be automatically installed.
• Ensure you're using Python version 3.9 or higher. Confirm with: python --version.
• Library installation issues? Consider upgrading pip: python -m pip install --upgrade pip.

Examples:

• Get started with ChatGPT and LLM Guard.
• Deploy LLM Guard as API

Supported scanners

Prompt scanners

• Anonymize
• BanCode
• BanCompetitors
• BanSubstrings
• BanTopics
• Code
• Gibberish
• InvisibleText
• Language
• PromptInjection
• Regex
• Secrets
• Sentiment
• TokenLimit
• Toxicity

Output scanners

• BanCode
• BanCompetitors
• BanSubstrings
• BanTopics
• Bias
• Code
• Deanonymize
• JSON
• Language
• LanguageSame
• MaliciousURLs
• NoRefusal
• ReadingTime
• FactualConsistency
• Gibberish
• Regex
• Relevance
• Sensitive
• Sentiment
• Toxicity
• URLReachability

Community, Contributing, Docs & Support

LLM Guard is an open source solution. We are committed to a transparent development process and highly appreciate any contributions. Whether you are helping us fix bugs, propose new features, improve our documentation or spread the word, we would love to have you as part of our community.

• Give us a ⭐️ github star ⭐️ on the top of this page to support what we're doing, it means a lot for open source projects!
• Read our docs for more info about how to use and customize LLM Guard, and for step-by-step tutorials.
• Post a Github Issue to submit a bug report, feature request, or suggest an improvement.
• To contribute to the package, check out our contribution guidelines, and open a PR.

Join our Slack to give us feedback, connect with the maintainers and fellow users, ask questions, get help for package usage or contributions, or engage in discussions about LLM security!

Production Support

We're eager to provide personalized assistance when deploying your LLM Guard to a production environment.

• Send Email ✉️