Struct WebSearchLocation 

#[non_exhaustive]
pub struct WebSearchLocation {
    pub city: Option<String>,
    pub country: Option<String>,
    pub region: Option<String>,
    pub timezone: Option<String>,
}

Represents approximate location parameters for the web search.

Used By

• CreateChatCompletionRequest.web_search_options (within requests/chat.rs - assuming)
• WebSearchTool (as user_location field in some contexts, though not directly in the tool definition schema)

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

city: Option<String>

Free text input for the city (e.g., “San Francisco”).

country: Option<String>

The two-letter ISO country code (e.g., “US”).

region: Option<String>

Free text input for the region (e.g., “California”).

timezone: Option<String>

The IANA timezone (e.g., “America/Los_Angeles”).

Trait Implementations

impl Clone for WebSearchLocation

fn clone(&self) -> WebSearchLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSearchLocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebSearchLocation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebSearchLocation

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

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 WebSearchLocation