Struct text_splitter::TextSplitter
source · pub struct TextSplitter<Sizer>where
Sizer: ChunkSizer,{ /* private fields */ }
Expand description
Default plain-text splitter. Recursively splits chunks into the largest semantic units that fit within the chunk size. Also will attempt to merge neighboring chunks if they can fit within the given chunk size.
Implementations§
source§impl<Sizer> TextSplitter<Sizer>where
Sizer: ChunkSizer,
impl<Sizer> TextSplitter<Sizer>where
Sizer: ChunkSizer,
sourcepub fn new(chunk_config: impl Into<ChunkConfig<Sizer>>) -> Self
pub fn new(chunk_config: impl Into<ChunkConfig<Sizer>>) -> Self
Creates a new TextSplitter
.
use text_splitter::TextSplitter;
// By default, the chunk sizer is based on characters.
let splitter = TextSplitter::new(512);
sourcepub fn chunks<'splitter, 'text: 'splitter>(
&'splitter self,
text: &'text str
) -> impl Iterator<Item = &'text str> + 'splitter
pub fn chunks<'splitter, 'text: 'splitter>( &'splitter self, text: &'text str ) -> impl Iterator<Item = &'text str> + 'splitter
Generate a list of chunks from a given text. Each chunk will be up to the chunk_capacity
.
§Method
To preserve as much semantic meaning within a chunk as possible, each chunk is composed of the largest semantic units that can fit in the next given chunk. For each splitter type, there is a defined set of semantic levels. Here is an example of the steps used:
use text_splitter::TextSplitter;
let splitter = TextSplitter::new(10);
let text = "Some text\n\nfrom a\ndocument";
let chunks = splitter.chunks(text).collect::<Vec<_>>();
assert_eq!(vec!["Some text", "from a", "document"], chunks);
sourcepub fn chunk_indices<'splitter, 'text: 'splitter>(
&'splitter self,
text: &'text str
) -> impl Iterator<Item = (usize, &'text str)> + 'splitter
pub fn chunk_indices<'splitter, 'text: 'splitter>( &'splitter self, text: &'text str ) -> impl Iterator<Item = (usize, &'text str)> + 'splitter
Returns an iterator over chunks of the text and their byte offsets.
Each chunk will be up to the chunk_capacity
.
See TextSplitter::chunks
for more information.
use text_splitter::{Characters, TextSplitter};
let splitter = TextSplitter::new(10);
let text = "Some text\n\nfrom a\ndocument";
let chunks = splitter.chunk_indices(text).collect::<Vec<_>>();
assert_eq!(vec![(0, "Some text"), (11, "from a"), (18, "document")], chunks);
Trait Implementations§
Auto Trait Implementations§
impl<Sizer> Freeze for TextSplitter<Sizer>where
Sizer: Freeze,
impl<Sizer> RefUnwindSafe for TextSplitter<Sizer>where
Sizer: RefUnwindSafe,
impl<Sizer> Send for TextSplitter<Sizer>where
Sizer: Send,
impl<Sizer> Sync for TextSplitter<Sizer>where
Sizer: Sync,
impl<Sizer> Unpin for TextSplitter<Sizer>where
Sizer: Unpin,
impl<Sizer> UnwindSafe for TextSplitter<Sizer>where
Sizer: UnwindSafe,
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
Mutably borrows from an owned value. Read more
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>
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 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>
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