Struct OpenAIWebSearchTool 

pub struct OpenAIWebSearchTool {
    pub external_web_access: Option<bool>,
    pub filters: Option<Value>,
    pub user_location: Option<Value>,
}

OpenAI hosted web search configuration.

Fields

external_web_access: Option<bool>

Whether live web access is allowed. None uses OpenAI’s default.

filters: Option<Value>

Official filter object, such as allowed_domains.

user_location: Option<Value>

Official user location object.

Implementations

impl OpenAIWebSearchTool

pub const fn external_web_access(self, allowed: bool) -> Self

Sets whether live web access is allowed.

pub fn filters(self, filters: Value) -> Self

Sets the official filter object.

pub fn user_location(self, location: Value) -> Self

Sets the official user location object.

Trait Implementations

impl Clone for OpenAIWebSearchTool

fn clone(&self) -> OpenAIWebSearchTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIWebSearchTool

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

Formats the value using the given formatter.

impl Default for OpenAIWebSearchTool

fn default() -> OpenAIWebSearchTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenAIWebSearchTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OpenAIWebSearchTool

impl PartialEq for OpenAIWebSearchTool

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OpenAIWebSearchTool

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 OpenAIWebSearchTool