CitationsContentBlock dataclass

A content block that contains both generated text and associated citation information. This block type is returned when document citations are enabled, providing traceability between the generated content and the source documents that informed the response.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass(kw_only=True)
class CitationsContentBlock:
    """A content block that contains both generated text and associated
    citation information. This block type is returned when document
    citations are enabled, providing traceability between the generated
    content and the source documents that informed the response.
    """

    content: list[CitationGeneratedContent] | None = None
    """The generated content that is supported by the associated citations."""

    citations: list[Citation] | None = None
    """An array of citations that reference the source documents used to
    generate the associated content.
    """

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

    def serialize_members(self, serializer: ShapeSerializer):
        if self.content is not None:
            _serialize_citation_generated_content_list(
                serializer,
                _SCHEMA_CITATIONS_CONTENT_BLOCK.members["content"],
                self.content,
            )

        if self.citations is not None:
            _serialize_citations(
                serializer,
                _SCHEMA_CITATIONS_CONTENT_BLOCK.members["citations"],
                self.citations,
            )

    @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["content"] = _deserialize_citation_generated_content_list(
                        de, _SCHEMA_CITATIONS_CONTENT_BLOCK.members["content"]
                    )

                case 1:
                    kwargs["citations"] = _deserialize_citations(
                        de, _SCHEMA_CITATIONS_CONTENT_BLOCK.members["citations"]
                    )

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

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

Attributes

citations class-attribute instance-attribute

citations: list[Citation] | None = None

An array of citations that reference the source documents used to generate the associated content.

content class-attribute instance-attribute

content: list[CitationGeneratedContent] | None = None

The generated content that is supported by the associated citations.