Skip to content

ApplyGuardrailResponse

Source code in docs_src/capo_bedrock_runtime/types/apply_guardrail_response.py
class ApplyGuardrailResponse(TypedDict, closed=True):
    usage: "capo_bedrock_runtime.types.guardrail_usage.GuardrailUsage"
    """<p>The usage details in the response from the guardrail.</p>"""
    action: "capo_bedrock_runtime.types.guardrail_action.GuardrailAction"
    """<p>The action taken in the response from the guardrail.</p>"""
    action_reason: NotRequired["str"]
    """<p>The reason for the action taken when harmful content is detected.</p>"""
    outputs: "capo_bedrock_runtime.types.guardrail_output_content_list.GuardrailOutputContentList"
    """<p>The output details in the response from the guardrail.</p>"""
    assessments: (
        "capo_bedrock_runtime.types.guardrail_assessment_list.GuardrailAssessmentList"
    )
    """<p>The assessment details in the response from the guardrail.</p>"""
    guardrail_coverage: NotRequired[
        "capo_bedrock_runtime.types.guardrail_coverage.GuardrailCoverage"
    ]
    """<p>The guardrail coverage details in the apply guardrail response.</p>"""

action instance-attribute

The action taken in the response from the guardrail.

action_reason instance-attribute

action_reason: NotRequired[str]

The reason for the action taken when harmful content is detected.

assessments instance-attribute

The assessment details in the response from the guardrail.

guardrail_coverage instance-attribute

guardrail_coverage: NotRequired[GuardrailCoverage]

The guardrail coverage details in the apply guardrail response.

outputs instance-attribute

The output details in the response from the guardrail.

usage instance-attribute

The usage details in the response from the guardrail.