-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathguardrails.py
More file actions
190 lines (160 loc) · 5.99 KB
/
Copy pathguardrails.py
File metadata and controls
190 lines (160 loc) · 5.99 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
import uuid
from uuid import UUID
from fastapi import APIRouter
from guardrails.guard import Guard
from guardrails.validators import FailResult
from app.api.deps import AuthDep, SessionDep
from app.core.constants import REPHRASE_ON_FAIL_PREFIX
from app.core.guardrail_controller import build_guard, get_validator_config_models
from app.crud.request_log import RequestLogCrud
from app.crud.validator_log import ValidatorLogCrud
from app.models.guardrail_config import GuardrailRequest, GuardrailResponse
from app.models.logging.request import RequestLogUpdate, RequestStatus
from app.models.logging.validator import ValidatorLog, ValidatorOutcome
from app.utils import APIResponse
router = APIRouter(prefix="/guardrails", tags=["guardrails"])
@router.post(
"/validate/",
response_model=APIResponse[GuardrailResponse],
response_model_exclude_none=True)
async def validate_guardrails(
payload: GuardrailRequest,
session: SessionDep,
_: AuthDep,
):
request_log_crud = RequestLogCrud(session=session)
validator_log_crud = ValidatorLogCrud(session=session)
try:
request_id = UUID(payload.request_id)
except ValueError:
return APIResponse.failure_response(error="Invalid request_id")
request_log = request_log_crud.create(request_id, input_text=payload.input)
return await _validate_with_guard(
payload.input,
payload.validators,
request_log_crud,
request_log.id,
validator_log_crud,
)
@router.get("/validators/")
async def list_validators(_: AuthDep):
"""
Lists all validators and their parameters directly.
"""
validator_config_models = get_validator_config_models()
validators = []
for model in validator_config_models:
try:
schema = model.model_json_schema()
validator_type = schema["properties"]["type"]["const"]
validators.append({
"type": validator_type,
"config": schema,
})
except (KeyError, TypeError) as e:
return APIResponse.failure_response(
error=f"Failed to retrieve schema for validator {model.__name__}: {str(e)}",
)
return {"validators": validators}
async def _validate_with_guard(
data: str,
validators: list,
request_log_crud: RequestLogCrud,
request_log_id: UUID,
validator_log_crud: ValidatorLogCrud,
) -> APIResponse:
"""
Runs Guardrails validation on input/output data, persists request & validator logs,
and returns a structured APIResponse.
This function treats validation failures as first-class outcomes (not exceptions),
while still safely handling unexpected runtime errors.
"""
response_id = uuid.uuid4()
guard: Guard | None = None
def _finalize(
*,
status: RequestStatus,
validated_output: str | None = None,
error_message: str | None = None,
) -> APIResponse:
"""
Single exit-point helper to ensure:
- request logs are always updated
- validator logs are written when available
- API responses are consistent
"""
response_text = (
validated_output if validated_output is not None else error_message
)
if response_text is None:
response_text = "Validation failed"
request_log_crud.update(
request_log_id=request_log_id,
request_status=status,
request_log_update=RequestLogUpdate(
response_text=response_text,
response_id=response_id,
),
)
if guard is not None:
add_validator_logs(guard, request_log_id, validator_log_crud)
rephrase_needed = (
validated_output is not None
and validated_output.startswith(REPHRASE_ON_FAIL_PREFIX)
)
response_model = GuardrailResponse(
response_id=response_id,
rephrase_needed=rephrase_needed,
safe_text=validated_output,
)
if status == RequestStatus.SUCCESS:
return APIResponse.success_response(data=response_model)
return APIResponse.failure_response(
data=response_model,
error=response_text or "Validation failed",
)
try:
guard = build_guard(validators)
result = guard.validate(data)
# Case 1: validation passed OR failed-with-fix (on_fail=FIX)
if result.validated_output is not None:
return _finalize(
status=RequestStatus.SUCCESS,
validated_output=result.validated_output,
)
# Case 2: validation failed without a fix
return _finalize(
status=RequestStatus.ERROR,
error_message=str(result.error),
)
except Exception as exc:
# Case 3: unexpected system / runtime failure
return _finalize(
status=RequestStatus.ERROR,
error_message=str(exc),
)
def add_validator_logs(guard: Guard, request_log_id: UUID, validator_log_crud: ValidatorLogCrud):
history = getattr(guard, "history", None)
if not history:
return
last_call = getattr(history, "last", None)
if not last_call or not getattr(last_call, "iterations", None):
return
iteration = last_call.iterations[-1]
outputs = getattr(iteration, "outputs", None)
if not outputs or not getattr(outputs, "validator_logs", None):
return
for log in iteration.outputs.validator_logs:
result = log.validation_result
error_message = None
if isinstance(result, FailResult):
error_message = result.error_message
validator_log = ValidatorLog(
request_id=request_log_id,
name=log.validator_name,
input=str(log.value_before_validation),
output=log.value_after_validation,
error=error_message,
outcome=ValidatorOutcome(result.outcome.upper()),
)
validator_log_crud.create(log=validator_log)