Module org.elasticsearch.server

Package org.elasticsearch.plugins

Interface SearchPlugin

public interface SearchPlugin

Plugin for extending search time behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SearchPlugin.AggregationSpec	Specification for an Aggregation.
static class	SearchPlugin.FetchPhaseConstructionContext	Context available during fetch phase construction.
static final record	SearchPlugin.GenericNamedWriteableSpec	Specification of GenericNamedWriteable classes that can be serialized/deserialized as generic objects in search results.
static class	SearchPlugin.PipelineAggregationSpec	Specification for a PipelineAggregator.
static class	SearchPlugin.QuerySpec<T extends QueryBuilder>	Specification of custom Query.
static class	SearchPlugin.QueryVectorBuilderSpec<T extends QueryVectorBuilder>	Specification of custom QueryVectorBuilder.
static class	SearchPlugin.RescorerSpec<T extends RescorerBuilder<T>>
static class	SearchPlugin.RetrieverSpec<RB extends RetrieverBuilder>	Specification of custom RetrieverBuilder.
static class	SearchPlugin.ScoreFunctionSpec<T extends ScoreFunctionBuilder<T>>	Specification of custom ScoreFunction.
static class	SearchPlugin.SearchExtensionSpec<W extends NamedWriteable,P>	Specification of search time behavior extension like a custom ScoreFunction.
static class	SearchPlugin.SearchExtSpec<T extends SearchExtBuilder>	Specification for a SearchExtBuilder which represents an additional section that can be parsed in a search request (within the ext element).
static class	SearchPlugin.SignificanceHeuristicSpec<T extends SignificanceHeuristic>	Specification of custom SignificanceHeuristic.
static class	SearchPlugin.SuggesterSpec<T extends SuggestionBuilder<T>>	Specification for a Suggester.

Method Summary

Modifier and Type	Method	Description
default List<Consumer<ValuesSourceRegistry.Builder>>	getAggregationExtentions()	Allows plugins to register new aggregations using aggregation names that are already defined in Core, as long as the new aggregations target different ValuesSourceTypes
default List<SearchPlugin.AggregationSpec>	getAggregations()	The new Aggregations added by this plugin.
default List<FetchSubPhase>	getFetchSubPhases(SearchPlugin.FetchPhaseConstructionContext context)	The new FetchSubPhases defined by this plugin.
default List<SearchPlugin.GenericNamedWriteableSpec>	getGenericNamedWriteables()	Additional GenericNamedWriteable classes added by this plugin.
default Map<String,Highlighter>	getHighlighters()	Get the Highlighters defined by this plugin.
default List<SearchPlugin.PipelineAggregationSpec>	getPipelineAggregations()	The new PipelineAggregators added by this plugin.
default List<SearchPlugin.QuerySpec<?>>	getQueries()	The new Querys defined by this plugin.
default List<SearchPlugin.QueryVectorBuilderSpec<?>>	getQueryVectorBuilders()	The new QueryVectorBuilders defined by this plugin.
default CheckedBiConsumer<ShardSearchRequest,StreamOutput,IOException>	getRequestCacheKeyDifferentiator()	Allows plugins to register a cache differentiator which contributes to the cacheKey computation for the request cache.
default List<SearchPlugin.RescorerSpec<?>>	getRescorers()	The new Rescorers added by this plugin.
default List<SearchPlugin.RetrieverSpec<?>>	getRetrievers()	The new RetrieverBuilders defined by this plugin.
default List<SearchPlugin.ScoreFunctionSpec<?>>	getScoreFunctions()	The new ScoreFunctions defined by this plugin.
default List<SearchPlugin.SearchExtSpec<?>>	getSearchExts()	The new SearchExtBuilders defined by this plugin.
default List<SearchPlugin.SignificanceHeuristicSpec<?>>	getSignificanceHeuristics()	The new SignificanceHeuristics defined by this plugin.
default List<SearchPlugin.SuggesterSpec<?>>	getSuggesters()	The new Suggesters defined by this plugin.

Method Details

getScoreFunctions

default List<SearchPlugin.ScoreFunctionSpec<?>> getScoreFunctions()

The new ScoreFunctions defined by this plugin.

getSignificanceHeuristics

default List<SearchPlugin.SignificanceHeuristicSpec<?>> getSignificanceHeuristics()

The new SignificanceHeuristics defined by this plugin. SignificanceHeuristics are used by the SignificantTerms aggregation to pick which terms are significant for a given query.

getQueryVectorBuilders

default List<SearchPlugin.QueryVectorBuilderSpec<?>> getQueryVectorBuilders()

The new QueryVectorBuilders defined by this plugin. QueryVectorBuilders can be used within a kNN search to build the query vector instead of having the user provide the vector directly

getFetchSubPhases

default List<FetchSubPhase> getFetchSubPhases(SearchPlugin.FetchPhaseConstructionContext context)

The new FetchSubPhases defined by this plugin.

getSearchExts

default List<SearchPlugin.SearchExtSpec<?>> getSearchExts()

The new SearchExtBuilders defined by this plugin.

getHighlighters

default Map<String,Highlighter> getHighlighters()

Get the Highlighters defined by this plugin.

getSuggesters

default List<SearchPlugin.SuggesterSpec<?>> getSuggesters()

The new Suggesters defined by this plugin.

getRetrievers

default List<SearchPlugin.RetrieverSpec<?>> getRetrievers()

The new RetrieverBuilders defined by this plugin.

getQueries

default List<SearchPlugin.QuerySpec<?>> getQueries()

The new Querys defined by this plugin.

getAggregations

default List<SearchPlugin.AggregationSpec> getAggregations()

The new Aggregations added by this plugin.

getAggregationExtentions

default List<Consumer<ValuesSourceRegistry.Builder>> getAggregationExtentions()

Allows plugins to register new aggregations using aggregation names that are already defined in Core, as long as the new aggregations target different ValuesSourceTypes

Returns:

A list of the new registrar functions

getPipelineAggregations

default List<SearchPlugin.PipelineAggregationSpec> getPipelineAggregations()

The new PipelineAggregators added by this plugin.

getRescorers

default List<SearchPlugin.RescorerSpec<?>> getRescorers()

The new Rescorers added by this plugin.

getGenericNamedWriteables

default List<SearchPlugin.GenericNamedWriteableSpec> getGenericNamedWriteables()

Additional GenericNamedWriteable classes added by this plugin.

getRequestCacheKeyDifferentiator

@Nullable
default CheckedBiConsumer<ShardSearchRequest,StreamOutput,IOException> getRequestCacheKeyDifferentiator()

Allows plugins to register a cache differentiator which contributes to the cacheKey computation for the request cache. This helps differentiate between queries that are otherwise identical.