Browse Source

Remove docs related to index time boosting (#51704)

As there is no really index time boosting,
as boost is only applied during query time,
this removes mentions of index time boosting.
Mayya Sharipova 5 years ago
parent
commit
620996287a

+ 0 - 3
docs/reference/mapping/params.asciidoc

@@ -8,7 +8,6 @@ parameters that are used by <<mapping-types,field mappings>>:
 The following mapping parameters are common to some or all field datatypes:
 
 * <<analyzer,`analyzer`>>
-* <<mapping-boost,`boost`>>
 * <<coerce,`coerce`>>
 * <<copy-to,`copy_to`>>
 * <<doc-values,`doc_values`>>
@@ -38,8 +37,6 @@ The following mapping parameters are common to some or all field datatypes:
 
 include::params/analyzer.asciidoc[]
 
-include::params/boost.asciidoc[]
-
 include::params/coerce.asciidoc[]
 
 include::params/copy-to.asciidoc[]

+ 0 - 81
docs/reference/mapping/params/boost.asciidoc

@@ -1,81 +0,0 @@
-[[mapping-boost]]
-=== `boost`
-
-Individual fields can be _boosted_ automatically -- count more towards the relevance score
--- at query time, with the `boost` parameter as follows:
-
-[source,console]
---------------------------------------------------
-PUT my_index
-{
-  "mappings": {
-    "properties": {
-      "title": {
-        "type": "text",
-        "boost": 2 <1>
-      },
-      "content": {
-        "type": "text"
-      }
-    }
-  }
-}
---------------------------------------------------
-
-<1> Matches on the `title` field will have twice the weight as those on the
-    `content` field, which has the default `boost` of `1.0`.
-
-NOTE: The boost is applied only for term queries (prefix, range and fuzzy queries are not _boosted_).
-
-You can achieve the same effect by using the boost parameter directly in the query, for instance the following query (with field time boost):
-
-[source,console]
---------------------------------------------------
-POST _search
-{
-    "query": {
-        "match" : {
-            "title": {
-                "query": "quick brown fox"
-            }
-        }
-    }
-}
---------------------------------------------------
-
-is equivalent to:
-
-[source,console]
---------------------------------------------------
-POST _search
-{
-    "query": {
-        "match" : {
-            "title": {
-                "query": "quick brown fox",
-                "boost": 2
-            }
-        }
-    }
-}
---------------------------------------------------
-
-
-deprecated[5.0.0, "Index time boost is deprecated.  Instead, the field mapping boost is applied at query time. For indices created before 5.0.0, the boost will still be applied at index time."]
-[WARNING]
-.Why index time boosting is a bad idea
-==================================================
-
-We advise against using index time boosting for the following reasons:
-
-* You cannot change index-time `boost` values without reindexing all of your
-  documents.
-
-* Every query supports query-time boosting which achieves the same effect. The
-  difference is that you can tweak the `boost` value without having to reindex.
-
-* Index-time boosts are stored as part of the <<norms,`norm`>>, which is only one
-  byte.  This reduces the resolution of the field length normalization factor
-  which can lead to lower quality relevance calculations.
-
-==================================================

+ 0 - 5
docs/reference/mapping/types/boolean.asciidoc

@@ -93,11 +93,6 @@ The following parameters are accepted by `boolean` fields:
 
 [horizontal]
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number, defaults
-    to `1.0`.
-
 <<doc-values,`doc_values`>>::
 
     Should the field be stored on disk in a column-stride fashion, so that it

+ 0 - 5
docs/reference/mapping/types/date.asciidoc

@@ -95,11 +95,6 @@ The following parameters are accepted by `date` fields:
 
 [horizontal]
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number, defaults
-    to `1.0`.
-
 <<doc-values,`doc_values`>>::
 
     Should the field be stored on disk in a column-stride fashion, so that it

+ 0 - 5
docs/reference/mapping/types/flattened.asciidoc

@@ -131,11 +131,6 @@ The following mapping parameters are accepted:
 
 [horizontal]
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number,
-    defaults to `1.0`.
-
 `depth_limit`::
 
     The maximum allowed depth of the flattened object field, in terms of nested

+ 0 - 5
docs/reference/mapping/types/ip.asciidoc

@@ -45,11 +45,6 @@ The following parameters are accepted by `ip` fields:
 
 [horizontal]
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number, defaults
-    to `1.0`.
-
 <<doc-values,`doc_values`>>::
 
     Should the field be stored on disk in a column-stride fashion, so that it

+ 0 - 5
docs/reference/mapping/types/keyword.asciidoc

@@ -43,11 +43,6 @@ The following parameters are accepted by `keyword` fields:
 
 [horizontal]
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number, defaults
-    to `1.0`.
-
 <<doc-values,`doc_values`>>::
 
     Should the field be stored on disk in a column-stride fashion, so that it

+ 1 - 6
docs/reference/mapping/types/numeric.asciidoc

@@ -95,7 +95,7 @@ queries. However, they are often retrieved using term-level queries.
 
 Consider mapping a numeric identifier as a `keyword` if:
 
-* You don't plan to search for the identifier data using 
+* You don't plan to search for the identifier data using
   <<query-dsl-range-query,`range`>> queries.
 * Fast retrieval is important. `term` query searches on `keyword` fields are
   often faster than `term` searches on numeric fields.
@@ -117,11 +117,6 @@ The following parameters are accepted by numeric types:
     Try to convert strings to numbers and truncate fractions for integers.
     Accepts `true` (default) and `false`.
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number, defaults
-    to `1.0`.
-
 <<doc-values,`doc_values`>>::
 
     Should the field be stored on disk in a column-stride fashion, so that it

+ 0 - 5
docs/reference/mapping/types/range.asciidoc

@@ -207,11 +207,6 @@ The following parameters are accepted by range types:
     Try to convert strings to numbers and truncate fractions for integers.
     Accepts `true` (default) and `false`.
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number, defaults
-    to `1.0`.
-
 <<mapping-index,`index`>>::
 
     Should the field be searchable? Accepts `true` (default) and `false`.

+ 0 - 5
docs/reference/mapping/types/text.asciidoc

@@ -54,11 +54,6 @@ The following parameters are accepted by `text` fields:
     Defaults to the default index analyzer, or the
     <<analysis-standard-analyzer,`standard` analyzer>>.
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number, defaults
-    to `1.0`.
-
 <<eager-global-ordinals,`eager_global_ordinals`>>::
 
     Should global ordinals be loaded eagerly on refresh? Accepts `true` or `false`

+ 0 - 5
docs/reference/mapping/types/token-count.asciidoc

@@ -69,11 +69,6 @@ Indicates if position increments should be counted.
 Set to `false` if you don't want to count tokens removed by analyzer filters (like <<analysis-stop-tokenfilter,`stop`>>). 
 Defaults to `true`.
 
-<<mapping-boost,`boost`>>::
-
-    Mapping field-level query time boosting. Accepts a floating point number, defaults
-    to `1.0`.
-
 <<doc-values,`doc_values`>>::
 
     Should the field be stored on disk in a column-stride fashion, so that it

+ 1 - 4
docs/reference/query-dsl/dis-max-query.asciidoc

@@ -11,9 +11,6 @@ If a returned document matches multiple query clauses, the `dis_max` query
 assigns the document the highest relevance score from any matching clause, plus
 a tie breaking increment for any additional matching subqueries.
 
-You can use the `dis_max` to search for a term in fields mapped with different
-<<mapping-boost,boost>> factors.
-
 [[query-dsl-dis-max-query-ex-request]]
 ==== Example request
 
@@ -63,4 +60,4 @@ relevance score for the document as follows:
 
 If the `tie_breaker` value is greater than `0.0`, all matching clauses count,
 but the clause with the highest score counts most.
---
+--

+ 1 - 1
docs/reference/query-dsl/multi-match-query.asciidoc

@@ -286,7 +286,7 @@ GET /_search
 }
 --------------------------------------------------
 
-Also, accepts `analyzer`, <<mapping-boost,`boost`>>, `lenient` and `zero_terms_query` as explained
+Also, accepts `analyzer`, `boost`, `lenient` and `zero_terms_query` as explained
 in <<query-dsl-match-query>>, as well as `slop` which is explained in <<query-dsl-match-query-phrase>>.
 Type `phrase_prefix` additionally accepts `max_expansions`.