Updated sample for findNearest documentation.

googleapis · Aug 14, 2024 · 6ccf5ae · 6ccf5ae
1 parent a042509
commit 6ccf5ae
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/dev/src/reference/query.ts b/dev/src/reference/query.ts
@@ -655,7 +655,14 @@ export class Query<
    * @example
    * ```
    * // Returns the closest 10 documents whose Euclidean distance from their 'embedding' fields are closed to [41, 42].
-   * const vectorQuery = col.findNearest('embedding', [41, 42], 10, 'EUCLIDEAN', { distanceResultField: 'distance'});
+   * const vectorQuery = col.findNearest({
+   *     vectorField: 'embedding',
+   *     queryVector: [41, 42],
+   *     limit: 10,
+   *     distanceMeasure: 'EUCLIDEAN',
+   *     distanceResultField: 'distance',
+   *     distanceThreshold: 0.125
+   * });
    *
    * const querySnapshot = await aggregateQuery.get();
    * querySnapshot.forEach(...);

diff --git a/types/firestore.d.ts b/types/firestore.d.ts
@@ -2078,7 +2078,14 @@ declare namespace FirebaseFirestore {
      * @example
      * ```
      * // Returns the closest 10 documents whose Euclidean distance from their 'embedding' fields are closed to [41, 42].
-     * const vectorQuery = col.findNearest('embedding', [41, 42], 10, 'EUCLIDEAN', { distanceResultField: 'distance'});
+     * const vectorQuery = col.findNearest({
+     *     vectorField: 'embedding',
+     *     queryVector: [41, 42],
+     *     limit: 10,
+     *     distanceMeasure: 'EUCLIDEAN',
+     *     distanceResultField: 'distance',
+     *     distanceThreshold: 0.125
+     * });
      *
      * const querySnapshot = await aggregateQuery.get();
      * querySnapshot.forEach(...);