@algolia/recommend 5.0.0-alpha.99 → 5.0.0-beta.2

package/dist/builds/browser.d.ts

@@ -1,6 +1,24 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { RecommendClient } from '../src/recommendClient';
-export { apiClientVersion, RecommendClient } from '../src/recommendClient';
+export { apiClientVersion } from '../src/recommendClient';
 export * from '../model';
-export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
+/**
+ * The client type.
+ */
+export type RecommendClient = ReturnType<typeof recommendClient>;
+export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    readonly _ua: string;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    deleteRecommendRule({ indexName, model, objectID }: import("../model").DeleteRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    getRecommendRule({ indexName, model, objectID }: import("../model").GetRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RecommendRule>;
+    getRecommendStatus({ indexName, model, taskID }: import("../model").GetRecommendStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendTaskResponse>;
+    getRecommendations(getRecommendationsParams: import("../model").GetRecommendationsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendationsResponse>;
+    searchRecommendRules({ indexName, model, searchRecommendRulesParams, }: import("../model").SearchRecommendRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRecommendRulesResponse>;
+};
 //# sourceMappingURL=browser.d.ts.map

package/dist/builds/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAe5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CA8BjB"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAgB5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;EA+BxB"}

package/dist/builds/node.d.ts

@@ -1,6 +1,24 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { RecommendClient } from '../src/recommendClient';
-export { apiClientVersion, RecommendClient } from '../src/recommendClient';
+export { apiClientVersion } from '../src/recommendClient';
 export * from '../model';
-export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
+/**
+ * The client type.
+ */
+export type RecommendClient = ReturnType<typeof recommendClient>;
+export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    deleteRecommendRule({ indexName, model, objectID }: import("../model").DeleteRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    getRecommendRule({ indexName, model, objectID }: import("../model").GetRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RecommendRule>;
+    getRecommendStatus({ indexName, model, taskID }: import("../model").GetRecommendStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendTaskResponse>;
+    getRecommendations(getRecommendationsParams: import("../model").GetRecommendationsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendationsResponse>;
+    searchRecommendRules({ indexName, model, searchRecommendRulesParams, }: import("../model").SearchRecommendRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRecommendRulesResponse>;
+};
 //# sourceMappingURL=node.d.ts.map

package/dist/builds/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CAwBjB"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAY5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;EA2BxB"}

package/dist/model/aroundPrecision.d.ts

@@ -1,6 +1,6 @@
 import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
 /**
- * Precision of a geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
+ * Precision of a coordinate-based search in meters to group results with similar distances.  The Geo ranking criterion considers all matches within the same range of distances to be equal.
  */
 export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
 //# sourceMappingURL=aroundPrecision.d.ts.map

package/dist/model/aroundPrecisionFromValueInner.d.ts

@@ -1,5 +1,14 @@
+/**
+ * Range object with lower and upper values in meters to define custom ranges.
+ */
 export type AroundPrecisionFromValueInner = {
+    /**
+     * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+     */
     from?: number;
+    /**
+     * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+     */
     value?: number;
 };
 //# sourceMappingURL=aroundPrecisionFromValueInner.d.ts.map

package/dist/model/aroundPrecisionFromValueInner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aroundPrecisionFromValueInner.d.ts","sourceRoot":"","sources":["../../model/aroundPrecisionFromValueInner.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"aroundPrecisionFromValueInner.d.ts","sourceRoot":"","sources":["../../model/aroundPrecisionFromValueInner.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/aroundRadius.d.ts

@@ -1,6 +1,6 @@
 import type { AroundRadiusAll } from './aroundRadiusAll';
 /**
- * [Maximum radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius) for a geographical search (in meters).
+ * Maximum radius for a search around a central location.  This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
  */
 export type AroundRadius = AroundRadiusAll | number;
 //# sourceMappingURL=aroundRadius.d.ts.map

package/dist/model/aroundRadiusAll.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Return all records with a valid `_geoloc` attribute. Don\'t filter by distance.
+ */
 export type AroundRadiusAll = 'all';
 //# sourceMappingURL=aroundRadiusAll.d.ts.map

package/dist/model/aroundRadiusAll.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC"}
+{"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC"}

package/dist/model/autoFacetFilter.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
+ */
+export type AutoFacetFilter = {
+    /**
+     * Facet attribute.
+     */
+    facet?: string;
+    /**
+     * Whether the filter is negative. If true, recommendations must not have the same value for the `facet` attribute. If false, recommendations must have the same value for the `facet` attribute.
+     */
+    negative?: boolean;
+};
+//# sourceMappingURL=autoFacetFilter.d.ts.map

package/dist/model/autoFacetFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoFacetFilter.d.ts","sourceRoot":"","sources":["../../model/autoFacetFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC"}

package/dist/model/baseRecommendRequest.d.ts

@@ -1,15 +1,17 @@
+import type { SearchParams } from './searchParams';
 export type BaseRecommendRequest = {
     /**
-     * Algolia index name.
+     * Index name (case-sensitive).
      */
     indexName: string;
     /**
-     * Recommendations with a confidence score lower than `threshold` won\'t appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
+     * Minimum score a recommendation must have to be included in the response.
      */
-    threshold?: number;
+    threshold: number;
     /**
-     * Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
+     * Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
      */
     maxRecommendations?: number;
+    queryParameters?: SearchParams;
 };
 //# sourceMappingURL=baseRecommendRequest.d.ts.map

package/dist/model/baseRecommendRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC"}
+{"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,eAAe,CAAC,EAAE,YAAY,CAAC;CAChC,CAAC"}

package/dist/model/baseSearchParamsWithoutQuery.d.ts

@@ -3,14 +3,15 @@ import type { AroundRadius } from './aroundRadius';
 import type { FacetFilters } from './facetFilters';
 import type { NumericFilters } from './numericFilters';
 import type { OptionalFilters } from './optionalFilters';
+import type { SupportedLanguage } from './supportedLanguage';
 import type { TagFilters } from './tagFilters';
 export type BaseSearchParamsWithoutQuery = {
     /**
-     * Overrides the query parameter and performs a more generic search.
+     * Keywords to be used instead of the search query to conduct a more broader search.  Using the `similarQuery` parameter changes other settings:  - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`.  Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
      */
     similarQuery?: string;
     /**
-     * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
      */
     filters?: string;
     facetFilters?: FacetFilters;
@@ -18,89 +19,85 @@ export type BaseSearchParamsWithoutQuery = {
     numericFilters?: NumericFilters;
     tagFilters?: TagFilters;
     /**
-     * Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
+     * Whether to sum all filter scores.  If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
      */
     sumOrFiltersScores?: boolean;
     /**
-     * Restricts a query to only look at a subset of your [searchable attributes](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/).
+     * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
      */
     restrictSearchableAttributes?: string[];
     /**
-     * Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
+     * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.  To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
      */
     facets?: string[];
     /**
-     * Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
+     * Whether faceting should be applied after deduplication with `distinct`.  This leads to accurate facet counts when using faceting in combination with `distinct`. It\'s usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
      */
     facetingAfterDistinct?: boolean;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page?: number;
     /**
-     * Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
+     * Position of the first hit to retrieve.
      */
     offset?: number;
     /**
-     * Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
+     * Number of hits to retrieve (used in combination with `offset`).
      */
     length?: number;
     /**
-     * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
+     * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
      */
     aroundLatLng?: string;
     /**
-     * Search for entries around a location. The location is automatically computed from the requester\'s IP address.
+     * Whether to obtain the coordinates from the request\'s IP address.
      */
     aroundLatLngViaIP?: boolean;
     aroundRadius?: AroundRadius;
     aroundPrecision?: AroundPrecision;
     /**
-     * Minimum radius (in meters) used for a geographical search when `aroundRadius` isn\'t set.
+     * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
      */
     minimumAroundRadius?: number;
     /**
-     * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+     * Coordinates for a rectangular area in which to search.  Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
      */
     insideBoundingBox?: number[][];
     /**
-     * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+     * Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
      */
     insidePolygon?: number[][];
     /**
-     * Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
+     * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
      */
-    naturalLanguages?: string[];
+    naturalLanguages?: SupportedLanguage[];
     /**
-     * Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
+     * Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
      */
     ruleContexts?: string[];
     /**
-     * Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
+     * Impact that Personalization should have on this search.  The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
      */
     personalizationImpact?: number;
     /**
-     * Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
+     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
     userToken?: string;
     /**
-     * Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
+     * Whether the search response should include detailed ranking information.
      */
     getRankingInfo?: boolean;
     /**
-     * Enriches the API\'s response with information about how the query was processed.
-     */
-    explain?: string[];
-    /**
-     * Whether to take into account an index\'s synonyms for a particular search.
+     * Whether to take into account an index\'s synonyms for this search.
      */
     synonyms?: boolean;
     /**
-     * Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
+     * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
      */
     clickAnalytics?: boolean;
     /**
-     * Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
+     * Whether this search will be included in Analytics.
      */
     analytics?: boolean;
     /**
@@ -108,11 +105,11 @@ export type BaseSearchParamsWithoutQuery = {
      */
     analyticsTags?: string[];
     /**
-     * Whether to include or exclude a query from the processing-time percentile computation.
+     * Whether to include this search when calculating processing-time percentiles.
      */
     percentileComputation?: boolean;
     /**
-     * Incidates whether this search will be considered in A/B testing.
+     * Whether to enable A/B testing for this search.
      */
     enableABTest?: boolean;
 };

package/dist/model/baseSearchParamsWithoutQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC"}
+{"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC"}

package/dist/model/baseSearchResponse.d.ts

@@ -16,7 +16,7 @@ export type BaseSearchResponse = Record<string, any> & {
      */
     aroundLatLng?: string;
     /**
-     * Automatically-computed radius.
+     * Distance from a central coordinate provided by `aroundLatLng`.
      */
     automaticRadius?: string;
     exhaustive?: Exhaustive;
@@ -33,7 +33,7 @@ export type BaseSearchResponse = Record<string, any> & {
      */
     exhaustiveTypo?: boolean;
     /**
-     * Mapping of each facet name to the corresponding facet counts.
+     * Facet counts.
      */
     facets?: Record<string, Record<string, number>>;
     /**
@@ -57,11 +57,11 @@ export type BaseSearchResponse = Record<string, any> & {
      */
     message?: string;
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
     nbHits: number;
     /**
-     * Number of pages of results for the current query.
+     * Number of pages of results.
      */
     nbPages: number;
     /**
@@ -69,7 +69,7 @@ export type BaseSearchResponse = Record<string, any> & {
      */
     nbSortedHits?: number;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page: number;
     /**
@@ -99,8 +99,12 @@ export type BaseSearchResponse = Record<string, any> & {
      */
     serverUsed?: string;
     /**
-     * Lets you store custom data in your indices.
+     * An object with custom data.  You can store up to 32&nbsp;kB as custom data.
      */
     userData?: any | null;
+    /**
+     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+     */
+    queryID?: string;
 };
 //# sourceMappingURL=baseSearchResponse.d.ts.map

package/dist/model/baseSearchResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CACvB,CAAC"}
+{"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/boughtTogetherQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { FrequentlyBoughtTogether } from './frequentlyBoughtTogether';
+export type BoughtTogetherQuery = BaseRecommendRequest & FrequentlyBoughtTogether;
+//# sourceMappingURL=boughtTogetherQuery.d.ts.map

package/dist/model/boughtTogetherQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boughtTogetherQuery.d.ts","sourceRoot":"","sources":["../../model/boughtTogetherQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GACpD,wBAAwB,CAAC"}

package/dist/model/clientMethodProps.d.ts

@@ -65,15 +65,15 @@ export type CustomPutProps = {
  */
 export type DeleteRecommendRuleProps = {
     /**
-     * Index on which to perform the request.
+     * Name of the index on which to perform the operation.
      */
     indexName: string;
     /**
-     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
     model: RecommendModels;
     /**
-     * Unique record (object) identifier.
+     * Unique record identifier.
      */
     objectID: string;
 };
@@ -82,15 +82,15 @@ export type DeleteRecommendRuleProps = {
  */
 export type GetRecommendRuleProps = {
     /**
-     * Index on which to perform the request.
+     * Name of the index on which to perform the operation.
      */
     indexName: string;
     /**
-     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
     model: RecommendModels;
     /**
-     * Unique record (object) identifier.
+     * Unique record identifier.
      */
     objectID: string;
 };
@@ -99,15 +99,15 @@ export type GetRecommendRuleProps = {
  */
 export type GetRecommendStatusProps = {
     /**
-     * Index on which to perform the request.
+     * Name of the index on which to perform the operation.
      */
     indexName: string;
     /**
-     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
     model: RecommendModels;
     /**
-     * Unique identifier of a task. Numeric value (up to 64bits).
+     * Unique task identifier.
      */
     taskID: number;
 };
@@ -116,11 +116,11 @@ export type GetRecommendStatusProps = {
  */
 export type SearchRecommendRulesProps = {
     /**
-     * Index on which to perform the request.
+     * Name of the index on which to perform the operation.
      */
     indexName: string;
     /**
-     * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
     model: RecommendModels;
     searchRecommendRulesParams?: SearchRecommendRulesParams;

package/dist/model/condition.d.ts

@@ -1,16 +1,13 @@
-import type { Anchoring } from './anchoring';
+/**
+ * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
+ */
 export type Condition = {
     /**
-     * Query pattern syntax.
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
      */
-    pattern?: string;
-    anchoring?: Anchoring;
+    filters?: string;
     /**
-     * Whether the pattern matches on plurals, synonyms, and typos.
-     */
-    alternatives?: boolean;
-    /**
-     * Rule context format: [A-Za-z0-9_-]+).
+     * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
      */
     context?: string;
 };

package/dist/model/condition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../model/condition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../model/condition.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/consequence.d.ts

@@ -1,26 +1,18 @@
-import type { ConsequenceHide } from './consequenceHide';
-import type { ConsequenceParams } from './consequenceParams';
-import type { Promote } from './promote';
+import type { HideConsequenceObject } from './hideConsequenceObject';
+import type { ParamsConsequence } from './paramsConsequence';
+import type { PromoteConsequenceObject } from './promoteConsequenceObject';
 /**
- * [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences) of a rule.
+ * Effect of the rule.
  */
 export type Consequence = {
-    params?: ConsequenceParams;
     /**
-     * Records to promote.
+     * Exclude items from recommendations.
      */
-    promote?: Promote[];
+    hide?: HideConsequenceObject[];
     /**
-     * Only use in combination with the `promote` consequence. When `true`, promoted results will be restricted to match the filters of the current search. When `false`, the promoted results will show up regardless of the filters.
+     * Place items at specific positions in the list of recommendations.
      */
-    filterPromotes?: boolean;
-    /**
-     * Records to hide. By default, you can hide up to 50 records per rule.
-     */
-    hide?: ConsequenceHide[];
-    /**
-     * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
-     */
-    userData?: any | null;
+    promote?: PromoteConsequenceObject[];
+    params?: ParamsConsequence;
 };
 //# sourceMappingURL=consequence.d.ts.map

package/dist/model/consequence.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"consequence.d.ts","sourceRoot":"","sources":["../../model/consequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CACvB,CAAC"}
+{"version":3,"file":"consequence.d.ts","sourceRoot":"","sources":["../../model/consequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAErC,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B,CAAC"}

package/dist/model/deletedAtResponse.d.ts

@@ -3,11 +3,11 @@
  */
 export type DeletedAtResponse = {
     /**
-     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
     taskID: number;
     /**
-     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     * Date and time when the object was deleted, in RFC 3339 format.
      */
     deletedAt: string;
 };

package/dist/model/distinct.d.ts

@@ -1,5 +1,5 @@
 /**
- * Enables [deduplication or grouping of results (Algolia\'s _distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
+ * Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
  */
 export type Distinct = boolean | number;
 //# sourceMappingURL=distinct.d.ts.map

package/dist/model/exactOnSingleWordQuery.d.ts

@@ -1,5 +1,5 @@
 /**
- * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the query contains only one word.
+ * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.  - `attribute`.   The Exact ranking criterion is 1 if the query word and attribute value are the same.   For example, a search for \"road\" will match the value \"road\", but not \"road trip\".  - `none`.   The Exact ranking criterion is ignored on single-word searches.  - `word`.   The Exact ranking criterion is 1 if the query word is found in the attribute value.   The query word must have at least 3 characters and must not be a stop word.   Only exact matches will be highlighted,   partial and prefix matches won\'t.
  */
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
 //# sourceMappingURL=exactOnSingleWordQuery.d.ts.map