Module org.elasticsearch.xcore
Class SparseVectorQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<SparseVectorQueryBuilder>
org.elasticsearch.xpack.core.ml.search.SparseVectorQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,QueryBuilder,Rewriteable<QueryBuilder>,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final Stringstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionSparseVectorQueryBuilder(String fieldName, String inferenceId, String query) SparseVectorQueryBuilder(String fieldName, List<WeightedToken> queryVectors, String inferenceId, String query, Boolean shouldPruneTokens, TokenPruningConfig tokenPruningConfig) -
Method Summary
Modifier and TypeMethodDescriptionprotected booleandoEquals(SparseVectorQueryBuilder other) protected intprotected QueryBuilderdoRewrite(QueryRewriteContext queryRewriteContext) protected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) protected voiddoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) static SparseVectorQueryBuilderfromXContent(org.elasticsearch.xcontent.XContentParser parser) getQuery()Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doInnerHitsRewrite, doSearchRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragmentMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
supportsVersion
-
Field Details
-
NAME
- See Also:
-
ALLOWED_FIELD_TYPE
- See Also:
-
FIELD_FIELD
public static final org.elasticsearch.xcontent.ParseField FIELD_FIELD -
QUERY_VECTOR_FIELD
public static final org.elasticsearch.xcontent.ParseField QUERY_VECTOR_FIELD -
INFERENCE_ID_FIELD
public static final org.elasticsearch.xcontent.ParseField INFERENCE_ID_FIELD -
QUERY_FIELD
public static final org.elasticsearch.xcontent.ParseField QUERY_FIELD -
PRUNE_FIELD
public static final org.elasticsearch.xcontent.ParseField PRUNE_FIELD -
PRUNING_CONFIG_FIELD
public static final org.elasticsearch.xcontent.ParseField PRUNING_CONFIG_FIELD
-
-
Constructor Details
-
SparseVectorQueryBuilder
-
SparseVectorQueryBuilder
public SparseVectorQueryBuilder(String fieldName, @Nullable List<WeightedToken> queryVectors, @Nullable String inferenceId, @Nullable String query, @Nullable Boolean shouldPruneTokens, @Nullable TokenPruningConfig tokenPruningConfig) -
SparseVectorQueryBuilder
- Throws:
IOException
-
-
Method Details
-
getFieldName
-
getQueryVectors
-
getInferenceId
-
getQuery
-
shouldPruneTokens
-
getTokenPruningConfig
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<SparseVectorQueryBuilder>- Throws:
IOException
-
doXContent
protected void doXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
doXContentin classAbstractQueryBuilder<SparseVectorQueryBuilder>- Throws:
IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<SparseVectorQueryBuilder>- Throws:
IOException
-
doRewrite
- Overrides:
doRewritein classAbstractQueryBuilder<SparseVectorQueryBuilder>
-
doEquals
- Specified by:
doEqualsin classAbstractQueryBuilder<SparseVectorQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<SparseVectorQueryBuilder>
-
getWriteableName
-
getMinimalSupportedVersion
-
fromXContent
public static SparseVectorQueryBuilder fromXContent(org.elasticsearch.xcontent.XContentParser parser)
-