Struct BuildConfig 

pub struct BuildConfig {
    pub chunk_size: usize,
    pub slide_len: usize,
    pub image_size: usize,
    pub min_summary_len: usize,
    pub max_summary_len: usize,
    pub strict_file_reader: bool,
    pub compression_threshold: u64,
    pub compression_level: u32,
    pub summary_after_build: bool,
}

Fields

chunk_size: usize

It’s not a max_chunk_size, and it’s impossible to make every chunk have the same size because

1. An image cannot be splitted.
2. Different files cannot be merged.

But it’s guaranteed that a chunk is never bigger than chunk_size * 2.

slide_len: usize

image_size: usize

An image is treated like an N characters string, and this is N.

min_summary_len: usize

It forces the LLM to generate a summary that has at least min_summary_len characters and at most max_summary_len characters.

max_summary_len: usize

strict_file_reader: bool

If it’s set, rag build panics if there’s any error with a file. For example, if there’s an invalid utf-8 character PlainTextReader would die. If it cannot follow a link of an image in a markdown file, it would die. You don’t need this option unless you’re debugging ragit itself.

compression_threshold: u64

If the .chunks file is bigger than this (in bytes), the file is compressed

compression_level: u32

0 ~ 9

summary_after_build: bool

If it’s set, it runs rag summary after rag build is complete.

Trait Implementations

impl Clone for BuildConfig

fn clone(&self) -> BuildConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildConfig

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

Formats the value using the given formatter.

impl Default for BuildConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BuildConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for BuildConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BuildConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BuildConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BuildConfig

impl StructuralPartialEq for BuildConfig