@algolia/recommend 5.2.5 → 5.3.0

package/dist/browser.d.ts

@@ -1,9 +1,7 @@
 import * as _algolia_client_common from '@algolia/client-common';
-import { ClientOptions } from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
-type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
-
-type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
+type RecommendModels = 'bought-together' | 'related-products' | 'trending-facets' | 'trending-items';
 
 /**
  * Range object with lower and upper values in meters to define custom ranges.
@@ -34,20 +32,6 @@ type AroundRadiusAll = 'all';
  */
 type AroundRadius = AroundRadiusAll | number;
 
-/**
- * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
- */
-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;
-};
-
 /**
  * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
@@ -191,6 +175,10 @@ type SearchParamsQuery = {
 
 type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
 
+type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
+
+type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
+
 /**
  * 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.
  */
@@ -476,258 +464,272 @@ type BaseRecommendRequest = {
 };
 
 /**
- * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+ * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
  */
-type Exhaustive = {
-    /**
-     * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
-     */
-    facetsCount?: boolean;
-    /**
-     * The value is `false` if not all facet values are retrieved.
-     */
-    facetValues?: boolean;
-    /**
-     * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
-     */
-    nbHits?: boolean;
-    /**
-     * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
-     */
-    rulesMatch?: boolean;
+type FbtModel = 'bought-together';
+
+type FrequentlyBoughtTogether = {
+    model: FbtModel;
     /**
-     * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+     * Unique record identifier.
      */
-    typo?: boolean;
+    objectID: string;
 };
 
-type FacetStats = {
-    /**
-     * Minimum value in the results.
-     */
-    min?: number;
-    /**
-     * Maximum value in the results.
-     */
-    max?: number;
-    /**
-     * Average facet value in the results.
-     */
-    avg?: number;
+type BoughtTogetherQuery = BaseRecommendRequest & FrequentlyBoughtTogether;
+
+type FallbackParams = Record<string, unknown> & SearchParamsObject;
+
+/**
+ * Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
+ */
+type LookingSimilarModel = 'looking-similar';
+
+type LookingSimilar = {
+    model: LookingSimilarModel;
     /**
-     * Sum of all values in the results.
+     * Unique record identifier.
      */
-    sum?: number;
+    objectID: string;
+    fallbackParameters?: FallbackParams;
 };
 
+type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;
+
 /**
- * Redirect rule data.
+ * \"Recommened for you\" model.
  */
-type RedirectRuleIndexData = {
-    ruleObjectID: string;
+type RecommendedForYouModel = 'recommended-for-you';
+
+type RecommendedForYou = {
+    model: RecommendedForYouModel;
+    fallbackParameters?: FallbackParams;
 };
 
-type RedirectRuleIndexMetadata = {
+type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
+
+/**
+ * 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.
+ */
+type RelatedModel = 'related-products';
+
+type RelatedProducts = {
+    model: RelatedModel;
     /**
-     * Source index for the redirect rule.
+     * Unique record identifier.
      */
-    source: string;
+    objectID: string;
+    fallbackParameters?: FallbackParams;
+};
+
+type RelatedQuery = BaseRecommendRequest & RelatedProducts;
+
+/**
+ * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
+ */
+type TrendingFacetsModel = 'trending-facets';
+
+type TrendingFacets = {
     /**
-     * Destination index for the redirect rule.
+     * Facet attribute for which to retrieve trending facet values.
      */
-    dest: string;
+    facetName: any | null;
+    model: TrendingFacetsModel;
+    fallbackParameters?: FallbackParams;
+};
+
+type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
+
+/**
+ * Trending items model.  Trending items are determined from the number of conversion events collected on them.
+ */
+type TrendingItemsModel = 'trending-items';
+
+type TrendingItems = {
     /**
-     * Reason for the redirect rule.
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
      */
-    reason: string;
+    facetName?: string;
     /**
-     * Redirect rule status.
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
      */
-    succeed: boolean;
-    data: RedirectRuleIndexData;
+    facetValue?: string;
+    model: TrendingItemsModel;
+    fallbackParameters?: SearchParamsObject;
 };
 
+type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
+
+type RecommendationsRequest = BoughtTogetherQuery | LookingSimilarQuery | RecommendedForYouQuery | RelatedQuery | TrendingFacetsQuery | TrendingItemsQuery;
+
 /**
- * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
+ * Recommend rules parameters.
  */
-type Redirect = {
-    index?: RedirectRuleIndexMetadata[];
-};
-
-type BaseSearchResponse = Record<string, any> & {
+type SearchRecommendRulesParams = {
     /**
-     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
+     * Search query.
      */
-    abTestID?: number;
+    query?: string;
     /**
-     * Variant ID. This is only included in the response for indices that are part of an A/B test.
+     * Only search for rules with matching context.
      */
-    abTestVariantID?: number;
+    context?: string;
     /**
-     * Computed geographical location.
+     * Requested page of the API response.
      */
-    aroundLatLng?: string;
+    page?: number;
     /**
-     * Distance from a central coordinate provided by `aroundLatLng`.
+     * Maximum number of hits per page.
      */
-    automaticRadius?: string;
-    exhaustive?: Exhaustive;
+    hitsPerPage?: number;
     /**
-     * See the `facetsCount` field of the `exhaustive` object in the response.
+     * 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.
      */
-    exhaustiveFacetsCount?: boolean;
+    enabled?: boolean;
     /**
-     * See the `nbHits` field of the `exhaustive` object in the response.
+     * Filter expression. This only searches for rules matching the filter expression.
      */
-    exhaustiveNbHits?: boolean;
+    filters?: string;
     /**
-     * See the `typo` field of the `exhaustive` object in the response.
+     * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
      */
-    exhaustiveTypo?: boolean;
+    facets?: string[];
     /**
-     * Facet counts.
+     * Maximum number of values to return for each facet.
      */
-    facets?: Record<string, Record<string, number>>;
+    maxValuesPerFacet?: number;
+};
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
     /**
-     * Statistics for numerical facets.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    facets_stats?: Record<string, FacetStats>;
+    path: string;
     /**
-     * Index name used for the query.
+     * Query parameters to apply to the current query.
      */
-    index?: string;
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+type CustomGetProps = {
     /**
-     * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    indexUsed?: string;
+    path: string;
     /**
-     * Warnings about the query.
+     * Query parameters to apply to the current query.
      */
-    message?: string;
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
     /**
-     * Number of hits selected and sorted by the relevant sort algorithm.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    nbSortedHits?: number;
+    path: string;
     /**
-     * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
+     * Query parameters to apply to the current query.
      */
-    parsedQuery?: string;
+    parameters?: Record<string, any>;
     /**
-     * Time the server took to process the request, in milliseconds.
+     * Parameters to send with the custom request.
      */
-    processingTimeMS: number;
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
     /**
-     * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    processingTimingsMS?: Record<string, unknown>;
+    path: string;
     /**
-     * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
+     * Query parameters to apply to the current query.
      */
-    queryAfterRemoval?: string;
-    redirect?: Redirect;
-    renderingContent?: RenderingContent;
+    parameters?: Record<string, any>;
     /**
-     * Time the server took to process the request, in milliseconds.
+     * Parameters to send with the custom request.
      */
-    serverTimeMS?: number;
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `deleteRecommendRule` method.
+ */
+type DeleteRecommendRuleProps = {
     /**
-     * Host name of the server that processed the request.
+     * Name of the index on which to perform the operation.
      */
-    serverUsed?: string;
-    /**
-     * An object with custom data.  You can store up to 32kB as custom data.
-     */
-    userData?: Record<string, unknown>;
+    indexName: string;
     /**
-     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
-    queryID?: string;
-};
-
-/**
- * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
- */
-type FbtModel = 'bought-together';
-
-type FrequentlyBoughtTogether = {
-    model: FbtModel;
+    model: RecommendModels;
     /**
      * Unique record identifier.
      */
     objectID: string;
 };
-
-type BoughtTogetherQuery = BaseRecommendRequest & FrequentlyBoughtTogether;
-
 /**
- * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
+ * Properties for the `getRecommendRule` method.
  */
-type Condition = {
+type GetRecommendRuleProps = {
     /**
-     * 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/).
+     * Name of the index on which to perform the operation.
      */
-    filters?: string;
+    indexName: string;
     /**
-     * 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.
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
-    context?: string;
-};
-
-/**
- * Object ID of the recommendation you want to exclude.
- */
-type HideConsequenceObject = {
+    model: RecommendModels;
     /**
      * Unique record identifier.
      */
-    objectID?: string;
+    objectID: string;
 };
-
 /**
- * Filter or boost recommendations matching a facet filter.
+ * Properties for the `getRecommendStatus` method.
  */
-type ParamsConsequence = {
+type GetRecommendStatusProps = {
     /**
-     * Filter recommendations that match or don\'t match the same `facet:facet_value` combination as the viewed item.
+     * Name of the index on which to perform the operation.
      */
-    automaticFacetFilters?: AutoFacetFilter[];
+    indexName: string;
     /**
-     * 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/).
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
-    filters?: string;
+    model: RecommendModels;
     /**
-     * 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.
+     * Unique task identifier.
      */
-    optionalFilters?: string[];
+    taskID: number;
 };
-
 /**
- * Object ID and position of the recommendation you want to pin.
+ * Recommend method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `GetRecommendationsParams` type for performances and future proof reasons.
  */
-type PromoteConsequenceObject = {
-    /**
-     * Unique record identifier.
-     */
-    objectID?: string;
-    /**
-     * Index in the list of recommendations where to place this item.
-     */
-    position?: number;
-};
-
+type LegacyGetRecommendationsParams = RecommendationsRequest[];
 /**
- * Effect of the rule.
+ * Properties for the `searchRecommendRules` method.
  */
-type Consequence = {
+type SearchRecommendRulesProps = {
     /**
-     * Exclude items from recommendations.
+     * Name of the index on which to perform the operation.
      */
-    hide?: HideConsequenceObject[];
+    indexName: string;
     /**
-     * Place items at specific positions in the list of recommendations.
+     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
      */
-    promote?: PromoteConsequenceObject[];
-    params?: ParamsConsequence;
+    model: RecommendModels;
+    searchRecommendRulesParams?: SearchRecommendRulesParams;
 };
 
 /**
@@ -744,15 +746,6 @@ type DeletedAtResponse = {
     deletedAt: string;
 };
 
-/**
- * Error.
- */
-type ErrorBase = Record<string, any> & {
-    message?: string;
-};
-
-type FallbackParams = Record<string, unknown> & SearchParamsObject;
-
 /**
  * Task status, `published` if the task is completed, `notPublished` otherwise.
  */
@@ -763,95 +756,182 @@ type GetRecommendTaskResponse = {
 };
 
 /**
- * Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
+ * Recommend request body.
  */
-type LookingSimilarModel = 'looking-similar';
-
-type LookingSimilar = {
-    model: LookingSimilarModel;
+type GetRecommendationsParams = {
     /**
-     * Unique record identifier.
+     * Recommendation request with parameters depending on the requested model.
      */
-    objectID: string;
-    fallbackParameters?: FallbackParams;
+    requests: RecommendationsRequest[];
 };
 
-type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;
-
 /**
- * \"Recommened for you\" model.
+ * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
  */
-type RecommendedForYouModel = 'recommended-for-you';
-
-type RecommendedForYou = {
-    model: RecommendedForYouModel;
-    fallbackParameters?: FallbackParams;
+type Exhaustive = {
+    /**
+     * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     */
+    facetsCount?: boolean;
+    /**
+     * The value is `false` if not all facet values are retrieved.
+     */
+    facetValues?: boolean;
+    /**
+     * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+     */
+    nbHits?: boolean;
+    /**
+     * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+     */
+    rulesMatch?: boolean;
+    /**
+     * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+     */
+    typo?: boolean;
 };
 
-type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
-
-/**
- * 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.
- */
-type RelatedModel = 'related-products';
-
-type RelatedProducts = {
-    model: RelatedModel;
+type FacetStats = {
     /**
-     * Unique record identifier.
+     * Minimum value in the results.
      */
-    objectID: string;
-    fallbackParameters?: FallbackParams;
+    min?: number;
+    /**
+     * Maximum value in the results.
+     */
+    max?: number;
+    /**
+     * Average facet value in the results.
+     */
+    avg?: number;
+    /**
+     * Sum of all values in the results.
+     */
+    sum?: number;
 };
 
-type RelatedQuery = BaseRecommendRequest & RelatedProducts;
-
 /**
- * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
+ * Redirect rule data.
  */
-type TrendingFacetsModel = 'trending-facets';
+type RedirectRuleIndexData = {
+    ruleObjectID: string;
+};
 
-type TrendingFacets = {
+type RedirectRuleIndexMetadata = {
     /**
-     * Facet attribute for which to retrieve trending facet values.
+     * Source index for the redirect rule.
      */
-    facetName: any | null;
-    model: TrendingFacetsModel;
-    fallbackParameters?: FallbackParams;
+    source: string;
+    /**
+     * Destination index for the redirect rule.
+     */
+    dest: string;
+    /**
+     * Reason for the redirect rule.
+     */
+    reason: string;
+    /**
+     * Redirect rule status.
+     */
+    succeed: boolean;
+    data: RedirectRuleIndexData;
 };
 
-type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
-
 /**
- * Trending items model.  Trending items are determined from the number of conversion events collected on them.
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
  */
-type TrendingItemsModel = 'trending-items';
+type Redirect = {
+    index?: RedirectRuleIndexMetadata[];
+};
 
-type TrendingItems = {
+type BaseSearchResponse = Record<string, any> & {
+    /**
+     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
+     */
+    abTestID?: number;
+    /**
+     * Variant ID. This is only included in the response for indices that are part of an A/B test.
+     */
+    abTestVariantID?: number;
+    /**
+     * Computed geographical location.
+     */
+    aroundLatLng?: string;
+    /**
+     * Distance from a central coordinate provided by `aroundLatLng`.
+     */
+    automaticRadius?: string;
+    exhaustive?: Exhaustive;
+    /**
+     * See the `facetsCount` field of the `exhaustive` object in the response.
+     */
+    exhaustiveFacetsCount?: boolean;
+    /**
+     * See the `nbHits` field of the `exhaustive` object in the response.
+     */
+    exhaustiveNbHits?: boolean;
+    /**
+     * See the `typo` field of the `exhaustive` object in the response.
+     */
+    exhaustiveTypo?: boolean;
+    /**
+     * Facet counts.
+     */
+    facets?: Record<string, Record<string, number>>;
+    /**
+     * Statistics for numerical facets.
+     */
+    facets_stats?: Record<string, FacetStats>;
+    /**
+     * Index name used for the query.
+     */
+    index?: string;
+    /**
+     * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
+     */
+    indexUsed?: string;
+    /**
+     * Warnings about the query.
+     */
+    message?: string;
+    /**
+     * Number of hits selected and sorted by the relevant sort algorithm.
+     */
+    nbSortedHits?: number;
+    /**
+     * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
+     */
+    parsedQuery?: string;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    processingTimeMS: number;
+    /**
+     * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
+     */
+    processingTimingsMS?: Record<string, unknown>;
+    /**
+     * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
+     */
+    queryAfterRemoval?: string;
+    redirect?: Redirect;
+    renderingContent?: RenderingContent;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    serverTimeMS?: number;
     /**
-     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+     * Host name of the server that processed the request.
      */
-    facetName?: string;
+    serverUsed?: string;
     /**
-     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+     * An object with custom data.  You can store up to 32kB as custom data.
      */
-    facetValue?: string;
-    model: TrendingItemsModel;
-    fallbackParameters?: SearchParamsObject;
-};
-
-type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
-
-type RecommendationsRequest = BoughtTogetherQuery | LookingSimilarQuery | RecommendedForYouQuery | RelatedQuery | TrendingFacetsQuery | TrendingItemsQuery;
-
-/**
- * Recommend request body.
- */
-type GetRecommendationsParams = {
+    userData?: Record<string, unknown>;
     /**
-     * Recommendation request with parameters depending on the requested model.
+     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
      */
-    requests: RecommendationsRequest[];
+    queryID?: string;
 };
 
 /**
@@ -1052,249 +1132,283 @@ type GetRecommendationsResponse = {
     results: RecommendationsResults[];
 };
 
-type RecommendModels = 'bought-together' | 'related-products' | 'trending-facets' | 'trending-items';
-
 /**
- * Rule metadata.
+ * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
  */
-type RuleMetadata = {
+type Condition = {
     /**
-     * Date and time when the object was updated, in RFC 3339 format.
+     * 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/).
      */
-    lastUpdate?: string;
+    filters?: string;
+    /**
+     * 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;
 };
 
 /**
- * Recommend rule.
+ * Object ID of the recommendation you want to exclude.
  */
-type RecommendRule = {
-    _metadata?: RuleMetadata;
+type HideConsequenceObject = {
     /**
-     * Unique identifier of a rule object.
+     * Unique record identifier.
      */
     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;
 };
 
 /**
- * Recommend rules parameters.
+ * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
  */
-type SearchRecommendRulesParams = {
-    /**
-     * Search query.
-     */
-    query?: string;
-    /**
-     * Only search for rules with matching context.
-     */
-    context?: string;
-    /**
-     * Requested page of the API response.
-     */
-    page?: number;
-    /**
-     * Maximum number of hits per page.
-     */
-    hitsPerPage?: number;
-    /**
-     * 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;
-    /**
-     * Filter expression. This only searches for rules matching the filter expression.
-     */
-    filters?: string;
+type AutoFacetFilter = {
     /**
-     * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
+     * Facet attribute.
      */
-    facets?: string[];
+    facet?: string;
     /**
-     * Maximum number of values to return for each facet.
+     * 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.
      */
-    maxValuesPerFacet?: number;
+    negative?: boolean;
 };
 
-type SearchRecommendRulesResponse = {
-    /**
-     * Recommend rules that match the search criteria.
-     */
-    hits: RecommendRule[];
+/**
+ * Filter or boost recommendations matching a facet filter.
+ */
+type ParamsConsequence = {
     /**
-     * Number of results (hits).
+     * Filter recommendations that match or don\'t match the same `facet:facet_value` combination as the viewed item.
      */
-    nbHits: number;
+    automaticFacetFilters?: AutoFacetFilter[];
     /**
-     * Page of search results to retrieve.
+     * 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/).
      */
-    page: number;
+    filters?: string;
     /**
-     * Number of pages of results.
+     * 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.
      */
-    nbPages: number;
+    optionalFilters?: string[];
 };
 
 /**
- * Properties for the `customDelete` method.
+ * Object ID and position of the recommendation you want to pin.
  */
-type CustomDeleteProps = {
+type PromoteConsequenceObject = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Unique record identifier.
      */
-    path: string;
+    objectID?: string;
     /**
-     * Query parameters to apply to the current query.
+     * Index in the list of recommendations where to place this item.
      */
-    parameters?: Record<string, any>;
+    position?: number;
 };
+
 /**
- * Properties for the `customGet` method.
+ * Effect of the rule.
  */
-type CustomGetProps = {
+type Consequence = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Exclude items from recommendations.
      */
-    path: string;
+    hide?: HideConsequenceObject[];
     /**
-     * Query parameters to apply to the current query.
+     * Place items at specific positions in the list of recommendations.
      */
-    parameters?: Record<string, any>;
+    promote?: PromoteConsequenceObject[];
+    params?: ParamsConsequence;
 };
+
 /**
- * Properties for the `customPost` method.
+ * Rule metadata.
  */
-type CustomPostProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
+type RuleMetadata = {
     /**
-     * Parameters to send with the custom request.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
-    body?: Record<string, unknown>;
+    lastUpdate?: string;
 };
+
 /**
- * Properties for the `customPut` method.
+ * Recommend rule.
  */
-type CustomPutProps = {
+type RecommendRule = {
+    _metadata?: RuleMetadata;
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Unique identifier of a rule object.
      */
-    path: string;
+    objectID?: string;
+    condition?: Condition;
+    consequence?: Consequence;
     /**
-     * Query parameters to apply to the current query.
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
      */
-    parameters?: Record<string, any>;
+    description?: string;
     /**
-     * Parameters to send with the custom request.
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
      */
-    body?: Record<string, unknown>;
+    enabled?: boolean;
 };
-/**
- * Properties for the `deleteRecommendRule` method.
- */
-type DeleteRecommendRuleProps = {
-    /**
-     * Name of the index on which to perform the operation.
-     */
-    indexName: string;
-    /**
-     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-     */
-    model: RecommendModels;
+
+type SearchRecommendRulesResponse = {
     /**
-     * Unique record identifier.
+     * Recommend rules that match the search criteria.
      */
-    objectID: string;
-};
-/**
- * Properties for the `getRecommendRule` method.
- */
-type GetRecommendRuleProps = {
+    hits: RecommendRule[];
     /**
-     * Name of the index on which to perform the operation.
+     * Number of results (hits).
      */
-    indexName: string;
+    nbHits: number;
     /**
-     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * Page of search results to retrieve.
      */
-    model: RecommendModels;
+    page: number;
     /**
-     * Unique record identifier.
+     * Number of pages of results.
      */
-    objectID: string;
+    nbPages: number;
 };
-/**
- * Properties for the `getRecommendStatus` method.
- */
-type GetRecommendStatusProps = {
+
+declare const apiClientVersion = "5.3.0";
+declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: _algolia_client_common.Transporter;
     /**
-     * Name of the index on which to perform the operation.
+     * The `appId` currently in use.
      */
-    indexName: string;
+    appId: string;
     /**
-     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
-    model: RecommendModels;
+    clearCache(): Promise<void>;
     /**
-     * Unique task identifier.
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
-    taskID: number;
-};
-/**
- * Recommend method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
- *
- * @deprecated This signature will be removed from the next major version, we recommend using the `GetRecommendationsParams` type for performances and future proof reasons.
- */
-type LegacyGetRecommendationsParams = RecommendationsRequest[];
-/**
- * Properties for the `searchRecommendRules` method.
- */
-type SearchRecommendRulesProps = {
+    readonly _ua: string;
     /**
-     * Name of the index on which to perform the operation.
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
      */
-    indexName: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
     /**
-     * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-     */
-    model: RecommendModels;
-    searchRecommendRulesParams?: SearchRecommendRulesParams;
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }: {
+        apiKey: string;
+    }): void;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.parameters - Query parameters to apply to the current query.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * 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 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.
+     */
+    deleteRecommendRule({ indexName, model, objectID }: DeleteRecommendRuleProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
+    /**
+     * 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 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.
+     */
+    getRecommendRule({ indexName, model, objectID }: GetRecommendRuleProps, requestOptions?: RequestOptions): Promise<RecommendRule>;
+    /**
+     * 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 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 }: GetRecommendStatusProps, requestOptions?: RequestOptions): Promise<GetRecommendTaskResponse>;
+    /**
+     * Retrieves recommendations from selected AI models.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param getRecommendationsParams - The getRecommendationsParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendations(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: RequestOptions): Promise<GetRecommendationsResponse>;
+    /**
+     * 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 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.
+     */
+    searchRecommendRules({ indexName, model, searchRecommendRulesParams }: SearchRecommendRulesProps, requestOptions?: RequestOptions): Promise<SearchRecommendRulesResponse>;
 };
 
-declare const apiClientVersion = "5.2.5";
-
 /**
- * The client type.
+ * Error.
  */
-type RecommendClient = ReturnType<typeof recommendClient>;
-declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): {
-    transporter: _algolia_client_common.Transporter;
-    appId: string;
-    clearCache(): Promise<void>;
-    readonly _ua: string;
-    addAlgoliaAgent(segment: string, version?: string): void;
-    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    deleteRecommendRule({ indexName, model, objectID }: DeleteRecommendRuleProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeletedAtResponse>;
-    getRecommendRule({ indexName, model, objectID }: GetRecommendRuleProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<RecommendRule>;
-    getRecommendStatus({ indexName, model, taskID }: GetRecommendStatusProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetRecommendTaskResponse>;
-    getRecommendations(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetRecommendationsResponse>;
-    searchRecommendRules({ indexName, model, searchRecommendRulesParams }: SearchRecommendRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<SearchRecommendRulesResponse>;
+type ErrorBase = Record<string, any> & {
+    message?: string;
 };
 
+type RecommendClient = ReturnType<typeof createRecommendClient>;
+
+declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
+
 export { type AdvancedSyntaxFeatures, type AlternativesAsExact, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AutoFacetFilter, type BaseRecommendRequest, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BooleanString, type BoughtTogetherQuery, type Condition, type Consequence, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteRecommendRuleProps, type DeletedAtResponse, type Distinct, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetOrdering, type FacetStats, type Facets, type FallbackParams, type FbtModel, type FrequentlyBoughtTogether, type GetRecommendRuleProps, type GetRecommendStatusProps, type GetRecommendTaskResponse, type GetRecommendationsParams, type GetRecommendationsResponse, type HideConsequenceObject, type HighlightResult, type HighlightResultOption, type IgnorePlurals, type IndexSettingsAsSearchParams, type LegacyGetRecommendationsParams, type LookingSimilar, type LookingSimilarModel, type LookingSimilarQuery, type MatchLevel, type MatchedGeoLocation, type Mode, type NumericFilters, type OptionalFilters, type ParamsConsequence, type Personalization, type PromoteConsequenceObject, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type RecommendClient, type RecommendHit, type RecommendModels, type RecommendRule, type RecommendationsHit, type RecommendationsHits, type RecommendationsRequest, type RecommendationsResults, type RecommendedForYou, type RecommendedForYouModel, type RecommendedForYouQuery, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RelatedModel, type RelatedProducts, type RelatedQuery, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type RuleMetadata, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchRecommendRulesParams, type SearchRecommendRulesProps, type SearchRecommendRulesResponse, type SemanticSearch, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TagFilters, type TaskStatus, type TrendingFacetHit, type TrendingFacets, type TrendingFacetsModel, type TrendingFacetsQuery, type TrendingItems, type TrendingItemsModel, type TrendingItemsQuery, type TypoTolerance, type TypoToleranceEnum, type Value, apiClientVersion, recommendClient };