Class UTryllRetrieveParams¶

ClassList > UTryllRetrieveParams

#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	Schema
FString	Source
ETryllKnowledgeSourceKind	SourceKind = `ETryllKnowledgeSourceKind::FromFile`
FString	StorageName
float	Threshold = `0.5f`
int32	TopK = `2`
bool	bOverrideFilter = `false`
bool	bOverrideInput = `false`
bool	bOverrideSource = `false`

Public Functions¶

Type	Name
virtual FString	GetDocsUrl () override const
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 FString	GetDocsUrl () const
virtual TArray< FString >	GetExitTargetOptions () const
virtual ETryllNodeType	GetNodeType () const
FString	GetOwnerNodeName () const
virtual bool	IsTtsConsumer () const
virtual flatbuffers::Offset< void >	Pack (flatbuffers::FlatBufferBuilder & Fbb, ::Tryll::NodeParams::NodeParams & OutType) const
virtual void	PostLoad () override
virtual void	Serialize (FArchive & Ar) override
ETryllNodeType return	static_cast (0)

Public Static Functions inherited from UTryllNodeParamsBase¶

See UTryllNodeParamsBase

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

Protected Functions inherited from UTryllNodeParamsBase¶

See UTryllNodeParamsBase

Type	Name
virtual void	ApplyOldDefaults (int32 SavedVersion)
virtual bool	UpgradeFrom (int32 SavedVersion)

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;

Embedded knowledge file to search. Used when Source Kind is From File; leave empty with From Name.

variable Filter¶

FString UTryllRetrieveParams::Filter;

variable FoundExit¶

FString UTryllRetrieveParams::FoundExit;

Node to run when at least one chunk is found. Empty = end the turn. 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;

Node to run when nothing is found. Empty = end the turn. Graph exit "not_found" — target node name; empty = END.

variable RetrievalMode¶

ETryllRetrievalMode UTryllRetrieveParams::RetrievalMode;

Dense = match by meaning. Lexical = match by keywords (BM25). Hybrid = both, merged.

variable RrfK¶

int32 UTryllRetrieveParams::RrfK;

Hybrid only: how strongly the merge favours top-ranked hits. Higher = flatter. 60 is the standard value.

variable Schema¶

FString UTryllRetrieveParams::Schema;

Record schema of the store. Required with From Name; with From File, checked against the file.

variable Source¶

FString UTryllRetrieveParams::Source;

variable SourceKind¶

ETryllKnowledgeSourceKind UTryllRetrieveParams::SourceKind;

From File = a prebuilt knowledge file. From Name = a memory store the game fills during play (Write To Memory).

variable StorageName¶

FString UTryllRetrieveParams::StorageName;

Memory store to search, by name. Used when Source Kind is From Name. May include agent variables (var.*).

variable Threshold¶

float UTryllRetrieveParams::Threshold;

Max cosine distance for a chunk to count (0 = identical, 2 = opposite). 0 = no limit. Ignored in Lexical mode.

variable TopK¶

int32 UTryllRetrieveParams::TopK;

How many matching chunks to return.

variable bOverrideFilter¶

bool UTryllRetrieveParams::bOverrideFilter;

JSON filter on chunk metadata; only matching chunks are searched. Empty = no filter. Set to true to override the inherited Filter value.

variable bOverrideInput¶

bool UTryllRetrieveParams::bOverrideInput;

Text to search with: the player's message or an earlier node's output. Empty = the player's message. Set to true to override the inherited Input value.

variable bOverrideSource¶

bool UTryllRetrieveParams::bOverrideSource;

Name templates use for these results: the knowledge_<source> tag. Empty = this node's name. Set to true to override the inherited Source value.

Public Functions Documentation¶

function GetDocsUrl¶

inline virtual FString UTryllRetrieveParams::GetDocsUrl () override const

Reference page of this node type on docs.tryllengine.com, opened by the editor's help button. Empty for test-only node types, which have no page.

Implements UTryllNodeParamsBase::GetDocsUrl

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