Struct WebSearchPreviewTool

pub struct WebSearchPreviewTool {
    pub type: WebSearchPreviewToolType,
    pub user_location: Option<ApproximateLocation>,
    pub search_context_size: Option<WebSearchPreviewToolSearchContextSize>,
}

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

Fields

type: WebSearchPreviewToolType

The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.

user_location: Option<ApproximateLocation>

The user’s location.

search_context_size: Option<WebSearchPreviewToolSearchContextSize>

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

Implementations

impl WebSearchPreviewTool

pub fn builder() -> WebSearchPreviewToolBuilder<((), (), ())>

Create a builder for building WebSearchPreviewTool. On the builder, call .r#type(...)(optional), .user_location(...)(optional), .search_context_size(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of WebSearchPreviewTool.

Trait Implementations

impl Clone for WebSearchPreviewTool

fn clone(&self) -> WebSearchPreviewTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSearchPreviewTool

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

Formats the value using the given formatter.

impl Default for WebSearchPreviewTool

fn default() -> WebSearchPreviewTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSearchPreviewTool

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebSearchPreviewTool

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

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 WebSearchPreviewTool