Skip to main content

RagController

Struct RagController 

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

Sends commands to the Ragrig worker and mirrors its state for widgets.

Implementations§

Source§

impl RagController

Source

pub fn new(setup: RagSetup, cx: &mut Context<'_, Self>) -> Result<Self, String>

Spawn the worker and start mirroring its events.

Returns an error when the worker thread cannot be created; an agent that fails to build is reported later through RagEvent::AgentFailed.

Source

pub fn ask( &mut self, prompt: impl Into<String>, attachments: Vec<PendingAttachment>, cx: &mut Context<'_, Self>, ) -> Result<RequestId, String>

Ask one question and return the request identity.

Source

pub fn ask_with_retrieval( &mut self, prompt: impl Into<String>, retrieval: Option<String>, attachments: Vec<PendingAttachment>, cx: &mut Context<'_, Self>, ) -> Result<RequestId, String>

Ask one question whose retrieval is enriched with retrieval.

The worker prepends retrieval to the prompt before embedding and searching, so a marked passage drives the similarity search as well as the question. An empty or whitespace-only enrichment is ignored. The host transcript still echoes only the prompt.

Source

pub fn stop(&mut self, id: RequestId, cx: &mut Context<'_, Self>)

Stop one running generation.

Source

pub fn new_session(&mut self, cx: &mut Context<'_, Self>)

Start an empty conversation.

Source

pub fn load_session( &mut self, id: impl Into<String>, cx: &mut Context<'_, Self>, )

Continue a saved conversation.

Source

pub fn refresh_sessions(&mut self, cx: &mut Context<'_, Self>)

Re-read the session store.

Source

pub fn refresh_library(&mut self, cx: &mut Context<'_, Self>)

Re-read the vector store.

Source

pub fn sync_corpus( &mut self, name: impl Into<String>, folder: impl Into<PathBuf>, cx: &mut Context<'_, Self>, ) -> Result<RequestId, String>

Index a folder as a named corpus.

Source

pub fn stop_sync(&mut self, cx: &mut Context<'_, Self>)

Stop the running ingestion.

Source

pub fn apply(&mut self, setup: RagSetup, cx: &mut Context<'_, Self>)

Rebuild the agent with new configuration.

Source

pub fn sessions(&self) -> &[SessionEntry]

Saved conversations, newest first.

Source

pub fn current_session(&self) -> Option<&str>

The active conversation id, when known.

Source

pub fn library(&self) -> &LibrarySnapshot

The last library snapshot.

Source

pub fn agent(&self) -> Option<&AgentInfo>

The active agent, once it built successfully.

Source

pub fn ingest_progress(&self) -> Option<&IngestProgress>

The running ingestion, if any.

Source

pub fn is_busy(&self) -> bool

Whether an answer is streaming.

Source

pub fn is_ingesting(&self) -> bool

Whether a corpus is being indexed.

Source

pub fn error(&self) -> Option<&str>

The last fatal error.

Source

pub fn status_line(&self) -> String

One line for a status bar.

Source

pub fn memory_enabled(&self) -> bool

Whether conversation memory is on.

Source

pub fn hybrid(&self) -> bool

Whether hybrid retrieval (embeddings) is on.

Source

pub fn agent_components(&self) -> Vec<AgentComponent>

Pipeline components for AgentBar.

Trait Implementations§

Source§

impl Drop for RagController

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl EventEmitter<RagEvent> for RagController

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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