Class DocumentSplittingResult

Namespace

LMKit.Extraction

Assembly

LM-Kit.NET.dll

Represents the result of a document splitting operation, containing the detected logical document segments and their page ranges.

public sealed class DocumentSplittingResult

Inheritance

object

DocumentSplittingResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

DocumentSplittingResult result = splitter.Split(new Attachment("batch.pdf"));

Console.WriteLine($"Multiple documents: {result.ContainsMultipleDocuments}");
Console.WriteLine($"Document count: {result.DocumentCount}");
Console.WriteLine($"Confidence: {result.Confidence:P0}");

foreach (var segment in result.Segments)
{
    Console.WriteLine($"  {segment}");
}

Remarks

This class is returned by Split(Attachment, CancellationToken) and SplitAsync(Attachment, CancellationToken). It provides the list of detected DocumentSegment instances, each describing a contiguous range of pages that belong to the same logical document.

Use ContainsMultipleDocuments to quickly determine whether the input file contains more than one logical document, and Segments to access the individual document boundaries.

Properties

Confidence

Gets the overall confidence score of the splitting result.

ContainsMultipleDocuments

Gets a value indicating whether the file contains more than one logical document.

DocumentCount

Gets the total number of detected logical documents.

Segments

Gets the list of detected document segments, sorted by StartPage.