Skip to content

Commit d0a9700

Browse files
goodrootgoodroot
authored
Merge pull request #27 from swiftype/suggestions
Add suggestions
2 parents af36f59 + 613f63b commit d0a9700

File tree

13 files changed

+483
-197
lines changed

13 files changed

+483
-197
lines changed

‎.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
8.10.0

‎README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,18 @@ and then restart this app.
4949

5050
The following is a complete list of options available for configuration in [engine.json](src/config/engine.json).
5151

52-
| option | value type | required/optional | source |
53-
| ------------------ | ------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
54-
| `engineName` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
55-
| `hostIdentifier` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
56-
| `searchKey` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
57-
| `fields` | Array[String] | required | A list of fields that will be searched and displayed within your results. |
58-
| `titleField` | String | optional | The field to display as the title in results. |
59-
| `urlField` | String | optional | A field with a url to use as a link in results. |
60-
| `urlFieldTemplate` | String | optional | Instead of urlField, you can provide a URL "template" here, which lets you build a URL from other fields. ex: "https://www.example.com/{{id}}". |
61-
| `sortFields` | Array[String] | optional | A list of fields that will be used for sort options. |
62-
| `facets` | Array[String] | optional | A list of fields that will be available as "facet" filters. Read more about facets within the [App Search documentation](https://swiftype.com/documentation/search-lib/guides/facets). |
52+
| option | value type | required/optional | source |
53+
| -------------------- | ------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
54+
| `engineName` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
55+
| `hostIdentifier` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
56+
| `searchKey` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
57+
| `fields` | Array[String] | required | A list of fields that will be searched and displayed within your results. |
58+
| `querySuggestFields` | Array[String] | optional | A list of fields that will be searched and displayed as query suggestions. |
59+
| `titleField` | String | optional | The field to display as the title in results. |
60+
| `urlField` | String | optional | A field with a url to use as a link in results. |
61+
| `urlFieldTemplate` | String | optional | Instead of urlField, you can provide a URL "template" here, which lets you build a URL from other fields. ex: "https://www.example.com/{{id}}". |
62+
| `sortFields` | Array[String] | optional | A list of fields that will be used for sort options. |
63+
| `facets` | Array[String] | optional | A list of fields that will be available as "facet" filters. Read more about facets within the [App Search documentation](https://swiftype.com/documentation/search-lib/guides/facets). |
6364

6465
### External configuration
6566

0 commit comments

Comments
 (0)