Method FromPartitions

Namespace: LMKit.Retrieval

Assembly: LM-Kit.NET.dll

FromPartitions(IEnumerable<PartitionSimilarity>)

Creates a list of DocumentReference instances from a collection of partition similarities.

public static List<DocumentReference> FromPartitions(IEnumerable<PartitionSimilarity> partitions)

Parameters

partitions IEnumerable<PartitionSimilarity>: The collection of PartitionSimilarity instances to convert. If null, an empty list is returned.

Returns

List<DocumentReference>: A list of DocumentReference instances corresponding to the input partitions.

Examples

// Perform semantic search
var partitions = await ragEngine.FindMatchingPartitionsAsync(
    "What is machine learning?",
    topK: 5,
    minScore: 0.5f);

// Convert to document references for easier metadata access
var references = DocumentReference.FromPartitions(partitions);

foreach (var reference in references)
{
    Console.WriteLine($"Document: {reference.Name}");
    Console.WriteLine($"Page: {reference.PageNumber}");
    Console.WriteLine($"Score: {reference.SimilarityScore:P1}");
    Console.WriteLine($"Excerpt: {reference.Excerpt}");
    Console.WriteLine();
}

Remarks

This method converts raw retrieval results into document references that provide convenient access to document metadata such as name, page number, and source URI.