Refactored guardrails API code and supporting files

.env.example

@@ -6,9 +6,9 @@ PROJECT_NAME="Kaapi-Guardrails"
 STACK_NAME=Kaapi-Guardrails
 
 #Backend
-SECRET_KEY=changethis
+SECRET_KEY="<add-secret-key>"
 FIRST_SUPERUSER=superuser@example.com
-FIRST_SUPERUSER_PASSWORD=changethis
+FIRST_SUPERUSER_PASSWORD="<add-superuser-password>"
 EMAIL_TEST_USER="test@example.com"
 
 # API Base URL for cron scripts (defaults to http://localhost:8000 if not set)
@@ -32,6 +32,6 @@ CALLBACK_CONNECT_TIMEOUT=3
 CALLBACK_READ_TIMEOUT=10
 
 # require as a env if you want to use doc transformation
-OPENAI_API_KEY="<ADD-KEY>"
-GUARDRAILS_HUB_API_KEY="<ADD-KEY>"
-AUTH_TOKEN="<ADD-TOKEN>"
+OPENAI_API_KEY="<add-openai-key>"
+GUARDRAILS_HUB_API_KEY="<add-guardrails-hub-api-key>"
+AUTH_TOKEN="<add-auth-token>"

.env.test

@@ -6,9 +6,9 @@ PROJECT_NAME="Kaapi-Guardrails"
 STACK_NAME=Kaapi-Guardrails
 
 #Backend
-SECRET_KEY="<change-this>"
+SECRET_KEY="<add-secret-key>"
 FIRST_SUPERUSER=superuser@example.com
-FIRST_SUPERUSER_PASSWORD="<change-this>"
+FIRST_SUPERUSER_PASSWORD="<add-superuser-password>"
 EMAIL_TEST_USER="test@example.com"
 
 # API Base URL for cron scripts (defaults to http://localhost:8000 if not set)
@@ -32,6 +32,6 @@ CALLBACK_CONNECT_TIMEOUT=3
 CALLBACK_READ_TIMEOUT=10
 
 # require as a env if you want to use doc transformation
-OPENAI_API_KEY="<ADD-KEY>"
-GUARDRAILS_HUB_API_KEY="<ADD-KEY>"
-AUTH_TOKEN="<ADD-TOKEN>"
+OPENAI_API_KEY="<add-openai-key>"
+GUARDRAILS_HUB_API_KEY="<add-guardrails-hub-api-key>"
+AUTH_TOKEN="<add-auth-token>"

backend/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10
+FROM python:3.12
 
 ENV PYTHONUNBUFFERED=1
 

backend/app/api/deps.py

@@ -1,11 +1,11 @@
 from collections.abc import Generator
+import secrets
 from typing import Annotated
 
 from fastapi import Depends, Header, HTTPException, status, Security
 from fastapi.security import HTTPBearer, HTTPAuthorizationCredentials
 from sqlmodel import Session
 
-# from app.core import security
 from app.core.config import settings
 from app.core.db import engine
 
@@ -30,7 +30,7 @@ def verify_bearer_token(
 
     token = credentials.credentials
 
-    if token != settings.AUTH_TOKEN:
+    if not secrets.compare_digest(token, settings.AUTH_TOKEN):
         raise HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED,
             detail="Invalid token",

backend/app/api/main.py

@@ -4,7 +4,4 @@
 
 api_router = APIRouter()
 api_router.include_router(utils.router)
-api_router.include_router(guardrails.router)
-
-# if settings.ENVIRONMENT == "local":
-#     api_router.include_router(private.router)
+api_router.include_router(guardrails.router)

backend/app/api/routes/guardrails.py

@@ -1,14 +1,13 @@
 import uuid
 from uuid import UUID
-from fastapi import APIRouter, HTTPException, status
+from fastapi import APIRouter, status
 from fastapi.responses import JSONResponse
 
-from app.models.guardrail_config import GuardrailInputRequest, GuardrailOutputRequest
 from app.api.deps import AuthDep, SessionDep
 from app.core.api_response import APIResponse
 from app.core.guardrail_controller import build_guard, get_validator_config_models
-
 from app.crud.request_log import RequestLogCrud
+from app.models.guardrail_config import GuardrailInputRequest, GuardrailOutputRequest
 from app.models.request import  RequestLogUpdate
 
 router = APIRouter(prefix="/guardrails", tags=["guardrails"])

backend/app/api/routes/utils.py

@@ -1,5 +1,4 @@
 from fastapi import APIRouter
-from app.api.deps import AuthDep
 
 router = APIRouter(prefix="/utils", tags=["utils"])
 

backend/app/core/api_response.py

@@ -9,7 +9,7 @@ class APIResponse(BaseModel):
 
     @classmethod
     def success_response(cls, data: Any, metadata: Any = None):
-        return cls(success=True, data=data, metadata=metadata)
+        return cls(success=True, data=data).model_dump(exclude_none=True)
 
     @classmethod
     def failure_response(cls, error: Any, metadata: Any = None):

backend/app/core/validators/gender_assumption_bias.py

@@ -21,9 +21,11 @@ class GenderAssumptionBias(Validator):
 
     def __init__(
         self, 
-        categories: Optional[List[BiasCategories]] = [BiasCategories.All],
+        categories: Optional[List[BiasCategories]] = None,
         on_fail: Optional[Callable] = OnFailAction.FIX
     ):
+        if categories is None:
+            categories = [BiasCategories.All]
         self.gender_bias_list = self.load_gender_bias_list(categories)
         self.text = None
         super().__init__(on_fail=on_fail)

backend/app/crud/__init__.py

@@ -1 +1 @@
-from .request_log import RequestLogCrud
+from app.crud.request_log import RequestLogCrud

backend/app/models/__init__.py

@@ -1,5 +1,4 @@
 from sqlmodel import SQLModel
 
-from .request import RequestLog
-
-from .validator import ValidatorLog
+from app.models.request import RequestLog
+from app.models.validator import ValidatorLog