GuardrailContentFilter¶
Structure Class¶
dataclass
¶
Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
-
Hate -- Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
-
Insults -- Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
-
Sexual -- Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
-
Violence -- Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
For more information, see Guardrails content filters.
This data type is used in the following API operations:
Attributes¶
class-attribute
instance-attribute
¶
input_action: GuardrailContentFilterAction | None = field(repr=False, default=None)
The action to take when harmful content is detected in the input. Supported values include:
-
BLOCK-- Block the content and replace it with blocked messaging. -
NONE-- Take no action but return detection information in the trace response.
class-attribute
instance-attribute
¶
input_enabled: bool | None = None
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
class-attribute
instance-attribute
¶
input_modalities: list[GuardrailModality] | None = None
The input modalities selected for the guardrail content filter.
instance-attribute
¶
input_strength: GuardrailFilterStrength
The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
class-attribute
instance-attribute
¶
output_action: GuardrailContentFilterAction | None = field(repr=False, default=None)
The action to take when harmful content is detected in the output. Supported values include:
-
BLOCK-- Block the content and replace it with blocked messaging. -
NONE-- Take no action but return detection information in the trace response.
class-attribute
instance-attribute
¶
output_enabled: bool | None = None
Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
class-attribute
instance-attribute
¶
output_modalities: list[GuardrailModality] | None = None
The output modalities selected for the guardrail content filter.
instance-attribute
¶
output_strength: GuardrailFilterStrength
The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
instance-attribute
¶
The harmful category that the content filter is applied to.