Enum ContentBlock

#[non_exhaustive]
pub enum ContentBlock {
    CachePoint(CachePointBlock),
    CitationsContent(CitationsContentBlock),
    Document(DocumentBlock),
    GuardContent(GuardrailConverseContentBlock),
    Image(ImageBlock),
    ReasoningContent(ReasoningContentBlock),
    Text(String),
    ToolResult(ToolResultBlock),
    ToolUse(ToolUseBlock),
    Video(VideoBlock),
    #[non_exhaustive]
    Unknown,
}

A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CachePoint(CachePointBlock)

CachePoint to include in the message.

CitationsContent(CitationsContentBlock)

A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

Document(DocumentBlock)

A document to include in the message.

GuardContent(GuardrailConverseContentBlock)

Contains the content to assess with the guardrail. If you don't specify guardContent in 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 in the Amazon Bedrock User Guide.

Image(ImageBlock)

Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

ReasoningContent(ReasoningContentBlock)

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.

Text(String)

Text to include in the message.

ToolResult(ToolResultBlock)

The result for a tool request that a model makes.

ToolUse(ToolUseBlock)

Information about a tool use request from a model.

Video(VideoBlock)

Video to include in the message.

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl ContentBlock

pub fn as_cache_point(&self) -> Result<&CachePointBlock, &Self>

Tries to convert the enum instance into CachePoint, extracting the inner CachePointBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_cache_point(&self) -> bool

Returns true if this is a CachePoint.

pub fn as_citations_content(&self) -> Result<&CitationsContentBlock, &Self>

Tries to convert the enum instance into CitationsContent, extracting the inner CitationsContentBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_citations_content(&self) -> bool

Returns true if this is a CitationsContent.

pub fn as_document(&self) -> Result<&DocumentBlock, &Self>

Tries to convert the enum instance into Document, extracting the inner DocumentBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_document(&self) -> bool

Returns true if this is a Document.

pub fn as_guard_content(&self) -> Result<&GuardrailConverseContentBlock, &Self>

Tries to convert the enum instance into GuardContent, extracting the inner GuardrailConverseContentBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_guard_content(&self) -> bool

Returns true if this is a GuardContent.

pub fn as_image(&self) -> Result<&ImageBlock, &Self>

Tries to convert the enum instance into Image, extracting the inner ImageBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_image(&self) -> bool

Returns true if this is a Image.

pub fn as_reasoning_content(&self) -> Result<&ReasoningContentBlock, &Self>

Tries to convert the enum instance into ReasoningContent, extracting the inner ReasoningContentBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_reasoning_content(&self) -> bool

Returns true if this is a ReasoningContent.

pub fn as_text(&self) -> Result<&String, &Self>

Tries to convert the enum instance into Text, extracting the inner String. Returns Err(&Self) if it can’t be converted.

pub fn is_text(&self) -> bool

Returns true if this is a Text.

pub fn as_tool_result(&self) -> Result<&ToolResultBlock, &Self>

Tries to convert the enum instance into ToolResult, extracting the inner ToolResultBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_tool_result(&self) -> bool

Returns true if this is a ToolResult.

pub fn as_tool_use(&self) -> Result<&ToolUseBlock, &Self>

Tries to convert the enum instance into ToolUse, extracting the inner ToolUseBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_tool_use(&self) -> bool

Returns true if this is a ToolUse.

pub fn as_video(&self) -> Result<&VideoBlock, &Self>

Tries to convert the enum instance into Video, extracting the inner VideoBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_video(&self) -> bool

Returns true if this is a Video.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for ContentBlock

fn clone(&self) -> ContentBlock

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContentBlock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ContentBlock

fn eq(&self, other: &ContentBlock) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ContentBlock