Documents

Struct Documents 

Source
pub struct Documents<'a> { /* private fields */ }
Expand description

Documents resource for managing documents in collections

Implementations§

Source§

impl<'a> Documents<'a>

Source

pub async fn add( &self, collection_name: impl Into<String>, path: impl Into<String>, content: DocumentContent, metadata: Option<Metadata>, overwrite: Option<bool>, ) -> Result<DocumentResponse>

Add a document to a collection

§Arguments
  • collection_name - Name of the collection
  • path - Document path/identifier
  • content - Document content
  • metadata - Optional metadata
  • overwrite - Whether to overwrite if exists
Source

pub async fn add_text( &self, collection_name: impl Into<String>, path: impl Into<String>, text: impl Into<String>, metadata: Option<Metadata>, ) -> Result<DocumentResponse>

Add a text document

Convenience method for adding plain text documents

Source

pub async fn add_pdf( &self, collection_name: impl Into<String>, path: impl Into<String>, base64_data: impl Into<String>, metadata: Option<Metadata>, ) -> Result<DocumentResponse>

Add a PDF document from base64 data

Convenience method for adding PDF documents with OCR

Source

pub async fn add_pdf_file( &self, collection_name: impl Into<String>, document_path: impl Into<String>, file_path: impl AsRef<Path>, metadata: Option<Metadata>, ) -> Result<DocumentResponse>

Add a PDF document from file path

Reads the file and encodes it as base64

Source

pub async fn update( &self, collection_name: impl Into<String>, path: impl Into<String>, metadata: Option<Metadata>, index_status: Option<IndexStatus>, ) -> Result<DocumentResponse>

Update a document’s metadata or index status

Source

pub async fn delete( &self, collection_name: impl Into<String>, path: impl Into<String>, ) -> Result<DocumentResponse>

Delete a document

Source

pub async fn get_info( &self, collection_name: impl Into<String>, path: impl Into<String>, include_content: Option<bool>, ) -> Result<DocumentInfoResponse>

Get document information

Source

pub async fn get_info_list( &self, collection_name: impl Into<String>, limit: Option<u32>, path_gt: Option<String>, ) -> Result<DocumentInfoListResponse>

Get list of documents in a collection

Source

pub async fn get_page_info( &self, collection_name: impl Into<String>, path: impl Into<String>, page_number: u32, include_content: Option<bool>, ) -> Result<PageInfoResponse>

Get information about a specific page

Auto Trait Implementations§

§

impl<'a> Freeze for Documents<'a>

§

impl<'a> !RefUnwindSafe for Documents<'a>

§

impl<'a> Send for Documents<'a>

§

impl<'a> Sync for Documents<'a>

§

impl<'a> Unpin for Documents<'a>

§

impl<'a> !UnwindSafe for Documents<'a>

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,