Struct Client 

pub struct Client { /* private fields */ }

An async VectrixDB client.

Implementations

impl Client

pub fn new(url: impl Into<String>) -> ClientBuilder

Start building a client for the server at url.

pub fn url(&self) -> &str

The server’s address, without a trailing slash.

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

true when the process answers.

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

true when models are loaded. Falls back to health on a server without /ready.

pub async fn whoami(&self) -> Result<Value>

Who the key or token is, as the server’s data object.

pub async fn collections(&self) -> Result<Vec<Collection>>

pub async fn describe(&self, name: &str) -> Result<Collection>

pub async fn create_collection( &self, name: &str, options: CreateOptions, ) -> Result<Collection>

pub async fn delete_collection(&self, name: &str) -> Result<()>

pub async fn add_document( &self, collection: &str, bytes: impl AsRef<[u8]>, filename: &str, options: AddOptions, ) -> Result<Added>

Upload a file’s bytes: the server reads, cuts, embeds and writes it.

pub async fn add_texts(&self, collection: &str, texts: Vec<Text>) -> Result<u64>

Embed and store texts; returns how many were added.

pub async fn search( &self, collection: &str, query: &str, options: SearchOptions, ) -> Result<Vec<Hit>>

pub async fn documents(&self, collection: &str) -> Result<Vec<Document>>

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

The Markdown the document was indexed from.

pub async fn delete_document( &self, collection: &str, doc_id: &str, ) -> Result<u64>

Remove a document; returns how many chunks went with it.

pub async fn sources(&self, collection: &str) -> Result<Vec<Source>>

pub async fn add_source( &self, collection: &str, address: &str, options: SourceOptions, ) -> Result<Source>

pub async fn refresh_sources(&self, collection: &str) -> Result<Refreshed>

Read the sources that are due and write what changed.

pub async fn delete_source( &self, collection: &str, source_id: &str, delete_documents: bool, ) -> Result<()>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.