Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.search

Class SparseVectorQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<SparseVectorQueryBuilder>

org.elasticsearch.index.query.LeafQueryBuilder<SparseVectorQueryBuilder>

org.elasticsearch.xpack.core.ml.search.SparseVectorQueryBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

public class SparseVectorQueryBuilder
extends LeafQueryBuilder<SparseVectorQueryBuilder>

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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	ALLOWED_FIELD_TYPE
static final ParseField	FIELD_FIELD
static final ParseField	INFERENCE_ID_FIELD
static final String	NAME
static final ParseField	PRUNE_FIELD
static final ParseField	PRUNING_CONFIG_FIELD
static final ParseField	QUERY_FIELD
static final ParseField	QUERY_VECTOR_FIELD
static final String	SPARSE_VECTOR_FIELD_PRUNING_OPTIONS

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SparseVectorQueryBuilder(String fieldName, String inferenceId, String query)
SparseVectorQueryBuilder(String fieldName, List<WeightedToken> queryVectors, String inferenceId, String query, Boolean shouldPruneTokens, TokenPruningConfig tokenPruningConfig)
SparseVectorQueryBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(SparseVectorQueryBuilder other)
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
static SparseVectorQueryBuilder	fromXContent(XContentParser parser)
String	getFieldName()
String	getInferenceId()
TransportVersion	getMinimalSupportedVersion()
String	getQuery()
List<WeightedToken>	getQueryVectors()
TokenPruningConfig	getTokenPruningConfig()
String	getWriteableName()
Boolean	shouldPruneTokens()

Methods inherited from class org.elasticsearch.index.query.LeafQueryBuilder

doToQuery

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, toQuery, toString, toXContent, writeQueries, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

supportsVersion

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

ALLOWED_FIELD_TYPE

public static final String ALLOWED_FIELD_TYPE

See Also:

• Constant Field Values

FIELD_FIELD

public static final ParseField FIELD_FIELD

QUERY_VECTOR_FIELD

public static final ParseField QUERY_VECTOR_FIELD

INFERENCE_ID_FIELD

public static final ParseField INFERENCE_ID_FIELD

QUERY_FIELD

public static final ParseField QUERY_FIELD

PRUNE_FIELD

public static final ParseField PRUNE_FIELD

PRUNING_CONFIG_FIELD

public static final ParseField PRUNING_CONFIG_FIELD

SPARSE_VECTOR_FIELD_PRUNING_OPTIONS

public static final String SPARSE_VECTOR_FIELD_PRUNING_OPTIONS

See Also:

• Constant Field Values

Constructor Details

SparseVectorQueryBuilder

public SparseVectorQueryBuilder(String fieldName,
 String inferenceId,
 String query)

SparseVectorQueryBuilder

public SparseVectorQueryBuilder(String fieldName,
 @Nullable
 List<WeightedToken> queryVectors,
 @Nullable
 String inferenceId,
 @Nullable
 String query,
 @Nullable
 Boolean shouldPruneTokens,
 @Nullable
 TokenPruningConfig tokenPruningConfig)

SparseVectorQueryBuilder

public SparseVectorQueryBuilder(StreamInput in)
                         throws IOException

Throws:

IOException

Method Details

getFieldName

public String getFieldName()

getQueryVectors

public List<WeightedToken> getQueryVectors()

getInferenceId

public String getInferenceId()

getQuery

public String getQuery()

shouldPruneTokens

public Boolean shouldPruneTokens()

getTokenPruningConfig

public TokenPruningConfig getTokenPruningConfig()

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<SparseVectorQueryBuilder>

Throws:

IOException

doXContent

protected void doXContent(XContentBuilder builder,
 ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<SparseVectorQueryBuilder>

Throws:

IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class LeafQueryBuilder<SparseVectorQueryBuilder>

Throws:

IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)

Overrides:

doRewrite in class AbstractQueryBuilder<SparseVectorQueryBuilder>

doEquals

protected boolean doEquals(SparseVectorQueryBuilder other)

Specified by:

doEquals in class AbstractQueryBuilder<SparseVectorQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<SparseVectorQueryBuilder>

getWriteableName

public String getWriteableName()

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

fromXContent

public static SparseVectorQueryBuilder fromXContent(XContentParser parser)