Browse Source

[DOCS] Add doc for delimited payload token filter

Britta Weber 12 years ago
parent
commit
c3ab79a10e

+ 1 - 0
docs/reference/analysis/tokenfilters.asciidoc

@@ -69,3 +69,4 @@ include::tokenfilters/common-grams-tokenfilter.asciidoc[]
 
 include::tokenfilters/normalization-tokenfilter.asciidoc[]
 
+include::tokenfilters/delimited-payload-tokenfilter.asciidoc[]

+ 16 - 0
docs/reference/analysis/tokenfilters/delimited-payload-tokenfilter.asciidoc

@@ -0,0 +1,16 @@
+[[analysis-delimited-payload-tokenfilter]]
+=== Delimited Payload Token Filter
+
+Named `delimited_payload_filter`. Splits tokens into tokens and payload whenever a delimiter character is found.
+
+Example: "the|1 quick|2 fox|3" is split per default int to tokens `fox`, `quick` and `the` with payloads `1`, `2` and `3` respectively.
+
+
+
+Parameters:
+
+`delimiter`:: 
+    Character used for splitting the tokens. Default is `|`. 
+
+`encoding`:: 
+    The type of the payload. `int` for integer, `float` for float and `identity` for characters. Default is `float`.