Package org.elasticsearch.xpack.esql.plan.logical.inference

Class Rerank

java.lang.Object

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

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

org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

org.elasticsearch.xpack.esql.plan.logical.UnaryPlan

org.elasticsearch.xpack.esql.plan.logical.inference.InferencePlan<Rerank>

org.elasticsearch.xpack.esql.plan.logical.inference.Rerank

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisVerificationAware, TelemetryAware, Resolvable, GeneratingPlan<InferencePlan<Rerank>>, ExecutesOn, ExecutesOn.Coordinator, SortAgnostic, SortPreserving, Streaming, SurrogateLogicalPlan

public class Rerank
extends InferencePlan<Rerank>
implements PostAnalysisVerificationAware, TelemetryAware

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

LogicalPlan.Stage

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.plan.logical.ExecutesOn

ExecutesOn.Coordinator, ExecutesOn.ExecuteLocation, ExecutesOn.Remote

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY

Fields inherited from class org.elasticsearch.xpack.esql.plan.logical.inference.InferencePlan

ESQL_INFERENCE_ROW_LIMIT, INFERENCE_ID_OPTION_NAME, VALID_INFERENCE_OPTION_NAMES

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Rerank(StreamInput in)
Rerank(Source source, LogicalPlan child, Expression rowLimit, Expression queryText, List<Alias> rerankFields, Attribute scoreAttribute)
Rerank(Source source, LogicalPlan child, Expression inferenceId, Expression rowLimit, Expression queryText, List<Alias> rerankFields, Attribute scoreAttribute)

Method Summary

Modifier and Type	Method	Description
protected AttributeSet	computeReferences()	This very likely needs to be overridden for QueryPlan.references() to be correct when inheriting.
static AttributeSet	computeReferences(List<Alias> fields)
boolean	equals(Object o)
boolean	expressionsResolved()
List<Attribute>	generatedAttributes()
String	getWriteableName()
int	hashCode()
protected NodeInfo<? extends LogicalPlan>	info()	Normally, you want to use one of the static create methods to implement this.
boolean	isFoldable()	Checks if this InferencePlan is foldable (all input expressions are foldable).
boolean	isValidRerankField(Alias rerankField)
List<Attribute>	output()	The ordered list of attributes (i.e.
void	postAnalysisVerification(Failures failures)	Allows the implementer to validate itself.
Expression	queryText()
UnaryPlan	replaceChild(LogicalPlan newChild)
List<Alias>	rerankFields()
Attribute	scoreAttribute()
TaskType	taskType()
Rerank	withGeneratedNames(List<String> newNames)	Create a new instance of this node with new output Attributes using the given names.
Rerank	withInferenceId(Expression newInferenceId)
Rerank	withRerankFields(List<Alias> newRerankFields)
Rerank	withScoreAttribute(Attribute newScoreAttribute)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.inference.InferencePlan

inferenceId, rowLimit, surrogate, validOptionNames, withInferenceResolutionError

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.UnaryPlan

child, inputSet, outputSet, replaceChildren

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

analyzed, childrenResolved, optimized, preAnalyzed, preOptimized, resolved, setAnalyzed, setOptimized, setPreAnalyzed, setPreOptimized

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xpack.esql.plan.logical.ExecutesOn.Coordinator

executesOn

Methods inherited from interface org.elasticsearch.xpack.esql.plan.GeneratingPlan

checkNumberOfNewNames

Methods inherited from interface org.elasticsearch.xpack.esql.capabilities.TelemetryAware

telemetryLabel

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

Rerank

public Rerank(Source source,
 LogicalPlan child,
 Expression rowLimit,
 Expression queryText,
 List<Alias> rerankFields,
 Attribute scoreAttribute)

Rerank

public Rerank(Source source,
 LogicalPlan child,
 Expression inferenceId,
 Expression rowLimit,
 Expression queryText,
 List<Alias> rerankFields,
 Attribute scoreAttribute)

Rerank

public Rerank(StreamInput in)
       throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class InferencePlan<Rerank>

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

queryText

public Expression queryText()

rerankFields

public List<Alias> rerankFields()

scoreAttribute

public Attribute scoreAttribute()

taskType

public TaskType taskType()

Specified by:

taskType in class InferencePlan<Rerank>

withInferenceId

public Rerank withInferenceId(Expression newInferenceId)

Specified by:

withInferenceId in class InferencePlan<Rerank>

withRerankFields

public Rerank withRerankFields(List<Alias> newRerankFields)

withScoreAttribute

public Rerank withScoreAttribute(Attribute newScoreAttribute)

replaceChild

public UnaryPlan replaceChild(LogicalPlan newChild)

Specified by:

replaceChild in class UnaryPlan

computeReferences

protected AttributeSet computeReferences()

Description copied from class: QueryPlan

This very likely needs to be overridden for QueryPlan.references() to be correct when inheriting. This can be called on unresolved plans and therefore must not rely on calls to QueryPlan.output().

Overrides:

computeReferences in class QueryPlan<LogicalPlan>

generatedAttributes

public List<Attribute> generatedAttributes()

Specified by:

generatedAttributes in interface GeneratingPlan<InferencePlan<Rerank>>

withGeneratedNames

public Rerank withGeneratedNames(List<String> newNames)

Description copied from interface: GeneratingPlan

Create a new instance of this node with new output Attributes using the given names. If an output attribute already has the desired name, we continue using it; otherwise, we create a new attribute with a new NameId.

Specified by:

withGeneratedNames in interface GeneratingPlan<InferencePlan<Rerank>>

computeReferences

public static AttributeSet computeReferences(List<Alias> fields)

isValidRerankField

public boolean isValidRerankField(Alias rerankField)

expressionsResolved

public boolean expressionsResolved()

Overrides:

expressionsResolved in class InferencePlan<Rerank>

isFoldable

public boolean isFoldable()

Description copied from class: InferencePlan

Checks if this InferencePlan is foldable (all input expressions are foldable). A plan is foldable if all its input expressions can be evaluated statically.

Specified by:

isFoldable in class InferencePlan<Rerank>

info

protected NodeInfo<? extends LogicalPlan> 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<LogicalPlan>

postAnalysisVerification

public void postAnalysisVerification(Failures failures)

Description copied from interface: PostAnalysisVerificationAware

Allows the implementer to validate itself. This usually involves checking its internal setup, which often means checking the parameters it received on construction: their data or syntactic type, class, their count, expressions' structure etc. The discovered failures are added to the given Failures object.

It is often more useful to perform the checks as extended as it makes sense, over stopping at the first failure. This will allow the author to progress faster to a correct query.

Example: the Filter class, which models the WHERE command, checks that the expression it filters on - condition - is of a Boolean or NULL type:

     
     @Override
     void postAnalysisVerification(Failures failures) {
          if (condition.dataType() != NULL && condition.dataType() != BOOLEAN) {
              failures.add(fail(condition, "Condition expression needs to be boolean, found [{}]", condition.dataType()));
          }
     }
     
     

Specified by:

postAnalysisVerification in interface PostAnalysisVerificationAware

Parameters:

failures - the object to add failures to.

equals

public boolean equals(Object o)

Overrides:

equals in class InferencePlan<Rerank>

hashCode

public int hashCode()

Overrides:

hashCode in class InferencePlan<Rerank>

output

public List<Attribute> output()

Description copied from class: QueryPlan

The ordered list of attributes (i.e. columns) this plan produces when executed. Must be called only on resolved plans, otherwise may throw an exception or return wrong results.

Overrides:

output in class UnaryPlan