added docs to the repo

2013-12-27 16:41:38 -07:00
parent 11c976e9f8
commit 65f9cc7e99
101 changed files with 3907 additions and 63 deletions
--- a/docs/_examples/suggest.asciidoc
+++ b/docs/_examples/suggest.asciidoc
@ -0,0 +1,34 @@
+.Return query terms suggestions (“auto-correction”)
+[source,js]
+---------
+client.suggest({
+index: 'myindex',
+body: {
+  mysuggester: {
+    text: 'tset',
+    term: {
+      field: 'title'
+    }
+  }
+}
+}, function (error, response) {
+// response will be formatted like so:
+//
+// {
+//   ...
+//   mysuggester: [
+//     {
+//       text: "tset",
+//       ...
+//       options: [
+//         {
+//           text: "test",
+//           score: 0.75,
+//           freq: 5
+//         }
+//       ]
+//     }
+//   ]
+// }
+});
+---------