Interface RagRetrievalResult

Retrieval result passed back to callers.

interface RagRetrievalResult {
    queryText: string;
    retrievedChunks: RagRetrievedChunk[];
    augmentedContext: string;
    queryEmbedding?: number[];
    diagnostics?: RagRetrievalDiagnostics;
    auditTrail?: RAGAuditTrail;
}

Index

Properties

queryText retrievedChunks augmentedContext queryEmbedding? diagnostics? auditTrail?

Properties

queryText

queryText: string

retrievedChunks

retrievedChunks: RagRetrievedChunk[]

augmentedContext

augmentedContext: string

`Optional` queryEmbedding

queryEmbedding?: number[]

`Optional` diagnostics

diagnostics?: RagRetrievalDiagnostics

`Optional` auditTrail

auditTrail?: RAGAuditTrail

Full audit trail when includeAudit was set on the retrieval options.