Bedrock Runtime  >  Unions  >  ToolResultContentBlock

ToolResultContentBlock

Union Type

ToolResultContentBlock module-attribute

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

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

Union Member Types

ToolResultContentBlockJson dataclass

A tool result that is JSON format data.

Attributes

value instance-attribute

value: Document

ToolResultContentBlockText dataclass

A tool result that is text.

Attributes

value instance-attribute

value: str

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.

Attributes

value instance-attribute

value: ImageBlock

ToolResultContentBlockDocument dataclass

A tool result that is a document.

Attributes

value instance-attribute

value: DocumentBlock

ToolResultContentBlockVideo dataclass

A tool result that is video.

Attributes

value instance-attribute

value: VideoBlock

ToolResultContentBlockSearchResult dataclass

A tool result that is a search result.

Attributes

value instance-attribute

value: SearchResultBlock

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.

Attributes

tag instance-attribute

tag: str