Interface IVectorDB

Interface for implementing a VectorDB

Namespace: Quantellia.WMServer.Asset.LLM.VectorDB

Assembly: WMServer.dll

Syntax

public interface IVectorDB

Properties

LLMData

The WMLLM object containing the metadata for ILLM derived classes.

Declaration

WMLLM LLMData { get; set; }

Property Value

Type	Description
WMLLM

Methods

GetSimilarEmbeddings(WMPrincipal, string, float, int, WMAppDbContext)

Returns a list of text fragments similar in context to the supplied source text.

Declaration

Task<List<string>> GetSimilarEmbeddings(WMPrincipal principal, string source, float threshold, int maxRecords, WMAppDbContext context)

Parameters

Type	Name	Description
WMPrincipal	principal
string	source	The message to search for contextually similar text.
float	threshold	A number between -1 and 1 indicating how similar the embedding should be. (1 for identical, 0 for opposite)
int	maxRecords	The highest number of records that should be returned.
WMAppDbContext	context

Returns

Type	Description
Task<List<string>>

Insert(WMPrincipal, string, string, WMAppDbContext)

Inserts the text from a WMDocument to the vectorDB.

Declaration

Task Insert(WMPrincipal principal, string documentIndexDir, string documentDir, WMAppDbContext context)

Parameters

Type	Name	Description
WMPrincipal	principal
string	documentIndexDir	The Dir or ID of the documentIndex.
string	documentDir	The ID/Dir of the document to insert.
WMAppDbContext	context

Returns

Type	Description
Task

Exceptions

Type	Condition
Exception

Remove(WMPrincipal, string, string, WMAppDbContext)

Removes the text from a WMDocument from the vectorDB.

Declaration

Task Remove(WMPrincipal principal, string documentIndexDir, string documentDir, WMAppDbContext context)

Parameters

Type	Name	Description
WMPrincipal	principal
string	documentIndexDir	The Dir or ID of the documentIndex.
string	documentDir	The ID/Dir of the document to remove.
WMAppDbContext	context

Returns

Type	Description
Task

Exceptions

Type	Condition
Exception