@algolia/recommend 5.0.0-alpha.110 → 5.0.0-alpha.112

package/dist/model/paramsConsequence.d.ts

@@ -0,0 +1,19 @@
+import type { AutoFacetFilter } from './autoFacetFilter';
+/**
+ * Filter or boost recommendations matching a facet filter.
+ */
+export type ParamsConsequence = {
+    /**
+     * Filter recommendations that match or don\'t match the same `facet:facet_value` combination as the viewed item.
+     */
+    automaticFacetFilters?: AutoFacetFilter[];
+    /**
+     * 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;
+    /**
+     * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.
+     */
+    optionalFilters?: string[];
+};
+//# sourceMappingURL=paramsConsequence.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"paramsConsequence.d.ts","sourceRoot":"","sources":["../../model/paramsConsequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,eAAe,EAAE,CAAC;IAE1C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B,CAAC"}

package/dist/model/promoteConsequenceObject.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Object ID and position of the recommendation you want to pin.
+ */
+export type PromoteConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+    /**
+     * Index in the list of recommendations where to place this item.
+     */
+    position?: number;
+};
+//# sourceMappingURL=promoteConsequenceObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"promoteConsequenceObject.d.ts","sourceRoot":"","sources":["../../model/promoteConsequenceObject.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/reRankingApplyFilter.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
+ * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
 export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

package/dist/model/recommendRule.d.ts

@@ -0,0 +1,24 @@
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { RecommendRuleMetadata } from './recommendRuleMetadata';
+/**
+ * Recommend rule.
+ */
+export type RecommendRule = {
+    _metadata?: RecommendRuleMetadata;
+    /**
+     * Unique identifier of a rule object.
+     */
+    objectID?: string;
+    condition?: Condition;
+    consequence?: Consequence;
+    /**
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+     */
+    description?: string;
+    /**
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+     */
+    enabled?: boolean;
+};
+//# sourceMappingURL=recommendRule.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendRule.d.ts","sourceRoot":"","sources":["../../model/recommendRule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}

package/dist/model/recommendRuleMetadata.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Rule metadata.
+ */
+export type RecommendRuleMetadata = {
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    lastUpdate?: string;
+};
+//# sourceMappingURL=recommendRuleMetadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendRuleMetadata.d.ts","sourceRoot":"","sources":["../../model/recommendRuleMetadata.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/model/recommendationsHits.d.ts

@@ -1,13 +1,5 @@
 import type { RecommendationsHit } from './recommendationsHit';
 export type RecommendationsHits = {
     hits: RecommendationsHit[];
-    /**
-     * Search query.
-     */
-    query?: string;
-    /**
-     * URL-encoded string of all search parameters.
-     */
-    params?: string;
 };
 //# sourceMappingURL=recommendationsHits.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendationsHits.d.ts","sourceRoot":"","sources":["../../model/recommendationsHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,kBAAkB,EAAE,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"recommendationsHits.d.ts","sourceRoot":"","sources":["../../model/recommendationsHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,kBAAkB,EAAE,CAAC;CAC5B,CAAC"}

package/dist/model/recommendationsRequest.d.ts

@@ -1,6 +1,8 @@
-import type { RecommendationsQuery } from './recommendationsQuery';
+import type { BoughtTogetherQuery } from './boughtTogetherQuery';
+import type { LookingSimilarQuery } from './lookingSimilarQuery';
 import type { RecommendedForYouQuery } from './recommendedForYouQuery';
+import type { RelatedQuery } from './relatedQuery';
 import type { TrendingFacetsQuery } from './trendingFacetsQuery';
 import type { TrendingItemsQuery } from './trendingItemsQuery';
-export type RecommendationsRequest = RecommendationsQuery | RecommendedForYouQuery | TrendingFacetsQuery | TrendingItemsQuery;
+export type RecommendationsRequest = BoughtTogetherQuery | LookingSimilarQuery | RecommendedForYouQuery | RelatedQuery | TrendingFacetsQuery | TrendingItemsQuery;
 //# sourceMappingURL=recommendationsRequest.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAC9B,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,kBAAkB,CAAC"}
