elastic.js: Module: FuzzyLikeThisQuery

Module

FuzzyLikeThisQuery


        FuzzyLikeThisQuery ( likeText )

Constructs a query where each documents returned are “like” provided text

Parameters: likeText <String> The text to find documents like it.

Method Summary

Returns	Name	Description
`String`	`_type()`	The type of ejs object. For internal use only.
`Object`	`analyzer(analyzerName)`	The analyzer that will be used to analyze the text. Defaults to the analyzer associated with the field.
`Object`	`boost(boost)`	Sets the boost value for documents matching the `Query`.
`Object`	`failOnUnsupportedField(trueFalse)`	Should the `Query` fail when an unsupported field is specified. Defaults to true.
`Object`	`fields(f)`	The fields to run the query against. If you call with a single field, it is added to the existing list of fields. If called with an array of field names, it replaces any existing values with the new array.
`Object`	`ignoreTf(trueFalse)`	Should term frequency be ignored. Defaults to false.
`Object`	`likeText(s)`	The text to find documents like
`Object`	`maxQueryTerms(max)`	The maximum number of query terms that will be included in any generated query. Defaults to 25.
`Object`	`minSimilarity(min)`	The minimum similarity of the term variants. Defaults to 0.5.
`Object`	`prefixLength(len)`	Length of required common prefix on variant terms. Defaults to 0..
`String`	`toJSON()`	Retrieves the internal `query` object. This is typically used by internal API functions so use with caution.

Method Detail

_type


        String _type ( )

The type of ejs object. For internal use only.

Returns: the type of object

analyzer


        Object analyzer ( analyzerName )

The analyzer that will be used to analyze the text. Defaults to the analyzer associated with the field.

Parameters: analyzerName <String> The name of the analyzer.
Returns: returns this so that calls can be chained.

boost


        Object boost ( boost )

Sets the boost value for documents matching the Query.

Parameters: boost <Double> A positive double value.
Returns: returns this so that calls can be chained.

failOnUnsupportedField


        Object failOnUnsupportedField ( trueFalse )

Should the Query fail when an unsupported field is specified. Defaults to true.

Parameters: trueFalse <Boolean> A boolean value
Returns: returns this so that calls can be chained.

fields


        Object fields ( f )

The fields to run the query against. If you call with a single field, it is added to the existing list of fields. If called with an array of field names, it replaces any existing values with the new array.

Parameters: f <String | String[]> A single field name or a list of field names.
Returns: returns this so that calls can be chained.

ignoreTf


        Object ignoreTf ( trueFalse )

Should term frequency be ignored. Defaults to false.

Parameters: trueFalse <Boolean> A boolean value
Returns: returns this so that calls can be chained.

likeText


        Object likeText ( s )

The text to find documents like

Parameters: s <String> A text string.
Returns: returns this so that calls can be chained.

maxQueryTerms


        Object maxQueryTerms ( max )

The maximum number of query terms that will be included in any generated query. Defaults to 25.

Parameters: max <Integer> A positive integer value.
Returns: returns this so that calls can be chained.

minSimilarity


        Object minSimilarity ( min )

The minimum similarity of the term variants. Defaults to 0.5.

Parameters: min <Double> A positive double value.
Returns: returns this so that calls can be chained.

prefixLength


        Object prefixLength ( len )

Length of required common prefix on variant terms. Defaults to 0..

Parameters: len <Integer> A positive integer value.
Returns: returns this so that calls can be chained.

toJSON


        String toJSON ( )

Retrieves the internal query object. This is typically used by internal API functions so use with caution.

Returns: returns this object's internal query property.

ejs ⟩ FuzzyLikeThisQuery