From 205135c9f69c51a0a33346a5c05541c5ee60b9b5 Mon Sep 17 00:00:00 2001
From: Stefan Bofirov <stefan.bofirov@dnhsoft.com>
Date: Thu, 4 Feb 2016 08:39:56 +0200
Subject: [PATCH] Added documentation about suggest
---
docs/Suggest/index.md | 64 +++++++++++++++++++++++++++++++++++++++++++
docs/index.md | 1 +
2 files changed, 65 insertions(+)
create mode 100644 docs/Suggest/index.md
diff --git a/docs/Suggest/index.md b/docs/Suggest/index.md
new file mode 100644
index 0000000..273c784
--- /dev/null
+++ b/docs/Suggest/index.md
@@ -0,0 +1,64 @@
+# Suggest
+
+Objective suggest builder represents [Elasticsearch Term suggest][1].
+
+To form a suggest you have to create `Search` object. See below an example of suggest usage.
+
+```php
+$search = new Search();
+$suggest = new Suggest('my_suggest', 'searchText', ['field' => 'title', 'size' => 5]);
+$search->addSuggest($suggest);
+$queryArray = $search->toArray();
+```
+
+That will generate following JSON:
+
+```JSON
+"suggest": {
+ "my_suggest": {
+ "text": "searchText",
+ "term": {
+ "field": "title",
+ "size": 5
+ }
+ }
+}
+```
+
+You're able to create more than one suggest:
+
+```php
+$search = new Search();
+$suggest1 = new Suggest('my_suggest1', 'the amsterdma meetpu', ['field' => 'body', 'size' => 5]);
+$search->addSuggest($suggest1);
+$suggest2 = new Suggest('my_suggest2', 'the rottredam meetpu', ['field' => 'title', 'size' => 5]);
+$search->addSuggest($suggest2);
+$queryArray = $search->toArray();
+```
+
+That will generate following JSON:
+
+```JSON
+"suggest": {
+ "my_suggest1": {
+ "text": "the amsterdma meetpu",
+ "term": {
+ "field": "body",
+ "size": 5
+ }
+ },
+ "my_suggest2": {
+ "text": "the rottredam meetpu",
+ "term": {
+ "field": "title",
+ "size": 5
+ }
+ }
+}
+```
+
+If parameters `field` or `size` are not provided they will have default values, `field = _all` and `size = 3`
+
+Find available parameters in [Elasticsearch Term suggest documentation][1]
+
+[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-term.html
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index b14009c..c4ff87b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -7,6 +7,7 @@ Everything starts from the `Search` object. We recommend first to take a look at
### Topics:
- [Build Queries](Query/index.md)
- [Build Aggregations](Aggregation/index.md)
+- [Build Suggest](Suggest/index.md)
### How to
- [How to Search](HowTo/HowToSearch.md)
--
GitLab