Class TextEmbedding
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<TextEmbedding>
org.elasticsearch.xpack.esql.expression.function.inference.TextEmbedding
- All Implemented Interfaces:
NamedWriteable,Writeable,Resolvable
TEXT_EMBEDDING function converts text to dense vector embeddings using an inference endpoint.
-
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 inherited from class org.elasticsearch.xpack.esql.expression.function.inference.InferenceFunction
INFERENCE_ID_PARAMETER_NAME -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondataType()booleanbooleanfoldable()inthashCode()The inference endpoint identifier expression.protected NodeInfo<? extends Expression> info()replaceChildren(List<Expression> newChildren) protected Expression.TypeResolutiontaskType()The task type required by this function (e.g., TEXT_EMBEDDING).toString()withInferenceResolutionError(String inferenceId, String error) Returns a copy with inference resolution error for display to user.voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.xpack.esql.expression.function.inference.InferenceFunction
hasNestedInferenceFunctionMethods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function
arguments, functionName, nodeString, nullableMethods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression
canonical, canonicalize, childrenResolved, fold, propertiesToString, references, resolved, semanticEquals, semanticHash, 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, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp
-
Constructor Details
-
TextEmbedding
-
-
Method Details
-
writeTo
- Throws:
IOException
-
getWriteableName
-
inputText
-
inferenceId
Description copied from class:InferenceFunctionThe inference endpoint identifier expression.- Specified by:
inferenceIdin classInferenceFunction<TextEmbedding>
-
foldable
public boolean foldable()- Overrides:
foldablein classExpression
-
dataType
- Specified by:
dataTypein classExpression
-
resolveType
- Overrides:
resolveTypein classExpression
-
taskType
Description copied from class:InferenceFunctionThe task type required by this function (e.g., TEXT_EMBEDDING).- Specified by:
taskTypein classInferenceFunction<TextEmbedding>
-
withInferenceResolutionError
Description copied from class:InferenceFunctionReturns a copy with inference resolution error for display to user.- Specified by:
withInferenceResolutionErrorin classInferenceFunction<TextEmbedding>
-
replaceChildren
- Specified by:
replaceChildrenin classNode<Expression>
-
info
- Specified by:
infoin classNode<Expression>
-
toString
- Overrides:
toStringin classExpression
-
equals
-
hashCode
public int hashCode()
-