Navigation
API > API/Plugins > API/Plugins/SemanticSearch
Interface for embedding generation providers. Can support both remote (HTTP API) and local (on-device) implementations.
| Name | IEmbeddingProvider |
| Type | class |
| Header File | /Engine/Plugins/Experimental/SemanticSearch/Source/SemanticSearch/Public/Interfaces/IEmbeddingProvider.h |
| Include Path | #include "Interfaces/IEmbeddingProvider.h" |
Syntax
class IEmbeddingProvider
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IEmbeddingProvider() |
Interfaces/IEmbeddingProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GenerateCaptionAsync
(
FCaptionRequest&& Request, |
Generate a caption and keywords for an asset. Called during indexing to describe the asset content. | Interfaces/IEmbeddingProvider.h | |
void GenerateEmbeddingAsync
(
const FStringView Text, |
Generate embedding for a text string. | Interfaces/IEmbeddingProvider.h | |
uint32 GetConfigHash() |
Get a hash that represents the configuration of this embedding provider | Interfaces/IEmbeddingProvider.h | |
int32 GetEmbeddingDimension() |
Embedding vector dimensionality | Interfaces/IEmbeddingProvider.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CancelAllPendingRequests () |
Cancel all pending requests that have not yet been dispatched. | Interfaces/IEmbeddingProvider.h |