Package com.tnsai.rag

Record Class RetrievalEvidence

java.lang.Object

java.lang.Record

com.tnsai.rag.RetrievalEvidence

Record Components:

content - retrieved text

provenance - source, ranking, score, and strategy provenance

metadata - implementation-neutral evidence metadata

public record RetrievalEvidence(String content, RetrievalEvidence.Provenance provenance, Map<String,Object> metadata)
extends Record

Immutable evidence returned by a RetrievalEngine.

Action-context evidence marked selection=DIRECT retains the complete normalized original text, including surrounding whitespace. Other evidence retains the usual stripping of surrounding whitespace. DIRECT has an unranked score of zero; its strategy identifies the configured retrieval fallback and its rank is the one-based output position. The selection metadata is descriptive, not an authorization or trust signal.

Since:

0.13.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RetrievalEvidence.Provenance	Stable provenance required for audit, citation, and diagnostics.

Constructor Summary

Constructors

Constructor	Description
RetrievalEvidence(String content, RetrievalEvidence.Provenance provenance, Map<String,Object> metadata)	Validates and defensively copies evidence state.

Method Summary

Modifier and Type	Method	Description
String	content()	Returns the value of the content record component.
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.
Map<String,Object>	metadata()	Returns the value of the metadata record component.
RetrievalEvidence.Provenance	provenance()	Returns the value of the provenance record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RetrievalEvidence

public RetrievalEvidence(String content,
 RetrievalEvidence.Provenance provenance,
 Map<String,Object> metadata)

Validates and defensively copies evidence state.

Method Details

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

content

public String content()

Returns the value of the content record component.

Returns:

the value of the content record component

provenance

public RetrievalEvidence.Provenance provenance()

Returns the value of the provenance record component.

Returns:

the value of the provenance record component

metadata

public Map<String,Object> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component