GuardrailAssessment dataclass

A behavior assessment of the guardrail policies used in a call to the Converse API.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass(kw_only=True)
class GuardrailAssessment:
    """A behavior assessment of the guardrail policies used in a call to the
    Converse API.
    """

    topic_policy: GuardrailTopicPolicyAssessment | None = None
    """The topic policy."""

    content_policy: GuardrailContentPolicyAssessment | None = None
    """The content policy."""

    word_policy: GuardrailWordPolicyAssessment | None = None
    """The word policy."""

    sensitive_information_policy: (
        GuardrailSensitiveInformationPolicyAssessment | None
    ) = None
    """The sensitive information policy."""

    contextual_grounding_policy: GuardrailContextualGroundingPolicyAssessment | None = (
        None
    )
    """The contextual grounding policy used for the guardrail assessment."""

    automated_reasoning_policy: GuardrailAutomatedReasoningPolicyAssessment | None = (
        None
    )
    """The automated reasoning policy assessment results, including logical
    validation findings for the input content.
    """

    invocation_metrics: GuardrailInvocationMetrics | None = None
    """The invocation metrics for the guardrail assessment."""

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_GUARDRAIL_ASSESSMENT, self)

    def serialize_members(self, serializer: ShapeSerializer):
        if self.topic_policy is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_ASSESSMENT.members["topicPolicy"], self.topic_policy
            )

        if self.content_policy is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_ASSESSMENT.members["contentPolicy"],
                self.content_policy,
            )

        if self.word_policy is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_ASSESSMENT.members["wordPolicy"], self.word_policy
            )

        if self.sensitive_information_policy is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_ASSESSMENT.members["sensitiveInformationPolicy"],
                self.sensitive_information_policy,
            )

        if self.contextual_grounding_policy is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_ASSESSMENT.members["contextualGroundingPolicy"],
                self.contextual_grounding_policy,
            )

        if self.automated_reasoning_policy is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_ASSESSMENT.members["automatedReasoningPolicy"],
                self.automated_reasoning_policy,
            )

        if self.invocation_metrics is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_ASSESSMENT.members["invocationMetrics"],
                self.invocation_metrics,
            )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(**cls.deserialize_kwargs(deserializer))

    @classmethod
    def deserialize_kwargs(cls, deserializer: ShapeDeserializer) -> dict[str, Any]:
        kwargs: dict[str, Any] = {}

        def _consumer(schema: Schema, de: ShapeDeserializer) -> None:
            match schema.expect_member_index():
                case 0:
                    kwargs["topic_policy"] = GuardrailTopicPolicyAssessment.deserialize(
                        de
                    )

                case 1:
                    kwargs["content_policy"] = (
                        GuardrailContentPolicyAssessment.deserialize(de)
                    )

                case 2:
                    kwargs["word_policy"] = GuardrailWordPolicyAssessment.deserialize(
                        de
                    )

                case 3:
                    kwargs["sensitive_information_policy"] = (
                        GuardrailSensitiveInformationPolicyAssessment.deserialize(de)
                    )

                case 4:
                    kwargs["contextual_grounding_policy"] = (
                        GuardrailContextualGroundingPolicyAssessment.deserialize(de)
                    )

                case 5:
                    kwargs["automated_reasoning_policy"] = (
                        GuardrailAutomatedReasoningPolicyAssessment.deserialize(de)
                    )

                case 6:
                    kwargs["invocation_metrics"] = (
                        GuardrailInvocationMetrics.deserialize(de)
                    )

                case _:
                    logger.debug("Unexpected member schema: %s", schema)

        deserializer.read_struct(_SCHEMA_GUARDRAIL_ASSESSMENT, consumer=_consumer)
        return kwargs

Attributes

automated_reasoning_policy class-attribute instance-attribute

automated_reasoning_policy: GuardrailAutomatedReasoningPolicyAssessment | None = None

The automated reasoning policy assessment results, including logical validation findings for the input content.

content_policy class-attribute instance-attribute

content_policy: GuardrailContentPolicyAssessment | None = None

The content policy.

contextual_grounding_policy class-attribute instance-attribute

contextual_grounding_policy: GuardrailContextualGroundingPolicyAssessment | None = None

The contextual grounding policy used for the guardrail assessment.

invocation_metrics class-attribute instance-attribute

invocation_metrics: GuardrailInvocationMetrics | None = None

The invocation metrics for the guardrail assessment.

sensitive_information_policy class-attribute instance-attribute

sensitive_information_policy: GuardrailSensitiveInformationPolicyAssessment | None = None

The sensitive information policy.

topic_policy class-attribute instance-attribute

topic_policy: GuardrailTopicPolicyAssessment | None = None

The topic policy.

word_policy class-attribute instance-attribute

word_policy: GuardrailWordPolicyAssessment | None = None

The word policy.