Struct TrieveKnowledgeBaseChunkPlan

pub struct TrieveKnowledgeBaseChunkPlan {
    pub file_ids: Option<Vec<String>>,
    pub websites: Option<Vec<String>>,
    pub target_splits_per_chunk: Option<f64>,
    pub split_delimiters: Option<Vec<String>>,
    pub rebalance_chunks: Option<bool>,
}

Fields

file_ids: Option<Vec<String>>

These are the file ids that will be used to create the vector store. To upload files, use the POST /files endpoint.

websites: Option<Vec<String>>

These are the websites that will be used to create the vector store.

target_splits_per_chunk: Option<f64>

This is an optional field which allows you to specify the number of splits you want per chunk. If not specified, the default 20 is used. However, you may want to use a different number.

split_delimiters: Option<Vec<String>>

This is an optional field which allows you to specify the delimiters to use when splitting the file before chunking the text. If not specified, the default [.!?\n] are used to split into sentences. However, you may want to use spaces or other delimiters.

rebalance_chunks: Option<bool>

This is an optional field which allows you to specify whether or not to rebalance the chunks created from the file. If not specified, the default true is used. If true, Trieve will evenly distribute remainder splits across chunks such that 66 splits with a target_splits_per_chunk of 20 will result in 3 chunks with 22 splits each.

Implementations

impl TrieveKnowledgeBaseChunkPlan

pub fn new() -> TrieveKnowledgeBaseChunkPlan

Trait Implementations

impl Clone for TrieveKnowledgeBaseChunkPlan

fn clone(&self) -> TrieveKnowledgeBaseChunkPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrieveKnowledgeBaseChunkPlan

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

Formats the value using the given formatter.

impl Default for TrieveKnowledgeBaseChunkPlan

fn default() -> TrieveKnowledgeBaseChunkPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrieveKnowledgeBaseChunkPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TrieveKnowledgeBaseChunkPlan

fn eq(&self, other: &TrieveKnowledgeBaseChunkPlan) -> 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 TrieveKnowledgeBaseChunkPlan

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TrieveKnowledgeBaseChunkPlan