Class InferenceFunction<PlanType extends InferenceFunction<PlanType>>
java.lang.Object
org.elasticsearch.xpack.esql.core.tree.Node<Expression>
org.elasticsearch.xpack.esql.core.expression.Expression
org.elasticsearch.xpack.esql.core.expression.function.Function
org.elasticsearch.xpack.esql.expression.function.inference.InferenceFunction<PlanType>
- All Implemented Interfaces:
NamedWriteable,Writeable,Resolvable
- Direct Known Subclasses:
TextEmbedding
public abstract class InferenceFunction<PlanType extends InferenceFunction<PlanType>>
extends Function
Base class for ESQL functions that use inference endpoints (e.g., TEXT_EMBEDDING).
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression
Expression.TypeResolutionNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedInferenceFunction(Source source, List<Expression> children) -
Method Summary
Modifier and TypeMethodDescriptionbooleanTrue if this function contains nested inference function calls.abstract ExpressionThe inference endpoint identifier expression.abstract TaskTypetaskType()The task type required by this function (e.g., TEXT_EMBEDDING).abstract PlanTypewithInferenceResolutionError(String inferenceId, String error) Returns a copy with inference resolution error for display to user.Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function
arguments, equals, functionName, hashCode, nodeString, nullableMethods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression
canonical, canonicalize, childrenResolved, dataType, fold, foldable, propertiesToString, references, resolved, resolveType, semanticEquals, semanticHash, toString, typeResolvedMethods inherited from class org.elasticsearch.xpack.esql.core.tree.Node
anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, nodeName, nodeProperties, replaceChildren, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUpMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable
getWriteableName
-
Field Details
-
INFERENCE_ID_PARAMETER_NAME
- See Also:
-
-
Constructor Details
-
InferenceFunction
-
-
Method Details
-
inferenceId
The inference endpoint identifier expression. -
taskType
The task type required by this function (e.g., TEXT_EMBEDDING). -
withInferenceResolutionError
Returns a copy with inference resolution error for display to user. -
hasNestedInferenceFunction
public boolean hasNestedInferenceFunction()True if this function contains nested inference function calls.
-