From 20848d2895ad58a8da3dbac84f10743e386934f6 Mon Sep 17 00:00:00 2001
From: Aivaras Gotovskis <aivaras.gotovskis@ongr.io>
Date: Wed, 1 Jul 2015 16:06:04 +0300
Subject: [PATCH] Add fuzzy query doc.
---
docs/Query/Fuzzy.md | 63 +++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 63 insertions(+)
create mode 100644 docs/Query/Fuzzy.md
diff --git a/docs/Query/Fuzzy.md b/docs/Query/Fuzzy.md
new file mode 100644
index 0000000..2f3ed8a
--- /dev/null
+++ b/docs/Query/Fuzzy.md
@@ -0,0 +1,63 @@
+# Fuzzy Query
+
+> More info about fuzzy query is in the [official elasticsearch docs][1]
+
+The fuzzy query uses similarity based on Levenshtein edit distance for string fields, and a +/- margin on numeric and
+date fields.
+
+## Simple example
+
+```JSON
+{
+ "fuzzy" : { "user" : "ki" }
+}
+```
+
+In DSL:
+
+```php
+$fuzzyQuery = new FuzzyQuery('user', 'ki');
+
+$search = new Search();
+$search->addQuery($fuzzyQuery);
+
+$queryArray = $search->toArray();
+```
+
+## With more advanced settings
+
+```JSON
+{
+ "fuzzy" : {
+ "user" : {
+ "value" : "ki",
+ "boost" : 1.0,
+ "fuzziness" : 2,
+ "prefix_length" : 0,
+ "max_expansions": 100
+ }
+ }
+}
+```
+
+In DSL
+```php
+$fuzzyQuery = new FuzzyQuery(
+ 'user',
+ 'ki',
+ [
+ 'boost' => 1,
+ 'fuzziness' => 2,
+ 'prefix_length' => 0,
+ 'max_expansions' => 100,
+ ]
+);
+
+
+$search = new Search();
+$search->addQuery($fuzzyQuery);
+
+$queryArray = $search->toArray();
+```
+
+[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html
--
GitLab