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

Update docs for the DFR similarity (#40579) 

The basic models `b, de, p` and the after effect `no`
are not available anymore in Lucene 8 but they are still
listed in the >7x documentation. This change removes these
references that should also be listed in the breaking change
of es 7.0.

Closes #40264
This commit is contained in:
Jim Ferenczi 2019-03-29 09:34:51 +01:00 committed by jimczi
parent be31800154
commit ae65f77add
1 changed files with 5 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/reference/index-modules/similarity.asciidoc
View File

@ -92,22 +92,14 @@ from randomness] framework. This similarity has the following options:
[horizontal]
`basic_model`::
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelG.html[`be`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelD.html[`d`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelG.html[`g`],
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelG.html[`g`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIF.html[`if`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIn.html[`in`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIne.html[`ine`] and
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelP.html[`p`].
`be`, `d` and `p` should be avoided in practice as they might return scores that
are equal to 0 or infinite with terms that do not meet the expected random
distribution.
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIn.html[`in`] and
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIne.html[`ine`].
`after_effect`::
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffect.NoAfterEffect.html[`no`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffectB.html[`b`] and
{lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffectL.html[`l`].
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffectB.html[`b`] and
{lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffectB.html[`l`].
`normalization`::
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/Normalization.NoNormalization.html[`no`],