Update README to note pros and cons of the plugin vs the ES suggestors

[timbunce]

Hi. It's hard for a relative novice to tell what value the elasticsearch-suggest-plugin has relative to the ES suggestors.

Adding a section to the README which clarifies what use-cases the plugin is a good fit for would be appreciated.

[spinscale]

sure, anything you would want to see there in particular? Pull request is accepted as well :-)

[timbunce]

Someone (like me) would like to know what use-cases the plugin is a good fit for. i.e. in what circumstances, or for what purposes, is this plugin a better choice than the built-in suggestors. I'd write it if I knew the answer!

[Sander-Toonen]

I like this plugin because it can be used to achieve a form of autocomplete/suggestion a bit similar to Google suggest.

• While typing a word, it suggests autocompletions for the word
• Additional words are suggested

The term and phrase suggesters in ES are more convenient for spell suggestions. The completion suggester in ES is useful to complete while you type but only if you are looking for exact documents.

Example:

When I type: "floor w"

The completion suggester in ES would suggest:

• Dark floor with skirting 1200x1600 mm
• Dancefloor width: 8m, length 6m
• Floor window and ceiling paint, bucket 5L white

(E.g. The complete content of the title field of matching documents.)

While this suggester would suggest:

• floor wood
• floor window
• floor washing
• floor wet

This provides a way better tool to autocomplete search terms.

@spinscale: I hope you will continue to work/update this plugin even tough there are now several other suggesters available in ES. This plugin still fills a gap that can't be closed with any of the suggesters that are available in ElasticSearch.

[timbunce]

Thanks @xatoo.

I presume it handles synonyms. (Trying to use synonyms with the completion suggester is tricky).

I'd like to see some details about of scoring/ordering of the results. That too is tricky with the completion suggester.

For the record, I'm trying to implement something like the suggestion interface of http://www.bestlosangeleshomesearch.com