Skip to main content

WebSearchTool

Struct WebSearchTool 

Source
pub struct WebSearchTool {
    pub search_engine: Option<SearchEngine>,
    pub enable: Option<bool>,
    pub search_query: Option<String>,
    pub count: Option<u32>,
    pub search_domain_filter: Option<String>,
    pub search_recency_filter: Option<SearchRecencyFilter>,
    pub content_size: Option<ContentSize>,
    pub result_sequence: Option<ResultSequence>,
    pub search_result: Option<bool>,
    pub require_search: Option<bool>,
    pub search_prompt: Option<String>,
}
Expand description

GLM’s web_search tool: lets the model call Zhipu’s web search.

A zai-gated variant of RequestTool; the wire shape is {"type": "web_search", "web_search": { ... }}. Every field except search_engine is optional and omitted when unset, so GLM applies its own default.

Fields§

§search_engine: Option<SearchEngine>

The search backend. Required by GLM; currently only SearchEngine::SearchProJina is accepted.

§enable: Option<bool>

Whether the tool is enabled. GLM’s default is false.

§search_query: Option<String>

An explicit query to search for, instead of letting the model phrase it.

§count: Option<u32>

Number of results to return, 1..=50. GLM’s default is 10.

§search_domain_filter: Option<String>

Restrict results to this domain.

§search_recency_filter: Option<SearchRecencyFilter>

Only return results published within this window. GLM’s default is SearchRecencyFilter::NoLimit.

§content_size: Option<ContentSize>

How much of each page to keep. GLM’s default is ContentSize::Medium.

§result_sequence: Option<ResultSequence>

Whether search results are placed before or after the model’s answer. GLM’s default is ResultSequence::After.

§search_result: Option<bool>

Return the raw search results alongside the answer. GLM’s default is false.

§require_search: Option<bool>

Force a search even when the model thinks none is needed. GLM’s default is false.

§search_prompt: Option<String>

Extra instructions steering what the model searches for.

Trait Implementations§

Source§

impl Clone for WebSearchTool

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WebSearchTool

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WebSearchTool

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for WebSearchTool

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more