Enum IndexCommands 

pub enum IndexCommands {
    Create {
        output: String,
        inputs: Vec<String>,
        from_chunks: Option<String>,
        chunk_size: usize,
        chunk_overlap: usize,
        model: String,
        gpu: bool,
        quiet: bool,
    },
    Add {
        index_path: String,
        inputs: Vec<String>,
        chunk_size: usize,
        chunk_overlap: usize,
        model: String,
        gpu: bool,
        quiet: bool,
    },
    Info {
        index_path: String,
    },
}

Variants

Create

Create a new index from documents

Fields

output: String

Output index file path

inputs: Vec<String>

Input files/directories (uses built-in chunking)

from_chunks: Option<String>

Pre-chunked JSONL file (bypass chunking)

chunk_size: usize

Chunk size in characters

The default fits inside the encoder’s window. minilm-l6-v2 reads 256 tokens, roughly 900 characters, so the previous default of 1000 left about nine chunks in ten longer than the model reads, with the tail dropped silently. The C# Indexer has always used 512; this matches it.

chunk_overlap: usize

Chunk overlap in characters

model: String

Encoder model for embeddings

gpu: bool

Run on the GPU

quiet: bool

Suppress progress output

Add

Add documents to an existing index

Fields

index_path: String

Index file path

inputs: Vec<String>

Input files or directories to add

chunk_size: usize

Chunk size in characters

Matches index create; see the note there.

chunk_overlap: usize

model: String

gpu: bool

Run on the GPU

quiet: bool

Suppress progress output

Info

Show index info

Fields

index_path: String

Index file path

Trait Implementations

impl Debug for IndexCommands

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

Formats the value using the given formatter.

impl FromArgMatches for IndexCommands

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

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

Assign values from ArgMatches to self.

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

Assign values from ArgMatches to self.

impl PartialEq for IndexCommands

fn eq(&self, other: &IndexCommands) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for IndexCommands

impl Subcommand for IndexCommands

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand