ContentBlock
A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.
Contents
Important
This data type is a UNION, so only one of the following members can be specified when used or returned.
- cachePoint
-
CachePoint to include in the message.
Type: CachePointBlock object
Required: No
- citationsContent
-
A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.
Type: CitationsContentBlock object
Required: No
- document
-
A document to include in the message.
Type: DocumentBlock object
Required: No
- guardContent
-
Contains the content to assess with the guardrail. If you don't specify
guardContentin a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.For more information, see Use a guardrail with the Converse API.
Type: GuardrailConverseContentBlock object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- image
-
Image to include in the message.
Type: ImageBlock object
Required: No
- reasoningContent
-
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.
Type: ReasoningContentBlock object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- text
-
Text to include in the message.
Type: String
Required: No
- toolResult
-
The result for a tool request that a model makes.
Type: ToolResultBlock object
Required: No
- toolUse
-
Information about a tool use request from a model.
Type: ToolUseBlock object
Required: No
- video
-
Video to include in the message.
Type: VideoBlock object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
