Skip to main content

ChunkConfig

Struct ChunkConfig 

Source
pub struct ChunkConfig {
    pub max_tokens: usize,
    pub overlap_tokens: usize,
    pub normalization: Normalization,
    pub snap_words: bool,
    pub include_context: bool,
    pub merge_blocks: bool,
    pub strict: bool,
}
Expand description

Chunking options.

§include_context selects the chunking mode

  • true (default): the Markdown block parser runs. Headings are tracked and attached to every chunk as headers; the compact label [ctx:A > B] produced by context_prefix counts against max_tokens (at most about a quarter of the budget is reserved for it). Fenced code blocks and list items are kept intact when they fit. Other constructs (tables, block quotes, HTML blocks, indented code) are ordinary blank-line-separated text blocks with no special handling.
  • false (“flat mode”): crate::smart_chunk and crate::smart_chunk_mapped do not parse Markdown. The normalized text is cut into token windows (with overlap_tokens honoured) that prefer paragraph, line and word boundaries. Fences, lists and tables are not protected, headings are ordinary text, headers is empty and merge_blocks has no effect. crate::FileChunker uses the same whole-document path, so file results equal smart_chunk on the file’s text at any size. Because that needs the whole file in memory, flat-mode files larger than crate::FLAT_FILE_MAX_BYTES (32 MiB) are rejected with an error; stream big files with include_context = true instead.

§strict selects the budget guarantee

  • true (default): every chunk is re-tokenized exactly as delivered (context prefix plus body) and must fit max_tokens; token_count is exact. If the context prefix alone prevents the first grapheme from fitting, the headers of that chunk are dropped. If a single grapheme cluster still exceeds the budget, chunking fails with ChipError::ChunkTooLarge.
  • false: the final exact check is skipped. This is faster, but there is no guarantee that every chunk fits and token_count may be an estimate for chunks without headers. An unsplittable grapheme cluster larger than the budget becomes its own oversized chunk.

Fields§

§max_tokens: usize

Token budget per chunk (context prefix included). 0 disables the limit.

§overlap_tokens: usize

Tokens repeated at the start of the next chunk when text has to be split. Must be smaller than max_tokens (see ChunkConfig::validate).

§normalization: Normalization

Unicode normalization applied before chunking; offsets are mapped back to the input.

§snap_words: bool

Prefer cutting at word/sentence boundaries instead of at an arbitrary token when a hard split is unavoidable.

§include_context: bool

Chunking mode: structure-aware with header context (true) or flat (false). See the type-level documentation.

§merge_blocks: bool

Pack adjacent Markdown blocks into one chunk while they fit. When false, every block starts a new chunk. Only relevant when include_context is true.

§strict: bool

Budget guarantee: exact re-count of every delivered chunk (true) or best effort (false). See the type-level documentation.

Implementations§

Source§

impl ChunkConfig

Source

pub fn validate(&self) -> Result<(), ChipError>

Check option combinations that can never work (currently: overlap must be smaller than the budget).

Trait Implementations§

Source§

impl Clone for ChunkConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChunkConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ChunkConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.