Skip to main content

DeepResearchAgent

Struct DeepResearchAgent 

Source
pub struct DeepResearchAgent<M: BaseChatModel> { /* private fields */ }
Expand description

Multi-round deep research agent.

Decomposes a topic into sub-topics, searches in parallel, synthesizes a comprehensive report with citations, and iterates if gaps remain.

Implementations§

Source§

impl<M: BaseChatModel> DeepResearchAgent<M>

Source

pub fn new(llm: M) -> Self

Creates a new DeepResearchAgent with the given LLM.

At least one search tool must be added via with_searcher before calling research.

Source

pub fn with_searcher(self, tool: Box<dyn BaseTool>) -> Self

Adds a search tool to the agent.

Multiple search tools can be added; all are queried in parallel.

Source

pub fn with_max_rounds(self, n: usize) -> Self

Sets the maximum number of research rounds (default: 2).

Source

pub fn with_max_subtopics(self, n: usize) -> Self

Sets the maximum number of sub-topics to decompose (default: 5).

Source

pub fn with_max_source_tokens(self, tokens: usize) -> Self

Sets the maximum number of tokens for source text in synthesis prompts.

When set, source snippets are truncated to fit within this budget.

Source

pub async fn research( &self, topic: &str, ) -> Result<ResearchReport, ResearchError>

Runs the full deep research pipeline on the given topic.

Returns a ResearchReport containing the markdown report, citations, sub-topics, and round count.

Trait Implementations§

Source§

impl<M: BaseChatModel> Debug for DeepResearchAgent<M>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<M> !RefUnwindSafe for DeepResearchAgent<M>

§

impl<M> !UnwindSafe for DeepResearchAgent<M>

§

impl<M> Freeze for DeepResearchAgent<M>
where M: Freeze,

§

impl<M> Send for DeepResearchAgent<M>

§

impl<M> Sync for DeepResearchAgent<M>

§

impl<M> Unpin for DeepResearchAgent<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for DeepResearchAgent<M>
where M: UnsafeUnpin,

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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