algoliasearch 5.2.3 → 5.2.4-beta.1

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

@@ -1,94 +0,0 @@
-import type { Exhaustive } from './exhaustive';
-import type { FacetStats } from './facetStats';
-import type { Redirect } from './redirect';
-import type { RenderingContent } from './renderingContent';
-export 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;
-    /**
-     * Host name of the server that processed the request.
-     */
-    serverUsed?: string;
-    /**
-     * An object with custom data.  You can store up to 32kB as custom data.
-     */
-    userData?: Record<string, unknown>;
-    /**
-     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
-     */
-    queryID?: string;
-};
-//# sourceMappingURL=baseSearchResponse.d.ts.map

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

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

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

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

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

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

package/dist/recommend/model/clientMethodProps.d.ts

@@ -1,135 +0,0 @@
-import type { RecommendModels } from './recommendModels';
-import type { RecommendationsRequest } from './recommendationsRequest';
-import type { SearchRecommendRulesParams } from './searchRecommendRulesParams';
-/**
- * Properties for the `customDelete` method.
- */
-export type CustomDeleteProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `customGet` method.
- */
-export type CustomGetProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `customPost` method.
- */
-export 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>;
-    /**
-     * Parameters to send with the custom request.
-     */
-    body?: Record<string, unknown>;
-};
-/**
- * Properties for the `customPut` method.
- */
-export type CustomPutProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * Parameters to send with the custom request.
-     */
-    body?: Record<string, unknown>;
-};
-/**
- * Properties for the `deleteRecommendRule` method.
- */
-export 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;
-    /**
-     * Unique record identifier.
-     */
-    objectID: string;
-};
-/**
- * Properties for the `getRecommendRule` method.
- */
-export type GetRecommendRuleProps = {
-    /**
-     * 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;
-    /**
-     * Unique record identifier.
-     */
-    objectID: string;
-};
-/**
- * Properties for the `getRecommendStatus` method.
- */
-export type GetRecommendStatusProps = {
-    /**
-     * 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;
-    /**
-     * Unique task identifier.
-     */
-    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.
- */
-export type LegacyGetRecommendationsParams = RecommendationsRequest[];
-/**
- * Properties for the `searchRecommendRules` method.
- */
-export type SearchRecommendRulesProps = {
-    /**
-     * 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;
-    searchRecommendRulesParams?: SearchRecommendRulesParams;
-};
-//# sourceMappingURL=clientMethodProps.d.ts.map

package/dist/recommend/model/clientMethodProps.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../recommend/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG,sBAAsB,EAAE,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB,0BAA0B,CAAC,EAAE,0BAA0B,CAAC;CACzD,CAAC"}

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

@@ -1,14 +0,0 @@
-/**
- * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
- */
-export type Condition = {
-    /**
-     * 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;
-    /**
-     * 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;
-};
-//# sourceMappingURL=condition.d.ts.map

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

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

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

@@ -1,18 +0,0 @@
-import type { HideConsequenceObject } from './hideConsequenceObject';
-import type { ParamsConsequence } from './paramsConsequence';
-import type { PromoteConsequenceObject } from './promoteConsequenceObject';
-/**
- * Effect of the rule.
- */
-export type Consequence = {
-    /**
-     * Exclude items from recommendations.
-     */
-    hide?: HideConsequenceObject[];
-    /**
-     * Place items at specific positions in the list of recommendations.
-     */
-    promote?: PromoteConsequenceObject[];
-    params?: ParamsConsequence;
-};
-//# sourceMappingURL=consequence.d.ts.map

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

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

package/dist/recommend/model/deletedAtResponse.d.ts

@@ -1,14 +0,0 @@
-/**
- * Response, taskID, and deletion timestamp.
- */
-export type DeletedAtResponse = {
-    /**
-     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
-     */
-    taskID: number;
-    /**
-     * Date and time when the object was deleted, in RFC 3339 format.
-     */
-    deletedAt: string;
-};
-//# sourceMappingURL=deletedAtResponse.d.ts.map

package/dist/recommend/model/deletedAtResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deletedAtResponse.d.ts","sourceRoot":"","sources":["../../../../recommend/model/deletedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/recommend/model/distinct.d.ts

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

package/dist/recommend/model/distinct.d.ts.map

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

package/dist/recommend/model/errorBase.d.ts

@@ -1,7 +0,0 @@
-/**
- * Error.
- */
-export type ErrorBase = Record<string, any> & {
-    message?: string;
-};
-//# sourceMappingURL=errorBase.d.ts.map

package/dist/recommend/model/errorBase.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../../../recommend/model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/recommend/model/exactOnSingleWordQuery.d.ts

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

package/dist/recommend/model/exactOnSingleWordQuery.d.ts.map

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

package/dist/recommend/model/exhaustive.d.ts

@@ -1,26 +0,0 @@
-/**
- * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
- */
-export 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;
-};
-//# sourceMappingURL=exhaustive.d.ts.map

package/dist/recommend/model/exhaustive.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"exhaustive.d.ts","sourceRoot":"","sources":["../../../../recommend/model/exhaustive.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC"}

package/dist/recommend/model/facetFilters.d.ts

@@ -1,5 +0,0 @@
-/**
- * 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`.
- */
-export type FacetFilters = FacetFilters[] | string;
-//# sourceMappingURL=facetFilters.d.ts.map

package/dist/recommend/model/facetFilters.d.ts.map

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

package/dist/recommend/model/facetOrdering.d.ts

@@ -1,13 +0,0 @@
-import type { Facets } from './facets';
-import type { Value } from './value';
-/**
- * Order of facet names and facet values in your UI.
- */
-export type FacetOrdering = {
-    facets?: Facets;
-    /**
-     * Order of facet values. One object for each facet.
-     */
-    values?: Record<string, Value>;
-};
-//# sourceMappingURL=facetOrdering.d.ts.map

package/dist/recommend/model/facetOrdering.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"facetOrdering.d.ts","sourceRoot":"","sources":["../../../../recommend/model/facetOrdering.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAChC,CAAC"}

package/dist/recommend/model/facetStats.d.ts

@@ -1,19 +0,0 @@
-export type FacetStats = {
-    /**
-     * Minimum value in the results.
-     */
-    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;
-};
-//# sourceMappingURL=facetStats.d.ts.map

package/dist/recommend/model/facetStats.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"facetStats.d.ts","sourceRoot":"","sources":["../../../../recommend/model/facetStats.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/recommend/model/facets.d.ts

@@ -1,10 +0,0 @@
-/**
- * Order of facet names.
- */
-export type Facets = {
-    /**
-     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
-     */
-    order?: string[];
-};
-//# sourceMappingURL=facets.d.ts.map

package/dist/recommend/model/facets.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"facets.d.ts","sourceRoot":"","sources":["../../../../recommend/model/facets.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC"}

package/dist/recommend/model/fallbackParams.d.ts

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

package/dist/recommend/model/fallbackParams.d.ts.map

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

package/dist/recommend/model/fbtModel.d.ts

@@ -1,5 +0,0 @@
-/**
- * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
- */
-export type FbtModel = 'bought-together';
-//# sourceMappingURL=fbtModel.d.ts.map

package/dist/recommend/model/fbtModel.d.ts.map

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

package/dist/recommend/model/frequentlyBoughtTogether.d.ts

@@ -1,9 +0,0 @@
-import type { FbtModel } from './fbtModel';
-export type FrequentlyBoughtTogether = {
-    model: FbtModel;
-    /**
-     * Unique record identifier.
-     */
-    objectID: string;
-};
-//# sourceMappingURL=frequentlyBoughtTogether.d.ts.map

package/dist/recommend/model/frequentlyBoughtTogether.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"frequentlyBoughtTogether.d.ts","sourceRoot":"","sources":["../../../../recommend/model/frequentlyBoughtTogether.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/recommend/model/getRecommendTaskResponse.d.ts

@@ -1,5 +0,0 @@
-import type { TaskStatus } from './taskStatus';
-export type GetRecommendTaskResponse = {
-    status: TaskStatus;
-};
-//# sourceMappingURL=getRecommendTaskResponse.d.ts.map

package/dist/recommend/model/getRecommendTaskResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getRecommendTaskResponse.d.ts","sourceRoot":"","sources":["../../../../recommend/model/getRecommendTaskResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC;CACpB,CAAC"}

package/dist/recommend/model/getRecommendationsParams.d.ts

@@ -1,11 +0,0 @@
-import type { RecommendationsRequest } from './recommendationsRequest';
-/**
- * Recommend request body.
- */
-export type GetRecommendationsParams = {
-    /**
-     * Recommendation request with parameters depending on the requested model.
-     */
-    requests: RecommendationsRequest[];
-};
-//# sourceMappingURL=getRecommendationsParams.d.ts.map

package/dist/recommend/model/getRecommendationsParams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getRecommendationsParams.d.ts","sourceRoot":"","sources":["../../../../recommend/model/getRecommendationsParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACpC,CAAC"}

package/dist/recommend/model/getRecommendationsResponse.d.ts

@@ -1,5 +0,0 @@
-import type { RecommendationsResults } from './recommendationsResults';
-export type GetRecommendationsResponse = {
-    results: RecommendationsResults[];
-};
-//# sourceMappingURL=getRecommendationsResponse.d.ts.map

package/dist/recommend/model/getRecommendationsResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getRecommendationsResponse.d.ts","sourceRoot":"","sources":["../../../../recommend/model/getRecommendationsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,sBAAsB,EAAE,CAAC;CACnC,CAAC"}

package/dist/recommend/model/hideConsequenceObject.d.ts

@@ -1,10 +0,0 @@
-/**
- * Object ID of the recommendation you want to exclude.
- */
-export type HideConsequenceObject = {
-    /**
-     * Unique record identifier.
-     */
-    objectID?: string;
-};
-//# sourceMappingURL=hideConsequenceObject.d.ts.map

package/dist/recommend/model/hideConsequenceObject.d.ts.map

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

package/dist/recommend/model/highlightResult.d.ts

@@ -1,5 +0,0 @@
-import type { HighlightResultOption } from './highlightResultOption';
-export type HighlightResult = HighlightResultOption | HighlightResultOption[] | Record<string, HighlightResultOption> | {
-    [key: string]: HighlightResult;
-};
-//# sourceMappingURL=highlightResult.d.ts.map

package/dist/recommend/model/highlightResult.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"highlightResult.d.ts","sourceRoot":"","sources":["../../../../recommend/model/highlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,MAAM,MAAM,eAAe,GACvB,qBAAqB,GACrB,qBAAqB,EAAE,GACvB,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,GACrC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;CAAE,CAAC"}

package/dist/recommend/model/highlightResultOption.d.ts

@@ -1,20 +0,0 @@
-import type { MatchLevel } from './matchLevel';
-/**
- * Surround words that match the query with HTML tags for highlighting.
- */
-export type HighlightResultOption = {
-    /**
-     * Highlighted attribute value, including HTML tags.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-    /**
-     * List of matched words from the search query.
-     */
-    matchedWords: string[];
-    /**
-     * Whether the entire attribute value is highlighted.
-     */
-    fullyHighlighted?: boolean;
-};
-//# sourceMappingURL=highlightResultOption.d.ts.map

package/dist/recommend/model/highlightResultOption.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"highlightResultOption.d.ts","sourceRoot":"","sources":["../../../../recommend/model/highlightResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC"}

package/dist/recommend/model/ignorePlurals.d.ts

@@ -1,6 +0,0 @@
-import type { SupportedLanguage } from './supportedLanguage';
-/**
- * Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
- */
-export type IgnorePlurals = SupportedLanguage[] | boolean;
-//# sourceMappingURL=ignorePlurals.d.ts.map

package/dist/recommend/model/ignorePlurals.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ignorePlurals.d.ts","sourceRoot":"","sources":["../../../../recommend/model/ignorePlurals.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAC"}