Documentation Index
Fetch the complete documentation index at: https://dev.docs.inworld.ai/llms.txt
Use this file to discover all available pages before exploring further.
Overview > Inworld Agent Runtime Subsystem
Class: UInworldRuntimeSubsystem | Inherits from: UEngineSubsystem
The subsystem that manages instancing graphs and their execution.
Methods
Reference
ClearGraphExecutionHistory
Clears the stored graph execution history.
Examples
void ClearGraphExecutionHistory()
GetAEC
Gets the Acoustic Echo Cancellation (AEC) filter interface.
Examples
inworld::AECFilterInterface& GetAEC()
Returns
Type: inworld::AECFilterInterface&
Description: Reference to the AEC filter interface.
GetAllExecutionHistory
Retrieves all execution history entries for a specific owner object.
Examples
void GetAllExecutionHistory()
GetAllUniqueOwner
Retrieves all unique owner objects from the execution history for debugging.
Examples
void GetAllUniqueOwner(TArray<UObject*>& OwnerList)
Parameters
| Parameter | Type | Description |
|---|
| OwnerList | TArray<UObject*>& | Output array of unique owner objects. |
GetHistoryList
Gets the complete execution history list (primarily for editor utility widgets).
Examples
const TArray<FInworldGraphExecutionHistory>& GetHistoryList()
Returns
Type: const TArray<FInworldGraphExecutionHistory>&
Description: Reference to the array of all graph execution history entries.
GetNodeHistoryOuput
Extracts and formats the output data from a node history entry.
Examples
FString GetNodeHistoryOuput(const FInworldNodeHistory& Node)
Parameters
| Parameter | Type | Description |
|---|
| Node | const FInworldNodeHistory& | The node history entry to extract output from. |
Returns
Type: FString
Description: Formatted string representation of the node’s output.
GetOrCreateTextEmbedder
Gets a cached TextEmbedder instance for the given ConfigId, or creates a new one if it doesn’t exist.
Examples
UInworldTextEmbedder* GetOrCreateTextEmbedder()
Returns
Type: UInworldTextEmbedder*
Description: A pointer to the UInworldTextEmbedder instance, or nullptr if the config is invalid or creation fails.
GetVAD
Gets the Voice Activity Detection (VAD) interface.
Examples
inworld::VADInterface& GetVAD()
Returns
Type: inworld::VADInterface&
Description: Reference to the VAD interface.
RegisterCreationConfigType
Examples
bool RegisterCreationConfigType()
Returns
Type: bool
RegisterCustomEdgeConditionType
Examples
bool RegisterCustomEdgeConditionType()
Returns
Type: bool
RegisterNodeType
Examples
Returns
Type: bool
RegisterProcessContext
Examples
void RegisterProcessContext()
SendGraphFeedback
Records user feedback with OpenTelemetry for analytics and improvement.
Examples
void SendGraphFeedback(const FInworldGraphFeedback& Feedback)
Parameters
| Parameter | Type | Description |
|---|
| Feedback | const FInworldGraphFeedback& | The feedback data including graph ID, execution ID, rating, and description. |
UnregisterComponent
Examples
bool UnregisterComponent()
Returns
Type: bool
UnregisterProcessContext
Examples
void UnregisterProcessContext()
