Class implementing the search method template. More...

Inheritance diagram for LLMUnity.SearchMethod:

Public Member Functions
void	SetLLM (LLM llm)
	Sets the LLM for encoding the search entries.

async Task<(string[], float[])>	SearchFromList (string query, string[] searchList)
	Orders the entries in the searchList according to their similarity to the provided query. The entries and distances (dissimilarity) to the query are returned in decreasing order of similarity.

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.

virtual ValueTuple< string[], float[], bool >	IncrementalFetch (int fetchKey, int k)
	Retrieves the most similar search results in batches (incremental search). The most similar results and their distances (dissimilarity) to the query are retrieved as well as a parameter that dictates whether the search is exhausted.

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
LLMEmbedder	llmEmbedder

Detailed Description

Class implementing the search method template.

Definition at line 253 of file Search.cs.

Member Function Documentation

◆ SearchFromList()

async Task<(string[], float[])> LLMUnity.SearchMethod.SearchFromList	(	string	query,
		string[]	searchList )

inline

Orders the entries in the searchList according to their similarity to the provided query. The entries and distances (dissimilarity) to the query are returned in decreasing order of similarity.

Parameters

queryString	query
searchList	entries to order based on similarity

Returns

A tuple containing:

Array of entries (string[]).
Array of distances for each result (float[]).

Definition at line 293 of file Search.cs.

◆ SetLLM()

void LLMUnity.SearchMethod.SetLLM ( LLM llm )

inline

Sets the LLM for encoding the search entries.

Parameters

llm

Definition at line 274 of file Search.cs.

Here is the caller graph for this function:

Member Data Documentation

◆ llmEmbedder

LLMEmbedder LLMUnity.SearchMethod.llmEmbedder

Definition at line 255 of file Search.cs.

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

Runtime/RAG/Search.cs