Package com.tnsai.rag

Record Class RetrievalDiagnostics

java.lang.Object

java.lang.Record

com.tnsai.rag.RetrievalDiagnostics

Record Components:

elapsed - total engine latency

candidateCount - candidates considered before final filtering

returnedCount - evidence entries returned to the caller

cacheOutcome - cache behavior for this invocation

warnings - non-fatal warnings, such as a partial source failure

attributes - implementation-specific diagnostics

public record RetrievalDiagnostics(Duration elapsed, int candidateCount, int returnedCount, RetrievalDiagnostics.CacheOutcome cacheOutcome, List<String> warnings, Map<String,Object> attributes)
extends Record

Entry-point-neutral diagnostics emitted by a retrieval engine.

Since:

0.13.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RetrievalDiagnostics.CacheOutcome	Cache behavior visible to callers and observability integrations.

Constructor Summary

Constructors

Constructor	Description
RetrievalDiagnostics(Duration elapsed, int candidateCount, int returnedCount, RetrievalDiagnostics.CacheOutcome cacheOutcome, List<String> warnings, Map<String,Object> attributes)	Validates counts and defensively copies diagnostic state.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	attributes()	Returns the value of the attributes record component.
RetrievalDiagnostics.CacheOutcome	cacheOutcome()	Returns the value of the cacheOutcome record component.
int	candidateCount()	Returns the value of the candidateCount record component.
Duration	elapsed()	Returns the value of the elapsed record component.
static RetrievalDiagnostics	empty()	Returns diagnostics for an immediate empty, uncached result.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	returnedCount()	Returns the value of the returnedCount record component.
final String	toString()	Returns a string representation of this record class.
List<String>	warnings()	Returns the value of the warnings record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RetrievalDiagnostics

public RetrievalDiagnostics(Duration elapsed,
 int candidateCount,
 int returnedCount,
 RetrievalDiagnostics.CacheOutcome cacheOutcome,
 List<String> warnings,
 Map<String,Object> attributes)

Validates counts and defensively copies diagnostic state.

Method Details

empty

public static RetrievalDiagnostics empty()

Returns diagnostics for an immediate empty, uncached result.

Returns:

empty diagnostics

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

elapsed

public Duration elapsed()

Returns the value of the elapsed record component.

Returns:

the value of the elapsed record component

candidateCount

public int candidateCount()

Returns the value of the candidateCount record component.

Returns:

the value of the candidateCount record component

returnedCount

public int returnedCount()

Returns the value of the returnedCount record component.

Returns:

the value of the returnedCount record component

cacheOutcome

public RetrievalDiagnostics.CacheOutcome cacheOutcome()

Returns the value of the cacheOutcome record component.

Returns:

the value of the cacheOutcome record component

warnings

public List<String> warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component

attributes

public Map<String,Object> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component