Struct WebSearchTool 

#[non_exhaustive]
pub struct WebSearchTool {
    pub search_context_size: Option<String>,
    pub user_location: Option<WebSearchUserLocation>,
}

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

Used By

• Tool::WebSearch (within tools.rs)

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.

search_context_size: Option<String>

The amount of context window space to use for search results

user_location: Option<WebSearchUserLocation>

User location information for search personalization

Implementations

impl WebSearchTool

pub fn former() -> WebSearchToolFormer<WebSearchToolFormerDefinition<(), WebSearchTool, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

Trait Implementations

impl Clone for WebSearchTool

fn clone(&self) -> WebSearchTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSearchTool

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

Formats the value using the given formatter.

impl Default for WebSearchTool

fn default() -> WebSearchTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSearchTool

where WebSearchTool: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for WebSearchTool

where __End: FormingEnd<WebSearchToolFormerDefinitionTypes<__Context, __Formed>>,

type Definition = WebSearchToolFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = WebSearchToolFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for WebSearchTool

type Types = WebSearchToolFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for WebSearchTool

where Definition: FormerDefinition<Storage = WebSearchToolFormerStorage>,

type Former = WebSearchToolFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for WebSearchTool

type Storage = WebSearchToolFormerStorage

The storage type used for forming the entity.

impl PartialEq for WebSearchTool

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

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 WebSearchTool