npm - @algolia/recommend - Versions diffs - 5.55.1 → 5.56.0 - Mend

@algolia/recommend 5.55.1 → 5.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/README.md +4 -4
package/dist/browser.d.ts +146 -23
package/dist/builds/browser.js +282 -1
package/dist/builds/browser.js.map +1 -1
package/dist/builds/browser.min.js +5 -5
package/dist/builds/browser.min.js.map +1 -1
package/dist/builds/browser.umd.js +6 -6
package/dist/builds/fetch.js +282 -1
package/dist/builds/fetch.js.map +1 -1
package/dist/builds/node.cjs +282 -1
package/dist/builds/node.cjs.map +1 -1
package/dist/builds/node.js +282 -1
package/dist/builds/node.js.map +1 -1
package/dist/builds/worker.js +282 -1
package/dist/builds/worker.js.map +1 -1
package/dist/fetch.d.ts +146 -23
package/dist/node.d.cts +146 -23
package/dist/node.d.ts +146 -23
package/dist/src/recommendClient.cjs +282 -1
package/dist/src/recommendClient.cjs.map +1 -1
package/dist/src/recommendClient.js +282 -1
package/dist/src/recommendClient.js.map +1 -1
package/dist/worker.d.ts +146 -23
package/package.json +9 -9

package/README.md CHANGED Viewed

@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
 ### With a package manager
 ```bash
-yarn add @algolia/recommend@5.55.1
+yarn add @algolia/recommend@5.56.0
 # or
-npm install @algolia/recommend@5.55.1
+npm install @algolia/recommend@5.56.0
 # or
-pnpm add @algolia/recommend@5.55.1
+pnpm add @algolia/recommend@5.56.0
 ```
 ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/recommend@5.55.1
 Add the following JavaScript snippet to the <head> of your website:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/recommend@5.55.1/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/recommend@5.56.0/dist/builds/browser.umd.js"></script>
 ```
 ### Usage

package/dist/browser.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 import * as _algolia_client_common from '@algolia/client-common';
-import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
 /**
  * Response, taskID, and deletion timestamp.
@@ -53,11 +53,6 @@ type AroundRadiusAll = 'all';
  */
 type AroundRadius = number | AroundRadiusAll;
-/**
- * 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`.
- */
-type FacetFilters = Array<FacetFilters> | string;
 type InsideBoundingBox = string | Array<Array<number>>;
 /**
@@ -89,7 +84,6 @@ type BaseRecommendSearchParams = {
      * 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 if the facet attribute name or facet value contains 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 | undefined;
-    facetFilters?: FacetFilters | undefined;
     optionalFilters?: OptionalFilters | undefined;
     numericFilters?: NumericFilters | undefined;
     tagFilters?: TagFilters | undefined;
@@ -168,10 +162,6 @@ type BaseRecommendSearchParams = {
      * Whether to include this search when calculating processing-time percentiles.
      */
     percentileComputation?: boolean | undefined;
