PutArgs

Struct PutArgs 

Source
pub struct PutArgs {
Show 38 fields pub file: PathBuf, pub json: bool, pub input: Option<String>, pub uri: Option<String>, pub title: Option<String>, pub timestamp: Option<i64>, pub track: Option<String>, pub kind: Option<String>, pub video: bool, pub transcript: bool, pub tags: Vec<(String, String)>, pub labels: Vec<String>, pub metadata: Vec<String>, pub no_auto_tag: bool, pub no_extract_dates: bool, pub audio: bool, pub audio_segment_seconds: Option<u32>, pub embedding: bool, pub no_embedding: bool, pub embedding_vec: Option<PathBuf>, pub vector_compression: bool, pub contextual: bool, pub contextual_model: Option<String>, pub tables: bool, pub no_tables: bool, pub clip: bool, pub no_clip: bool, pub update_existing: bool, pub allow_duplicate: bool, pub temporal_enrich: bool, pub logic_mesh: bool, pub parallel_segments: bool, pub no_parallel_segments: bool, pub parallel_segment_tokens: Option<usize>, pub parallel_segment_pages: Option<usize>, pub parallel_threads: Option<usize>, pub parallel_queue_depth: Option<usize>, pub lock: LockCliArgs,
}
Expand description

Arguments for the put subcommand

Fields§

§file: PathBuf

Path to the memory file to append to

§json: bool

Emit JSON instead of human-readable output

§input: Option<String>

Read payload bytes from a file instead of stdin

§uri: Option<String>

Override the derived URI for the document

§title: Option<String>

Override the derived title for the document

§timestamp: Option<i64>

Optional POSIX timestamp to store on the frame

§track: Option<String>

Track name for the frame

§kind: Option<String>

Kind metadata for the frame

§video: bool

Store the payload as a binary video without transcoding

§transcript: bool

Attempt to attach a transcript (Dev/Enterprise tiers only)

§tags: Vec<(String, String)>

Tags to attach in key=value form

§labels: Vec<String>

Free-form labels to attach to the frame

§metadata: Vec<String>

Additional metadata payloads expressed as JSON

§no_auto_tag: bool

Disable automatic tag generation from extracted text

§no_extract_dates: bool

Disable automatic date extraction from content

§audio: bool

Force audio analysis and tagging when ingesting binary data

§audio_segment_seconds: Option<u32>

Override the default segment duration (in seconds) when generating audio snippets

§embedding: bool

Compute semantic embeddings using the installed model Increases storage overhead from ~5KB to ~270KB per document

§no_embedding: bool

Explicitly disable embeddings (default, but kept for clarity)

§embedding_vec: Option<PathBuf>

Path to a JSON file containing a pre-computed embedding vector (e.g., from OpenAI) The JSON file should contain a flat array of floats like [0.1, 0.2, …]

§vector_compression: bool

Enable Product Quantization compression for vectors (16x compression) Reduces vector storage from ~270KB to ~20KB per document with ~95% accuracy Only applies when –embedding is enabled

§contextual: bool

Enable contextual retrieval: prepend LLM-generated context to each chunk before embedding This improves retrieval accuracy for preference/personalization queries Requires OPENAI_API_KEY or a local model (phi-3.5-mini)

§contextual_model: Option<String>

Model to use for contextual retrieval (default: gpt-4o-mini, or “local” for phi-3.5-mini)

§tables: bool

Automatically extract tables from PDF documents Uses aggressive mode with fallbacks for best results

§no_tables: bool

Disable automatic table extraction (when –tables is the default)

§clip: bool

Enable CLIP visual embeddings for images and PDF pages Allows text-to-image search using natural language queries Auto-enabled when CLIP model is installed; use –no-clip to disable

§no_clip: bool

Disable CLIP visual embeddings even when model is available

§update_existing: bool

Replace any existing frame with the same URI instead of inserting a duplicate

§allow_duplicate: bool

Allow inserting a new frame even if a frame with the same URI already exists

§temporal_enrich: bool

Enable temporal enrichment: resolve relative time phrases (“last year”) to absolute dates Prepends resolved temporal context to chunks for improved temporal question accuracy Requires the temporal_enrich feature in memvid-core

§logic_mesh: bool

Build Logic-Mesh entity graph during ingestion (opt-in) Extracts entities (people, organizations, locations, etc.) and their relationships Enables graph traversal with memvid follow Requires NER model: memvid models install --ner distilbert-ner

§parallel_segments: bool

Use the experimental parallel segment builder (requires –features parallel_segments)

§no_parallel_segments: bool

Force the legacy ingestion path even when the parallel feature is available

§parallel_segment_tokens: Option<usize>

Target tokens per segment when using the parallel builder

§parallel_segment_pages: Option<usize>

Target pages per segment when using the parallel builder

§parallel_threads: Option<usize>

Worker threads used by the parallel builder

§parallel_queue_depth: Option<usize>

Worker queue depth used by the parallel builder

§lock: LockCliArgs

Implementations§

Trait Implementations§

Source§

impl Args for PutArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl FromArgMatches for PutArgs

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

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<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

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

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

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<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,

Source§

impl<T> Fruit for T
where T: Send + Downcast,