Skip to main content

TextSearchProvider

Struct TextSearchProvider 

Source
pub struct TextSearchProvider { /* private fields */ }
Expand description

A ContextProvider that adds text-search results to a run. See the module docs.

Cloning yields a handle onto the same provider.

Implementations§

Source§

impl TextSearchProvider

Source

pub fn new<F, Fut>(search: F) -> TextSearchProvider
where F: Fn(String) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Vec<TextSearchResult>, Error>> + Send + 'static,

A provider searching with search, which takes the query text.

Source

pub fn with_behavior(self, behavior: TextSearchBehavior) -> TextSearchProvider

When to search (default TextSearchBehavior::BeforeInvoke).

Source

pub fn with_tool( self, name: impl Into<String>, description: impl Into<String>, ) -> TextSearchProvider

The on-demand tool’s name and description (default Search).

Source

pub fn with_context_prompt( self, prompt: impl Into<String>, ) -> TextSearchProvider

The line put before the results.

Source

pub fn with_citations_prompt( self, prompt: impl Into<String>, ) -> TextSearchProvider

The line put after the results, asking for citations.

Source

pub fn with_context_formatter( self, formatter: impl Fn(&[TextSearchResult]) -> Result<String, Error> + Send + Sync + 'static, ) -> TextSearchProvider

Format results yourself instead of the default layout. Called for every search, including one with no results.

Source

pub fn with_recent_message_memory(self, limit: usize) -> TextSearchProvider

Include up to limit recent conversation messages in the search input (default 0, off). Only messages with a role in Self::with_recent_message_roles (default user) are kept. The memory lives in the session state under Self::with_state_key, so a run without a session has none.

Source

pub fn with_recent_message_roles(self, roles: Vec<Role>) -> TextSearchProvider

The roles recent-message memory keeps (default user only).

Source

pub fn with_state_key( self, key: impl Into<String>, ) -> Result<TextSearchProvider, Error>

The session-state key for recent-message memory (default DEFAULT_TEXT_SEARCH_STATE_KEY). A blank key is refused.

Source

pub fn with_sensitive_logging(self, enabled: bool) -> TextSearchProvider

Log queries and formatted results at trace level. Off by default: both carry conversation content.

Source

pub fn state_key(&self) -> &str

The session-state key recent-message memory uses.

Source

pub fn search_tool(&self) -> ToolDefinition

The on-demand search tool. Added to every run under TextSearchBehavior::OnDemandFunctionCalling; it takes one string argument, userQuestion.

Source

pub async fn search_and_format(&self, query: String) -> Result<String, Error>

Run a search and format its results.

Trait Implementations§

Source§

impl Clone for TextSearchProvider

Source§

fn clone(&self) -> TextSearchProvider

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 ContextProvider for TextSearchProvider

Source§

fn after_run<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, request_messages: &'life1 [Message], response_messages: &'life2 [Message], error: Option<&'life3 Error>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, TextSearchProvider: 'async_trait,

Records the run’s messages in recent-message memory. after_run receives no session, so the run is matched by its input to the state handle before_run recorded (as the harness mode provider does). A failed run records nothing, and neither does a run whose input matches in-flight runs of more than one session, since it cannot be told apart from them.

Source§

fn before_run<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut SessionContext, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, TextSearchProvider: 'async_trait,

Called before the model is invoked; mutate ctx to inject instructions, messages, and/or tools. Read ctx.input_messages / ctx.session_id.
Source§

fn after_run_in_session<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, session: &'life1 AgentSession, request_messages: &'life2 [Message], response_messages: &'life3 [Message], error: Option<&'life4 Error>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, Self: 'async_trait,

The completion hook with the run’s session, which is what agents call. Mirrors the session argument of upstream’s after_run. Read more
Source§

fn is_history_provider(&self) -> bool

Whether this provider manages conversation history (a HistoryProvider). Agent and WorkflowAgent use this to detect an already-attached history provider among a session’s context_providers and avoid auto-attaching a redundant InMemoryHistoryProvider. Defaults to false; history providers override it to true.
Source§

fn source_id(&self) -> String

The id this provider’s context messages are attributed to (see ATTRIBUTION_KEY). Defaults to the provider’s type name; upstream’s source_id.
Source§

impl Debug for TextSearchProvider

Source§

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

Formats the value using the given formatter. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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