ConverseStreamMetadataEvent dataclass

A conversation stream metadata event.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass(kw_only=True)
class ConverseStreamMetadataEvent:
    """A conversation stream metadata event."""

    usage: TokenUsage
    """Usage information for the conversation stream event."""

    metrics: ConverseStreamMetrics
    """The metrics for the conversation stream metadata event."""

    trace: ConverseStreamTrace | None = None
    """The trace object in the response from
    [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)
    that contains information about the guardrail behavior.
    """

    performance_config: PerformanceConfiguration | None = None
    """Model performance configuration metadata for the conversation stream
    event.
    """

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

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_CONVERSE_STREAM_METADATA_EVENT.members["usage"], self.usage
        )
        serializer.write_struct(
            _SCHEMA_CONVERSE_STREAM_METADATA_EVENT.members["metrics"], self.metrics
        )
        if self.trace is not None:
            serializer.write_struct(
                _SCHEMA_CONVERSE_STREAM_METADATA_EVENT.members["trace"], self.trace
            )

        if self.performance_config is not None:
            serializer.write_struct(
                _SCHEMA_CONVERSE_STREAM_METADATA_EVENT.members["performanceConfig"],
                self.performance_config,
            )

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

                case 1:
                    kwargs["metrics"] = ConverseStreamMetrics.deserialize(de)

                case 2:
                    kwargs["trace"] = ConverseStreamTrace.deserialize(de)

                case 3:
                    kwargs["performance_config"] = PerformanceConfiguration.deserialize(
                        de
                    )

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

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

Attributes

metrics instance-attribute

metrics: ConverseStreamMetrics

The metrics for the conversation stream metadata event.

performance_config class-attribute instance-attribute

performance_config: PerformanceConfiguration | None = None

Model performance configuration metadata for the conversation stream event.

trace class-attribute instance-attribute

trace: ConverseStreamTrace | None = None

The trace object in the response from ConverseStream that contains information about the guardrail behavior.

usage instance-attribute

usage: TokenUsage

Usage information for the conversation stream event.