Browse Source

[DOCS] Completion suggest: Clarify de-duplication, optimize/merge

This contribution is based on the feedback given in issue #4254 and
issue #4255, and should clear things up, when suggestions are being
removed and not displayed anymore after deletion of data.
Markus Fischer 12 years ago
parent
commit
2da0611dfb
1 changed files with 9 additions and 2 deletions
  1. 9 2
      docs/reference/search/suggesters/completion-suggest.asciidoc

+ 9 - 2
docs/reference/search/suggesters/completion-suggest.asciidoc

@@ -112,7 +112,9 @@ The following parameters are supported:
 `output`::
     The string to return, if a suggestion matches. This is very
     useful to normalize outputs (i.e. have them always in the format
-    `artist - songname`). This is optional.
+    `artist - songname`). The result is de-duplicated if several documents
+    have the same output, i.e. only one is returned as part of the
+    suggest result. This is optional.
 
 `payload`::
     An arbitrary JSON object, which is simply returned in the
@@ -124,7 +126,7 @@ The following parameters are supported:
     A positive integer, which defines a weight and allows you to
     rank your suggestions. This field is optional.
 
-[NOTE] Even though you are losing most of the features of the
+NOTE: Even though you are losing most of the features of the
 completion suggest, you can opt in for the shortest form, which even
 allows you to use inside of multi_field. But keep in mind, that you will
 not be able to use several inputs, an output, payloads or weights.
@@ -136,6 +138,11 @@ not be able to use several inputs, an output, payloads or weights.
 }
 --------------------------------------------------
 
+NOTE: The suggest data structure might not reflect deletes on
+documents immediately. You may need to do an <<indices-optimize>> for that.
+You can call optimize with the `only_expunge_deletes=true` to only cater for deletes
+or alternatively call a <<index-modules-merge>> operation.
+
 [[querying]]
 ==== Querying