LLMUnity.SentenceSplitter Class Reference

Class implementing a sentence-based splitter. More...

Inheritance diagram for LLMUnity.SentenceSplitter:

Public Member Functions
override async Task< List<(int, int)> >	Split (string input)
	Splits the provided phrase into chunks according to delimiters (defined in the delimiters variable)
Public Member Functions inherited from LLMUnity.Chunking
void	ReturnChunks (bool returnChunks)
	Set to true to return chunks or the direct input with the Search function.
Task< List<(int, int)> >	Split (string input)
	Splits the provided phrase into chunks.
override string	Get (int key)
	Retrieves the phrase with the specific id.
override async Task< int >	Add (string inputString, string group="")
	Adds a phrase to the search after splitting it into chunks.
override void	Remove (int key)
	Removes a phrase and the phrase chunks from the search.
override int	Remove (string inputString, string group="")
	Removes a phrase and the phrase chunks from the search.
override int	Count ()
	Returns a count of the phrases.
override int	Count (string group)
	Returns a count of the phrases in a specific data group.
override async Task< int >	IncrementalSearch (string queryString, string group="")
	Allows to do search and retrieve results in batches (incremental search).
override ValueTuple< int[], float[], bool >	IncrementalFetchKeys (int fetchKey, int k)
	Retrieves the most similar search results in batches (incremental search). The phrase/chunk keys and distances are retrieved, as well as a parameter that dictates whether the search is exhausted. The returnChunks variable defines whether to return chunks or phrases.
override ValueTuple< string[], float[], bool >	IncrementalFetch (int fetchKey, int k)
	Retrieves the most similar search results in batches (incremental search). The phrases/chunks and their distances are retrieved, as well as a parameter that dictates whether the search is exhausted. The returnChunks variable defines whether to return chunks or phrases.
override void	IncrementalSearchComplete (int fetchKey)
	Completes the search and clears the cached results for an incremental search.
override void	Clear ()
	Clears the object and the associated search object.
Public Member Functions inherited from LLMUnity.SearchPlugin
void	SetSearch (SearchMethod search)
	Sets the search method of the plugin.
Public Member Functions inherited from LLMUnity.Searchable
string	Get (int key)
	Retrieves the phrase with the specific id.
Task< int >	Add (string inputString, string group="")
	Adds a phrase to the search.
int	Remove (string inputString, string group="")
	Removes a phrase from the search.
void	Remove (int key)
	Removes a phrase from the search.
int	Count ()
	Returns a count of the phrases.
int	Count (string group)
	Returns a count of the phrases in a specific data group.
void	Clear ()
	Clears the search object.
Task< int >	IncrementalSearch (string queryString, string group="")
	Allows to do search and retrieve results in batches (incremental search).
ValueTuple< int[], float[], bool >	IncrementalFetchKeys (int fetchKey, int k)
	Retrieves the most similar search results in batches (incremental search). The phrase keys and distances are retrieved, as well as a parameter that dictates whether the search is exhausted.
void	IncrementalSearchComplete (int fetchKey)
	Completes the search and clears the cached results for an incremental search.
async Task<(string[], float[])>	Search (string queryString, int k, string group="")
	Search for similar results to the provided query. The most similar results and their distances (dissimilarity) to the query are retrieved.
void	Save (string filePath)
	Saves the state of the search object.
async Task< bool >	Load (string filePath)
	Loads the state of the search object.

Public Attributes
char[]	delimiters = DefaultDelimiters.ToCharArray()
	delimiters used to split the phrases

Static Public Attributes
const string	DefaultDelimiters = ".!:;?\n\r"

Detailed Description

Class implementing a sentence-based splitter.

Definition at line 15 of file SentenceSplitter.cs.

Member Function Documentation

Split()

override async Task< List<(int, int)> > LLMUnity.SentenceSplitter.Split ( string input )

inline

Splits the provided phrase into chunks according to delimiters (defined in the delimiters variable)

Parameters

input

phrase

Returns

List of start/end indices of the split chunks

Definition at line 26 of file SentenceSplitter.cs.

Member Data Documentation

DefaultDelimiters

const string LLMUnity.SentenceSplitter.DefaultDelimiters = ".!:;?\n\r"

static

Definition at line 17 of file SentenceSplitter.cs.

delimiters

char [] LLMUnity.SentenceSplitter.delimiters = DefaultDelimiters.ToCharArray()

delimiters used to split the phrases

Definition at line 19 of file SentenceSplitter.cs.

---

The documentation for this class was generated from the following file:

• Runtime/RAG/SentenceSplitter.cs