Navigation
| Name | SemanticSearch |
| Type | Plugin |
| Part of Plugins | Semantic Search |
| Location | /Engine/Plugins/Experimental/SemanticSearch/Source/SemanticSearch/ |
| Module Build Rules | SemanticSearch.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FAssetProcessorManager | |
| FHybridSearchIndex | Singleton that owns all search indices (vector + BM25) and fuses results using Reciprocal Rank Fusion (RRF). |
| FThumbnailBaseAssetProcessor | Reusable base class for asset processors that operate via on-disk thumbnails. |
| USemanticSearchSettings |
Structs
| Name | Remarks |
|---|---|
| FAssetCaptionResult | |
| FAssetEmbeddingResult | |
| FAssetIndexingResult | Combined result for a single-call indexing data fetch (caption + embedding or quantized codes). |
| FAssetMedia | A single media payload attached to a caption request. |
| FAssetQuantizedEmbeddingResult | |
| FCaptionRequest | Request to generate a caption (and keywords) for an asset. |
| FCaptionResponse | Response from caption generation. Success if ErrorMessage is empty (FailureReason == None). |
| FEmbeddingResponse | Response from embedding generation. Success if ErrorMessage is empty (FailureReason == None). |
| FHybridSearchResult | |
| FSearchResult | |
| FSemanticSearchIndexStats |
Interfaces
| Name | Remarks |
|---|---|
| IAssetProcessor | |
| IEmbeddingProvider | Interface for embedding generation providers. |
| IQuantizedVectorIndex | Interface for vector indices that support quantization (PQ, RaBitQ, etc.). |
| ISemanticSearchModule | |
| IVectorIndex | Abstract interface for vector similarity search indices. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCaptionComplete | TUniqueFunction< void(FCaptionResponse &&)> | Interfaces/IEmbeddingProvider.h | |
| FOnEmbeddingComplete | TUniqueFunction< void(FEmbeddingResponse &&)> | Interfaces/IEmbeddingProvider.h | |
| FOnIndexChanged | TMulticastDelegate_OneParam< void, bool > | HybridSearchIndex.h | |
| FOnRequestComplete | TUniqueFunction< void(bool bHasGeneratedCaptionRequest, FCaptionRequest &&CaptionRequest, FString &&ErrorMessage, EAssetIndexFailureReason Reason)> | Processor-generated caption-request result. | Interfaces/IAssetProcessor.h |
Enums
Public
| Name | Remarks |
|---|---|
| ESemanticSearchEmbeddingProvider | |
| ESemanticSearchIndexType | |
| UE::SemanticSearch::EAssetIndexFailureReason | Classification of an indexing failure. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool UE::SemanticSearch::IsPreProcessorFailure
(
EAssetIndexFailureReason Reason |
Pre-processor failures are permanent; Provider failures are retryable. | HybridSearchIndex.h |