llm-guardrails-maintained 0.3.17__tar.gz

llm_guardrails_maintained-0.3.17/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Protect AI. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

llm_guardrails_maintained-0.3.17/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: llm-guardrails-maintained
+Version: 0.3.17
+Summary: LLM Guard Rails - An actively maintained security toolkit for Large Language Model interactions. Features advanced sanitization, harmful language detection, data leakage prevention, and prompt injection resistance with continuous improvements and enhancements.
+Author-email: Nikhil Singh Bora <nikhilsinghbora17@gmail.com>, "Protect AI (Original)" <community@protectai.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) Protect AI. All rights reserved.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: homepage, https://github.com/Nikhilsinghbora/llm-guardrails
+Project-URL: documentation, https://github.com/Nikhilsinghbora/llm-guardrails/blob/main/README.md
+Project-URL: repository, https://github.com/Nikhilsinghbora/llm-guardrails
+Project-URL: issues, https://github.com/Nikhilsinghbora/llm-guardrails/issues
+Project-URL: changelog, https://github.com/Nikhilsinghbora/llm-guardrails/blob/main/docs/changelog.md
+Project-URL: source, https://github.com/Nikhilsinghbora/llm-guardrails
+Project-URL: original-project, https://github.com/protectai/llm-guard
+Keywords: llm,language model,security,adversarial attacks,prompt injection,prompt leakage,PII detection,self-hardening,firewall,atr-scanner,agent-threat-rules
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: bc-detect-secrets>=1.5.43
+Requires-Dist: faker<38,>=37
+Requires-Dist: fuzzysearch<0.9,>=0.7
+Requires-Dist: json-repair>=0.44.1
+Requires-Dist: nltk<4,>=3.9.1
+Requires-Dist: presidio-analyzer>=2.2.362
+Requires-Dist: presidio-anonymizer>=2.2.362
+Requires-Dist: regex>=2024.11.6
+Requires-Dist: tiktoken<1.0,>=0.9
+Requires-Dist: torch>=2.4.0
+Requires-Dist: transformers<5,>=4.52.1
+Requires-Dist: structlog>=24
+Provides-Extra: onnxruntime
+Requires-Dist: optimum[onnxruntime]<2,>=1.26.0; extra == "onnxruntime"
+Provides-Extra: onnxruntime-gpu
+Requires-Dist: optimum[onnxruntime-gpu]<2,>=1.26.0; extra == "onnxruntime-gpu"
+Provides-Extra: docs-dev
+Requires-Dist: mkdocs<2,>=1.6; extra == "docs-dev"
+Requires-Dist: mkdocs-autorefs==1.4.1; extra == "docs-dev"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.4.0; extra == "docs-dev"
+Requires-Dist: mkdocs-jupyter>=0.25.1; extra == "docs-dev"
+Requires-Dist: mkdocs-material>=9.6.14; extra == "docs-dev"
+Requires-Dist: mkdocs-material-extensions>=1.3.1; extra == "docs-dev"
+Requires-Dist: mkdocs-swagger-ui-tag>=0.7.1; extra == "docs-dev"
+Provides-Extra: dev
+Requires-Dist: llm_guard[docs-dev]; extra == "dev"
+Requires-Dist: autoflake<3,>=2; extra == "dev"
+Requires-Dist: pytest<9,>=8.3.5; extra == "dev"
+Requires-Dist: pytest-cov<7,>=6.1.1; extra == "dev"
+Requires-Dist: pre-commit<5,>=4.2.0; extra == "dev"
+Requires-Dist: pyright~=1.1.400; extra == "dev"
+Requires-Dist: ruff==0.11.10; extra == "dev"
+
+# LLM Guard Rails - Comprehensive Security Toolkit for LLM Interactions
+
+> **About**: This is an actively maintained fork of the original [LLM Guard](https://github.com/protectai/llm-guard) project by [Protect AI](https://protectai.com/llm-guard). We maintain enhancements and improvements beyond the original project, ensuring continuous updates and feature development.
+
+LLM Guard Rails is a comprehensive security toolkit designed to fortify the safety and security of Large Language Model (LLM) interactions. It provides robust protection against various attack vectors and malicious inputs with actively maintained enhancements.
+
+[**Documentation**](https://github.com/Nikhilsinghbora/llm-guardrails) | [**Original Project**](https://github.com/protectai/llm-guard) | [**Getting Started**](./docs/get_started/quickstart.md)
+
+[![GitHub
+stars](https://img.shields.io/github/stars/protectai/llm-guard.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/protectai/llm-guard/stargazers/)
+[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI - Python Version](https://img.shields.io/pypi/v/llm-guard)](https://pypi.org/project/llm-guard)
+[![Downloads](https://static.pepy.tech/badge/llm-guard)](https://pepy.tech/project/llm-guard)
+[![Downloads](https://static.pepy.tech/badge/llm-guard/month)](https://pepy.tech/project/llm-guard)
+
+<a href="https://mlsecops.com/slack"><img src="https://github.com/protectai/llm-guard/blob/main/docs/assets/join-our-slack-community.png?raw=true" width="200" alt="Join Our Slack Community"></a>
+
+## What is LLM Guard?
+
+![LLM-Guard](https://github.com/protectai/llm-guard/blob/main/docs/assets/flow.png?raw=true)
+
+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 Rails by downloading the package:
+
+```sh
+# Coming soon to PyPI as llm-guardrails
+pip install llm-guard
+```
+
+Or install from source:
+
+```sh
+git clone https://github.com/Nikhilsinghbora/llm-guardrails.git
+cd llm-guardrails
+pip install -e .
+```
+
+## Getting Started
+
+**Important Notes**:
+
+- LLM Guard Rails 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.10 or higher. Confirm with: `python --version`.
+- We fully support Python 3.10, 3.11, 3.12, 3.13, and 3.14.
+- Library installation issues? Consider upgrading pip: `python -m pip install --upgrade pip`.
+
+**Examples**:
+
+- Get started with [ChatGPT and LLM Guard](./examples/openai_api.py).
+- Deploy LLM Guard as [API](https://protectai.github.io/llm-guard/api/overview/)
+
+## Supported scanners
+
+### Prompt scanners
+
+- [Anonymize](https://protectai.github.io/llm-guard/input_scanners/anonymize/)
+- [ATRScanner](./docs/input_scanners/atr.md) ⭐ **NEW**
+- [BanCode](./docs/input_scanners/ban_code.md)
+- [BanCompetitors](https://protectai.github.io/llm-guard/input_scanners/ban_competitors/)
+- [BanSubstrings](https://protectai.github.io/llm-guard/input_scanners/ban_substrings/)
+- [BanTopics](https://protectai.github.io/llm-guard/input_scanners/ban_topics/)
+- [Code](https://protectai.github.io/llm-guard/input_scanners/code/)
+- [Gibberish](https://protectai.github.io/llm-guard/input_scanners/gibberish/)
+- [InvisibleText](https://protectai.github.io/llm-guard/input_scanners/invisible_text/)
+- [Language](https://protectai.github.io/llm-guard/input_scanners/language/)
+- [PromptInjection](https://protectai.github.io/llm-guard/input_scanners/prompt_injection/)
+- [Regex](https://protectai.github.io/llm-guard/input_scanners/regex/)
+- [Secrets](https://protectai.github.io/llm-guard/input_scanners/secrets/)
+- [Sentiment](https://protectai.github.io/llm-guard/input_scanners/sentiment/)
+- [TokenLimit](https://protectai.github.io/llm-guard/input_scanners/token_limit/)
+- [Toxicity](https://protectai.github.io/llm-guard/input_scanners/toxicity/)
+
+### Output scanners
+
+- [ATRScanner](./docs/output_scanners/atr.md) ⭐ **NEW**
+- [BanCode](./docs/output_scanners/ban_code.md)
+- [BanCompetitors](https://protectai.github.io/llm-guard/output_scanners/ban_competitors/)
+- [BanSubstrings](https://protectai.github.io/llm-guard/output_scanners/ban_substrings/)
+- [BanTopics](https://protectai.github.io/llm-guard/output_scanners/ban_topics/)
+- [Bias](https://protectai.github.io/llm-guard/output_scanners/bias/)
+- [Code](https://protectai.github.io/llm-guard/output_scanners/code/)
+- [Deanonymize](https://protectai.github.io/llm-guard/output_scanners/deanonymize/)
+- [JSON](https://protectai.github.io/llm-guard/output_scanners/json/)
+- [Language](https://protectai.github.io/llm-guard/output_scanners/language/)
+- [LanguageSame](https://protectai.github.io/llm-guard/output_scanners/language_same/)
+- [MaliciousURLs](https://protectai.github.io/llm-guard/output_scanners/malicious_urls/)
+- [NoRefusal](https://protectai.github.io/llm-guard/output_scanners/no_refusal/)
+- [ReadingTime](https://protectai.github.io/llm-guard/output_scanners/reading_time/)
+- [FactualConsistency](https://protectai.github.io/llm-guard/output_scanners/factual_consistency/)
+- [Gibberish](https://protectai.github.io/llm-guard/output_scanners/gibberish/)
+- [Regex](https://protectai.github.io/llm-guard/output_scanners/regex/)
+- [Relevance](https://protectai.github.io/llm-guard/output_scanners/relevance/)
+- [Sensitive](https://protectai.github.io/llm-guard/output_scanners/sensitive/)
+- [Sentiment](https://protectai.github.io/llm-guard/output_scanners/sentiment/)
+- [Toxicity](https://protectai.github.io/llm-guard/output_scanners/toxicity/)
+- [URLReachability](https://protectai.github.io/llm-guard/output_scanners/url_reachability/)
+
+## Community, Contributing, Docs & Support
+
+LLM Guard Rails is an open source solution maintained as an active fork of the original LLM Guard project.
+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.
+
+### How We Differ
+
+- **Active Development**: We maintain and release updates more frequently than the original project
+- **Feature Requests Welcome**: We actively review and implement community feature requests
+- **Responsive Maintenance**: Issues and PRs receive timely reviews and updates
+
+### Recent Improvements & Updates
+
+**Security & Bug Fixes:**
+- ✅ Fixed CVE-2026-26007: Updated `presidio-anonymizer` to ≥2.2.362
+- ✅ Fixed critical transformers vulnerability (GHSA-phhr-52qp-3mj4)
+- ✅ Fixed Anonymize scanner to properly respect language parameter (#337)
+- ✅ Fixed PromptInjection tokenizer initialization bug (#331)
+- ✅ Fixed MaliciousURLs missing top_k parameter TypeError (#318)
+
+**New Features & Enhancements:**
+- ✅ **Python 3.13+ Support**: Full compatibility with Python 3.13 and 3.14
+- ✅ **ATRScanner**: New Agent Threat Rule scanner with 10+ built-in detection patterns
+- ✅ **ThresholdMixin**: Dynamically adjust scanner sensitivity without model reloading
+- ✅ **Model.from_local()**: Factory method for locally-downloaded HuggingFace models
+- ✅ Improved dependency management for better compatibility
+
+### Get Involved
+
+- 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](./docs/index.md)
+  for more info about how to use and customize LLM Guard Rails, and for step-by-step tutorials.
+- Post a [Github Issue](https://github.com/Nikhilsinghbora/llm-guardrails/issues) to submit a bug report, feature request, or suggest an improvement.
+- To contribute to the package, check out our [contribution guidelines](CONTRIBUTING.md), and open a PR.
+
+### Support & Contact
+
+We're eager to provide personalized assistance and discuss feature requests or improvements.
+
+- [Send Email ✉️](mailto:nikhilsinghbora17@gmail.com) - Open to feature requests, improvements, and collaboration
+- [GitHub Issues](https://github.com/Nikhilsinghbora/llm-guardrails/issues) - Report bugs or request features

llm_guardrails_maintained-0.3.17/README.md

@@ -0,0 +1,150 @@
+# LLM Guard Rails - Comprehensive Security Toolkit for LLM Interactions
+
+> **About**: This is an actively maintained fork of the original [LLM Guard](https://github.com/protectai/llm-guard) project by [Protect AI](https://protectai.com/llm-guard). We maintain enhancements and improvements beyond the original project, ensuring continuous updates and feature development.
+
+LLM Guard Rails is a comprehensive security toolkit designed to fortify the safety and security of Large Language Model (LLM) interactions. It provides robust protection against various attack vectors and malicious inputs with actively maintained enhancements.
+
+[**Documentation**](https://github.com/Nikhilsinghbora/llm-guardrails) | [**Original Project**](https://github.com/protectai/llm-guard) | [**Getting Started**](./docs/get_started/quickstart.md)
+
+[![GitHub
+stars](https://img.shields.io/github/stars/protectai/llm-guard.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/protectai/llm-guard/stargazers/)
+[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI - Python Version](https://img.shields.io/pypi/v/llm-guard)](https://pypi.org/project/llm-guard)
+[![Downloads](https://static.pepy.tech/badge/llm-guard)](https://pepy.tech/project/llm-guard)
+[![Downloads](https://static.pepy.tech/badge/llm-guard/month)](https://pepy.tech/project/llm-guard)
+
+<a href="https://mlsecops.com/slack"><img src="https://github.com/protectai/llm-guard/blob/main/docs/assets/join-our-slack-community.png?raw=true" width="200" alt="Join Our Slack Community"></a>
+
+## What is LLM Guard?
+
+![LLM-Guard](https://github.com/protectai/llm-guard/blob/main/docs/assets/flow.png?raw=true)
+
+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 Rails by downloading the package:
+
+```sh
+# Coming soon to PyPI as llm-guardrails
+pip install llm-guard
+```
+
+Or install from source:
+
+```sh
+git clone https://github.com/Nikhilsinghbora/llm-guardrails.git
+cd llm-guardrails
+pip install -e .
+```
+
+## Getting Started
+
+**Important Notes**:
+
+- LLM Guard Rails 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.10 or higher. Confirm with: `python --version`.
+- We fully support Python 3.10, 3.11, 3.12, 3.13, and 3.14.
+- Library installation issues? Consider upgrading pip: `python -m pip install --upgrade pip`.
+
+**Examples**:
+
+- Get started with [ChatGPT and LLM Guard](./examples/openai_api.py).
+- Deploy LLM Guard as [API](https://protectai.github.io/llm-guard/api/overview/)
+
+## Supported scanners
+
+### Prompt scanners
+
+- [Anonymize](https://protectai.github.io/llm-guard/input_scanners/anonymize/)
+- [ATRScanner](./docs/input_scanners/atr.md) ⭐ **NEW**
+- [BanCode](./docs/input_scanners/ban_code.md)
+- [BanCompetitors](https://protectai.github.io/llm-guard/input_scanners/ban_competitors/)
+- [BanSubstrings](https://protectai.github.io/llm-guard/input_scanners/ban_substrings/)
+- [BanTopics](https://protectai.github.io/llm-guard/input_scanners/ban_topics/)
+- [Code](https://protectai.github.io/llm-guard/input_scanners/code/)
+- [Gibberish](https://protectai.github.io/llm-guard/input_scanners/gibberish/)
+- [InvisibleText](https://protectai.github.io/llm-guard/input_scanners/invisible_text/)
+- [Language](https://protectai.github.io/llm-guard/input_scanners/language/)
+- [PromptInjection](https://protectai.github.io/llm-guard/input_scanners/prompt_injection/)
+- [Regex](https://protectai.github.io/llm-guard/input_scanners/regex/)
+- [Secrets](https://protectai.github.io/llm-guard/input_scanners/secrets/)
+- [Sentiment](https://protectai.github.io/llm-guard/input_scanners/sentiment/)
+- [TokenLimit](https://protectai.github.io/llm-guard/input_scanners/token_limit/)
+- [Toxicity](https://protectai.github.io/llm-guard/input_scanners/toxicity/)
+
+### Output scanners
+
+- [ATRScanner](./docs/output_scanners/atr.md) ⭐ **NEW**
+- [BanCode](./docs/output_scanners/ban_code.md)
+- [BanCompetitors](https://protectai.github.io/llm-guard/output_scanners/ban_competitors/)
+- [BanSubstrings](https://protectai.github.io/llm-guard/output_scanners/ban_substrings/)
+- [BanTopics](https://protectai.github.io/llm-guard/output_scanners/ban_topics/)
+- [Bias](https://protectai.github.io/llm-guard/output_scanners/bias/)
+- [Code](https://protectai.github.io/llm-guard/output_scanners/code/)
+- [Deanonymize](https://protectai.github.io/llm-guard/output_scanners/deanonymize/)
+- [JSON](https://protectai.github.io/llm-guard/output_scanners/json/)
+- [Language](https://protectai.github.io/llm-guard/output_scanners/language/)
+- [LanguageSame](https://protectai.github.io/llm-guard/output_scanners/language_same/)
+- [MaliciousURLs](https://protectai.github.io/llm-guard/output_scanners/malicious_urls/)
+- [NoRefusal](https://protectai.github.io/llm-guard/output_scanners/no_refusal/)
+- [ReadingTime](https://protectai.github.io/llm-guard/output_scanners/reading_time/)
+- [FactualConsistency](https://protectai.github.io/llm-guard/output_scanners/factual_consistency/)
+- [Gibberish](https://protectai.github.io/llm-guard/output_scanners/gibberish/)
+- [Regex](https://protectai.github.io/llm-guard/output_scanners/regex/)
+- [Relevance](https://protectai.github.io/llm-guard/output_scanners/relevance/)
+- [Sensitive](https://protectai.github.io/llm-guard/output_scanners/sensitive/)
+- [Sentiment](https://protectai.github.io/llm-guard/output_scanners/sentiment/)
+- [Toxicity](https://protectai.github.io/llm-guard/output_scanners/toxicity/)
+- [URLReachability](https://protectai.github.io/llm-guard/output_scanners/url_reachability/)
+
+## Community, Contributing, Docs & Support
+
+LLM Guard Rails is an open source solution maintained as an active fork of the original LLM Guard project.
+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.
+
+### How We Differ
+
+- **Active Development**: We maintain and release updates more frequently than the original project
+- **Feature Requests Welcome**: We actively review and implement community feature requests
+- **Responsive Maintenance**: Issues and PRs receive timely reviews and updates
+
+### Recent Improvements & Updates
+
+**Security & Bug Fixes:**
+- ✅ Fixed CVE-2026-26007: Updated `presidio-anonymizer` to ≥2.2.362
+- ✅ Fixed critical transformers vulnerability (GHSA-phhr-52qp-3mj4)
+- ✅ Fixed Anonymize scanner to properly respect language parameter (#337)
+- ✅ Fixed PromptInjection tokenizer initialization bug (#331)
+- ✅ Fixed MaliciousURLs missing top_k parameter TypeError (#318)
+
+**New Features & Enhancements:**
+- ✅ **Python 3.13+ Support**: Full compatibility with Python 3.13 and 3.14
+- ✅ **ATRScanner**: New Agent Threat Rule scanner with 10+ built-in detection patterns
+- ✅ **ThresholdMixin**: Dynamically adjust scanner sensitivity without model reloading
+- ✅ **Model.from_local()**: Factory method for locally-downloaded HuggingFace models
+- ✅ Improved dependency management for better compatibility
+
+### Get Involved
+
+- 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](./docs/index.md)
+  for more info about how to use and customize LLM Guard Rails, and for step-by-step tutorials.
+- Post a [Github Issue](https://github.com/Nikhilsinghbora/llm-guardrails/issues) to submit a bug report, feature request, or suggest an improvement.
+- To contribute to the package, check out our [contribution guidelines](CONTRIBUTING.md), and open a PR.
+
+### Support & Contact
+
+We're eager to provide personalized assistance and discuss feature requests or improvements.
+
+- [Send Email ✉️](mailto:nikhilsinghbora17@gmail.com) - Open to feature requests, improvements, and collaboration
+- [GitHub Issues](https://github.com/Nikhilsinghbora/llm-guardrails/issues) - Report bugs or request features

llm_guardrails_maintained-0.3.17/llm_guard/__init__.py

@@ -0,0 +1,4 @@
+"""LLM Guard package"""
+from __future__ import annotations
+
+from .evaluate import scan_output, scan_prompt

llm_guardrails_maintained-0.3.17/llm_guard/evaluate.py

@@ -0,0 +1,127 @@
+from __future__ import annotations
+
+import time
+
+from .input_scanners.base import Scanner as InputScanner
+from .output_scanners.base import Scanner as OutputScanner
+from .util import get_logger
+
+"""
+This file contains main functionality for scanning both prompts and outputs of Large Language Models (LLMs).
+There are two primary functions: 'scan_prompt' and 'scan_output'.
+Each function takes a list of scanner objects and applies each scanner to the input string(s).
+
+An Scanner in this context is an object of a class that inherits from either `input_scanners.Scanner` or `output_scanners.Scanner` base classes.
+These base classes define an `scan` method that takes in a string and returns a processed string and a boolean value indicating the validity of the input string.
+
+These functions return the processed string after all scanners have been applied, along with a dictionary mapping the name of each scanner to its validity result.
+"""
+
+LOGGER = get_logger()
+
+
+def scan_prompt(
+    scanners: list[InputScanner], prompt: str, fail_fast: bool = False
+) -> tuple[str, dict[str, bool], dict[str, float]]:
+    """
+    Scans a given prompt using the provided scanners.
+
+    Args:
+        scanners: A list of scanner objects. Each scanner should be an instance of a class that inherits from `Scanner`.
+        prompt: The input prompt string to be scanned.
+        fail_fast: A boolean value indicating whether to stop scanning after the first scanner fails.
+
+    Returns:
+        A tuple containing:
+            - The processed prompt string after applying all scanners.
+            - A dictionary mapping scanner names to boolean values indicating whether the input prompt is valid according to each scanner.
+            - A dictionary mapping scanner names to float values of risk scores, where 0 is no risk, and 1 is high risk.
+    """
+
+    sanitized_prompt = prompt
+    results_valid = {}
+    results_score = {}
+
+    if len(scanners) == 0 or prompt is None or prompt.strip() == "":
+        return sanitized_prompt, results_valid, results_score
+
+    start_time = time.time()
+    for scanner in scanners:
+        start_time_scanner = time.time()
+        sanitized_prompt, is_valid, risk_score = scanner.scan(sanitized_prompt)
+        elapsed_time_scanner = time.time() - start_time_scanner
+
+        LOGGER.debug(
+            "Scanner completed",
+            scanner=type(scanner).__name__,
+            is_valid=is_valid,
+            elapsed_time_seconds=round(elapsed_time_scanner, 6),
+        )
+
+        results_valid[type(scanner).__name__] = is_valid
+        results_score[type(scanner).__name__] = risk_score
+        if fail_fast and not is_valid:
+            break
+
+    elapsed_time = time.time() - start_time
+    LOGGER.info(
+        "Scanned prompt",
+        scores=results_score,
+        elapsed_time_seconds=round(elapsed_time, 6),
+    )
+
+    return sanitized_prompt, results_valid, results_score
+
+
+def scan_output(
+    scanners: list[OutputScanner], prompt: str, output: str, fail_fast: bool = False
+) -> tuple[str, dict[str, bool], dict[str, float]]:
+    """
+    Scans a given output of a large language model using the provided scanners.
+
+    Args:
+        scanners: A list of scanner objects. Each scanner should be an instance of a class that inherits from `Scanner`.
+        prompt: The input prompt string that produced the output.
+        output: The output string to be scanned.
+        fail_fast: A boolean value indicating whether to stop scanning after the first scanner fails.
+
+    Returns:
+        A tuple containing:
+            - The processed output string after applying all scanners.
+            - A dictionary mapping scanner names to boolean values indicating whether the output is valid according to each scanner.
+            - A dictionary mapping scanner names to float values of risk scores, where 0 is no risk, and 1 is high risk.
+    """
+
+    sanitized_output = output
+    results_valid = {}
+    results_score = {}
+
+    if len(scanners) == 0 or output is None or output.strip() == "":
+        return sanitized_output, results_valid, results_score
+
+    start_time = time.time()
+    for scanner in scanners:
+        start_time_scanner = time.time()
+        sanitized_output, is_valid, risk_score = scanner.scan(prompt, sanitized_output)
+        elapsed_time_scanner = time.time() - start_time_scanner
+
+        LOGGER.debug(
+            "Scanner completed",
+            scanner=type(scanner).__name__,
+            is_valid=is_valid,
+            elapsed_time_seconds=round(elapsed_time_scanner, 6),
+        )
+
+        results_valid[type(scanner).__name__] = is_valid
+        results_score[type(scanner).__name__] = risk_score
+        if fail_fast and not is_valid:
+            break
+
+    elapsed_time = time.time() - start_time
+    LOGGER.info(
+        "Scanned output",
+        scores=results_score,
+        elapsed_time_seconds=round(elapsed_time, 6),
+    )
+
+    return sanitized_output, results_valid, results_score

llm_guardrails_maintained-0.3.17/llm_guard/exception.py

@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+class LLMGuardValidationError(ValueError):
+    pass

llm_guardrails_maintained-0.3.17/llm_guard/input_scanners/__init__.py

@@ -0,0 +1,42 @@
+"""Input scanners init"""
+from __future__ import annotations
+
+from .anonymize import Anonymize
+from .atr import ATRScanner
+from .ban_code import BanCode
+from .ban_competitors import BanCompetitors
+from .ban_substrings import BanSubstrings
+from .ban_topics import BanTopics
+from .code import Code
+from .emotion_detection import EmotionDetection
+from .gibberish import Gibberish
+from .invisible_text import InvisibleText
+from .language import Language
+from .prompt_injection import PromptInjection
+from .regex import Regex
+from .secrets import Secrets
+from .sentiment import Sentiment
+from .token_limit import TokenLimit
+from .toxicity import Toxicity
+from .util import get_scanner_by_name
+
+__all__ = [
+    "Anonymize",
+    "ATRScanner",
+    "BanCode",
+    "BanCompetitors",
+    "BanSubstrings",
+    "BanTopics",
+    "Code",
+    "EmotionDetection",
+    "Gibberish",
+    "InvisibleText",
+    "Language",
+    "PromptInjection",
+    "Regex",
+    "Secrets",
+    "Sentiment",
+    "TokenLimit",
+    "Toxicity",
+    "get_scanner_by_name",
+]