honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add pointer to the index-phrases option in shingle filter docs (#35771) 

We should be discouraging the use of shingle filters and instead pointing users to the
index-phrases parameter on text fields.
This commit is contained in:
Alan Woodward 2018-11-21 15:27:11 +00:00 committed by GitHub
parent 592a909ba7
commit 26cc8ff8c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/analysis/tokenfilters/shingle-tokenfilter.asciidoc
View File

@ -1,6 +1,10 @@
[[analysis-shingle-tokenfilter]] [[analysis-shingle-tokenfilter]]
=== Shingle Token Filter === Shingle Token Filter
NOTE: Shingles are generally used to help speed up phrase queries. Rather
than building filter chains by hand, you may find it easier to use the
<<index-phrases,`index-phrases`>> option on a text field.
A token filter of type `shingle` that constructs shingles (token A token filter of type `shingle` that constructs shingles (token
n-grams) from a token stream. In other words, it creates combinations of n-grams) from a token stream. In other words, it creates combinations of
tokens as a single token. For example, the sentence "please divide this tokens as a single token. For example, the sentence "please divide this

3
docs/reference/mapping/params.asciidoc
View File

@ -21,6 +21,7 @@ The following mapping parameters are common to some or all field datatypes:
* <<ignore-above,`ignore_above`>> * <<ignore-above,`ignore_above`>>
* <<ignore-malformed,`ignore_malformed`>> * <<ignore-malformed,`ignore_malformed`>>
* <<index-options,`index_options`>> * <<index-options,`index_options`>>
* <<index-phrases,`index_phrases`>>
* <<mapping-index,`index`>> * <<mapping-index,`index`>>
* <<multi-fields,`fields`>> * <<multi-fields,`fields`>>
* <<norms,`norms`>> * <<norms,`norms`>>
@ -63,6 +64,8 @@ include::params/index.asciidoc[]
include::params/index-options.asciidoc[] include::params/index-options.asciidoc[]
include::params/index-phrases.asciidoc[]
include::params/multi-fields.asciidoc[] include::params/multi-fields.asciidoc[]
include::params/norms.asciidoc[] include::params/norms.asciidoc[]

8
docs/reference/mapping/params/index-phrases.asciidoc Normal file
View File

@ -0,0 +1,8 @@
[[index-phrases]]
=== Index Phrases
If enabled, two-term word combinations ('shingles') are indexed into a separate
field. This allows exact phrase queries (no slop) to run more efficiently, at the expense
of a larger index. Note that this works best when stopwords are not removed,
as phrases containing stopwords will not use the subsidiary field and will fall
back to a standard phrase query. Accepts `true` or `false` (default).

2
docs/reference/mapping/types/text.asciidoc
View File

@ -96,7 +96,7 @@ The following parameters are accepted by `text` fields:
the expense of a larger index. Accepts an the expense of a larger index. Accepts an
<<index-prefix-config,`index-prefix configuration block`>> <<index-prefix-config,`index-prefix configuration block`>>
`index_phrases`:: <<index-phrases,`index_phrases`>>::
If enabled, two-term word combinations ('shingles') are indexed into a separate If enabled, two-term word combinations ('shingles') are indexed into a separate
field. This allows exact phrase queries (no slop) to run more efficiently, at the expense field. This allows exact phrase queries (no slop) to run more efficiently, at the expense