Added query suggestions

Author: JasonStoltz

README.md

@@ -186,7 +186,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
 {'meta': {'page': {'current': 1, 'total_pages': 1, 'total_results': 2, 'size': 10}, ...}, 'results': [...]}
 ```
 
-#### Multi-Search
+### Multi-Search
 
 ```python
 >>> client.multi_search('favorite-videos', [{
@@ -199,6 +199,36 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
 [{'meta': {...}, 'results': [...]}, {'meta': {...}, 'results': [...]}]
 ```
 
+### Query Suggestion
+
+```python
+>>> client.query_suggestion('favorite-videos', 'cat', {
+  'size': 10,
+  'types': {
+    'documents': {
+      'fields': ['title']
+    }
+  }
+})
+{'results': {'documents': [{'suggestion': 'cat'}]}, 'meta': {'request_id': '390be384ad5888353e1b32adcfaaf1c9'}}
+```
+
+```ruby
+engine_name = 'favorite-videos'
+
+options = {
+  :size => 3,
+  :types => {
+    :documents => {
+      :fields => ['title']
+    }
+  }
+}
+
+client.query_suggestion(engine_name, 'cat', options)
+```
+
+
 ### Create a Signed Search Key
 
 Creating a search key that will only search over the body field.

swiftype_app_search/client.py

@@ -186,6 +186,20 @@ def build_options_from_search(search):
         }
         return self.swiftype_session.request('get', endpoint, json=options)
 
+    def query_suggestion(self, engine_name, query, options=None):
+        """
+        Request Query Suggestions. See https://swiftype.com/documentation/app-search/ for more details
+        on options and return values.
+
+        :param engine_name: Name of engine to search over.
+        :param query: Query string to search for.
+        :param options: Dict of search options.
+        """
+        endpoint = "engines/{}/query_suggestion".format(engine_name)
+        options = options or {}
+        options['query'] = query
+        return self.swiftype_session.request('get', endpoint, json=options)
+
 
     @staticmethod
     def create_signed_search_key(api_key, api_key_name, options):

tests/test_client.py

@@ -229,3 +229,16 @@ def test_multi_search(self):
             m.register_uri('GET', url, json=expected_return, status_code=200)
             response = self.client.multi_search(self.engine_name, {})
             self.assertEqual(response, expected_return)
+
+    def test_query_suggestion(self):
+        query = 'query'
+        expected_return = { 'meta': {}, 'results': {}}
+
+        with requests_mock.Mocker() as m:
+            url = "{}/{}".format(
+                self.client.swiftype_session.base_url,
+                "engines/{}/query_suggestion".format(self.engine_name)
+            )
+            m.register_uri('GET', url, json=expected_return, status_code=200)
+            response = self.client.query_suggestion(self.engine_name, query, {})
+            self.assertEqual(response, expected_return)