Enum KnownBlock 

#[non_exhaustive]
pub enum KnownBlock {
    Text {
        text: String,
        cache_control: Option<CacheControl>,
        citations: Option<Vec<Citation>>,
    },
    Image {
        source: ImageSource,
        cache_control: Option<CacheControl>,
    },
    Document {
        source: DocumentSource,
        title: Option<String>,
        citations: Option<CitationConfig>,
        cache_control: Option<CacheControl>,
    },
    ToolUse {
        id: String,
        name: String,
        input: Value,
    },
    ToolResult {
        tool_use_id: String,
        content: ToolResultContent,
        is_error: Option<bool>,
        cache_control: Option<CacheControl>,
    },
    Thinking {
        thinking: String,
        signature: String,
    },
    RedactedThinking {
        data: String,
    },
    ServerToolUse {
        id: String,
        name: String,
        input: Value,
    },
    WebSearchToolResult {
        tool_use_id: String,
        content: Value,
    },
}

All content block variants known to this SDK version.

#[non_exhaustive] so that adding a new variant in a future release is not a breaking change for downstream match statements.

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.

Text

Plain text content.

Fields

text: String

The text payload.

cache_control: Option<CacheControl>

Optional cache breakpoint.

citations: Option<Vec<Citation>>

Citations the model attached to this text span, if any.

Image

An image embedded in the message.

Fields

source: ImageSource

Where the image bytes come from.

cache_control: Option<CacheControl>

Optional cache breakpoint.

Document

A document (e.g. PDF) embedded in the message.

Fields

source: DocumentSource

Where the document bytes come from.

title: Option<String>

Optional human-readable title used in citation rendering.

citations: Option<CitationConfig>

Optional citation configuration for this document.

cache_control: Option<CacheControl>

Optional cache breakpoint.

ToolUse

A model-emitted request to invoke a tool.

Fields

id: String

Identifier the model assigns to this invocation.

name: String

Name of the tool to invoke.

input: Value

Tool arguments as JSON.

ToolResult

The result of a tool invocation, supplied back to the model.

Fields

tool_use_id: String

The id of the KnownBlock::ToolUse this result corresponds to.

content: ToolResultContent

The tool’s output.

is_error: Option<bool>

Whether the tool execution failed.

cache_control: Option<CacheControl>

Optional cache breakpoint.

Thinking

Extended-thinking trace from the model.

Fields

thinking: String

The model’s chain-of-thought text.

signature: String

Cryptographic signature over the thinking text.

RedactedThinking

A redacted thinking block; only the opaque blob is visible.

Fields

data: String

Opaque server-side blob.

ServerToolUse

A server-side tool invocation initiated by the model.

Fields

id: String

Identifier the model assigns to this invocation.

name: String

Server tool name (e.g. web_search).

input: Value

Tool arguments as JSON.

WebSearchToolResult

The result of a server-side web_search invocation.

Fields

tool_use_id: String

The id of the KnownBlock::ServerToolUse this result corresponds to.

content: Value

Result payload (search hits etc.); shape is server-defined.

Trait Implementations

impl Clone for KnownBlock

fn clone(&self) -> KnownBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KnownBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KnownBlock

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KnownBlock> for ContentBlock

fn from(k: KnownBlock) -> Self

Converts to this type from the input type.

impl PartialEq for KnownBlock

fn eq(&self, other: &KnownBlock) -> 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 Serialize for KnownBlock

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KnownBlock