Skip to main content

Class: RAGOperationHandle

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:51

Fluent handle for a single in-flight RAG operation. Call .complete(resultsCount) to finalize timing and add it to the collector.

Constructors

Constructor

new RAGOperationHandle(type, onComplete): RAGOperationHandle

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:57

Parameters

type

"embedding" | "rerank" | "hyde" | "vector_query" | "graph_local" | "graph_global" | "ingest"

onComplete

(entry) => void

Returns

RAGOperationHandle

Methods

addSources()

addSources(chunks): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:85

Parameters

chunks

object[]

Returns

this


complete()

complete(resultsCount, overrideDurationMs?): RAGOperationEntry

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:163

Finalizes the operation, records duration, computes relevance score stats, and adds the entry to the parent collector.

Parameters

resultsCount

number

Number of results this operation produced.

overrideDurationMs?

number

Optional override for duration (when timing is measured externally).

Returns

RAGOperationEntry


setCollectionIds()

setCollectionIds(ids): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:130

Parameters

ids

string[]

Returns

this


setCost()

setCost(costUSD): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:120

Parameters

costUSD

number

Returns

this


setDataSourceIds()

setDataSourceIds(ids): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:125

Parameters

ids

string[]

Returns

this


setGraphDetails()

setGraphDetails(details): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:135

Parameters

details
communitiesSearched

number

entitiesMatched

number

traversalTimeMs

number

Returns

this


setHydeDetails()

setHydeDetails(details): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:151

Attach HyDE-specific metadata to this audit operation.

Parameters

details

Hypothesis text, effective threshold, and step count.

effectiveThreshold

number

Final similarity threshold after adaptive stepping.

hypothesis

string

The generated hypothetical answer used for embedding.

thresholdSteps

number

Number of adaptive threshold steps taken.

Returns

this

this for fluent chaining.


setRerankDetails()

setRerankDetails(details): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:140

Parameters

details
documentsReranked

number

modelId

string

providerId

string

Returns

this


setRetrievalMethod()

setRetrievalMethod(method): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:80

Parameters

method

{ hybridAlpha?: number; mmrLambda?: number; strategy: "hybrid" | "similarity" | "mmr"; topK?: number; } | undefined

Returns

this


setTokenUsage()

setTokenUsage(usage): this

Defined in: packages/agentos/src/rag/audit/RAGAuditCollector.ts:115

Parameters

usage
embeddingTokens

number

llmCompletionTokens

number

llmPromptTokens

number

totalTokens

number

Returns

this