Struct rig::rag::RagAgent

source ·
pub struct RagAgent<M: CompletionModel, C: VectorStoreIndex, T: VectorStoreIndex> {
    pub tools: ToolSet,
    /* private fields */
}
Expand description

Struct representing a RAG agent, i.e.: an agent enhanced with two collections of vector store indices, one for context documents and one for tools. The ragged context and tools are used to enhance the completion model at prompt-time. Note: The type of the VectorStoreIndex must be the same for all the dynamic context and tools indices (but can be different for context and tools). If you need to use a more complex combination of vector store indices, you should implement a custom agent.

Fields§

§tools: ToolSet

Actual tool implementations

Implementations§

source§

impl<M: CompletionModel, C: VectorStoreIndex, T: VectorStoreIndex> RagAgent<M, C, T>

source

pub async fn call_tool( &self, toolname: &str, args: &str, ) -> Result<String, ToolSetError>

Trait Implementations§

source§

impl<M: CompletionModel, C: VectorStoreIndex, T: VectorStoreIndex> Chat for RagAgent<M, C, T>

source§

async fn chat( &self, prompt: &str, chat_history: Vec<Message>, ) -> Result<String, PromptError>

Send a prompt with optional chat history to the underlying completion model. Read more
source§

impl<M: CompletionModel, C: VectorStoreIndex, T: VectorStoreIndex> Completion<M> for RagAgent<M, C, T>

source§

async fn completion( &self, prompt: &str, chat_history: Vec<Message>, ) -> Result<CompletionRequestBuilder<M>, CompletionError>

Generates a completion request builder for the given prompt and chat_history. This function is meant to be called by the user to further customize the request at prompt time before sending it. Read more
source§

impl<M: CompletionModel, C: VectorStoreIndex, T: VectorStoreIndex> Prompt for RagAgent<M, C, T>

source§

async fn prompt(&self, prompt: &str) -> Result<String, PromptError>

Send a simple prompt to the underlying completion model. Read more

Auto Trait Implementations§

§

impl<M, C, T> Freeze for RagAgent<M, C, T>
where M: Freeze,

§

impl<M, C, T> !RefUnwindSafe for RagAgent<M, C, T>

§

impl<M, C, T> Send for RagAgent<M, C, T>

§

impl<M, C, T> Sync for RagAgent<M, C, T>

§

impl<M, C, T> Unpin for RagAgent<M, C, T>
where M: Unpin, C: Unpin, T: Unpin,

§

impl<M, C, T> !UnwindSafe for RagAgent<M, C, T>

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, 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