mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-05 20:48:22 +00:00
18866c4c0b
This commit changes the format of the `hits.total` in the search response to be an object with a `value` and a `relation`. The `value` indicates the number of hits that match the query and the `relation` indicates whether the number is accurate (in which case the relation is equals to `eq`) or a lower bound of the total (in which case it is equals to `gte`). This change also adds a parameter called `rest_total_hits_as_int` that can be used in the search APIs to opt out from this change (retrieve the total hits as a number in the rest response). Note that currently all search responses are accurate (`track_total_hits: true`) or they don't contain `hits.total` (`track_total_hits: true`). We'll add a way to get a lower bound of the total hits in a follow up (to allow numbers to be passed to `track_total_hits`). Relates #33028
124 lines
2.9 KiB
Plaintext
124 lines
2.9 KiB
Plaintext
[[query-dsl-terms-set-query]]
|
|
=== Terms Set Query
|
|
|
|
Returns any documents that match with at least one or more of the
|
|
provided terms. The terms are not analyzed and thus must match exactly.
|
|
The number of terms that must match varies per document and is either
|
|
controlled by a minimum should match field or computed per document in
|
|
a minimum should match script.
|
|
|
|
The field that controls the number of required terms that must match must
|
|
be a number field:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT /my-index
|
|
{
|
|
"mappings": {
|
|
"_doc": {
|
|
"properties": {
|
|
"required_matches": {
|
|
"type": "long"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT /my-index/_doc/1?refresh
|
|
{
|
|
"codes": ["ghi", "jkl"],
|
|
"required_matches": 2
|
|
}
|
|
|
|
PUT /my-index/_doc/2?refresh
|
|
{
|
|
"codes": ["def", "ghi"],
|
|
"required_matches": 2
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TESTSETUP
|
|
|
|
An example that uses the minimum should match field:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /my-index/_search
|
|
{
|
|
"query": {
|
|
"terms_set": {
|
|
"codes" : {
|
|
"terms" : ["abc", "def", "ghi"],
|
|
"minimum_should_match_field": "required_matches"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
Response:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"took": 13,
|
|
"timed_out": false,
|
|
"_shards": {
|
|
"total": 1,
|
|
"successful": 1,
|
|
"skipped" : 0,
|
|
"failed": 0
|
|
},
|
|
"hits": {
|
|
"total" : {
|
|
"value": 1,
|
|
"relation": "eq"
|
|
},
|
|
"max_score": 0.87546873,
|
|
"hits": [
|
|
{
|
|
"_index": "my-index",
|
|
"_type": "_doc",
|
|
"_id": "2",
|
|
"_score": 0.87546873,
|
|
"_source": {
|
|
"codes": ["def", "ghi"],
|
|
"required_matches": 2
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/"took": 13,/"took": "$body.took",/]
|
|
|
|
Scripts can also be used to control how many terms are required to match
|
|
in a more dynamic way. For example a create date or a popularity field
|
|
can be used as basis for the number of required terms to match.
|
|
|
|
Also the `params.num_terms` parameter is available in the script to indicate the
|
|
number of terms that have been specified.
|
|
|
|
An example that always limits the number of required terms to match to never
|
|
become larger than the number of terms specified:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /my-index/_search
|
|
{
|
|
"query": {
|
|
"terms_set": {
|
|
"codes" : {
|
|
"terms" : ["abc", "def", "ghi"],
|
|
"minimum_should_match_script": {
|
|
"source": "Math.min(params.num_terms, doc['required_matches'].value)"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|