GuardrailCoverage dataclass

The action of the guardrail coverage details.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass(kw_only=True)
class GuardrailCoverage:
    """The action of the guardrail coverage details."""

    text_characters: GuardrailTextCharactersCoverage | None = None
    """The text characters of the guardrail coverage details."""

    images: GuardrailImageCoverage | None = None
    """The guardrail coverage for images (the number of images that guardrails
    guarded).
    """

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

    def serialize_members(self, serializer: ShapeSerializer):
        if self.text_characters is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_COVERAGE.members["textCharacters"],
                self.text_characters,
            )

        if self.images is not None:
            serializer.write_struct(
                _SCHEMA_GUARDRAIL_COVERAGE.members["images"], self.images
            )

    @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["text_characters"] = (
                        GuardrailTextCharactersCoverage.deserialize(de)
                    )

                case 1:
                    kwargs["images"] = GuardrailImageCoverage.deserialize(de)

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

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

Attributes

images class-attribute instance-attribute

images: GuardrailImageCoverage | None = None

The guardrail coverage for images (the number of images that guardrails guarded).

text_characters class-attribute instance-attribute

text_characters: GuardrailTextCharactersCoverage | None = None

The text characters of the guardrail coverage details.