Guardrails#
ragbits.guardrails.base.Guardrail
#
Bases: ABC
Abstract class representing guardrail
verify
abstractmethod
async
#
verify(input_to_verify: Prompt | str) -> GuardrailVerificationResult
Verifies whether provided input meets certain criteria
PARAMETER | DESCRIPTION |
---|---|
input_to_verify |
prompt or output of the model to check
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuardrailVerificationResult
|
verification result |
Source code in packages/ragbits-guardrails/src/ragbits/guardrails/base.py
ragbits.guardrails.base.GuardrailManager
#
GuardrailManager(guardrails: list[Guardrail])
Class responsible for running guardrails
Source code in packages/ragbits-guardrails/src/ragbits/guardrails/base.py
verify
async
#
verify(input_to_verify: Prompt | str) -> list[GuardrailVerificationResult]
Verifies whether provided input meets certain criteria
PARAMETER | DESCRIPTION |
---|---|
input_to_verify |
prompt or output of the model to check
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
list[GuardrailVerificationResult]
|
list of verification result |
Source code in packages/ragbits-guardrails/src/ragbits/guardrails/base.py
ragbits.guardrails.base.GuardrailVerificationResult
#
ragbits.guardrails.openai_moderation.OpenAIModerationGuardrail
#
Bases: Guardrail
Guardrail based on OpenAI moderation
Source code in packages/ragbits-guardrails/src/ragbits/guardrails/openai_moderation.py
verify
async
#
verify(input_to_verify: Prompt | str) -> GuardrailVerificationResult
Verifies whether provided input meets certain criteria
PARAMETER | DESCRIPTION |
---|---|
input_to_verify |
prompt or output of the model to check
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
GuardrailVerificationResult
|
verification result |