Navigation
API > API/Plugins > API/Plugins/SemanticSearch
| Name | ISemanticSearchModule |
| Type | class |
| Header File | /Engine/Plugins/Experimental/SemanticSearch/Source/SemanticSearch/Public/ISemanticSearchModule.h |
| Include Path | #include "ISemanticSearchModule.h" |
Syntax
class ISemanticSearchModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelIndexing() |
Cancel all in-flight indexing tasks, drop the job queue, and dismiss progress UI. | ISemanticSearchModule.h | |
TSharedPtr< IEmbeddingProvider > GetEmbeddingProvider() |
Returns the active embedding provider, or nullptr if none has been registered. | ISemanticSearchModule.h | |
FSemanticSearchIndexStats GetIndexStats() |
Get current index statistics. | ISemanticSearchModule.h | |
void IndexAllAssets
(
bool bForceBuild |
Re-index all supported assets. | ISemanticSearchModule.h | |
void IndexAsset
(
const FAssetData& AssetData |
Index a single asset, always building from the backend if not already cached. | ISemanticSearchModule.h | |
void IndexAssets
(
TConstArrayView< FAssetData > Assets |
Index a batch of assets. Filters through processor check, uses batch DDC paths, and shows progress. | ISemanticSearchModule.h | |
void Initialize () |
Load the saved index, start the consumer queue, and subscribe to asset-registry events using the currently registered embedding provider. | ISemanticSearchModule.h | |
bool IsIndexingInProgress() |
Returns true while a batch indexing operation is in flight (safe to call from any thread). | ISemanticSearchModule.h | |
bool IsInitialized() |
True once Initialize() has run successfully. | ISemanticSearchModule.h | |
void RegisterEmbeddingProvider
(
TUniquePtr< IEmbeddingProvider >&& EmbeddingProvider, |
ISemanticSearchModule.h | ||
void RetrainIndex() |
Retrain the current quantized index from scratch (new codebook). No-op for flat index. | ISemanticSearchModule.h | |
void SearchAsync
(
const FString& QueryText, |
Perform a hybrid search asynchronously via the index command queue. | ISemanticSearchModule.h | |
void SetIndexingPending () |
Mark an indexing-related operation as pending. | ISemanticSearchModule.h | |
void SwitchIndexType
(
ESemanticSearchIndexType NewType |
Switch to a different index type. Re-indexes all assets. | ISemanticSearchModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ISemanticSearchModule & Get() |
ISemanticSearchModule.h | ||
static bool IsInIndexedFolder
(
const FAssetData& AssetData |
Returns true if the asset is in a folder configured for indexing. | ISemanticSearchModule.h | |
static bool IsInIndexedFolder
(
FStringView PackagePath |
Returns true if the given package path is in a folder configured for indexing. | ISemanticSearchModule.h |