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

Class InferencePlan<PlanType extends InferencePlan<PlanType>>

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<PlanType>

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, GeneratingPlan<InferencePlan<PlanType>>, ExecutesOn, ExecutesOn.Coordinator, SortAgnostic, Streaming

Direct Known Subclasses:

Completion, Rerank

public abstract class InferencePlan<PlanType extends InferencePlan<PlanType>>
extends UnaryPlan
implements Streaming, SortAgnostic, GeneratingPlan<InferencePlan<PlanType>>, ExecutesOn.Coordinator

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 String	INFERENCE_ID_OPTION_NAME
static final List<String>	VALID_INFERENCE_OPTION_NAMES

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InferencePlan(Source source, LogicalPlan child, Expression inferenceId)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
boolean	expressionsResolved()
int	hashCode()
Expression	inferenceId()
abstract boolean	isFoldable()	Checks if this InferencePlan is foldable (all input expressions are foldable).
abstract TaskType	taskType()
List<String>	validOptionNames()
abstract PlanType	withInferenceId(Expression newInferenceId)
PlanType	withInferenceResolutionError(String inferenceId, String error)
void	writeTo(StreamOutput out)

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

child, inputSet, output, outputSet, replaceChild, 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, 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

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, 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, generatedAttributes, withGeneratedNames

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Field Details

INFERENCE_ID_OPTION_NAME

public static final String INFERENCE_ID_OPTION_NAME

See Also:

• Constant Field Values

VALID_INFERENCE_OPTION_NAMES

public static final List<String> VALID_INFERENCE_OPTION_NAMES

Constructor Details

InferencePlan

protected InferencePlan(Source source,
 LogicalPlan child,
 Expression inferenceId)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

inferenceId

public Expression inferenceId()

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

equals

public boolean equals(Object o)

Overrides:

equals in class UnaryPlan

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryPlan

taskType

public abstract TaskType taskType()

withInferenceId

public abstract PlanType withInferenceId(Expression newInferenceId)

withInferenceResolutionError

public PlanType withInferenceResolutionError(String inferenceId,
 String error)

validOptionNames

public List<String> validOptionNames()

isFoldable

public abstract boolean isFoldable()

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