Struct WebSearchOptions 

pub struct WebSearchOptions { /* private fields */ }

Portable policy shared by hosted web-search adapters.

Implementations

impl WebSearchOptions

pub const fn new() -> Self

Creates unrestricted web-search options with no location disclosure.

pub fn with_allowed_domains<I, S>( self, domains: I, ) -> Result<Self, ModelRequestError>

where I: IntoIterator<Item = S>, S: Into<String>,

Sets a canonical allowlist, replacing any previous allowlist.

Errors

Returns an error for invalid domains, too many domains, or a configured blocklist.

pub fn with_blocked_domains<I, S>( self, domains: I, ) -> Result<Self, ModelRequestError>

where I: IntoIterator<Item = S>, S: Into<String>,

Sets a canonical blocklist, replacing any previous blocklist.

Errors

Returns an error for invalid domains, too many domains, or a configured allowlist.

pub fn with_location(self, location: WebSearchLocation) -> Self

Adds an approximate location disclosed only after the tool is active.

pub fn allowed_domains(&self) -> &[String]

Returns allowed domains in deterministic canonical order.

pub fn blocked_domains(&self) -> &[String]

Returns blocked domains in deterministic canonical order.

pub const fn location(&self) -> Option<&WebSearchLocation>

Returns the optional approximate location.

Trait Implementations

impl Clone for WebSearchOptions

fn clone(&self) -> WebSearchOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSearchOptions

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

Formats the value using the given formatter.

impl Default for WebSearchOptions

fn default() -> WebSearchOptions

Returns the “default value” for a type.

impl Eq for WebSearchOptions

impl PartialEq for WebSearchOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WebSearchOptions