ContentBlockDelta module-attribute

ContentBlockDelta = Union[ContentBlockDeltaText | ContentBlockDeltaToolUse | ContentBlockDeltaToolResult | ContentBlockDeltaReasoningContent | ContentBlockDeltaCitation | ContentBlockDeltaUnknown]

A block of content in a streaming response.

Union Members

ContentBlockDeltaText dataclass

The content text.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ContentBlockDeltaText:
    """The content text."""

    value: str

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

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_string(_SCHEMA_CONTENT_BLOCK_DELTA.members["text"], self.value)

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(
            value=deserializer.read_string(_SCHEMA_CONTENT_BLOCK_DELTA.members["text"])
        )

ContentBlockDeltaToolUse dataclass

Information about a tool that the model is requesting to use.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ContentBlockDeltaToolUse:
    """Information about a tool that the model is requesting to use."""

    value: ToolUseBlockDelta

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

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_CONTENT_BLOCK_DELTA.members["toolUse"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=ToolUseBlockDelta.deserialize(deserializer))

ContentBlockDeltaToolResult dataclass

An incremental update that contains the results from a tool call.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ContentBlockDeltaToolResult:
    """An incremental update that contains the results from a tool call."""

    value: list[ToolResultBlockDelta]

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

    def serialize_members(self, serializer: ShapeSerializer):
        _serialize_tool_result_blocks_delta(
            serializer, _SCHEMA_CONTENT_BLOCK_DELTA.members["toolResult"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(
            value=_deserialize_tool_result_blocks_delta(
                deserializer, _SCHEMA_CONTENT_BLOCK_DELTA.members["toolResult"]
            )
        )

ContentBlockDeltaReasoningContent dataclass

Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ContentBlockDeltaReasoningContent:
    """Contains content regarding the reasoning that is carried out by the
    model. Reasoning refers to a Chain of Thought (CoT) that the model
    generates to enhance the accuracy of its final response.
    """

    value: ReasoningContentBlockDelta

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

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_CONTENT_BLOCK_DELTA.members["reasoningContent"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(
            value=_ReasoningContentBlockDeltaDeserializer().deserialize(deserializer)
        )

ContentBlockDeltaCitation dataclass

Incremental citation information that is streamed as part of the response generation process.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ContentBlockDeltaCitation:
    """Incremental citation information that is streamed as part of the
    response generation process.
    """

    value: CitationsDelta

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

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_CONTENT_BLOCK_DELTA.members["citation"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=CitationsDelta.deserialize(deserializer))

ContentBlockDeltaUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ContentBlockDeltaUnknown:
    """Represents an unknown variant.

    If you receive this value, you will need to update your library to receive the
    parsed value.

    This value may not be deliberately sent.
    """

    tag: str

    def serialize(self, serializer: ShapeSerializer):
        raise SerializationError("Unknown union variants may not be serialized.")

    def serialize_members(self, serializer: ShapeSerializer):
        raise SerializationError("Unknown union variants may not be serialized.")

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        raise NotImplementedError()