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

[docs] explain default settings for parameters of decay functions 

relates to #8624
This commit is contained in:
Britta Weber 2014-11-26 16:04:11 +01:00
parent 06c39e79d6
commit f00b431c18
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/reference/query-dsl/queries/function-score-query.asciidoc
View File

@ -243,6 +243,18 @@ The format of the origin depends on the <<mapping-date-format>> defined in your
The `offset` and `decay` parameters are optional. The `offset` and `decay` parameters are optional.
[horizontal] [horizontal]
`origin`::
The point of origin used for calculating distance. Must be given as a
number for numeric field, date for date fields and geo point for geo fields.
Required for geo and numeric field. For date fields the default is `now`. Date
math (for example `now-1h`) is supported for origin.
`scale`::
Required for all types. Defines the distance from origin at which the computed
score will equal `decay` parameter. For geo fields: Can be defined as number+unit (1km, 12m,...).
Default unit is meters. For date fields: Can to be defined as a number+unit ("1h", "10d",...).
Default unit is milliseconds. For numeric field: Any number.
`offset`:: `offset`::
If an `offset` is defined, the decay function will only compute the If an `offset` is defined, the decay function will only compute the
decay function for documents with a distance greater that the defined decay function for documents with a distance greater that the defined