Add has parent query (#8365)

* Add has parent query Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit c0127fb) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Sep 26, 2024 · b1c5b9c · b1c5b9c
1 parent dc60ff9
commit b1c5b9c
Show file tree

Hide file tree

Showing 6 changed files with 516 additions and 3 deletions.
diff --git a/_field-types/supported-field-types/join.md b/_field-types/supported-field-types/join.md
@@ -327,3 +327,8 @@ PUT testindex1
 - Multiple parents are not supported. 
 - You can add a child document to an existing document only if the existing document is already marked as a parent.
 - You can add a new relation to an existing join field.
+
+## Next steps
+
+- Learn about [joining queries]({{site.url}}{{site.baseurl}}/query-dsl/joining/) on join fields.
+- Learn more about [retrieving inner hits]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/inner-hits/).
diff --git a/_field-types/supported-field-types/nested.md b/_field-types/supported-field-types/nested.md
@@ -314,3 +314,8 @@ Parameter | Description
 `include_in_parent` | A Boolean value that specifies whether all fields in the child nested object should also be added to the parent document in flattened form. Default is `false`.
 `include_in_root` | A Boolean value that specifies whether all fields in the child nested object should also be added to the root document in flattened form. Default is `false`.
 `properties` | Fields of this object, which can be of any supported type. New properties can be dynamically added to this object if `dynamic` is set to `true`.
+
+## Next steps
+
+- Learn about [joining queries]({{site.url}}{{site.baseurl}}/query-dsl/joining/) on nested fields.
+- Learn about [retrieving inner hits]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/inner-hits/).
diff --git a/_query-dsl/joining/has-child.md b/_query-dsl/joining/has-child.md
@@ -176,6 +176,140 @@ The response returns both brands:
 }
 ```
 
+## Retrieving inner hits
+
+To return child documents that matched the query, provide the `inner_hits` parameter:
+
+```json
+GET testindex1/_search
+{
+  "query" : {
+    "has_child": {
+      "type":"product",
+      "query": {
+        "match" : {
+            "name": "watch"
+        }
+      },
+      "inner_hits": {}
+    }
+  }
+}
+```
+{% include copy-curl.html %}
+
+The response contains child documents in the `inner_hits` field:
+
+```json
+{
+  "took": 52,
+  "timed_out": false,
+  "_shards": {
+    "total": 1,
+    "successful": 1,
+    "skipped": 0,
+    "failed": 0
+  },
+  "hits": {
+    "total": {
+      "value": 2,
+      "relation": "eq"
+    },
+    "max_score": 1,
+    "hits": [
+      {
+        "_index": "testindex1",
+        "_id": "1",
+        "_score": 1,
+        "_source": {
+          "name": "Luxury brand",
+          "product_to_brand": "brand"
+        },
+        "inner_hits": {
+          "product": {
+            "hits": {
+              "total": {
+                "value": 1,
+                "relation": "eq"
+              },
+              "max_score": 0.53899646,
+              "hits": [
+                {
+                  "_index": "testindex1",
+                  "_id": "3",
+                  "_score": 0.53899646,
+                  "_routing": "1",
+                  "_source": {
+                    "name": "Mechanical watch",
+                    "sales_count": 150,
+                    "product_to_brand": {
+                      "name": "product",
+                      "parent": "1"
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      },
+      {
+        "_index": "testindex1",
+        "_id": "2",
+        "_score": 1,
+        "_source": {
+          "name": "Economy brand",
+          "product_to_brand": "brand"
+        },
+        "inner_hits": {
+          "product": {
+            "hits": {
+              "total": {
+                "value": 2,
+                "relation": "eq"
+              },
+              "max_score": 0.53899646,
+              "hits": [
+                {
+                  "_index": "testindex1",
+                  "_id": "4",
+                  "_score": 0.53899646,
+                  "_routing": "2",
+                  "_source": {
+                    "name": "Electronic watch",
+                    "sales_count": 300,
+                    "product_to_brand": {
+                      "name": "product",
+                      "parent": "2"
+                    }
+                  }
+                },
+                {
+                  "_index": "testindex1",
+                  "_id": "5",
+                  "_score": 0.53899646,
+                  "_routing": "2",
+                  "_source": {
+                    "name": "Digital watch",
+                    "sales_count": 100,
+                    "product_to_brand": {
+                      "name": "product",
+                      "parent": "2"
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    ]
+  }
+}
+```
+
+For more information about retrieving inner hits, see [Inner hits]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/inner-hits/).
+
 ## Parameters
 
 The following table lists all top-level parameters supported by `has_child` queries.
@@ -188,6 +322,7 @@ The following table lists all top-level parameters supported by `has_child` quer
 | `max_children` | Optional | The maximum number of matching child documents for a parent document. If exceeded, the parent document is excluded from the search results. |
 | `min_children` | Optional | The minimum number of matching child documents required for a parent document to be included in the results. If not met, the parent is excluded. Default is `1`.|
 | `score_mode` | Optional | Defines how scores of matching child documents influence the parent document's score. Valid values are: <br> - `none`: Ignores the relevance scores of child documents and assigns a score of `0` to the parent document. <br> - `avg`: Uses the average relevance score of all matching child documents. <br> - `max`: Assigns the highest relevance score from the matching child documents to the parent. <br> - `min`: Assigns the lowest relevance score from the matching child documents to the parent. <br> - `sum`: Sums the relevance scores of all matching child documents. <br> Default is `none`. |
+| `inner_hits` | Optional | If provided, returns the underlying hits (child documents) that matched the query. |
 
 
 ## Sorting limitations
@@ -256,4 +391,8 @@ The response contains the brands sorted by the highest child `sales_count`:
     ]
   }
 }
-```
+```
+
+## Next steps
+
+- Learn more about [retrieving inner hits]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/inner-hits/).