ToolResultContentBlock module-attribute

ToolResultContentBlock = Union[ToolResultContentBlockJson | ToolResultContentBlockText | ToolResultContentBlockImage | ToolResultContentBlockDocument | ToolResultContentBlockVideo | ToolResultContentBlockUnknown]

The tool result content block. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

Union Members

ToolResultContentBlockJson dataclass

A tool result that is JSON format data.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ToolResultContentBlockJson:
    """A tool result that is JSON format data."""

    value: Document

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

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_document(
            _SCHEMA_TOOL_RESULT_CONTENT_BLOCK.members["json"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(
            value=deserializer.read_document(
                _SCHEMA_TOOL_RESULT_CONTENT_BLOCK.members["json"]
            )
        )

ToolResultContentBlockText dataclass

A tool result that is text.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ToolResultContentBlockText:
    """A tool result that is text."""

    value: str

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

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

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

ToolResultContentBlockImage dataclass

A tool result that is an image.

Note

This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ToolResultContentBlockImage:
    """A tool result that is an image.

    Note:
        This field is only supported by Amazon Nova and Anthropic Claude 3 and 4
        models.
    """

    value: ImageBlock

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

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

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

ToolResultContentBlockDocument dataclass

A tool result that is a document.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ToolResultContentBlockDocument:
    """A tool result that is a document."""

    value: DocumentBlock

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

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

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

ToolResultContentBlockVideo dataclass

A tool result that is video.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class ToolResultContentBlockVideo:
    """A tool result that is video."""

    value: VideoBlock

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

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

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

ToolResultContentBlockUnknown 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 ToolResultContentBlockUnknown:
    """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()