feat: Expose the FindNearest.distance_result_field parameter

Google APIs · copybara-github · commit 28685f723d37 · 2024-08-07T15:18:36.000-07:00
feat: Expose the `FindNearest.distance_threshold` parameter

PiperOrigin-RevId: 660557033
diff --git a/google/firestore/v1/query.proto b/google/firestore/v1/query.proto
@@ -312,6 +312,22 @@ message StructuredQuery {
     // integer of no more than 1000.
     google.protobuf.Int32Value limit = 4
         [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. Optional name of the field to output the result of the vector
+    // distance calculation. Must conform to [document field
+    // name][google.firestore.v1.Document.fields] limitations.
+    string distance_result_field = 5 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Option to specify a threshold for which no less similar
+    // documents will be returned. The behavior of the specified
+    // `distance_measure` will affect the meaning of the distance threshold.
+    // Since DOT_PRODUCT distances increase when the vectors are more similar,
+    // the comparison is inverted.
+    //
+    // For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold
+    // For DOT_PRODUCT:       WHERE distance >= distance_threshold
+    google.protobuf.DoubleValue distance_threshold = 6
+        [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Optional sub-set of the fields to return.
