Skip to main content

Engine

vectorless::client

Struct Engine

pub struct Engine { /* private fields */ }

Expand description

The main Engine client.

Provides high-level operations for document indexing and retrieval. Uses interior mutability to allow sharing across async tasks.

§Cloning

Cloning is cheap - it only increments reference counts (Arc). All clones share the same underlying resources.

§Thread Safety

The client is Clone + Send + Sync and can be safely shared across threads.

Implementations§

impl Engine

pub fn builder() -> EngineBuilder

Create a builder for custom configuration.

pub async fn index(&self, ctx: IndexContext) -> Result<String>

Index a document.

This is the main entry point for indexing documents. The IndexContext parameter specifies the source (file path, content string, or bytes) and indexing options.

§Arguments

ctx - The index context containing source and options

§Returns

A unique document ID string.

§Errors

Returns an error if:

The file does not exist (for path sources)
The file format is not supported
The pipeline execution fails

§Example

use vectorless::client::{Engine, EngineBuilder, IndexContext, IndexMode};
use vectorless::parser::DocumentFormat;

let engine = EngineBuilder::new()
    .with_workspace("./data")
    .build()
    .await?;

// From file
let id1 = engine.index(IndexContext::from_path("./doc.md")).await?;

// From content
let html = "<html><body><h1>Title</h1></body></html>";
let id2 = engine.index(
    IndexContext::from_content(html, DocumentFormat::Html)
        .with_name("webpage")
).await?;

// From bytes with force mode
let pdf_bytes = std::fs::read("./doc.pdf")?;
let id3 = engine.index(
    IndexContext::from_bytes(pdf_bytes, DocumentFormat::Pdf)
        .with_mode(IndexMode::Force)
).await?;

pub async fn query(&self, doc_id: &str, question: &str) -> Result<QueryResult>

Query a document.

Uses the adaptive retriever to find relevant content.

§Errors

Returns an error if:

No workspace is configured
The document is not found
The retrieval fails

pub async fn query_with_context( &self, doc_id: &str, question: &str, ctx: &ClientContext, ) -> Result<QueryResult>

Query a document with context.

Allows request-specific configuration overrides.

pub async fn session(&self) -> Session

Create a session for multi-document operations.

Sessions provide:

Automatic caching of document trees
Cross-document queries
Session statistics

pub async fn list_documents(&self) -> Result<Vec<DocumentInfo>>

Get a list of all indexed documents.

§Errors

Returns an error if the workspace operation fails.

pub async fn get_structure(&self, doc_id: &str) -> Result<DocumentTree>

Get document structure (tree).

§Errors

Returns an error if:

No workspace is configured
The document is not found

pub async fn get_page_content( &self, doc_id: &str, pages: &str, ) -> Result<String>

Get page content for PDFs.

§Errors

Returns an error if:

No workspace is configured
The document is not found
No page content is available

pub async fn load(&self, doc_id: &str) -> Result<bool>

Load a document from the workspace into cache.

This preloads the document into the LRU cache for faster access.

§Errors

Returns an error if no workspace is configured.

pub async fn remove(&self, doc_id: &str) -> Result<bool>

Remove a document from the workspace.

§Errors

Returns an error if no workspace is configured.

pub async fn exists(&self, doc_id: &str) -> Result<bool>

Check if a document exists in the workspace.

§Errors

Returns an error if no workspace is configured.

pub async fn get_metadata(&self, doc_id: &str) -> Result<Option<DocumentInfo>>

Get metadata for a document.

§Errors

Returns an error if no workspace is configured.

pub async fn batch_remove(&self, doc_ids: &[&str]) -> Result<usize>

Remove multiple documents from the workspace.

Returns the number of documents successfully removed.

§Errors

Returns an error if no workspace is configured.

pub async fn clear(&self) -> Result<usize>

Remove all documents from the workspace.

Returns the number of documents removed.

§Errors

Returns an error if no workspace is configured.

pub async fn len(&self) -> Result<usize>

Get the number of indexed documents.

§Errors

Returns an error if the workspace operation fails.

pub async fn is_empty(&self) -> Result<bool>

Check if there are no documents.

§Errors

Returns an error if the workspace operation fails.

pub fn indexer(&self) -> &IndexerClient

Get the indexer client.

pub fn retriever(&self) -> &RetrieverClient

Get the retriever client.

pub fn workspace(&self) -> Option<&WorkspaceClient>

Get the workspace client.

pub fn config(&self) -> &Config

Get the configuration.

Trait Implementations§

impl Clone for Engine

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for Engine

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Engine

impl !RefUnwindSafe for Engine

impl Send for Engine

impl Sync for Engine

impl Unpin for Engine

impl UnsafeUnpin for Engine

impl !UnwindSafe for Engine

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more