Enum ContentBlock 

pub enum ContentBlock {
    Text {
        text: String,
        citations: Option<Vec<Citation>>,
        cache_control: Option<CacheControl>,
    },
    Image {
        source: ImageSource,
    },
    Document(DocumentBlock),
    SearchResult(SearchResultBlock),
    ToolUse(ToolUseBlock),
    ToolResult(ToolResultBlock),
    Thinking(ThinkingBlock),
    RedactedThinking {
        data: String,
    },
    ServerToolUse(ServerToolUseBlock),
    WebSearchToolResult(WebSearchToolResultBlock),
    WebFetchToolResult(WebFetchToolResultBlock),
}

Variants

Text

Fields

text: String

citations: Option<Vec<Citation>>

cache_control: Option<CacheControl>

Image

Fields

source: ImageSource

Document(DocumentBlock)

SearchResult(SearchResultBlock)

ToolUse(ToolUseBlock)

ToolResult(ToolResultBlock)

Thinking(ThinkingBlock)

RedactedThinking

Fields

data: String

ServerToolUse(ServerToolUseBlock)

WebSearchToolResult(WebSearchToolResultBlock)

WebFetchToolResult(WebFetchToolResultBlock)

Implementations

impl ContentBlock

pub fn text(text: impl Into<String>) -> Self

pub fn text_cached(text: impl Into<String>) -> Self

pub fn text_with_cache(text: impl Into<String>, cache: CacheControl) -> Self

pub fn text_with_citations( text: impl Into<String>, citations: Vec<Citation>, ) -> Self

pub fn document(doc: DocumentBlock) -> Self

pub fn search_result(result: SearchResultBlock) -> Self

pub fn image(source: ImageSource) -> Self

pub fn image_base64( media_type: impl Into<String>, data: impl Into<String>, ) -> Self

pub fn image_url(url: impl Into<String>) -> Self

pub fn image_file(file_id: impl Into<String>) -> Self

pub async fn image_from_path(path: impl AsRef<Path>) -> Result<Self>

pub fn as_text(&self) -> Option<&str>

pub fn citations(&self) -> Option<&[Citation]>

pub fn has_citations(&self) -> bool

pub fn cache_control(&self) -> Option<&CacheControl>

pub fn is_cached(&self) -> bool

pub fn set_cache_control(&mut self, cache: Option<CacheControl>)

Set cache control in-place (only for Text blocks).

pub fn with_cache_control(self, cache: CacheControl) -> Self

pub fn without_cache_control(self) -> Self

pub fn as_document(&self) -> Option<&DocumentBlock>

pub fn as_search_result(&self) -> Option<&SearchResultBlock>

pub fn is_document(&self) -> bool

pub fn is_search_result(&self) -> bool

pub fn is_image(&self) -> bool

pub fn as_image(&self) -> Option<&ImageSource>

pub fn as_thinking(&self) -> Option<&ThinkingBlock>

pub fn is_thinking(&self) -> bool

pub fn is_server_tool_use(&self) -> bool

pub fn as_server_tool_use(&self) -> Option<&ServerToolUseBlock>

pub fn is_web_search_result(&self) -> bool

pub fn as_web_search_result(&self) -> Option<&WebSearchToolResultBlock>

pub fn is_web_fetch_result(&self) -> bool

pub fn as_web_fetch_result(&self) -> Option<&WebFetchToolResultBlock>

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<'de> Deserialize<'de> for ContentBlock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for ContentBlock

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<DocumentBlock> for ContentBlock

fn from(doc: DocumentBlock) -> Self

Converts to this type from the input type.

impl From<SearchResultBlock> for ContentBlock

fn from(result: SearchResultBlock) -> Self

Converts to this type from the input type.

impl From<String> for ContentBlock

fn from(text: String) -> Self

Converts to this type from the input type.

impl Serialize for ContentBlock

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

where __S: Serializer,

Serialize this value into the given Serde serializer.