com.arakelian.elastic.model.search

Interface MoreLikeThisQuery

All Superinterfaces:

Query, java.io.Serializable, StandardQuery

@Value.Immutable(copy=false)
public interface MoreLikeThisQuery
extends StandardQuery

See Also:

More Like This Query

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MoreLikeThisQuery.Item

Field Summary

Fields inherited from interface com.arakelian.elastic.model.search.Query

BOOL_QUERY, EXISTS_QUERY, FUZZY_QUERY, GEO_BOUNDING_BOX_QUERY, GEO_DISTANCE_QUERY, GEO_POLYGON_QUERY, GEO_SHAPE_QUERY, IDS_QUERY, MATCH_QUERY, MORE_LIKE_THIS_QUERY, PREFIX_QUERY, QUERY_STRING_QUERY, RANGE_QUERY, REGEXP_QUERY, TERMS_QUERY, WILDCARD_QUERY

Method Summary

Modifier and Type	Method and Description
default void	accept(QueryVisitor visitor)
java.lang.String	getAnalyzer() Returns the analyzer that is used to analyze the free form text.
java.lang.Float	getBoostTerms() Returns the additional boost for each term in the formed query.
default java.util.Set<java.lang.String>	getFields()
default java.util.List<java.lang.Object>	getLike()
default java.util.List<MoreLikeThisQuery.Item>	getLikeItems()
default java.util.List<java.lang.String>	getLikeTexts()
java.lang.Integer	getMaxDocFrequency() Returns the maximum document frequency above which the terms will be ignored from the input document.
java.lang.Integer	getMaxQueryTerms() Returns the maximum number of query terms that will be selected.
java.lang.Integer	getMaxWordLength() Returns the maximum word length above which the terms will be ignored.
java.lang.Integer	getMinDocFrequency() Returns the minimum document frequency below which the terms will be ignored from the input document.
java.lang.String	getMinimumShouldMatch() Returns the number of terms that must match after the disjunctive query has been formed.
java.lang.Integer	getMinTermFrequency() Returns the minimum term frequency below which the terms will be ignored from the input document.
java.lang.Integer	getMinWordLength() Returns the minimum word length below which the terms will be ignored.
default java.util.Set<java.lang.String>	getStopWords() Returns an array of stop words.
default java.util.List<java.lang.Object>	getUnlike()
default java.util.List<MoreLikeThisQuery.Item>	getUnlikeItems()
default java.util.List<java.lang.String>	getUnlikeTexts()
default boolean	isEmpty()
java.lang.Boolean	isFailOnUnsupportedField() Returns true if query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword').
java.lang.Boolean	isInclude() Returns whether the input documents should also be included in the search results returned.

Methods inherited from interface com.arakelian.elastic.model.search.StandardQuery

getBoost, getName, hasStandardDefaults

Methods inherited from interface com.arakelian.elastic.model.search.Query

countNotEmpty

Method Detail

getAnalyzer

java.lang.String getAnalyzer()

Returns the analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields

Returns:

the analyzer that is used to analyze the free form text

getBoostTerms

java.lang.Float getBoostTerms()

Returns the additional boost for each term in the formed query. Defaults to deactivated (0). Any other positive value activates terms boosting with the given boost factor.

Returns:

the additional boost for each term in the formed query

getFields

@Value.Default
default java.util.Set<java.lang.String> getFields()

getLike

@Value.Lazy
default java.util.List<java.lang.Object> getLike()

getLikeItems

@Value.Default
default java.util.List<MoreLikeThisQuery.Item> getLikeItems()

getLikeTexts

@Value.Default
default java.util.List<java.lang.String> getLikeTexts()

getMaxDocFrequency

java.lang.Integer getMaxDocFrequency()

Returns the maximum document frequency above which the terms will be ignored from the input document. This could be useful in order to ignore highly frequent words such as stop words. Defaults to unbounded (0)

Returns:

the maximum document frequency above which the terms will be ignored from the input document

getMaxQueryTerms

java.lang.Integer getMaxQueryTerms()

Returns the maximum number of query terms that will be selected. Increasing this value gives greater accuracy at the expense of query execution speed. Defaults to 25.

Returns:

the maximum number of query terms that will be selected

getMaxWordLength

java.lang.Integer getMaxWordLength()

Returns the maximum word length above which the terms will be ignored. Defaults to unbounded (0)

Returns:

the maximum word length above which the terms will be ignored

getMinDocFrequency

java.lang.Integer getMinDocFrequency()

Returns the minimum document frequency below which the terms will be ignored from the input document. Defaults to 5

Returns:

the minimum document frequency below which the terms will be ignored from the input document

getMinimumShouldMatch

java.lang.String getMinimumShouldMatch()

Returns the number of terms that must match after the disjunctive query has been formed. The syntax is the same as the minimum should match. (Defaults to "30%").

Returns:

the number of terms that must match after the disjunctive query has been formed

getMinTermFrequency

java.lang.Integer getMinTermFrequency()

Returns the minimum term frequency below which the terms will be ignored from the input document. Defaults to 2

Returns:

the minimum term frequency below which the terms will be ignored from the input document

getMinWordLength

java.lang.Integer getMinWordLength()

Returns the minimum word length below which the terms will be ignored. Defaults to 0

Returns:

the minimum word length below which the terms will be ignored

getStopWords

@Value.Default
default java.util.Set<java.lang.String> getStopWords()

Returns an array of stop words. Any word in this set is considered "uninteresting" and ignored. If the analyzer allows for stop words, you might want to tell MLT to explicitly ignore them, as for the purposes of document similarity it seems reasonable to assume that "a stop word is never interesting".

Returns:

an array of stop words

getUnlike

@Value.Lazy
default java.util.List<java.lang.Object> getUnlike()

getUnlikeItems

@Value.Default
default java.util.List<MoreLikeThisQuery.Item> getUnlikeItems()

getUnlikeTexts

@Value.Default
default java.util.List<java.lang.String> getUnlikeTexts()

isFailOnUnsupportedField

java.lang.Boolean isFailOnUnsupportedField()

Returns true if query should fail (throw an exception) if any of the specified fields are not of the supported types (text or keyword'). Set this to `false to ignore the field and continue processing. Defaults to true.

Returns:

true if query should fail if any of the specified fields are not of the supported types (text or keyword')

isInclude

java.lang.Boolean isInclude()

Returns whether the input documents should also be included in the search results returned. Defaults to false

Returns:

whether the input documents should also be included in the search results returned

accept

default void accept(QueryVisitor visitor)

Specified by:

accept in interface Query

isEmpty

default boolean isEmpty()

Specified by:

isEmpty in interface Query