CitationsConfig dataclass

Configuration settings for enabling and controlling document citations in Converse API responses. When enabled, the model can include citation information that links generated content back to specific source documents.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass(kw_only=True)
class CitationsConfig:
    """Configuration settings for enabling and controlling document citations
    in Converse API responses. When enabled, the model can include citation
    information that links generated content back to specific source
    documents.
    """

    enabled: bool
    """Specifies whether citations from the selected document should be used in
    the model's response. When set to true, the model can generate
    citations that reference the source documents used to inform the
    response.
    """

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

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_boolean(
            _SCHEMA_CITATIONS_CONFIG.members["enabled"], self.enabled
        )

    @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["enabled"] = de.read_boolean(
                        _SCHEMA_CITATIONS_CONFIG.members["enabled"]
                    )

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

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

Attributes

enabled instance-attribute

enabled: bool

Specifies whether citations from the selected document should be used in the model's response. When set to true, the model can generate citations that reference the source documents used to inform the response.