update: docs

docs/guardrails/secrets_detection.md

@@ -0,0 +1,3 @@
+# Secrets Detection
+
+::: guardrails_genie.guardrails.secrets_detection.secrets_detection

guardrails_genie/guardrails/__init__.py

@@ -1,14 +1,15 @@
 from guardrails_genie.guardrails.entity_recognition import (
     PresidioEntityRecognitionGuardrail,
     RegexEntityRecognitionGuardrail,
-    TransformersEntityRecognitionGuardrail,
     RestrictedTermsJudge,
+    TransformersEntityRecognitionGuardrail,
 )
 from guardrails_genie.guardrails.injection import (
     PromptInjectionClassifierGuardrail,
     PromptInjectionSurveyGuardrail,
 )
 from guardrails_genie.guardrails.secrets_detection import SecretsDetectionGuardrail
+
 from .manager import GuardrailManager
 
 __all__ = [

guardrails_genie/guardrails/secrets_detection/__init__.py

@@ -1,9 +1,9 @@
 from guardrails_genie.guardrails.secrets_detection.secrets_detection import (
     DEFAULT_SECRETS_PATTERNS,
+    REDACTION,
     SecretsDetectionGuardrail,
-    SecretsDetectionSimpleResponse,
     SecretsDetectionResponse,
-    REDACTION,
+    SecretsDetectionSimpleResponse,
     redact,
 )
 

guardrails_genie/guardrails/secrets_detection/secrets_detection.py

@@ -2,7 +2,7 @@ import hashlib
 import json
 import pathlib
 from enum import Enum
-from typing import Union, Optional
+from typing import Optional, Union
 
 import weave
 from pydantic import BaseModel

guardrails_genie/regex_model.py

@@ -1,4 +1,4 @@
-from typing import Union, Optional
+from typing import Optional, Union
 
 import regex as re
 import weave
@@ -13,11 +13,12 @@ class RegexResult(BaseModel):
 
 class RegexModel(weave.Model):
     """
-        Initialize RegexModel with a dictionary of patterns.
+    Initialize RegexModel with a dictionary of patterns.
 
-        Args:
-            patterns (Dict[str, str]): Dictionary where key is pattern name and value is regex pattern.
+    Args:
+        patterns (Dict[str, str]): Dictionary where key is pattern name and value is regex pattern.
     """
+
     patterns: Optional[Union[dict[str, str], dict[str, list[str]]]] = None
 
     def __init__(

mkdocs.yml

@@ -73,6 +73,7 @@ nav:
     - Prompt Injection Guardrails:
       - Classifier Guardrail: 'guardrails/prompt_injection/classifier.md'
       - Survey Guardrail: 'guardrails/prompt_injection/llm_survey.md'
+    - Secrets Detection Guardrail: "guardrails/secrets_detection.md"
   - LLM: 'llm.md'
   - Metrics: 'metrics.md'
   - RegexModel: 'regex_model.md'

tests/guardrails_genie/guardrails/test_secrets_detection.py

@@ -2,14 +2,15 @@ import hashlib
 import re
 
 import pytest
-from hypothesis import given, strategies as st, settings
+from hypothesis import given, settings
+from hypothesis import strategies as st
 
 from guardrails_genie.guardrails.secrets_detection import (
     DEFAULT_SECRETS_PATTERNS,
-    SecretsDetectionSimpleResponse,
-    SecretsDetectionResponse,
-    SecretsDetectionGuardrail,
     REDACTION,
+    SecretsDetectionGuardrail,
+    SecretsDetectionResponse,
+    SecretsDetectionSimpleResponse,
     redact,
 )
 
@@ -86,8 +87,8 @@ def test_redact_no_match():
 
 def test_secrets_detection_guardrail_detect_types(mock_secrets_guard):
     from guardrails_genie.guardrails.secrets_detection import (
-        SecretsDetectionGuardrail,
         REDACTION,
+        SecretsDetectionGuardrail,
     )
 
     guardrail = SecretsDetectionGuardrail(redaction=REDACTION.REDACT_ALL)
@@ -103,8 +104,8 @@ def test_secrets_detection_guardrail_detect_types(mock_secrets_guard):
 
 def test_secrets_detection_guardrail_simple_response(mock_secrets_guard):
     from guardrails_genie.guardrails.secrets_detection import (
-        SecretsDetectionGuardrail,
         REDACTION,
+        SecretsDetectionGuardrail,
     )
 
     guardrail = SecretsDetectionGuardrail(redaction=REDACTION.REDACT_ALL)
@@ -119,8 +120,8 @@ def test_secrets_detection_guardrail_simple_response(mock_secrets_guard):
 
 def test_secrets_detection_guardrail_no_secrets(mock_secrets_guard):
     from guardrails_genie.guardrails.secrets_detection import (
-        SecretsDetectionGuardrail,
         REDACTION,
+        SecretsDetectionGuardrail,
     )
 
     guardrail = SecretsDetectionGuardrail(redaction=REDACTION.REDACT_ALL)