Spaces:
Running
Running
File size: 9,291 Bytes
d631808 |
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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
from __future__ import annotations
import inspect
from collections.abc import Awaitable
from dataclasses import dataclass
from typing import TYPE_CHECKING, Any, Callable, Generic, Union, overload
from typing_extensions import TypeVar
from .exceptions import UserError
from .items import TResponseInputItem
from .run_context import RunContextWrapper, TContext
from .util._types import MaybeAwaitable
if TYPE_CHECKING:
from .agent import Agent
@dataclass
class GuardrailFunctionOutput:
"""The output of a guardrail function."""
output_info: Any
"""
Optional information about the guardrail's output. For example, the guardrail could include
information about the checks it performed and granular results.
"""
tripwire_triggered: bool
"""
Whether the tripwire was triggered. If triggered, the agent's execution will be halted.
"""
@dataclass
class InputGuardrailResult:
"""The result of a guardrail run."""
guardrail: InputGuardrail[Any]
"""
The guardrail that was run.
"""
output: GuardrailFunctionOutput
"""The output of the guardrail function."""
@dataclass
class OutputGuardrailResult:
"""The result of a guardrail run."""
guardrail: OutputGuardrail[Any]
"""
The guardrail that was run.
"""
agent_output: Any
"""
The output of the agent that was checked by the guardrail.
"""
agent: Agent[Any]
"""
The agent that was checked by the guardrail.
"""
output: GuardrailFunctionOutput
"""The output of the guardrail function."""
@dataclass
class InputGuardrail(Generic[TContext]):
"""Input guardrails are checks that run in parallel to the agent's execution.
They can be used to do things like:
- Check if input messages are off-topic
- Take over control of the agent's execution if an unexpected input is detected
You can use the `@input_guardrail()` decorator to turn a function into an `InputGuardrail`, or
create an `InputGuardrail` manually.
Guardrails return a `GuardrailResult`. If `result.tripwire_triggered` is `True`, the agent
execution will immediately stop and a `InputGuardrailTripwireTriggered` exception will be raised
"""
guardrail_function: Callable[
[RunContextWrapper[TContext], Agent[Any], str | list[TResponseInputItem]],
MaybeAwaitable[GuardrailFunctionOutput],
]
"""A function that receives the agent input and the context, and returns a
`GuardrailResult`. The result marks whether the tripwire was triggered, and can optionally
include information about the guardrail's output.
"""
name: str | None = None
"""The name of the guardrail, used for tracing. If not provided, we'll use the guardrail
function's name.
"""
def get_name(self) -> str:
if self.name:
return self.name
return self.guardrail_function.__name__
async def run(
self,
agent: Agent[Any],
input: str | list[TResponseInputItem],
context: RunContextWrapper[TContext],
) -> InputGuardrailResult:
if not callable(self.guardrail_function):
raise UserError(f"Guardrail function must be callable, got {self.guardrail_function}")
output = self.guardrail_function(context, agent, input)
if inspect.isawaitable(output):
return InputGuardrailResult(
guardrail=self,
output=await output,
)
return InputGuardrailResult(
guardrail=self,
output=output,
)
@dataclass
class OutputGuardrail(Generic[TContext]):
"""Output guardrails are checks that run on the final output of an agent.
They can be used to do check if the output passes certain validation criteria
You can use the `@output_guardrail()` decorator to turn a function into an `OutputGuardrail`,
or create an `OutputGuardrail` manually.
Guardrails return a `GuardrailResult`. If `result.tripwire_triggered` is `True`, a
`OutputGuardrailTripwireTriggered` exception will be raised.
"""
guardrail_function: Callable[
[RunContextWrapper[TContext], Agent[Any], Any],
MaybeAwaitable[GuardrailFunctionOutput],
]
"""A function that receives the final agent, its output, and the context, and returns a
`GuardrailResult`. The result marks whether the tripwire was triggered, and can optionally
include information about the guardrail's output.
"""
name: str | None = None
"""The name of the guardrail, used for tracing. If not provided, we'll use the guardrail
function's name.
"""
def get_name(self) -> str:
if self.name:
return self.name
return self.guardrail_function.__name__
async def run(
self, context: RunContextWrapper[TContext], agent: Agent[Any], agent_output: Any
) -> OutputGuardrailResult:
if not callable(self.guardrail_function):
raise UserError(f"Guardrail function must be callable, got {self.guardrail_function}")
output = self.guardrail_function(context, agent, agent_output)
if inspect.isawaitable(output):
return OutputGuardrailResult(
guardrail=self,
agent=agent,
agent_output=agent_output,
output=await output,
)
return OutputGuardrailResult(
guardrail=self,
agent=agent,
agent_output=agent_output,
output=output,
)
TContext_co = TypeVar("TContext_co", bound=Any, covariant=True)
# For InputGuardrail
_InputGuardrailFuncSync = Callable[
[RunContextWrapper[TContext_co], "Agent[Any]", Union[str, list[TResponseInputItem]]],
GuardrailFunctionOutput,
]
_InputGuardrailFuncAsync = Callable[
[RunContextWrapper[TContext_co], "Agent[Any]", Union[str, list[TResponseInputItem]]],
Awaitable[GuardrailFunctionOutput],
]
@overload
def input_guardrail(
func: _InputGuardrailFuncSync[TContext_co],
) -> InputGuardrail[TContext_co]: ...
@overload
def input_guardrail(
func: _InputGuardrailFuncAsync[TContext_co],
) -> InputGuardrail[TContext_co]: ...
@overload
def input_guardrail(
*,
name: str | None = None,
) -> Callable[
[_InputGuardrailFuncSync[TContext_co] | _InputGuardrailFuncAsync[TContext_co]],
InputGuardrail[TContext_co],
]: ...
def input_guardrail(
func: _InputGuardrailFuncSync[TContext_co]
| _InputGuardrailFuncAsync[TContext_co]
| None = None,
*,
name: str | None = None,
) -> (
InputGuardrail[TContext_co]
| Callable[
[_InputGuardrailFuncSync[TContext_co] | _InputGuardrailFuncAsync[TContext_co]],
InputGuardrail[TContext_co],
]
):
"""
Decorator that transforms a sync or async function into an `InputGuardrail`.
It can be used directly (no parentheses) or with keyword args, e.g.:
@input_guardrail
def my_sync_guardrail(...): ...
@input_guardrail(name="guardrail_name")
async def my_async_guardrail(...): ...
"""
def decorator(
f: _InputGuardrailFuncSync[TContext_co] | _InputGuardrailFuncAsync[TContext_co],
) -> InputGuardrail[TContext_co]:
return InputGuardrail(guardrail_function=f, name=name)
if func is not None:
# Decorator was used without parentheses
return decorator(func)
# Decorator used with keyword arguments
return decorator
_OutputGuardrailFuncSync = Callable[
[RunContextWrapper[TContext_co], "Agent[Any]", Any],
GuardrailFunctionOutput,
]
_OutputGuardrailFuncAsync = Callable[
[RunContextWrapper[TContext_co], "Agent[Any]", Any],
Awaitable[GuardrailFunctionOutput],
]
@overload
def output_guardrail(
func: _OutputGuardrailFuncSync[TContext_co],
) -> OutputGuardrail[TContext_co]: ...
@overload
def output_guardrail(
func: _OutputGuardrailFuncAsync[TContext_co],
) -> OutputGuardrail[TContext_co]: ...
@overload
def output_guardrail(
*,
name: str | None = None,
) -> Callable[
[_OutputGuardrailFuncSync[TContext_co] | _OutputGuardrailFuncAsync[TContext_co]],
OutputGuardrail[TContext_co],
]: ...
def output_guardrail(
func: _OutputGuardrailFuncSync[TContext_co]
| _OutputGuardrailFuncAsync[TContext_co]
| None = None,
*,
name: str | None = None,
) -> (
OutputGuardrail[TContext_co]
| Callable[
[_OutputGuardrailFuncSync[TContext_co] | _OutputGuardrailFuncAsync[TContext_co]],
OutputGuardrail[TContext_co],
]
):
"""
Decorator that transforms a sync or async function into an `OutputGuardrail`.
It can be used directly (no parentheses) or with keyword args, e.g.:
@output_guardrail
def my_sync_guardrail(...): ...
@output_guardrail(name="guardrail_name")
async def my_async_guardrail(...): ...
"""
def decorator(
f: _OutputGuardrailFuncSync[TContext_co] | _OutputGuardrailFuncAsync[TContext_co],
) -> OutputGuardrail[TContext_co]:
return OutputGuardrail(guardrail_function=f, name=name)
if func is not None:
# Decorator was used without parentheses
return decorator(func)
# Decorator used with keyword arguments
return decorator
|