Class DocumentIndexingResult

Namespace: LMKit.Retrieval

Assembly: LM-Kit.NET.dll

Describes the outcome of loading a document into PdfChat, including how the document was processed and its resource consumption.

public sealed class DocumentIndexingResult

Inheritance: object

DocumentIndexingResult

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Examples

using var chat = new PdfChat(chatModel, embeddingModel);
var result = await chat.LoadDocumentAsync("report.pdf");

Console.WriteLine($"Document: {result.Name}");
Console.WriteLine($"Mode: {result.IndexingMode}");
Console.WriteLine($"Pages: {result.PageCount}, Tokens: {result.TokenCount}");
Console.WriteLine($"Exceeded budget: {result.ExceededTokenBudget}");

Properties

ExceededTokenBudget: Gets a value indicating whether the document exceeded the available token budget.

Id: Gets the unique identifier of the indexed document.

IndexingMode: Gets the processing mode used for this document.

LoadedAtUtc: Gets the UTC timestamp when the document was loaded.

Name: Gets the name of the indexed document.

PageCount: Gets the number of pages in the document.

SourceUri: Gets the source URI of the indexed document, or null if not specified.

TokenCount: Gets the estimated token count for this document.

Methods

ToString()