Skip to main content

MockToolIndex

rig_agent::test_utils

Struct MockToolIndex 

Source 
pub struct MockToolIndex { /* private fields */ }
Available on crate feature test-utils only.
Expand description

A vector index that returns a predefined list of tool IDs from top_n_ids.

Implementations§

Source§

impl MockToolIndex

Source

pub fn new(tool_ids: impl IntoIterator<Item = impl Into<String>>) -> Self

Create a tool index that returns the given IDs in order.

Trait Implementations§

Source§

impl VectorStoreIndex for MockToolIndex

Source§

type Filter = Filter<Value>

The filter type for this backend.
Source§

async fn top_n<T: for<'a> Deserialize<'a> + WasmCompatSend>( &self, _req: VectorSearchRequest, ) -> Result<Vec<(f64, String, T)>, VectorStoreError>

Returns the top N most similar documents as (score, id, document) tuples.
Source§

async fn top_n_ids( &self, _req: VectorSearchRequest, ) -> Result<Vec<(f64, String)>, VectorStoreError>

Returns the top N most similar document IDs as (score, id) tuples.

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> 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> 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, F> PortableTool for T
where F: SearchFilter<Value = Value> + WasmCompatSend + WasmCompatSync + for<'de> Deserialize<'de>, T: VectorStoreIndex<Filter = F>,

Source§

const NAME: &'static str = "search_vector_store"

Unique registration and provider-facing name.
Source§

type Error = VectorStoreError

Concrete author-facing failure.
Source§

type Args = VectorSearchRequest<F>

Owned JSON arguments.
Source§

type Output = Vec<VectorStoreOutput>

Canonical model-visible output.
Source§

fn description(&self) -> String

Model-facing description.
Source§

fn parameters(&self) -> Value

JSON Schema for arguments.
Source§

async fn call( &self, args: <T as PortableTool>::Args, ) -> Result<<T as PortableTool>::Output, <T as PortableTool>::Error>

Execute one owned invocation without runtime access.
Source§

fn map_error(&self, error: Self::Error) -> ToolExecutionError

Normalize a concrete failure at the runtime effect boundary.
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> Tool for T
where T: PortableTool,

Source§

const NAME: &'static str = const NAME: &'static str = <T as rig_core::tool::PortableTool>::NAME;

Unique registration and provider-facing name.
Source§

type Args = <T as PortableTool>::Args

Typed JSON arguments.
Source§

type Output = <T as PortableTool>::Output

Output convertible into Rig’s canonical model presentation. Read more
Source§

type Error = <T as PortableTool>::Error

Typed error returned by direct calls to this tool. Read more
Source§

fn description(&self) -> String

Model-facing description.
Source§

fn parameters(&self) -> Value

JSON Schema for arguments.
Source§

fn map_error(&self, error: <T as Tool>::Error) -> ToolExecutionError

Normalize a typed author-facing error for runtime policy and telemetry. Read more
Source§

async fn call( &self, _context: &mut ToolContext, args: <T as Tool>::Args, ) -> Result<<T as Tool>::Output, <T as Tool>::Error>

Execute the tool.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<I, F> VectorStoreIndexDyn for I
where I: VectorStoreIndex<Filter = F>, F: Debug + Clone + SearchFilter<Value = Value> + WasmCompatSend + WasmCompatSync + Serialize + for<'de> Deserialize<'de> + 'static,

Source§

fn top_n<'a>( &'a self, req: VectorSearchRequest, ) -> Pin<Box<dyn Future<Output = Result<Vec<(f64, String, Value)>, VectorStoreError>> + Send + 'a>>

Returns the top N documents for a JSON-serializable request.
Source§

fn top_n_ids<'a>( &'a self, req: VectorSearchRequest, ) -> Pin<Box<dyn Future<Output = Result<Vec<(f64, String)>, VectorStoreError>> + Send + 'a>>

Returns only the top N document IDs for a JSON-serializable request.
Source§

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

Source§

impl<T> WasmCompatSync 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
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