Package org.elasticsearch.xpack.esql.expression.function.inference

Class Embedding

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

org.elasticsearch.xpack.esql.expression.function.inference.Embedding

All Implemented Interfaces:

NamedWriteable, Writeable, PostOptimizationVerificationAware, Resolvable, OptionalArgument

public class Embedding
extends InferenceFunction<Embedding>
implements OptionalArgument, PostOptimizationVerificationAware

EMBEDDING function converts input to dense vector embeddings using an inference endpoint with the embedding task type. It can manage multiple data types and formats (e.g. text, images) based on the options provided

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

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

Node.NodeStringFormat

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.capabilities.PostOptimizationVerificationAware

PostOptimizationVerificationAware.CoordinatorOnly

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 FunctionDefinition	DEFINITION

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.inference.InferenceFunction

INFERENCE_ID_PARAMETER_NAME

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Embedding(Source source, Expression inputValue, Expression inferenceId, Expression inputOptions)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
boolean	foldable()	Whether the expression can be evaluated statically, aka "folded", or not.
String	getWriteableName()
Expression	inferenceId()	The inference endpoint identifier expression.
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
DataType	inputDataType()
Expression	inputText()
TimeValue	inputTimeout()
void	postOptimizationVerification(Failures failures)	Validates the implementing expression - discovered failures are reported to the given Failures class.
Expression	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
TaskType	taskType()	The task type required by this function (e.g., TEXT_EMBEDDING).
Embedding	withInferenceResolutionError(String inferenceId, String error)	Returns a copy with inference resolution error for display to user.
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.inference.InferenceFunction

hasNestedInferenceFunction

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, equals, functionName, hashCode, nodeString, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, fold, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, toString, typeResolved

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, replaceChildrenSameSize, source, sourceLocation, sourceText, 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

Field Details

DEFINITION

public static final FunctionDefinition DEFINITION

Constructor Details

Embedding

public Embedding(Source source,
 Expression inputValue,
 Expression inferenceId,
 Expression inputOptions)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

inputText

public Expression inputText()

inputDataType

public DataType inputDataType()

inputTimeout

public TimeValue inputTimeout()

inferenceId

public Expression inferenceId()

Description copied from class: InferenceFunction

The inference endpoint identifier expression.

Specified by:

inferenceId in class InferenceFunction<Embedding>

foldable

public boolean foldable()

Description copied from class: Expression

Whether the expression can be evaluated statically, aka "folded", or not.

Overrides:

foldable in class Expression

dataType

public DataType dataType()

Description copied from class: Expression

The DataType returned by executing the tree rooted at this expression. If Expression.typeResolved() returns an error then the behavior of this method is undefined. It may return a valid type. Or it may throw an exception. Or it may return a totally nonsensical type.

Specified by:

dataType in class Expression

resolveType

protected Expression.TypeResolution resolveType()

Description copied from class: Expression

The implementation of Expression.typeResolved(), which is just a caching wrapper around this method. See it's javadoc for what this method should return.

Implementations will rarely interact with the Expression.TypeResolution class directly, instead usually calling the utility methods on TypeResolutions.

Implementations should fail if Expression.childrenResolved() returns false.

Overrides:

resolveType in class Expression

postOptimizationVerification

public void postOptimizationVerification(Failures failures)

Description copied from interface: PostOptimizationVerificationAware

Validates the implementing expression - discovered failures are reported to the given Failures class.

Example: the Bucket function, which produces buckets over a numerical or date field, based on a number of literal arguments needs to check if its arguments are all indeed literals. This is how this verification is performed:

     

      @Override
      public void postOptimizationVerification(Failures failures) {
          String operation = sourceText();

          failures.add(isFoldable(buckets, operation, SECOND))
              .add(from != null ? isFoldable(from, operation, THIRD) : null)
              .add(to != null ? isFoldable(to, operation, FOURTH) : null);
      }
     
     

Specified by:

postOptimizationVerification in interface PostOptimizationVerificationAware

taskType

public TaskType taskType()

Description copied from class: InferenceFunction

The task type required by this function (e.g., TEXT_EMBEDDING).

Specified by:

taskType in class InferenceFunction<Embedding>

withInferenceResolutionError

public Embedding withInferenceResolutionError(String inferenceId,
 String error)

Description copied from class: InferenceFunction

Returns a copy with inference resolution error for display to user.

Specified by:

withInferenceResolutionError in class InferenceFunction<Embedding>

replaceChildren

public Expression replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

info

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