ToolResultBlock dataclass

A tool result block that contains the results for a tool request that the model previously made. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass(kw_only=True)
class ToolResultBlock:
    """A tool result block that contains the results for a tool request that
    the model previously made. For more information, see [Call a tool with
    the Converse
    API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html)
    in the Amazon Bedrock User Guide.
    """

    tool_use_id: str
    """The ID of the tool request that this is the result for."""

    content: list[ToolResultContentBlock]
    """The content for tool result content block."""

    status: str | None = None
    """The status for the tool result content block.

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

    type: str | None = None
    """The type for the tool result content block."""

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

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_string(
            _SCHEMA_TOOL_RESULT_BLOCK.members["toolUseId"], self.tool_use_id
        )
        _serialize_tool_result_content_blocks(
            serializer, _SCHEMA_TOOL_RESULT_BLOCK.members["content"], self.content
        )
        if self.status is not None:
            serializer.write_string(
                _SCHEMA_TOOL_RESULT_BLOCK.members["status"], self.status
            )

        if self.type is not None:
            serializer.write_string(
                _SCHEMA_TOOL_RESULT_BLOCK.members["type"], self.type
            )

    @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["tool_use_id"] = de.read_string(
                        _SCHEMA_TOOL_RESULT_BLOCK.members["toolUseId"]
                    )

                case 1:
                    kwargs["content"] = _deserialize_tool_result_content_blocks(
                        de, _SCHEMA_TOOL_RESULT_BLOCK.members["content"]
                    )

                case 2:
                    kwargs["status"] = de.read_string(
                        _SCHEMA_TOOL_RESULT_BLOCK.members["status"]
                    )

                case 3:
                    kwargs["type"] = de.read_string(
                        _SCHEMA_TOOL_RESULT_BLOCK.members["type"]
                    )

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

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

Attributes

content instance-attribute

content: list[ToolResultContentBlock]

The content for tool result content block.

status class-attribute instance-attribute

status: str | None = None

The status for the tool result content block.

Note

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

tool_use_id instance-attribute

tool_use_id: str

The ID of the tool request that this is the result for.

type class-attribute instance-attribute

type: str | None = None

The type for the tool result content block.