summaryrefslogtreecommitdiff
path: root/docs/reference/query-dsl/queries/flt-field-query.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/query-dsl/queries/flt-field-query.asciidoc')
-rw-r--r--docs/reference/query-dsl/queries/flt-field-query.asciidoc47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/reference/query-dsl/queries/flt-field-query.asciidoc b/docs/reference/query-dsl/queries/flt-field-query.asciidoc
new file mode 100644
index 0000000..205dc61
--- /dev/null
+++ b/docs/reference/query-dsl/queries/flt-field-query.asciidoc
@@ -0,0 +1,47 @@
+[[query-dsl-flt-field-query]]
+=== Fuzzy Like This Field Query
+
+The `fuzzy_like_this_field` query is the same as the `fuzzy_like_this`
+query, except that it runs against a single field. It provides nicer
+query DSL over the generic `fuzzy_like_this` query, and support typed
+fields query (automatically wraps typed fields with type filter to match
+only on the specific type).
+
+[source,js]
+--------------------------------------------------
+{
+ "fuzzy_like_this_field" : {
+ "name.first" : {
+ "like_text" : "text like this one",
+ "max_query_terms" : 12
+ }
+ }
+}
+--------------------------------------------------
+
+`fuzzy_like_this_field` can be shortened to `flt_field`.
+
+The `fuzzy_like_this_field` top level parameters include:
+
+[cols="<,<",options="header",]
+|=======================================================================
+|Parameter |Description
+|`like_text` |The text to find documents like it, *required*.
+
+|`ignore_tf` |Should term frequency be ignored. Defaults to `false`.
+
+|`max_query_terms` |The maximum number of query terms that will be
+included in any generated query. Defaults to `25`.
+
+|`fuzziness` |The fuzziness of the term variants. Defaults
+to `0.5`. See <<fuzziness>>.
+
+|`prefix_length` |Length of required common prefix on variant terms.
+Defaults to `0`.
+
+|`boost` |Sets the boost value of the query. Defaults to `1.0`.
+
+|`analyzer` |The analyzer that will be used to analyze the text.
+Defaults to the analyzer associated with the field.
+|=======================================================================
+