habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP better generated API reference docs

Browse Source
This commit is contained in:
Josh Mock
2025-05-27 15:30:21 -05:00
parent a1dc6f55ee
commit b627037af1
3745 changed files with 30211 additions and 15508 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/api/QueryDslDistanceFeatureQueryBase.md Normal file
View File

@ -0,0 +1,7 @@
## Interface `QueryDslDistanceFeatureQueryBase`
| Name | Type | Description |
| - | - | - |
| `field` | [Field](./Field.md) | Name of the field used to calculate distances. This field must meet the following criteria: be a `date`, `date_nanos` or `geo_point` field; have an `index` mapping parameter value of `true`, which is the default; have an `doc_values` mapping parameter value of `true`, which is the default. |
| `origin` | TOrigin | Date or point of origin used to calculate distances. If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. Date Math, such as `now-1h`, is supported. If the field value is a `geo_point` field, the `origin` value must be a geopoint. |
| `pivot` | TDistance | Distance from the `origin` at which relevance scores receive half of the `boost` value. If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. |