Skip to content

Class UTryllRetrieveParams

ClassList > UTryllRetrieveParams

More...

  • #include <TryllRetrieveParams.h>

Inherits the following classes: UTryllNodeParamsBase

Public Attributes

Type Name
FTryllStoragePath EmbeddedStringStorage
FString Filter
FString FoundExit
FTryllSlotInput Input
FString NotFoundExit
ETryllRetrievalMode RetrievalMode = ETryllRetrievalMode::Dense
int32 RrfK = 60
FString Source
float Threshold = 0.5f
int32 TopK = 2
bool bOverrideFilter = false
bool bOverrideInput = false
bool bOverrideSource = false

Public Functions

Type Name
virtual ETryllNodeType GetNodeType () override const
virtual flatbuffers::Offset< void > Pack (flatbuffers::FlatBufferBuilder & Fbb, Tryll::NodeParams::NodeParams & OutType) override const

Public Functions inherited from UTryllNodeParamsBase

See UTryllNodeParamsBase

Type Name
virtual TArray< FString > GetExitTargetOptions () const
virtual ETryllNodeType GetNodeType () const
FString GetOwnerNodeName () const
virtual flatbuffers::Offset< void > Pack (flatbuffers::FlatBufferBuilder & Fbb, ::Tryll::NodeParams::NodeParams & OutType) const
ETryllNodeType return static_cast (0)

Public Static Functions inherited from UTryllNodeParamsBase

See UTryllNodeParamsBase

Type Name
const FTryllGraphDescription * FindEnclosingGraph (const UObject * Obj)

Detailed Description

RAG retrieval node. Embeds the HumanMessage, searches an embedded storage, and attaches a KnowledgeComponent to the current interaction.

Public Attributes Documentation

variable EmbeddedStringStorage

FTryllStoragePath UTryllRetrieveParams::EmbeddedStringStorage;

Named embedded string storage (EmbeddedStringStorageManager). Structural because the storage is resolved and referenced at construction.


variable Filter

FString UTryllRetrieveParams::Filter;

variable FoundExit

FString UTryllRetrieveParams::FoundExit;

Exit taken when retrieval returned at least one chunk above threshold. Empty string = END. Graph exit "found" — target node name; empty = END.


variable Input

FTryllSlotInput UTryllRetrieveParams::Input;

Upstream inter-node slot this field consumes. Empty = context default.


variable NotFoundExit

FString UTryllRetrieveParams::NotFoundExit;

Exit taken when retrieval produced no results. Empty string = END. Graph exit "not_found" — target node name; empty = END.


variable RetrievalMode

ETryllRetrievalMode UTryllRetrieveParams::RetrievalMode;

Which retrieval path to use. Default Dense preserves historical behaviour. Mutable so a single agent can A/B modes without recreation.


variable RrfK

int32 UTryllRetrieveParams::RrfK;

RRF constant k in score(d) = Σ 1/(k + rank). Only used in Hybrid mode. Mutable. Default 60 (Cormack et al.).


variable Source

FString UTryllRetrieveParams::Source;

variable Threshold

float UTryllRetrieveParams::Threshold;

Maximum cosine distance applied to the dense leg. Dense mode: results above this threshold are dropped (unchanged historical behaviour). Hybrid mode: gates the dense candidate list before RRF fusion; BM25-only hits are not gated. Lexical mode: inert (ignored). Zero disables dense-leg filtering.


variable TopK

int32 UTryllRetrieveParams::TopK;

Number of chunks to retrieve.


variable bOverrideFilter

bool UTryllRetrieveParams::bOverrideFilter;

JSON filter compiled against the storage's metadata schema. Empty string = no filter. Mutable — recompiles the filter on change. Set to true to override the inherited Filter value.


variable bOverrideInput

bool UTryllRetrieveParams::bOverrideInput;

Slot name this node embeds and searches with. Empty = "user_message". Structural: immutable after creation — rebinding would re-wire the slot dataflow that is validated once at agent creation. Set to true to override the inherited Input value.


variable bOverrideSource

bool UTryllRetrieveParams::bOverrideSource;

Label attached to the KnowledgeComponent; defaults to node name. Set to true to override the inherited Source value.


Public Functions Documentation

function GetNodeType

inline virtual ETryllNodeType UTryllRetrieveParams::GetNodeType () override const

Implements UTryllNodeParamsBase::GetNodeType


function Pack

virtual flatbuffers::Offset< void > UTryllRetrieveParams::Pack (
    flatbuffers::FlatBufferBuilder & Fbb,
    Tryll::NodeParams::NodeParams & OutType
) override const

Implements UTryllNodeParamsBase::Pack



The documentation for this class was generated from the following file C:/_tryll/_monorepo3/tryll/clients/unreal/Source/TryllClient/Public/Generated/Nodes/TryllRetrieveParams.h