Table of Contents

Class KnowledgeEvidence

Namespace
LMKit.Agents.Knowledge
Assembly
LM-Kit.NET.dll

One passage a knowledge source returned for a query: the text a model reads, where it comes from, and how well it matched.

public sealed class KnowledgeEvidence
Inheritance
KnowledgeEvidence
Inherited Members

Examples

var evidence = new KnowledgeEvidence("handbook", "Refunds are accepted within 30 days.", 0.82f)
{
    Title = "Customer handbook",
    PageNumber = 12,
};

Remarks

A retriever creates evidence; the conversation that presents it to the model gives it a CitationId, the number the model cites ([1], [2]) and the key the answer's citations are verified against. The identifier is assigned by the runtime from real retrieval results, never taken from the model's text.

The text of a passage is data. It is presented to the model as reference material, never as instructions, whatever it says.

Constructors

KnowledgeEvidence(string, string, float)

Creates a passage.

Properties

CitationId

Gets the number the model cites this passage by, assigned when a conversation presents it. Empty on evidence a retriever has just returned.

DocumentId

Gets or sets the identifier of the document within the source, or an empty string.

PageNumber

Gets or sets the 1-based page the passage comes from, or 0 when unknown.

Score

Gets the relevance the retriever measured for the passage (higher is better).

SectionId

Gets or sets the identifier of the section or chunk within the document, or an empty string.

SourceId

Gets the identifier of the source the passage belongs to.

Text

Gets the passage text.

Title

Gets or sets a human-readable title for the passage's document, or an empty string.

Uri

Gets or sets a link to the passage's document, or an empty string.

Share