All Products
Search
Document Center

:query_match_ratio

Last Updated:Sep 09, 2021

Feature functions

You can use feature functions in sort expressions. Most feature functions can be used only in fine sort expressions. You can combine various syntax and statements to conduct complex sorts.

The fields that you reference in parameters of feature functions must be configured as index or attribute fields based on the description of each function.

query_match_ratio: returns the ratio of the number of terms that are hit in a specific field to the total number of terms in the search query

1.Syntax:

query_match_ratio(field_name)

2.Parameter:

field_name: optional. The name of the field for which you want to collect statistics. The field must be of the TEXT or SHORT_TEXT type. The analyzer can be the general analyzer for Chinese, a custom analyzer, the single character analyzer for Chinese, an analyzer for English, or the fuzzy analyzer.

3.Return value:

The return value is of the FLOAT type. Valid values: [0,1].

4.Scenarios:

Scenario 1: Use if (query_match_ratio() > 0.999, 1, 0) to check whether all terms in the search query are hit in documents.

Scenario 2: Use if (query_match_ratio(title) > 0.999, 1, 0) to check whether all terms in the search query are hit in the title field in documents.

5.Usage notes:

  • The field that you reference in the parameter of this function must be configured as an index field.

  • You can use this feature function in fine sort expressions.