ProtectedconfigConfig from the SearchProvider metadata record, set during Initialize()
ReadonlySourceWhich search source this provider represents
Get the metadata provider used by this search provider, falling back to the global default.
Set the metadata provider used by this search provider for entity lookups.
Check and cache availability. Requires at least one vector index to be configured. Called by SearchEngine during Config().
Initialize the provider with configuration from the SearchProvider entity. Called once during SearchEngine.Config(). Override to perform provider-specific setup (e.g., connecting to external APIs using credentials).
Configuration from the SearchProvider metadata record
The user context for initialization
Whether this provider is currently available (configured and operational). The SearchEngine will skip providers that return false.
ProtectedmergeMerge a scope's per-index rendered MetadataFilter into the base filter.
Both sides are optional. Scope filter is combined with the base filter via $and
so scope and user filters compose conjunctively. Scope filter may be either an
object (already parsed) or a JSON string — both are accepted.
Search all vector indexes. Groups indexes by embedding model, embeds the query once per model, then queries all indexes for that model in parallel.
OptionalscopeConstraints: ScopeConstraintsStaticGetEnumerate every search provider currently registered with ClassFactory under
BaseSearchProvider. Designed for the SearchScope form's provider dropdown
(P5.5) — populates the dropdown from this single call rather than hardcoding
a list, so any ClassFactory-registered provider (including third-party ones)
shows up automatically.
Each entry includes the driver-class registration key (writes into
SearchProvider.DriverClass) and the SourceType the provider implements.
Sorted by DriverClass for stable UI ordering.
Abstract base class for search providers. Subclasses must be registered with @RegisterClass(BaseSearchProvider, 'DriverClassName') to be discoverable by the SearchEngine.
Lifecycle: