findnearest update and length rename

Author: wu-hui

google-cloud-firestore/src/main/java/com/google/cloud/firestore/Pipeline.java

@@ -41,6 +41,7 @@
 import com.google.cloud.firestore.pipeline.stages.Distinct;
 import com.google.cloud.firestore.pipeline.stages.Documents;
 import com.google.cloud.firestore.pipeline.stages.FindNearest;
+import com.google.cloud.firestore.pipeline.stages.FindNearestOptions;
 import com.google.cloud.firestore.pipeline.stages.GenericStage;
 import com.google.cloud.firestore.pipeline.stages.Limit;
 import com.google.cloud.firestore.pipeline.stages.Offset;
@@ -495,23 +496,29 @@ public Pipeline distinct(Selectable... selectables) {
    * <pre>{@code
    * // Find books with similar "topicVectors" to the given targetVector
    * firestore.pipeline().collection("books")
-   *     .findNearest("topicVectors", targetVector,
+   *     .findNearest("topicVectors", targetVector, FindNearest.DistanceMeasure.cosine(),
    *        FindNearestOptions
-   *          .withLimitAndMeasure(10, DistanceMeasure.cosine())
-   *          .withOutputField("distance"));
+   *          .builder()
+   *          .limit(10)
+   *          .distanceField("distance")
+   *          .build());
    * }</pre>
    *
    * @param fieldName The name of the field containing the vector data. This field should store
    *     {@link VectorValue}.
    * @param vector The target vector to compare against.
-   * @param options Configuration options for the nearest neighbor search, such as the distance
-   *     metric to use.
+   * @param distanceMeasure The distance measure to use: cosine, euclidean, etc.
+   * @param options Configuration options for the nearest neighbor search, such as limit and output
+   *     distance field name.
    * @return A new {@code Pipeline} object with this stage appended to the stage list.
    */
   @BetaApi
   public Pipeline findNearest(
-      String fieldName, double[] vector, FindNearest.FindNearestOptions options) {
-    return findNearest(Field.of(fieldName), vector, options);
+      String fieldName,
+      double[] vector,
+      FindNearest.DistanceMeasure distanceMeasure,
+      FindNearestOptions options) {
+    return findNearest(Field.of(fieldName), vector, distanceMeasure, options);
   }
 
   /**
@@ -527,29 +534,38 @@ public Pipeline findNearest(
    * <pre>{@code
    * // Find books with similar "topicVectors" to the given targetVector
    * firestore.pipeline().collection("books")
-   *     .findNearest(Field.of("topicVectors"), targetVector,
+   *     .findNearest(Field.of("topicVectors"), targetVector, FindNearest.DistanceMeasure.cosine(),
    *        FindNearestOptions
-   *          .withLimitAndMeasure(10, DistanceMeasure.cosine())
-   *          .withOutputField("distance"));
+   *          .builder()
+   *          .limit(10)
+   *          .distanceField("distance")
+   *          .build());
    * }</pre>
    *
    * @param property The expression that evaluates to a vector value using the stage inputs.
    * @param vector The target vector to compare against.
-   * @param options Configuration options for the nearest neighbor search, such as the distance
-   *     metric to use.
+   * @param distanceMeasure The distance measure to use: cosine, euclidean, etc.
+   * @param options Configuration options for the nearest neighbor search, such as limit and output
+   *     distance field name.
    * @return A new {@code Pipeline} object with this stage appended to the stage list.
    */
   @BetaApi
   public Pipeline findNearest(
-      Expr property, double[] vector, FindNearest.FindNearestOptions options) {
+      Expr property,
+      double[] vector,
+      FindNearest.DistanceMeasure distanceMeasure,
+      FindNearestOptions options) {
     // Implementation for findNearest (add the FindNearest stage if needed)
     return new Pipeline(
         this.db,
         ImmutableList.<Stage>builder()
             .addAll(stages)
             .add(
                 new FindNearest(
-                    property, vector, options)) // Assuming FindNearest takes these arguments
+                    property,
+                    vector,
+                    distanceMeasure,
+                    options)) // Assuming FindNearest takes these arguments
             .build());
   }
 

