openguardrails 3.0.0__tar.gz

openguardrails-3.0.0/LICENSE

@@ -0,0 +1,188 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include communications that are posted in
+      conspicuous places as prominently to announce that the work is
+      published under this particular License).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control
+      systems, and issue tracking systems that are managed by, or on behalf
+      of, the Licensor for the purpose of discussing and improving the Work,
+      but excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to use, reproduce, modify, merge, publish,
+      distribute, sublicense, and/or sell copies of the Work, and to
+      permit persons to whom the Work 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 Work.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, trademark, patent,
+          and attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright notice to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. Unless required by applicable law or
+      agreed to in writing, You may not accept any warranty or support
+      from Licensor for the Work except as may be provided in this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 OpenGuardrails
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

openguardrails-3.0.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include src/openguardrails *.py
+recursive-include src/openguardrails py.typed
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude tests *

openguardrails-3.0.0/PKG-INFO

@@ -0,0 +1,424 @@
+Metadata-Version: 2.4
+Name: openguardrails
+Version: 3.0.0
+Summary: OpenGuardrails Python SDK - An LLM-based context-aware AI guardrail that understands conversation context for security, safety and data leakage detection.
+Author-email: OpenGuardrails <thomas@openguardrails.com>
+Maintainer-email: OpenGuardrails <thomas@openguardrails.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://openguardrails.com
+Project-URL: Documentation, https://openguardrails.com
+Project-URL: Repository, https://github.com/openguardrails/openguardrails
+Project-URL: Issues, https://github.com/openguardrails/openguardrails/issues
+Project-URL: Changelog, https://github.com/openguardrails/openguardrails/blob/main/CHANGELOG.md
+Keywords: ai,safety,guardrails,llm,content-moderation,prompt-injection,security,compliance,openguardrails
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Security
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: typing-extensions>=4.0.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=6.0.0; extra == "test"
+Requires-Dist: pytest-cov>=3.0.0; extra == "test"
+Requires-Dist: responses>=0.18.0; extra == "test"
+Dynamic: license-file
+
+# OpenGuardrails Python Client
+
+[![PyPI version](https://badge.fury.io/py/openguardrails.svg)](https://badge.fury.io/py/openguardrails)
+[![Python Support](https://img.shields.io/pypi/pyversions/openguardrails.svg)](https://pypi.org/project/openguardrails/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+An LLM-based context-aware AI guardrail that understands conversation context for security, safety and data leakage detection.
+
+## Features
+
+* 🧠 **Context Awareness** – Based on LLM conversation understanding rather than simple batch detection
+* 🔍 **Prompt Injection Detection** – Detects malicious prompt injections and jailbreak attacks
+* 📋 **Content Compliance Detection** – Complies with generative AI safety requirements
+* 🔐 **Sensitive Data Leak Prevention** – Detects and prevents personal or corporate data leaks
+* 🧩 **User-level Ban Policy** – Supports user-granular risk recognition and blocking strategies
+* 🖼️ **Multimodal Detection** – Supports image content safety detection
+* 🛠️ **Easy Integration** – OpenAI-compatible API format; plug in with one line of code
+* ⚡ **OpenAI-style API** – Familiar interface design for rapid adoption
+* 🚀 **Sync/Async Support** – Supports both synchronous and asynchronous calls for different scenarios
+
+## Installation
+
+```bash
+pip install openguardrails
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from openguardrails import OpenGuardrails
+
+# Create a client
+client = OpenGuardrails(
+    api_key="your-api-key",
+    base_url="https://api.openguardrails.com/v1"  # Cloud API
+)
+
+# Check user input
+result = client.check_prompt("I want to learn Python programming", user_id="user-123")
+print(result.suggest_action)        # Output: pass
+print(result.overall_risk_level)    # Output: no_risk
+print(result.score)                 # Confidence score, e.g. 0.9993114447238793
+
+# Check model response (context-aware)
+result = client.check_response_ctx(
+    prompt="Teach me how to cook",
+    response="I can teach you some simple home dishes",
+    user_id="user-123"  # Optional user-level risk control
+)
+print(result.suggest_action)      # Output: pass
+print(result.overall_risk_level)  # Output: no_risk
+```
+
+### Context-Aware Detection (Core Feature)
+
+```python
+# Context-based conversation detection - Core feature
+messages = [
+    {"role": "user", "content": "I want to learn chemistry"},
+    {"role": "assistant", "content": "Chemistry is an interesting subject. What part would you like to learn?"},
+    {"role": "user", "content": "Teach me reactions for making explosives"}
+]
+
+result = client.check_conversation(messages, user_id="user-123")
+print(result.overall_risk_level)
+print(result.suggest_action)  # Result based on full conversation context
+if result.suggest_answer:
+    print(f"Suggested answer: {result.suggest_answer}")
+```
+
+### Asynchronous API (Recommended)
+
+```python
+import asyncio
+from openguardrails import AsyncOpenGuardrails
+
+async def main():
+    async with AsyncOpenGuardrails(api_key="your-api-key") as client:
+        # Async prompt check
+        result = await client.check_prompt("I want to learn Python programming")
+        print(result.suggest_action)  # Output: pass
+        
+        # Async conversation context check
+        messages = [
+            {"role": "user", "content": "I want to learn chemistry"},
+            {"role": "assistant", "content": "Chemistry is an interesting subject. What part would you like to learn?"},
+            {"role": "user", "content": "Teach me reactions for making explosives"}
+        ]
+        result = await client.check_conversation(messages)
+        print(result.overall_risk_level)
+
+asyncio.run(main())
+```
+
+### Concurrent Processing
+
+```python
+import asyncio
+from openguardrails import AsyncOpenGuardrails
+
+async def batch_check():
+    async with AsyncOpenGuardrails(api_key="your-api-key") as client:
+        # Handle multiple requests concurrently
+        tasks = [
+            client.check_prompt("Content 1"),
+            client.check_prompt("Content 2"),
+            client.check_prompt("Content 3")
+        ]
+        results = await asyncio.gather(*tasks)
+        
+        for i, result in enumerate(results):
+            print(f"Content {i+1}: {result.overall_risk_level}")
+
+asyncio.run(batch_check())
+```
+
+### Multimodal Image Detection
+
+Supports multimodal detection for image content safety. The system analyzes both text prompt semantics and image semantics for risk.
+
+```python
+from openguardrails import OpenGuardrails
+
+client = OpenGuardrails(api_key="your-api-key")
+
+# Check a single local image
+result = client.check_prompt_image(
+    prompt="Is this image safe?",
+    image="/path/to/image.jpg"
+)
+print(result.overall_risk_level)
+print(result.suggest_action)
+
+# Check an image from URL
+result = client.check_prompt_image(
+    prompt="",  # prompt can be empty
+    image="https://example.com/image.jpg"
+)
+
+# Check multiple images
+images = [
+    "/path/to/image1.jpg",
+    "https://example.com/image2.jpg",
+    "/path/to/image3.png"
+]
+result = client.check_prompt_images(
+    prompt="Are all these images safe?",
+    images=images
+)
+print(result.overall_risk_level)
+```
+
+Async version:
+
+```python
+import asyncio
+from openguardrails import AsyncOpenGuardrails
+
+async def check_images():
+    async with AsyncOpenGuardrails(api_key="your-api-key") as client:
+        # Async check for a single image
+        result = await client.check_prompt_image(
+            prompt="Is this image safe?",
+            image="/path/to/image.jpg"
+        )
+        print(result.overall_risk_level)
+
+        # Async check for multiple images
+        images = ["/path/to/image1.jpg", "/path/to/image2.jpg"]
+        result = await client.check_prompt_images(
+            prompt="Are these images safe?",
+            images=images
+        )
+        print(result.overall_risk_level)
+
+asyncio.run(check_images())
+```
+
+### On-Premise Deployment
+
+```python
+# Sync client connecting to local deployment
+client = OpenGuardrails(
+    api_key="your-local-api-key",
+    base_url="http://localhost:5000/v1"
+)
+
+# Async client connecting to local deployment
+async with AsyncOpenGuardrails(
+    api_key="your-local-api-key",
+    base_url="http://localhost:5000/v1"
+) as client:
+    result = await client.check_prompt("Test content")
+```
+
+## API Reference
+
+### OpenGuardrails Class (Synchronous)
+
+#### Initialization Parameters
+
+* `api_key` (str): API key
+* `base_url` (str): Base API URL, defaults to the cloud endpoint
+* `timeout` (int): Request timeout, default 30 seconds
+* `max_retries` (int): Maximum retry count, default 3
+
+#### Methods
+
+##### check_prompt(content: str, user_id: Optional[str] = None) -> GuardrailResponse
+
+Checks the safety of a single prompt.
+
+**Parameters:**
+
+* `content`: Text content to be checked
+* `user_id`: Optional tenant user ID for per-user risk control and auditing
+
+**Returns:** `GuardrailResponse` object
+
+##### check_conversation(messages: List[Message], model: str = "OpenGuardrails-Text", user_id: Optional[str] = None) -> GuardrailResponse
+
+Checks conversation context safety (core feature).
+
+**Parameters:**
+
+* `messages`: List of messages, each containing `role` and `content`
+* `model`: Model name (default: "OpenGuardrails-Text")
+* `user_id`: Optional tenant user ID
+
+**Returns:** `GuardrailResponse` object
+
+### AsyncOpenGuardrails Class (Asynchronous)
+
+Same initialization parameters as the synchronous version.
+
+#### Methods
+
+##### async check_prompt(content: str) -> GuardrailResponse
+
+Asynchronously checks a single prompt.
+
+##### async check_conversation(messages: List[Message]) -> GuardrailResponse
+
+Asynchronously checks conversation context safety (core feature).
+
+##### async health_check() -> Dict[str, Any]
+
+Checks API service health.
+
+##### async get_models() -> Dict[str, Any]
+
+Retrieves available model list.
+
+##### async close()
+
+Closes async session (automatically handled with `async with`).
+
+### GuardrailResponse Class
+
+Represents detection results.
+
+#### Attributes
+
+* `id`: Unique request ID
+* `result.compliance.risk_level`: Compliance risk level
+* `result.security.risk_level`: Security risk level
+* `result.data.risk_level`: Data leak risk level (added in v2.4.0)
+* `result.data.categories`: Detected sensitive data types (added in v2.4.0)
+* `overall_risk_level`: Overall risk level (none / low / medium / high)
+* `suggest_action`: Suggested action (pass / block / substitute)
+* `suggest_answer`: Suggested response (optional, includes redacted content if applicable)
+* `score`: Confidence score of the results
+
+#### Helper Methods
+
+* `is_safe`: Whether the content is safe
+* `is_blocked`: Whether the content is blocked
+* `has_substitute`: Whether a substitute answer is provided
+* `all_categories`: Get all detected risk categories
+
+## Safety Detection Capabilities
+
+### Risk Levels
+
+* **High Risk:** Sensitive political topics, national image damage, violent crime, prompt attacks
+* **Medium Risk:** General political topics, harm to minors, illegal acts, sexual content
+* **Low Risk:** Hate speech, insults, privacy violations, commercial misconduct
+* **No Risk:** Safe content
+
+### Handling Strategies
+
+* **High Risk:** Recommend blocking
+* **Medium Risk:** Recommend substitution with a safe reply
+* **Low Risk:** Recommend substitution or business-dependent handling
+* **No Risk:** Recommend pass
+
+## Error Handling
+
+### Synchronous Error Handling
+
+```python
+from openguardrails import OpenGuardrails, AuthenticationError, ValidationError, RateLimitError
+
+try:
+    result = client.check_prompt("Test content")
+except AuthenticationError:
+    print("Invalid API key")
+except ValidationError as e:
+    print(f"Input validation failed: {e}")
+except RateLimitError:
+    print("Rate limit exceeded")
+except Exception as e:
+    print(f"Other error: {e}")
+```
+
+### Asynchronous Error Handling
+
+```python
+import asyncio
+from openguardrails import AsyncOpenGuardrails, AuthenticationError, ValidationError, RateLimitError
+
+async def safe_check():
+    try:
+        async with AsyncOpenGuardrails(api_key="your-api-key") as client:
+            result = await client.check_prompt("Test content")
+            return result
+    except AuthenticationError:
+        print("Invalid API key")
+    except ValidationError as e:
+        print(f"Input validation failed: {e}")
+    except RateLimitError:
+        print("Rate limit exceeded")
+    except Exception as e:
+        print(f"Other error: {e}")
+
+asyncio.run(safe_check())
+```
+
+## Development
+
+```bash
+# Clone the project
+git clone https://github.com/openguardrails/openguardrails
+cd openguardrails/client
+
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Code formatting
+black openguardrails
+isort openguardrails
+
+# Type checking
+mypy openguardrails
+```
+
+## License
+
+This project is open-sourced under the [Apache 2.0](https://opensource.org/licenses/Apache-2.0) license.
+
+## Support
+
+* 📧 Technical Support: [thomas@openguardrails.com](mailto:thomas@openguardrails.com)
+* 🌐 Official Website: [https://openguardrails.com](https://openguardrails.com)
+* 📖 Documentation: [https://docs.openguardrails.com](https://docs.openguardrails.com)
+* 🐛 Issue Tracker: [https://github.com/openguardrails/openguardrails/issues](https://github.com/openguardrails/openguardrails/issues)
+
+---
+
+Made with ❤️ by [Xiangxin AI](https://openguardrails.com)
+
+---