Package org.opensearch.search.rescore

Class QueryRescorerBuilder

java.lang.Object

org.opensearch.search.rescore.RescorerBuilder<QueryRescorerBuilder>

org.opensearch.search.rescore.QueryRescorerBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject, Rewriteable<RescorerBuilder<QueryRescorerBuilder>>

public class QueryRescorerBuilder
extends RescorerBuilder<QueryRescorerBuilder>

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static float	DEFAULT_QUERYWEIGHT
static float	DEFAULT_RESCORE_QUERYWEIGHT
static QueryRescoreMode	DEFAULT_SCORE_MODE
static java.lang.String	NAME

Fields inherited from class org.opensearch.search.rescore.RescorerBuilder

DEFAULT_WINDOW_SIZE, windowSize

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
QueryRescorerBuilder(StreamInput in)	Read from a stream.
QueryRescorerBuilder(QueryBuilder builder)	Creates a new QueryRescorerBuilder instance

Method Summary

Modifier and Type	Method	Description
void	doWriteTo(StreamOutput out)
void	doXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean	equals(java.lang.Object obj)
static QueryRescorerBuilder	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
float	getQueryWeight()	Gets the original query weight for rescoring.
QueryBuilder	getRescoreQuery()
float	getRescoreQueryWeight()	Gets the original query weight for rescoring.
QueryRescoreMode	getScoreMode()	Gets the original query score mode.
java.lang.String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
QueryRescorer.QueryRescoreContext	innerBuildContext(int windowSize, QueryShardContext context)	Extensions override this to build the context that they need for rescoring.
QueryRescorerBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
QueryRescorerBuilder	setQueryWeight(float queryWeight)	Sets the original query weight for rescoring.
QueryRescorerBuilder	setRescoreQueryWeight(float rescoreQueryWeight)	Sets the original query weight for rescoring.
QueryRescorerBuilder	setScoreMode(QueryRescoreMode scoreMode)	Sets the original query score mode.

Methods inherited from class org.opensearch.search.rescore.RescorerBuilder

buildContext, parseFromXContent, toString, toXContent, windowSize, windowSize, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_RESCORE_QUERYWEIGHT

public static final float DEFAULT_RESCORE_QUERYWEIGHT

See Also:

Constant Field Values

DEFAULT_QUERYWEIGHT

public static final float DEFAULT_QUERYWEIGHT

See Also:

Constant Field Values

DEFAULT_SCORE_MODE

public static final QueryRescoreMode DEFAULT_SCORE_MODE

Constructor Details

QueryRescorerBuilder

public QueryRescorerBuilder(QueryBuilder builder)

Creates a new QueryRescorerBuilder instance

Parameters:

builder - the query builder to build the rescore query from

QueryRescorerBuilder

public QueryRescorerBuilder(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

doWriteTo

public void doWriteTo(StreamOutput out) throws java.io.IOException

Specified by:

doWriteTo in class RescorerBuilder<QueryRescorerBuilder>

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

getRescoreQuery

public QueryBuilder getRescoreQuery()

Returns:

the query used for this rescore query

setQueryWeight

public QueryRescorerBuilder setQueryWeight(float queryWeight)

Sets the original query weight for rescoring. The default is 1.0

getQueryWeight

public float getQueryWeight()

Gets the original query weight for rescoring. The default is 1.0

setRescoreQueryWeight

public QueryRescorerBuilder setRescoreQueryWeight(float rescoreQueryWeight)

Sets the original query weight for rescoring. The default is 1.0

getRescoreQueryWeight

public float getRescoreQueryWeight()

Gets the original query weight for rescoring. The default is 1.0

setScoreMode

public QueryRescorerBuilder setScoreMode(QueryRescoreMode scoreMode)

Sets the original query score mode. The default is QueryRescoreMode.Total.

getScoreMode

public QueryRescoreMode getScoreMode()

Gets the original query score mode. The default is total

doXContent

public void doXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

doXContent in class RescorerBuilder<QueryRescorerBuilder>

Throws:

java.io.IOException

fromXContent

public static QueryRescorerBuilder fromXContent(org.opensearch.common.xcontent.XContentParser parser) throws java.io.IOException

Throws:

java.io.IOException

innerBuildContext

public QueryRescorer.QueryRescoreContext innerBuildContext(int windowSize, QueryShardContext context) throws java.io.IOException

Description copied from class: RescorerBuilder

Extensions override this to build the context that they need for rescoring.

Specified by:

innerBuildContext in class RescorerBuilder<QueryRescorerBuilder>

Throws:

java.io.IOException

hashCode

public final int hashCode()

Overrides:

hashCode in class RescorerBuilder<QueryRescorerBuilder>

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class RescorerBuilder<QueryRescorerBuilder>

rewrite

public QueryRescorerBuilder rewrite(QueryRewriteContext ctx) throws java.io.IOException

Description copied from interface: Rewriteable

Rewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.

Throws:

java.io.IOException