Add documentation for ml inference search request processor/ search r…

…esponse processor (#7852) * draft ml inference search request processor Signed-off-by: Mingshi Liu <[email protected]> * add doc Signed-off-by: Mingshi Liu <[email protected]> * add doc Signed-off-by: Mingshi Liu <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Fixed links 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]> * Unify processor docs Signed-off-by: Fanit Kolchina <[email protected]> * Update _query-dsl/geo-and-xy/xy.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Remove note Signed-off-by: Fanit Kolchina <[email protected]> * Fix link Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Mingshi Liu <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
opensearch-project · Aug 2, 2024 · 40943f4 · 40943f4
1 parent 76a29ff
commit 40943f4
Show file tree

Hide file tree

Showing 18 changed files with 968 additions and 18 deletions.
diff --git a/_query-dsl/geo-and-xy/xy.md b/_query-dsl/geo-and-xy/xy.md
@@ -14,7 +14,7 @@ To search for documents that contain [xy point]({{site.url}}{{site.baseurl}}/ope
 
 ## Spatial relations
 
-When you provide an xy shape to the xy query, the xy fields are matched using the following spatial relations to the provided shape.
+When you provide an xy shape to the xy query, the xy fields in the documents are matched using the following spatial relations to the provided shape.
 
 Relation | Description | Supporting xy field type
 :--- | :--- | :--- 
@@ -33,7 +33,7 @@ You can define the shape in an xy query either by providing a new shape definiti
 
 To provide a new shape to an xy query, define it in the `xy_shape` field.
 
-The following example illustrates searching for documents with xy shapes that match an xy shape defined at query time.
+The following example illustrates how to search for documents containing xy shapes that match an xy shape defined at query time.
 
 First, create an index and map the `geometry` field as an `xy_shape`:
 

diff --git a/_search-plugins/search-pipelines/collapse-processor.md b/_search-plugins/search-pipelines/collapse-processor.md
@@ -1,13 +1,15 @@
 ---
 layout: default
 title: Collapse
-nav_order: 7
+nav_order: 10
 has_children: false
 parent: Search processors
 grand_parent: Search pipelines
 ---
 
 # Collapse processor
+Introduced 2.12
+{: .label .label-purple }
 
 The `collapse` response processor discards hits that have the same value for a particular field as a previous document in the result set.
 This is similar to passing the `collapse` parameter in a search request, but the response processor is applied to the

diff --git a/_search-plugins/search-pipelines/filter-query-processor.md b/_search-plugins/search-pipelines/filter-query-processor.md
@@ -1,13 +1,15 @@
 ---
 layout: default
 title: Filter query
-nav_order: 10
+nav_order: 20
 has_children: false
 parent: Search processors
 grand_parent: Search pipelines
 ---
 
 # Filter query processor
+Introduced 2.8
+{: .label .label-purple }
 
 The `filter_query` search request processor intercepts a search request and applies an additional query to the request, filtering the results. This is useful when you don't want to rewrite existing queries in your application but need additional filtering of the results.