Struct WebSearchToolResultBlock 

pub struct WebSearchToolResultBlock {
    pub content: WebSearchToolResultBlockContent,
    pub tool_use_id: String,
    pub cache_control: Option<CacheControlEphemeral>,
}

A block containing the results of a web search tool operation.

WebSearchToolResultBlock contains either a list of search results or an error.

Fields

content: WebSearchToolResultBlockContent

The content of the web search tool result.

tool_use_id: String

The ID of the tool use that this result is for.

cache_control: Option<CacheControlEphemeral>

Create a cache control breakpoint at this content block.

Implementations

impl WebSearchToolResultBlock

pub fn new<S: Into<String>>( content: WebSearchToolResultBlockContent, tool_use_id: S, ) -> Self

Creates a new WebSearchToolResultBlock.

pub fn new_with_results<S: Into<String>>( results: Vec<WebSearchResultBlock>, tool_use_id: S, ) -> Self

Creates a new WebSearchToolResultBlock with results.

pub fn new_with_error<S: Into<String>>( error: WebSearchToolResultError, tool_use_id: S, ) -> Self

Creates a new WebSearchToolResultBlock with an error.

pub fn with_cache_control(self, cache_control: CacheControlEphemeral) -> Self

Add a cache control to this web search tool result block.

pub fn has_results(&self) -> bool

Returns true if the web search result contains successful results.

pub fn has_error(&self) -> bool

Returns true if the web search result contains an error.

pub fn result_count(&self) -> usize

Returns the number of search results, or 0 if this is an error result.

Trait Implementations

impl Clone for WebSearchToolResultBlock

fn clone(&self) -> WebSearchToolResultBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSearchToolResultBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebSearchToolResultBlock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<WebSearchToolResultBlock> for ContentBlock

fn from(block: WebSearchToolResultBlock) -> Self

Converts to this type from the input type.

impl PartialEq for WebSearchToolResultBlock

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

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 WebSearchToolResultBlock