-    /**
-     * Whether to enable A/B testing for this search.
-     */
-    enableABTest?: boolean | undefined;
 };
 type BaseIndexSettings = {
@@ -418,10 +408,6 @@ type BaseRecommendIndexSettings = {
      * Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
      */
     attributesToRetrieve?: Array<string> | undefined;
-    /**
-     * Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
-     */
-    ranking?: Array<string> | undefined;
     /**
      * Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
      */
@@ -477,10 +463,6 @@ type BaseRecommendIndexSettings = {
      * Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
      */
     decompoundQuery?: boolean | undefined;
-    /**
-     * Whether to enable rules.
-     */
-    enableRules?: boolean | undefined;
     /**
      * Whether to enable Personalization.
      */
@@ -553,7 +535,7 @@ type SearchParamsQuery = {
 /**
  * Search parameters for filtering the recommendations.
  */
-type RecommendSearchParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;
+type RecommendSearchParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings & Record<string, unknown>;
 type BaseRecommendRequest = {
     /**
@@ -571,7 +553,10 @@ type BaseRecommendRequest = {
     queryParameters?: RecommendSearchParams | undefined;
 };
-type FallbackParams = RecommendSearchParams & Record<string, unknown>;
+/**
+ * Search parameters to use for a fallback request if there aren\'t enough recommendations.
+ */
+type FallbackParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings & Record<string, unknown>;
 /**
  * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
@@ -1423,9 +1408,9 @@ type SearchRecommendRulesProps = {
     searchRecommendRulesParams?: SearchRecommendRulesParams | undefined;
 };
-declare const apiClientVersion = "5.55.1";
+declare const apiClientVersion = "5.56.0";
 declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
-    transporter: _algolia_client_common.Transporter;
+    transporter: _algolia_client_common.TransporterWithHttpInfo;
     /**
      * The `appId` currently in use.
      */
@@ -1470,6 +1455,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     batchRecommendRules({ indexName, model, recommendRule }: BatchRecommendRulesProps, requestOptions?: RequestOptions): Promise<RecommendUpdatedAtResponse>;
+    /**
+     * Create or update a batch of Recommend Rules  Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules.  Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn\'t require a facet value placeholder (it tries to match the data source item\'s attributes instead).
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     * @param batchRecommendRules - The batchRecommendRules object.
+     * @param batchRecommendRules.indexName - Name of the index on which to perform the operation.
+     * @param batchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+     * @param batchRecommendRules.recommendRule - The recommendRule object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see batchRecommendRules for the plain version.
+     */
+    batchRecommendRulesWithHTTPInfo({ indexName, model, recommendRule }: BatchRecommendRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<RecommendUpdatedAtResponse>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
@@ -1478,6 +1478,17 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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 lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
+     * @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.
+     * @see customDelete for the plain version.
+     */
+    customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
@@ -1486,6 +1497,17 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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 lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
+     * @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.
+     * @see customGet for the plain version.
+     */
+    customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
@@ -1495,6 +1517,18 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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 lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
+     * @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.
+     * @see customPost for the plain version.
+     */
+    customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
@@ -1504,6 +1538,18 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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>>;
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
+     * @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.
+     * @see customPut for the plain version.
+     */
+    customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * Deletes a Recommend rule from a recommendation scenario.
      *
@@ -1516,6 +1562,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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>;
+    /**
+     * Deletes a Recommend rule from a recommendation scenario.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * 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.
+     * @see deleteRecommendRule for the plain version.
+     */
+    deleteRecommendRuleWithHTTPInfo({ indexName, model, objectID }: DeleteRecommendRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeletedAtResponse>>;
     /**
      * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
      *
@@ -1528,6 +1589,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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>;
+    /**
+     * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * 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.
+     * @see getRecommendRule for the plain version.
+     */
+    getRecommendRuleWithHTTPInfo({ indexName, model, objectID }: GetRecommendRuleProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<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.
      *
@@ -1540,6 +1616,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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>;
+    /**
+     * 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.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * 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.
+     * @see getRecommendStatus for the plain version.
+     */
+    getRecommendStatusWithHTTPInfo({ indexName, model, taskID }: GetRecommendStatusProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetRecommendTaskResponse>>;
     /**
      * Retrieves recommendations from selected AI models.
      *
@@ -1549,6 +1640,18 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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>;
+    /**
+     * Retrieves recommendations from selected AI models.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * 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.
+     * @see getRecommendations for the plain version.
+     */
+    getRecommendationsWithHTTPInfo(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetRecommendationsResponse>>;
     /**
      * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
      *
@@ -1561,6 +1664,21 @@ declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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>;
+    /**
+     * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * 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.
+     * @see searchRecommendRules for the plain version.
+     */
+    searchRecommendRulesWithHTTPInfo({ indexName, model, searchRecommendRulesParams }: SearchRecommendRulesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SearchRecommendRulesResponse>>;
 };
 /**
@@ -1570,6 +1688,11 @@ type ErrorBase = Record<string, any> & {
     message?: string | undefined;
 };
+/**
+ * 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`.
+ */
+type FacetFilters = Array<FacetFilters> | string;
 declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions | undefined): RecommendClient;
 type RecommendClient = ReturnType<typeof createRecommendClient>;