ContentBlock

Enum ContentBlock 

Source
pub enum ContentBlock {
    Text {
        text: String,
    },
    Image {
        source: Option<ImageSource>,
    },
    ToolUse {
        id: String,
        name: String,
        input: Value,
    },
    ToolResult {
        tool_use_id: String,
        content: Option<String>,
        is_error: Option<bool>,
    },
    Thinking {
        thinking: String,
    },
    Document {
        source: DocumentSource,
        title: Option<String>,
    },
}
Expand description

A content block in a message

Variants§

§

Text

Plain text content.

Fields

§text: String

The text content.

§

Image

Image content.

Fields

§source: Option<ImageSource>

The source of the image data.

§

ToolUse

A request from the model to use a tool.

Fields

§id: String

The unique identifier for this tool use request.

§name: String

The name of the tool to be used.

§input: Value

The input to the tool, as a JSON object.

§

ToolResult

The result of a tool execution.

Fields

§tool_use_id: String

The id of the tool_use block this result is for.

§content: Option<String>

The content of the tool’s output.

§is_error: Option<bool>

Whether the tool execution resulted in an error.

§

Thinking

A block indicating that the model is performing an extended computation.

Fields

§thinking: String

A description of the thinking process.

§

Document

Content from a document.

Fields

§source: DocumentSource

The source of the document.

§title: Option<String>

The title of the document.

Implementations§

Source§

impl ContentBlock

Source

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

Create a text content block

Source

pub fn tool_use( id: impl Into<String>, name: impl Into<String>, input: Value, ) -> Self

Create a tool use content block

Source

pub fn tool_result( tool_use_id: impl Into<String>, content: impl Into<String>, ) -> Self

Create a tool result content block

Source

pub fn tool_error( tool_use_id: impl Into<String>, error: impl Into<String>, ) -> Self

Create an error tool result

Source

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

Create a thinking content block

Source

pub fn type_name(&self) -> &'static str

Get the type name of this content block

Source

pub fn is_text(&self) -> bool

Check if this is a text block

Source

pub fn is_tool_use(&self) -> bool

Check if this is a tool use block

Source

pub fn is_tool_result(&self) -> bool

Check if this is a tool result block

Source

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

Extract text if this is a text block

Source

pub fn as_tool_use(&self) -> Option<(&str, &str, &Value)>

Extract tool use if this is a tool use block

Trait Implementations§

Source§

impl Clone for ContentBlock

Source§

fn clone(&self) -> ContentBlock

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContentBlock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ContentBlock

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ContentBlock

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ContentBlock

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ContentBlock

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,