pub struct LocalExecutorOptions {Show 21 fields
pub on_disk_payload: bool,
pub wal_segment_capacity: Option<usize>,
pub model: Option<String>,
pub sparse_model: Option<String>,
pub multi_model: Option<String>,
pub image_model: Option<String>,
pub reranker_model: Option<String>,
pub cache_dir: Option<PathBuf>,
pub show_download_progress: bool,
pub bm25_k1: Option<f64>,
pub bm25_b: Option<f64>,
pub bm25_avg_len: Option<f64>,
pub bm25_language: Option<String>,
pub bm25_tokenizer: Option<String>,
pub bm25_lowercase: Option<bool>,
pub bm25_ascii_folding: Option<bool>,
pub bm25_min_token_len: Option<usize>,
pub bm25_max_token_len: Option<usize>,
pub bm25_stopwords: Option<Vec<String>>,
pub bm25_stemmer: Option<String>,
pub bm25_stopwords_languages: Option<Vec<String>>,
}Expand description
Options for local_executor_with_options.
Fields§
§on_disk_payload: boolStore payloads on disk (default: true when constructed via bindings;
this struct defaults to false for Rust ergonomics matching the
historical local_executor(path, false) tests).
wal_segment_capacity: Option<usize>Write-ahead-log segment capacity in bytes. qdrant-edge pre-allocates each WAL segment to this size (default 32 MiB), which dominates the on-disk footprint of small embedded shards.
Seeds the value when a shard is created or when it exists without a
persisted WAL capacity; a capacity already persisted in
edge_config.json wins, so later opens cannot ratchet the shard’s
config. Hosts configure it in MiB — wal_segment_capacity_bytes
performs the conversion: the CLI via --wal-segment-mb, Python via
wal_segment_mb, and Node via walSegmentMb.
model: Option<String>Local ONNX dense model name. See resolve_embedding_model for accepted forms.
None → default BGESmallENV15 (384-d).
sparse_model: Option<String>Offline sparse model (SPLADE or BGE-M3 via SparseTextEmbedding).
e.g. "splade", "bge-m3". When set, sparse embedding uses real ONNX
inference. None → local wire-compatible BM25 (Qdrant
qdrant/bm25-identical token IDs) for sparse requests. "bm25" names
the built-in encoder, not an ONNX model: leave this unset to use it.
multi_model: Option<String>Offline multivector model (BGE-M3 ColBERT). e.g. "bge-m3".
When set, embed_multi / multivector RERANK work with no network.
image_model: Option<String>Offline image / CLIP vision model. e.g. "clip-vision" / ClipVitB32.
Pair with dense CLIP text (model: Some("ClipVitB32".into())) for multimodal.
reranker_model: Option<String>Offline cross-encoder (bge-reranker-base, BGERerankerBase, …).
cache_dir: Option<PathBuf>Override fastembed model cache directory.
show_download_progress: boolShow HuggingFace download progress bars (default: false).
bm25_k1: Option<f64>Client-side BM25 k1 for the local wire-compatible document encoder
(used when no offline sparse model is configured). None keeps the
Qdrant qdrant/bm25 default (1.2). Write-path only; invalid values
fail closed with QQL-VALIDATION-CONFIG at executor construction.
bm25_b: Option<f64>Client-side BM25 b ([0, 1]); None keeps the Qdrant default
(0.75). See Self::bm25_k1.
bm25_avg_len: Option<f64>Client-side BM25 expected average document length in tokens; None
keeps the Qdrant default (256). See Self::bm25_k1.
bm25_language: Option<String>BM25 text-processing language (Qdrant name/alias); None keeps
English. Forwards to the engine (drives its stopwords/stemmer).
bm25_tokenizer: Option<String>BM25 tokenizer ("word", "whitespace", "prefix",
"multilingual"); None keeps "word".
bm25_lowercase: Option<bool>Lowercase before matching; None keeps true.
bm25_ascii_folding: Option<bool>Lucene ASCII folding before lowercasing; None keeps false.
bm25_min_token_len: Option<usize>Drop tokens shorter than this (chars); None keeps no minimum.
bm25_max_token_len: Option<usize>Drop over-long tokens on the document path (chars); None keeps no
maximum.
bm25_stopwords: Option<Vec<String>>Custom stopwords replacing the language default (None keeps it;
Some(vec![]) disables filtering).
bm25_stemmer: Option<String>Stemmer override (None = language default; Some("none") disables).
bm25_stopwords_languages: Option<Vec<String>>Additional language stopword lists merged with bm25_stopwords.
Trait Implementations§
Source§impl Clone for LocalExecutorOptions
impl Clone for LocalExecutorOptions
Source§impl Debug for LocalExecutorOptions
impl Debug for LocalExecutorOptions
Auto Trait Implementations§
impl Freeze for LocalExecutorOptions
impl RefUnwindSafe for LocalExecutorOptions
impl Send for LocalExecutorOptions
impl Sync for LocalExecutorOptions
impl Unpin for LocalExecutorOptions
impl UnsafeUnpin for LocalExecutorOptions
impl UnwindSafe for LocalExecutorOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> EmbedderBound for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> QdrantOpsBound for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian().Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.