@findlane/server 0.17.0 → 0.18.0

package/dist/index.d.cts

@@ -66,6 +66,14 @@ export type IndexSettings = {
     /** Query suggestions: whole searches offered as shoppers type, and popular searches for an empty box,
      * from what shoppers search and the catalog. On by default. Changes apply within a few minutes. */
     querySuggestions?: QuerySuggestionSettings;
+    /** Related results (0.18.0): when a search's words find nothing, the products closest to it in meaning, in
+     * the response's `related`. Paid plans, indexes of up to 200,000 records. Turned on, every record is
+     * embedded within minutes, and `minScore`, the floor, is calibrated from the index's own searches that
+     * found nothing; none show until it is. Off by default. */
+    relatedResults?: {
+        enabled?: boolean;
+        minScore?: number | null;
+    };
     normalizationProfile?: "default-v2" | "default-v1" | "icelandic-ascii-v1";
     /** An object field of lat and lng numbers, such as `_geoloc`, that `near` and `within` search; null for none. */
     locationField?: string | null;
@@ -335,6 +343,8 @@ export type SearchRequest = {
     /** Only records inside a box, in degrees, such as a map's visible area. West greater than east crosses the
      * antimeridian. */
     within?: GeoBox;
+    /** With the index's `relatedResults` on: false asks for no related results (0.18.0). */
+    related?: boolean;
 };
 /** A point in degrees: lat from -90 to 90, lng from -180 to 180. */
 export type GeoPoint = {
@@ -441,6 +451,17 @@ export type SearchResponse<T> = {
     appliedRules?: AppliedRule[];
     /** When a rule replaced words: the query that was searched. */
     rewrittenQuery?: string;
+    /** With the index's `relatedResults` on (0.18.0): when the query's words found nothing (`hits` empty,
+     * `total` 0), the products closest to it in meaning, best first, with their similarity as `score`. Show
+     * them under a heading of their own, such as "No exact matches. Related products". */
+    related?: {
+        hits: Array<{
+            id: string;
+            score: number | null;
+            record: T;
+        }>;
+        total: number;
+    };
 };
 /** How a product's recommendations are served (the recommendations add-on). */
 /** One of an index's lists (docs: Lists): a row of products, such as Popular or New arrivals, from a filter and
@@ -626,7 +647,7 @@ export type ServerEvent = {
     objectID: string;
     position?: number;
     query?: string;
-    list?: "goesWith" | "similar" | "together";
+    list?: "goesWith" | "similar" | "together" | "related";
     from?: string;
     timestamp?: number;
 } | {

package/dist/index.d.ts

@@ -66,6 +66,14 @@ export type IndexSettings = {
     /** Query suggestions: whole searches offered as shoppers type, and popular searches for an empty box,
      * from what shoppers search and the catalog. On by default. Changes apply within a few minutes. */
     querySuggestions?: QuerySuggestionSettings;
+    /** Related results (0.18.0): when a search's words find nothing, the products closest to it in meaning, in
+     * the response's `related`. Paid plans, indexes of up to 200,000 records. Turned on, every record is
+     * embedded within minutes, and `minScore`, the floor, is calibrated from the index's own searches that
+     * found nothing; none show until it is. Off by default. */
+    relatedResults?: {
+        enabled?: boolean;
+        minScore?: number | null;
+    };
     normalizationProfile?: "default-v2" | "default-v1" | "icelandic-ascii-v1";
     /** An object field of lat and lng numbers, such as `_geoloc`, that `near` and `within` search; null for none. */
     locationField?: string | null;
@@ -335,6 +343,8 @@ export type SearchRequest = {
     /** Only records inside a box, in degrees, such as a map's visible area. West greater than east crosses the
      * antimeridian. */
     within?: GeoBox;
+    /** With the index's `relatedResults` on: false asks for no related results (0.18.0). */
+    related?: boolean;
 };
 /** A point in degrees: lat from -90 to 90, lng from -180 to 180. */
 export type GeoPoint = {
@@ -441,6 +451,17 @@ export type SearchResponse<T> = {
     appliedRules?: AppliedRule[];
     /** When a rule replaced words: the query that was searched. */
     rewrittenQuery?: string;
+    /** With the index's `relatedResults` on (0.18.0): when the query's words found nothing (`hits` empty,
+     * `total` 0), the products closest to it in meaning, best first, with their similarity as `score`. Show
+     * them under a heading of their own, such as "No exact matches. Related products". */
+    related?: {
+        hits: Array<{
+            id: string;
+            score: number | null;
+            record: T;
+        }>;
+        total: number;
+    };
 };
 /** How a product's recommendations are served (the recommendations add-on). */
 /** One of an index's lists (docs: Lists): a row of products, such as Popular or New arrivals, from a filter and
@@ -626,7 +647,7 @@ export type ServerEvent = {
     objectID: string;
     position?: number;
     query?: string;
-    list?: "goesWith" | "similar" | "together";
+    list?: "goesWith" | "similar" | "together" | "related";
     from?: string;
     timestamp?: number;
 } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findlane/server",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "Findlane server SDK: upload catalogs, manage index settings, and search with a secret workspace API key.",
   "keywords": ["findlane", "search", "full-text search", "typo tolerance", "ecommerce search", "search api", "sdk"],
   "license": "MIT",