+{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAC9B,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,YAAY,GACZ,mBAAmB,GACnB,kBAAkB,CAAC"}

package/dist/model/recommendedForYou.d.ts

@@ -0,0 +1,7 @@
+import type { FallbackParams } from './fallbackParams';
+import type { RecommendedForYouModel } from './recommendedForYouModel';
+export type RecommendedForYou = {
+    model: RecommendedForYouModel;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=recommendedForYou.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendedForYou.d.ts","sourceRoot":"","sources":["../../model/recommendedForYou.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,sBAAsB,CAAC;IAE9B,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/recommendedForYouModel.d.ts

@@ -1,5 +1,5 @@
 /**
- * Recommended for you model.
+ * \"Recommened for you\" model.
  */
 export type RecommendedForYouModel = 'recommended-for-you';
 //# sourceMappingURL=recommendedForYouModel.d.ts.map

package/dist/model/recommendedForYouQuery.d.ts

@@ -1,4 +1,4 @@
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseRecommendedForYouQuery } from './baseRecommendedForYouQuery';
-export type RecommendedForYouQuery = BaseRecommendedForYouQuery & BaseRecommendRequest;
+import type { RecommendedForYou } from './recommendedForYou';
+export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
 //# sourceMappingURL=recommendedForYouQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendedForYouQuery.d.ts","sourceRoot":"","sources":["../../model/recommendedForYouQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE/E,MAAM,MAAM,sBAAsB,GAAG,0BAA0B,GAC7D,oBAAoB,CAAC"}
+{"version":3,"file":"recommendedForYouQuery.d.ts","sourceRoot":"","sources":["../../model/recommendedForYouQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG,iBAAiB,CAAC"}

package/dist/model/relatedModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Related products or similar content model.  This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
+ */
+export type RelatedModel = 'related-products';
+//# sourceMappingURL=relatedModel.d.ts.map

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

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

package/dist/model/relatedProducts.d.ts

@@ -0,0 +1,11 @@
+import type { FallbackParams } from './fallbackParams';
+import type { RelatedModel } from './relatedModel';
+export type RelatedProducts = {
+    model: RelatedModel;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=relatedProducts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relatedProducts.d.ts","sourceRoot":"","sources":["../../model/relatedProducts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,YAAY,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/relatedQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { RelatedProducts } from './relatedProducts';
+export type RelatedQuery = BaseRecommendRequest & RelatedProducts;
+//# sourceMappingURL=relatedQuery.d.ts.map

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

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

package/dist/model/removeWordsIfNoResults.d.ts

@@ -1,5 +1,5 @@
 /**
- * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  <dl> <dt><code>none</code></dt> <dd>No words are removed when a query doesn\'t return results.</dd> <dt><code>lastWords</code></dt> <dd>Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed.</dd> <dt><code>firstWords</code></dt> <dd>Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed.</dd> <dt><code>allOptional</code></dt> <dd>Treat all words as optional.</dd> </dl>  For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
+ * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  - `none`.   No words are removed when a query doesn\'t return results.  - `lastWords`.   Treat the last (then second to last, then third to last) word as optional,   until there are results or at most 5 words have been removed.  - `firstWords`.   Treat the first (then second, then third) word as optional,   until there are results or at most 5 words have been removed.  - `allOptional`.   Treat all words as optional.  For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
  */
 export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

package/dist/model/searchParams.d.ts

@@ -0,0 +1,3 @@
+import type { SearchParamsObject } from './searchParamsObject';
+export type SearchParams = Record<string, any> & SearchParamsObject;
+//# sourceMappingURL=searchParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchParams.d.ts","sourceRoot":"","sources":["../../model/searchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB,CAAC"}

package/dist/model/searchParamsObject.d.ts

@@ -1,4 +1,7 @@
 import type { BaseSearchParams } from './baseSearchParams';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+/**
+ * Each parameter value, including the `query` must not be larger than 512 bytes.
+ */
 export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
 //# sourceMappingURL=searchParamsObject.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}

package/dist/model/searchRecommendRulesParams.d.ts

@@ -1,5 +1,5 @@
 /**
- * Recommend rules search parameters.
+ * Recommend rules parameters.
  */
 export type SearchRecommendRulesParams = {
     /**
@@ -7,7 +7,7 @@ export type SearchRecommendRulesParams = {
      */
     query?: string;
     /**
-     * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+     * Only search for rules with matching context.
      */
     context?: string;
     /**
@@ -19,8 +19,20 @@ export type SearchRecommendRulesParams = {
      */
     hitsPerPage?: number;
     /**
-     * Restricts responses to enabled rules. When absent (default), _all_ rules are retrieved.
+     * Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property.
      */
-    enabled?: boolean | null;
+    enabled?: boolean;
+    /**
+     * Filter expression. This only searches for rules matching the filter expression.
+     */
+    filters?: string;
+    /**
+     * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
+     */
+    facets?: string[];
+    /**
+     * Maximum number of values to return for each facet.
+     */
+    maxValuesPerFacet?: number;
 };
 //# sourceMappingURL=searchRecommendRulesParams.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchRecommendRulesParams.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"searchRecommendRulesParams.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}

package/dist/model/searchRecommendRulesResponse.d.ts

@@ -1,9 +1,9 @@
-import type { RuleResponse } from './ruleResponse';
+import type { RecommendRule } from './recommendRule';
 export type SearchRecommendRulesResponse = {
     /**
-     * Fetched rules.
+     * Recommend rules that match the search criteria.
      */
-    hits: RuleResponse[];
+    hits: RecommendRule[];
     /**
      * Number of results (hits).
      */

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

@@ -1 +1 @@
-{"version":3,"file":"searchRecommendRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"searchRecommendRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,aAAa,EAAE,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/sortRemainingBy.d.ts

@@ -1,5 +1,5 @@
 /**
- * Order of facet values that aren\'t explicitly positioned with the `order` setting.  <dl> <dt><code>count</code></dt> <dd> Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Sort facet values alphabetically.</dd> <dt><code>hidden</code></dt> <dd>Don\'t show facet values that aren\'t explicitly positioned.</dd> </dl>.
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  - `count`.   Order remaining facet values by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Sort facet values alphabetically.  - `hidden`.   Don\'t show facet values that aren\'t explicitly positioned.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

package/dist/model/trendingFacetHit.d.ts

@@ -7,11 +7,11 @@ export type TrendingFacetHit = {
      */
     _score: number;
     /**
-     * Facet name for trending models.
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
      */
     facetName: string;
     /**
-     * Facet value for trending models.
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
      */
     facetValue: string;
 };

package/dist/model/trendingFacets.d.ts

@@ -0,0 +1,11 @@
+import type { FallbackParams } from './fallbackParams';
+import type { TrendingFacetsModel } from './trendingFacetsModel';
+export type TrendingFacets = {
+    /**
+     * Facet attribute for which to retrieve trending facet values.
+     */
+    facetName: any | null;
+    model: TrendingFacetsModel;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=trendingFacets.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trendingFacets.d.ts","sourceRoot":"","sources":["../../model/trendingFacets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB,KAAK,EAAE,mBAAmB,CAAC;IAE3B,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/trendingFacetsModel.d.ts

@@ -1,5 +1,5 @@
 /**
- * Trending facets model.
+ * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
  */
 export type TrendingFacetsModel = 'trending-facets';
 //# sourceMappingURL=trendingFacetsModel.d.ts.map

package/dist/model/trendingFacetsQuery.d.ts

@@ -1,4 +1,4 @@
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingFacetsQuery } from './baseTrendingFacetsQuery';
-export type TrendingFacetsQuery = BaseRecommendRequest & BaseTrendingFacetsQuery;
+import type { TrendingFacets } from './trendingFacets';
+export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
 //# sourceMappingURL=trendingFacetsQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trendingFacetsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingFacetsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEzE,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GACpD,uBAAuB,CAAC"}
+{"version":3,"file":"trendingFacetsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingFacetsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,cAAc,CAAC"}

package/dist/model/trendingItems.d.ts

@@ -0,0 +1,15 @@
+import type { SearchParamsObject } from './searchParamsObject';
+import type { TrendingItemsModel } from './trendingItemsModel';
+export type TrendingItems = {
+    /**
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetName: string;
+    /**
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetValue: string;
+    model: TrendingItemsModel;
+    fallbackParameters?: SearchParamsObject;
+};
+//# sourceMappingURL=trendingItems.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trendingItems.d.ts","sourceRoot":"","sources":["../../model/trendingItems.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,kBAAkB,CAAC;IAE1B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}

package/dist/model/trendingItemsModel.d.ts

@@ -1,5 +1,5 @@
 /**
- * Trending items model.
+ * Trending items model.  Trending items are determined from the number of conversion events collected on them.
  */
 export type TrendingItemsModel = 'trending-items';
 //# sourceMappingURL=trendingItemsModel.d.ts.map

package/dist/model/trendingItemsQuery.d.ts

@@ -1,4 +1,4 @@
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingItemsQuery } from './baseTrendingItemsQuery';
-export type TrendingItemsQuery = BaseRecommendRequest & BaseTrendingItemsQuery;
+import type { TrendingItems } from './trendingItems';
+export type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
 //# sourceMappingURL=trendingItemsQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trendingItemsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingItemsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,sBAAsB,CAAC"}
+{"version":3,"file":"trendingItemsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingItemsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,aAAa,CAAC"}

package/dist/recommend.cjs

@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '5.0.0-alpha.110';
+const apiClientVersion = '5.0.0-alpha.112';
 function getDefaultHosts(appId) {
     return [
         {
@@ -183,14 +183,14 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Deletes a Recommend rule from a recommendation scenario.
          *
          * Required API Key ACLs:
          * - editSettings.
          *
          * @param deleteRecommendRule - The deleteRecommendRule object.
          * @param deleteRecommendRule.indexName - Name of the index on which to perform the operation.
-         * @param deleteRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @param deleteRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
          * @param deleteRecommendRule.objectID - Unique record identifier.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -219,14 +219,14 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
          *
          * Required API Key ACLs:
          * - settings.
          *
          * @param getRecommendRule - The getRecommendRule object.
          * @param getRecommendRule.indexName - Name of the index on which to perform the operation.
-         * @param getRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @param getRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
          * @param getRecommendRule.objectID - Unique record identifier.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -255,15 +255,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
+         * Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
          *
          * Required API Key ACLs:
          * - editSettings.
          *
          * @param getRecommendStatus - The getRecommendStatus object.
          * @param getRecommendStatus.indexName - Name of the index on which to perform the operation.
-         * @param getRecommendStatus.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-         * @param getRecommendStatus.taskID - Unique identifier of a task. Numeric value (up to 64bits).
+         * @param getRecommendStatus.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @param getRecommendStatus.taskID - Unique task identifier.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getRecommendStatus({ indexName, model, taskID }, requestOptions) {
@@ -291,7 +291,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns results from either recommendation or trending models:    - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models   - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
+         * Retrieves recommendations from selected AI models.
          *
          * Required API Key ACLs:
          * - search.
@@ -321,14 +321,14 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
          *
          * Required API Key ACLs:
          * - settings.
          *
          * @param searchRecommendRules - The searchRecommendRules object.
          * @param searchRecommendRules.indexName - Name of the index on which to perform the operation.
-         * @param searchRecommendRules.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @param searchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
          * @param searchRecommendRules.searchRecommendRulesParams - The searchRecommendRulesParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */