Package org.elasticsearch.xpack.esql.plan.physical

Class MMRExec

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<PhysicalPlan>

org.elasticsearch.xpack.esql.plan.QueryPlan<PhysicalPlan>

org.elasticsearch.xpack.esql.plan.physical.PhysicalPlan

org.elasticsearch.xpack.esql.plan.physical.UnaryExec

org.elasticsearch.xpack.esql.plan.physical.MMRExec

All Implemented Interfaces:

NamedWriteable, Writeable

public class MMRExec
extends UnaryExec

Physical plan for the MMR command. MMR performs result diversification on incoming results using maximum marginal relevance. The input is a set of limited rows, where at least one field is a dense vector to use for vector comparison. The output is a reduced set of results, in the same order as the input, but "diversified" to be results that are semantically diverse from each other within the input set.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
MMRExec(Source source, PhysicalPlan child, Attribute diversifyField, Expression limit, Expression queryVectorExpression, MapExpression options)

Method Summary

Modifier and Type	Method	Description
Attribute	diversifyField()
boolean	equals(Object o)
String	getWriteableName()
int	hashCode()
protected NodeInfo<? extends PhysicalPlan>	info()	Normally, you want to use one of the static create methods to implement this.
float	lambda()
Expression	limit()
int	limitValue()
MapExpression	options()
VectorData	queryVector()
UnaryExec	replaceChild(PhysicalPlan newChild)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.UnaryExec

child, inputSet, output, outputSet, replaceChildren

Methods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan

computeExpressions, computeReferences, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, references, transformExpressionsDown, transformExpressionsDown, transformExpressionsOnly, transformExpressionsOnly, transformExpressionsOnlyUp, transformExpressionsUp, transformExpressionsUp

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, nodeString, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, toString, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MMRExec

public MMRExec(Source source,
 PhysicalPlan child,
 Attribute diversifyField,
 Expression limit,
 @Nullable
 Expression queryVectorExpression,
 @Nullable
 MapExpression options)

Method Details

diversifyField

public Attribute diversifyField()

limit

public Expression limit()

options

public MapExpression options()

replaceChild

public UnaryExec replaceChild(PhysicalPlan newChild)

Specified by:

replaceChild in class UnaryExec

info

protected NodeInfo<? extends PhysicalPlan> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Specified by:

info in class Node<PhysicalPlan>

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

equals

public boolean equals(Object o)

Overrides:

equals in class UnaryExec

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryExec

queryVector

public VectorData queryVector()

lambda

public float lambda()

limitValue

public int limitValue()