Merge branch 'opensearch-project:main' into main

Author: lucy66hw

CHANGELOG.md

@@ -6,6 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - Publish opensearch-protos python package to PyPi. ([#183](https://github.com/opensearch-project/opensearch-protobufs/pull/183))
 - Proto Convertion tooling support null value ([#189](https://github.com/opensearch-project/opensearch-protobufs/pull/189))
+- Add `geo_distance` and `geo_bounding_box` to QueryContainer. ([#188](https://github.com/opensearch-project/opensearch-protobufs/pull/188))
 
 ### Changed
 - update `score` protobuf type ([#179](https://github.com/opensearch-project/opensearch-protobufs/pull/179))

protos/schemas/common.proto

@@ -137,13 +137,23 @@ enum SourceType {
 }
 
 message GeoLocation {
-
   oneof geo_location {
-    LatLonGeoLocation lat_lon_geo_location = 1;
-    GeoHashLocation geo_hash_location = 2;
-    NumberArray number_array = 3;
+    // The location specified using latitude and longitude coordinates.
+    LatLonGeoLocation latlon = 1;
+
+    // The location specified using a geohash value.
+    GeoHashLocation geohash = 2;
+
+    DoubleArray double_array = 3;
+
+    // The location specified as a string in `lat,lon` or WKT format.
+    string text = 4;
   }
+}
 
+message DoubleArray {
+  // The location specified as an array of `[longitude, latitude]`.
+  repeated double double_array = 1;
 }
 
 message NumberArray {
@@ -153,16 +163,16 @@ message NumberArray {
 }
 
 message LatLonGeoLocation {
-  // Latitude
+  // [required] Latitude
   double lat = 1;
 
-  // Longitude
+  // [required] Longitude
   double lon = 2;
 
 }
 
 message GeoHashLocation {
-
+  // [required]
   string geohash = 1;
 
 }
@@ -456,9 +466,104 @@ message QueryContainer {
 
     // The nested query acts as a wrapper for other queries to search nested fields. The nested field objects are searched as though they were indexed as separate documents. If an object matches the search, the nested query returns the parent document at the root level.
     NestedQuery nested = 28;
+
+    // A geodistance query returns documents with geopoints that are within a specified distance from the provided geopoint. A document with multiple geopoints matches the query if at least one geopoint matches the query.
+    GeoDistanceQuery geo_distance = 29;
+
+    // To search for documents that contain geopoint fields, use a geo-bounding box query. The geo-bounding box query returns documents whose geopoints are within the bounding box specified in the query. A document with multiple geopoints matches the query if at least one geopoint is within the bounding box.
+    GeoBoundingBoxQuery geo_bounding_box = 30;
+  }
+}
+
+message GeoBoundingBoxQuery {
+  // [optional] Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
+  optional float boost = 1;
+  // [optional] The name of the filter.
+  optional string x_name = 2;
+  // [optional]
+  optional GeoExecution type = 3;
+  // [optional] The validation method. Valid values are IGNORE_MALFORMED (accept geopoints with invalid coordinates), COERCE (try to coerce coordinates to valid values), and STRICT (return an error when coordinates are invalid). Default is STRICT.
+  optional GeoValidationMethod validation_method = 4;
+  // [optional] Specifies whether to ignore an unmapped field. If set to true, the query does not return any documents that have an unmapped field. If set to false, an exception is thrown when the field is unmapped. Default is false.
+  optional bool ignore_unmapped = 5;
+  // [optional]
+  map<string, GeoBounds> bounding_box = 6;
+}
+
+message GeoBounds {
+  oneof geo_bounds {
+    // The bounds specified using coordinate values.
+    CoordsGeoBounds coords = 1;
+
+    // The bounds specified using upper-left and lower-right points.
+    TopLeftBottomRightGeoBounds tlbr = 2;
+
+    // The bounds specified using upper-right and lower-left points.
+    TopRightBottomLeftGeoBounds trbl = 3;
+
+    // The bounds specified using WKT format.
+    WktGeoBounds wkt = 4;
   }
 }
 
+message WktGeoBounds {
+  // [required] The WKT string representation of the geographical bounds.
+  string wkt = 1;
+}
+
+message CoordsGeoBounds {
+  // [required] The top boundary latitude.
+  double top = 1;
+
+  // [required] The bottom boundary latitude.
+  double bottom = 2;
+
+  // [required] The left boundary longitude.
+  double left = 3;
+
+  // [required] The right boundary longitude.
+  double right = 4;
+}
+
+message TopLeftBottomRightGeoBounds {
+  // [required] The upper-left corner coordinates.
+  GeoLocation top_left = 1;
+
+  // [required] The lower-right corner coordinates.
+  GeoLocation bottom_right = 2;
+}
+
+message TopRightBottomLeftGeoBounds {
+  // [required] The upper-right corner coordinates.
+  GeoLocation top_right = 1;
+
+  // [required] The lower-left corner coordinates.
+  GeoLocation bottom_left = 2;
+}
+
+enum GeoExecution {
+  GEO_EXECUTION_UNSPECIFIED = 0;
+  GEO_EXECUTION_INDEXED = 1;
+  GEO_EXECUTION_MEMORY = 2;
+}
+
+message GeoDistanceQuery {
+  // [optional] Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
+  optional float boost = 1;
+  // [optional] The name of the filter.
+  optional string x_name = 2;
+  // [required] The distance within which to match the points. This distance is the radius of a circle centered at the specified point. For supported distance units, see Distance units.
+  string distance = 3;
+  // [optional] Specifies how to calculate the distance. Valid values are arc or plane (faster but inaccurate for long distances or points close to the poles).
+  optional GeoDistanceType distance_type = 4;
+  // [optional] The validation method. Valid values are IGNORE_MALFORMED (accept geopoints with invalid coordinates), COERCE (try to coerce coordinates to valid values), and STRICT (return an error when coordinates are invalid). Default is STRICT.
+  optional GeoValidationMethod validation_method = 5;
+  // [optional] Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped.
+  optional bool ignore_unmapped = 6;
+  // [optional]
+  map<string, GeoLocation> location = 7;
+}
+
 message TermsQuery {
   // [optional] Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
   optional float boost = 1;