google-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/expressions/Expr.java

@@ -768,14 +768,14 @@ default Max max() {
    *
    * <pre>{@code
    * // Get the length of the 'name' field
-   * Field.of("name").length();
+   * Field.of("name").strLength();
    * }</pre>
    *
    * @return A new {@code Expr} representing the length of the string.
    */
   @BetaApi
-  default Length length() {
-    return new Length(this);
+  default StrLength strLength() {
+    return new StrLength(this);
   }
 
   /**

google-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/expressions/Function.java

@@ -1496,15 +1496,15 @@ public static ArrayTransform arrayTransform(String field, Function transform) {
    *
    * <pre>{@code
    * // Get the length of the 'name' field
-   * Function.length(Field.of("name"));
+   * Function.strLength(Field.of("name"));
    * }</pre>
    *
    * @param expr The expression representing the string to calculate the length of.
    * @return A new {@code Expr} representing the length of the string.
    */
   @BetaApi
-  public static Length length(Expr expr) {
-    return new Length(expr);
+  public static StrLength strLength(Expr expr) {
+    return new StrLength(expr);
   }
 
   /**
@@ -1514,15 +1514,15 @@ public static Length length(Expr expr) {
    *
    * <pre>{@code
    * // Get the length of the 'name' field
-   * Function.length("name");
+   * Function.strLength("name");
    * }</pre>
    *
    * @param field The name of the field containing the string.
    * @return A new {@code Expr} representing the length of the string.
    */
   @BetaApi
-  public static Length length(String field) {
-    return new Length(Field.of(field));
+  public static StrLength strLength(String field) {
+    return new StrLength(Field.of(field));
   }
 
   /**

google-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/expressions/Length.java renamed to google-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/expressions/StrLength.java

@@ -21,9 +21,9 @@
 import com.google.common.collect.Lists;
 
 @BetaApi
-public final class Length extends Function {
+public final class StrLength extends Function {
   @InternalApi
-  Length(Expr expr) {
+  StrLength(Expr expr) {
     super("length", Lists.newArrayList(expr));
   }
 }

google-cloud-firestore/src/main/java/com/google/cloud/firestore/pipeline/stages/FindNearest.java

@@ -16,47 +16,13 @@
 
 package com.google.cloud.firestore.pipeline.stages;
 
+import com.google.api.core.BetaApi;
 import com.google.api.core.InternalApi;
 import com.google.cloud.firestore.pipeline.expressions.Expr;
-import com.google.cloud.firestore.pipeline.expressions.Field;
-import javax.annotation.Nullable;
 
+@BetaApi
 public final class FindNearest implements Stage {
 
-  private static final String name = "find_nearest";
-  private final Expr property;
-  private final double[] vector;
-  private final FindNearest.FindNearestOptions options;
-
-  @InternalApi
-  public FindNearest(Expr property, double[] vector, FindNearest.FindNearestOptions options) {
-    this.property = property;
-    this.vector = vector;
-    this.options = options;
-  }
-
-  @Override
-  @InternalApi
-  public String getName() {
-    return name;
-  }
-
-  @InternalApi
-  public Expr getProperty() {
-    return property;
-  }
-
-  @InternalApi
-  public double[] getVector() {
-    return vector;
-  }
-
-  @InternalApi
-  public FindNearestOptions getOptions() {
-    return options;
-  }
-
-  // Nested interfaces and classes
   public interface DistanceMeasure {
 
     enum Type {
@@ -65,27 +31,27 @@ enum Type {
       DOT_PRODUCT
     }
 
-    static FindNearest.DistanceMeasure euclidean() {
-      return new FindNearest.EuclideanDistanceMeasure();
+    static DistanceMeasure euclidean() {
+      return new EuclideanDistanceMeasure();
     }
 
-    static FindNearest.DistanceMeasure cosine() {
-      return new FindNearest.CosineDistanceMeasure();
+    static DistanceMeasure cosine() {
+      return new CosineDistanceMeasure();
     }
 
-    static FindNearest.DistanceMeasure dotProduct() {
-      return new FindNearest.DotProductDistanceMeasure();
+    static DistanceMeasure dotProduct() {
+      return new DotProductDistanceMeasure();
     }
 
-    static FindNearest.DistanceMeasure generic(String name) {
-      return new FindNearest.GenericDistanceMeasure(name);
+    static DistanceMeasure generic(String name) {
+      return new GenericDistanceMeasure(name);
     }
 
     @InternalApi
     String toProtoString();
   }
 
-  static class EuclideanDistanceMeasure implements FindNearest.DistanceMeasure {
+  public static class EuclideanDistanceMeasure implements DistanceMeasure {
 
     @Override
     @InternalApi
@@ -94,7 +60,7 @@ public String toProtoString() {
     }
   }
 
-  static class CosineDistanceMeasure implements FindNearest.DistanceMeasure {
+  public static class CosineDistanceMeasure implements DistanceMeasure {
 
     @Override
     @InternalApi
@@ -103,7 +69,7 @@ public String toProtoString() {
     }
   }
 
-  static class DotProductDistanceMeasure implements FindNearest.DistanceMeasure {
+  public static class DotProductDistanceMeasure implements DistanceMeasure {
 
     @Override
     @InternalApi
@@ -112,7 +78,7 @@ public String toProtoString() {
     }
   }
 
-  static class GenericDistanceMeasure implements FindNearest.DistanceMeasure {
+  public static class GenericDistanceMeasure implements DistanceMeasure {
 
     String name;
 
@@ -127,45 +93,44 @@ public String toProtoString() {
     }
   }
 
-  public static class FindNearestOptions {
-
-    private final Long limit;
-    private final FindNearest.DistanceMeasure distanceMeasure;
-
-    @Nullable private final Field distanceField;
-
-    private FindNearestOptions(Long limit, FindNearest.DistanceMeasure distanceMeasure) {
-      this.limit = limit;
-      this.distanceMeasure = distanceMeasure;
-      this.distanceField = null;
-    }
+  private static final String name = "find_nearest";
+  private final Expr property;
+  private final double[] vector;
+  private final DistanceMeasure distanceMeasure;
+  private final FindNearestOptions options;
 
-    private FindNearestOptions(
-        Long limit, FindNearest.DistanceMeasure distanceMeasure, Field field) {
-      this.limit = limit;
-      this.distanceMeasure = distanceMeasure;
-      this.distanceField = field;
-    }
+  @InternalApi
+  public FindNearest(
+      Expr property, double[] vector, DistanceMeasure distanceMeasure, FindNearestOptions options) {
+    this.property = property;
+    this.vector = vector;
+    this.distanceMeasure = distanceMeasure;
+    this.options = options;
+  }
 
-    public static FindNearest.FindNearestOptions withLimitAndMeasure(
-        long limit, FindNearest.DistanceMeasure distanceMeasure) {
-      return new FindNearest.FindNearestOptions(limit, distanceMeasure);
-    }
+  @Override
+  @InternalApi
+  public String getName() {
+    return name;
+  }
 
-    public FindNearest.FindNearestOptions withDistanceField(String name) {
-      return new FindNearest.FindNearestOptions(limit, distanceMeasure, Field.of(name));
-    }
+  @InternalApi
+  public Expr getProperty() {
+    return property;
+  }
 
-    public Long getLimit() {
-      return limit;
-    }
+  @InternalApi
+  public double[] getVector() {
+    return vector;
+  }
 
-    public DistanceMeasure getDistanceMeasure() {
-      return distanceMeasure;
-    }
+  @InternalApi
+  public DistanceMeasure getDistanceMeasure() {
+    return distanceMeasure;
+  }
 
-    public Field getDistanceField() {
-      return distanceField;
-    }
+  @InternalApi
+  public FindNearestOptions getOptions() {
+    return options;
   }
 }