Table of Contents

Method QueryPartitions

Namespace
LMKit.Retrieval
Assembly
LM-Kit.NET.dll

QueryPartitions(string, IEnumerable<PartitionSimilarity>, IConversation, CancellationToken)

Generates a response by querying the specified partitions and returns the result with source document references.

public DocumentQueryResult QueryPartitions(string question, IEnumerable<PartitionSimilarity> partitions, IConversation conversation, CancellationToken cancellationToken = default)

Parameters

question string

The question to ask based on the partition content.

partitions IEnumerable<PartitionSimilarity>

A collection of PartitionSimilarity instances containing the context for answering the question. Typically obtained from FindMatchingPartitions(string, int, float, bool, bool, CancellationToken).

conversation IConversation

The IConversation to use for generating the response.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

DocumentQueryResult

A DocumentQueryResult containing the generated response and a list of source references indicating which documents and pages were used.

Examples

// Find relevant partitions
var partitions = docRag.FindMatchingPartitions("What is the conclusion?", topK: 5);

// Generate response with source tracking
LM chatModel = LM.LoadFromModelID("llama-3.1-8b-instruct");
var conversation = new SingleTurnConversation(chatModel);
var result = docRag.QueryPartitions(
    "What is the conclusion?",
    partitions,
    conversation,
    default);

Console.WriteLine($"Answer: {result.Response.Text}");
Console.WriteLine("Sources:");
foreach (var source in result.SourceReferences)
{
    Console.WriteLine($"  - {source.DocumentName}, Page {source.PageNumber}");
}

Remarks

This method extends the base QueryPartitions(string, IEnumerable<PartitionSimilarity>, IConversation, CancellationToken) by returning a DocumentQueryResult that includes source references extracted from partition metadata. These references identify the original document name and page number for each partition used in generating the response.

The PromptTemplate property is used to format the prompt sent to the conversation.

See Also

QueryPartitions(string, IEnumerable<PartitionSimilarity>, IConversation, bool, CancellationToken)

Generates a response by querying the specified partitions, optionally including page renderings for visual context, and returns the result with source document references.

public DocumentQueryResult QueryPartitions(string question, IEnumerable<PartitionSimilarity> partitions, IConversation conversation, bool includePageRenderingsInContext, CancellationToken cancellationToken = default)

Parameters

question string

The question to ask based on the partition content.

partitions IEnumerable<PartitionSimilarity>

A collection of PartitionSimilarity instances containing the context for answering the question. Typically obtained from FindMatchingPartitions(string, int, float, bool, bool, CancellationToken).

conversation IConversation

The IConversation to use for generating the response.

includePageRenderingsInContext bool

true to include page images alongside text for visual grounding; false to use text only. This parameter is only effective when the conversation model supports vision capabilities.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

DocumentQueryResult

A DocumentQueryResult containing the generated response and a list of source references indicating which documents and pages were used.

Examples

// Find relevant partitions
var partitions = docRag.FindMatchingPartitions("What does the chart show?", topK: 5);

// Generate response with visual context for better chart/table understanding
LM chatModel = LM.LoadFromModelID("qwen3-vl:4b"); // Vision-capable model
var conversation = new SingleTurnConversation(chatModel);
var result = docRag.QueryPartitions(
    "What does the chart show?",
    partitions,
    conversation,
    includePageRenderingsInContext: true,
    default);

Console.WriteLine($"Answer: {result.Response.Text}");
Console.WriteLine("Sources:");
foreach (var source in result.SourceReferences)
{
    Console.WriteLine($"  - {source.DocumentName}, Page {source.PageNumber}");
}

Remarks

This method extends the base QueryPartitions(string, IEnumerable<PartitionSimilarity>, IConversation, CancellationToken) by returning a DocumentQueryResult that includes source references extracted from partition metadata. These references identify the original document name and page number for each partition used in generating the response.

When includePageRenderingsInContext is true and the conversation model supports vision (HasVision), page renderings corresponding to retrieved passages are injected into the context. This enables the model to visually interpret tables, charts, figures, and complex layouts that may lose fidelity during text extraction.

Page renderings are deduplicated by document URI and page number to avoid redundant context when multiple partitions reference the same page. If a page rendering fails to load, the error is logged and processing continues with the remaining pages.

The PromptTemplate property is used to format the prompt sent to the conversation.

Exceptions

ArgumentNullException

Thrown if question, partitions, or conversation is null.

OperationCanceledException

Thrown if the operation is canceled.

See Also