@algolia/recommend 5.0.0-alpha.9 → 5.0.0-alpha.91

package/dist/model/rankingInfo.d.ts

@@ -1,51 +1,51 @@
-import type { MatchedGeoLocation } from './matchedGeoLocation';
-import type { Personalization } from './personalization';
-export declare type RankingInfo = {
-    /**
-     * This field is reserved for advanced usage.
-     */
-    filters: number;
-    /**
-     * Position of the most important matched attribute in the attributes to index list.
-     */
-    firstMatchedWord: number;
-    /**
-     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
-     */
-    geoDistance: number;
-    /**
-     * Precision used when computing the geo distance, in meters.
-     */
-    geoPrecision?: number;
-    matchedGeoLocation?: MatchedGeoLocation;
-    personalization?: Personalization;
-    /**
-     * Number of exactly matched words.
-     */
-    nbExactWords: number;
-    /**
-     * Number of typos encountered when matching the record.
-     */
-    nbTypos: number;
-    /**
-     * Present and set to true if a Rule promoted the hit.
-     */
-    promoted: boolean;
-    /**
-     * When the query contains more than one word, the sum of the distances between matched words (in meters).
-     */
-    proximityDistance?: number;
-    /**
-     * Custom ranking for the object, expressed as a single integer value.
-     */
-    userScore: number;
-    /**
-     * Number of matched words, including prefixes and typos.
-     */
-    words: number;
-    /**
-     * Wether the record are promoted by the re-ranking strategy.
-     */
-    promotedByReRanking?: boolean;
-};
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+export type RankingInfo = {
+    /**
+     * This field is reserved for advanced usage.
+     */
+    filters: number;
+    /**
+     * Position of the most important matched attribute in the attributes to index list.
+     */
+    firstMatchedWord: number;
+    /**
+     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+     */
+    geoDistance: number;
+    /**
+     * Precision used when computing the geo distance, in meters.
+     */
+    geoPrecision?: number;
+    matchedGeoLocation?: MatchedGeoLocation;
+    personalization?: Personalization;
+    /**
+     * Number of exactly matched words.
+     */
+    nbExactWords: number;
+    /**
+     * Number of typos encountered when matching the record.
+     */
+    nbTypos: number;
+    /**
+     * Present and set to true if a Rule promoted the hit.
+     */
+    promoted: boolean;
+    /**
+     * When the query contains more than one word, the sum of the distances between matched words (in meters).
+     */
+    proximityDistance?: number;
+    /**
+     * Custom ranking for the object, expressed as a single integer value.
+     */
+    userScore: number;
+    /**
+     * Number of matched words, including prefixes and typos.
+     */
+    words: number;
+    /**
+     * Wether the record are promoted by the re-ranking strategy.
+     */
+    promotedByReRanking?: boolean;
+};
 //# sourceMappingURL=rankingInfo.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}

package/dist/model/reRankingApplyFilter.d.ts

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

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

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

package/dist/model/recommendHit.d.ts

@@ -1,27 +1,27 @@
-import type { HighlightResult } from './highlightResult';
-import type { RankingInfo } from './rankingInfo';
-import type { SnippetResult } from './snippetResult';
-/**
- * A Recommend hit.
- */
-export declare type RecommendHit = Record<string, any> & {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * Show highlighted section and words matched on a query.
-     */
-    _highlightResult?: Record<string, HighlightResult>;
-    /**
-     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
-     */
-    _snippetResult?: Record<string, SnippetResult>;
-    _rankingInfo?: RankingInfo;
-    _distinctSeqID?: number;
-    /**
-     * The recommendation score.
-     */
-    _score: number;
-};
+import type { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+/**
+ * Recommend hit.
+ */
+export type RecommendHit = Record<string, any> & {
+    /**
+     * Unique object identifier.
+     */
+    objectID: string;
+    /**
+     * Show highlighted section and words matched on a query.
+     */
+    _highlightResult?: Record<string, HighlightResult>;
+    /**
+     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+     */
+    _snippetResult?: Record<string, SnippetResult>;
+    _rankingInfo?: RankingInfo;
+    _distinctSeqID?: number;
+    /**
+     * Recommendation score.
+     */
+    _score: number;
+};
 //# sourceMappingURL=recommendHit.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendHit.d.ts","sourceRoot":"","sources":["../../model/recommendHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,oBAAY,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEnD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"recommendHit.d.ts","sourceRoot":"","sources":["../../model/recommendHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEnD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/recommendHits.d.ts

@@ -1,5 +1,13 @@
-import type { RecommendHit } from './recommendHit';
-export declare type RecommendHits = {
-    hits: RecommendHit[];
-};
+import type { RecommendHit } from './recommendHit';
+export type RecommendHits = {
+    hits: RecommendHit[];
+    /**
+     * Text to search for in an index.
+     */
+    query?: string;
+    /**
+     * URL-encoded string of all search parameters.
+     */
+    params?: string;
+};
 //# sourceMappingURL=recommendHits.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendHits.d.ts","sourceRoot":"","sources":["../../model/recommendHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,aAAa,GAAG;IAC1B,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB,CAAC"}
+{"version":3,"file":"recommendHits.d.ts","sourceRoot":"","sources":["../../model/recommendHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,YAAY,EAAE,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/recommendModels.d.ts

@@ -0,0 +1,2 @@
+export type RecommendModels = 'bought-together' | 'related-products' | 'trending-facets' | 'trending-items';
+//# sourceMappingURL=recommendModels.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"recommendModels.d.ts","sourceRoot":"","sources":["../../model/recommendModels.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,CAAC"}

package/dist/model/recommendationModels.d.ts

@@ -1,5 +1,5 @@
-/**
- * The recommendation model to use.
- */
-export declare type RecommendationModels = 'bought-together' | 'related-products';
+/**
+ * Recommendation model.
+ */
+export type RecommendationModels = 'bought-together' | 'related-products';
 //# sourceMappingURL=recommendationModels.d.ts.map

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

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

package/dist/model/recommendationsQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { BaseRecommendationsQuery } from './baseRecommendationsQuery';
+export type RecommendationsQuery = BaseRecommendationsQuery & BaseRecommendRequest;
+//# sourceMappingURL=recommendationsQuery.d.ts.map

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

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

package/dist/model/recommendationsRequest.d.ts

@@ -1,4 +1,5 @@
-import type { RecommendationRequest } from './recommendationRequest';
-import type { TrendingRequest } from './trendingRequest';
-export declare type RecommendationsRequest = RecommendationRequest | TrendingRequest;
+import type { RecommendationsQuery } from './recommendationsQuery';
+import type { TrendingFacetsQuery } from './trendingFacetsQuery';
+import type { TrendingItemsQuery } from './trendingItemsQuery';
+export type RecommendationsRequest = RecommendationsQuery | TrendingFacetsQuery | TrendingItemsQuery;
 //# sourceMappingURL=recommendationsRequest.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,sBAAsB,GAAG,qBAAqB,GAAG,eAAe,CAAC"}
+{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAC9B,oBAAoB,GACpB,mBAAmB,GACnB,kBAAkB,CAAC"}

package/dist/model/recommendationsResponse.d.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchResponse } from './baseSearchResponse';
-import type { RecommendHits } from './recommendHits';
-export declare type RecommendationsResponse = BaseSearchResponse & RecommendHits;
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { RecommendHits } from './recommendHits';
+export type RecommendationsResponse = BaseSearchResponse & RecommendHits;
 //# sourceMappingURL=recommendationsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"recommendationsResponse.d.ts","sourceRoot":"","sources":["../../model/recommendationsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,oBAAY,uBAAuB,GAAG,kBAAkB,GAAG,aAAa,CAAC"}
+{"version":3,"file":"recommendationsResponse.d.ts","sourceRoot":"","sources":["../../model/recommendationsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,GAAG,aAAa,CAAC"}

package/dist/model/redirect.d.ts

@@ -0,0 +1,8 @@
+import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
+/**
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
+ */
+export type Redirect = {
+    index?: RedirectRuleIndexMetadata[];
+};
+//# sourceMappingURL=redirect.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.d.ts","sourceRoot":"","sources":["../../model/redirect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACrC,CAAC"}

package/dist/model/redirectRuleIndexMetadata.d.ts

@@ -0,0 +1,21 @@
+import type { RedirectRuleIndexMetadataData } from './redirectRuleIndexMetadataData';
+export type RedirectRuleIndexMetadata = {
+    /**
+     * Source index for the redirect rule.
+     */
+    source: string;
+    /**
+     * Destination index for the redirect rule.
+     */
+    dest: string;
+    /**
+     * Reason for the redirect rule.
+     */
+    reason: string;
+    /**
+     * Redirect rule status.
+     */
+    succeed: boolean;
+    data: RedirectRuleIndexMetadataData;
+};
+//# sourceMappingURL=redirectRuleIndexMetadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirectRuleIndexMetadata.d.ts","sourceRoot":"","sources":["../../model/redirectRuleIndexMetadata.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB,IAAI,EAAE,6BAA6B,CAAC;CACrC,CAAC"}

package/dist/model/redirectRuleIndexMetadataData.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Redirect rule data.
+ */
+export type RedirectRuleIndexMetadataData = {
+    ruleObjectID: string;
+};
+//# sourceMappingURL=redirectRuleIndexMetadataData.d.ts.map

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

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

package/dist/model/removeStopWords.d.ts

@@ -1,5 +1,5 @@
-/**
- * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
- */
-export declare type RemoveStopWords = string[] | boolean;
+/**
+ * Removes stop (common) words from the query before executing it. `removeStopWords` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

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

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

package/dist/model/removeWordsIfNoResults.d.ts

@@ -1,5 +1,5 @@
-/**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
- */
-export declare type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+/**
+ * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
+ */
+export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"removeWordsIfNoResults.d.ts","sourceRoot":"","sources":["../../model/removeWordsIfNoResults.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,sBAAsB,GAC9B,aAAa,GACb,YAAY,GACZ,WAAW,GACX,MAAM,CAAC"}
+{"version":3,"file":"removeWordsIfNoResults.d.ts","sourceRoot":"","sources":["../../model/removeWordsIfNoResults.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,aAAa,GACb,YAAY,GACZ,WAAW,GACX,MAAM,CAAC"}

package/dist/model/renderingContent.d.ts

@@ -1,8 +1,8 @@
-import type { FacetOrdering } from './facetOrdering';
-/**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
- */
-export declare type RenderingContent = {
-    facetOrdering?: FacetOrdering;
-};
+import type { FacetOrdering } from './facetOrdering';
+/**
+ * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
+ */
+export type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+};
 //# sourceMappingURL=renderingContent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}

package/dist/model/ruleResponse.d.ts

@@ -0,0 +1,27 @@
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { RuleResponseMetadata } from './ruleResponseMetadata';
+/**
+ * Rule object.
+ */
+export type RuleResponse = {
+    _metadata?: RuleResponseMetadata;
+    /**
+     * Unique identifier for a rule object.
+     */
+    objectID: string;
+    /**
+     * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
+     */
+    conditions?: Condition[];
+    consequence?: Consequence;
+    /**
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+     */
+    description?: string;
+    /**
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+     */
+    enabled?: boolean;
+};
+//# sourceMappingURL=ruleResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ruleResponse.d.ts","sourceRoot":"","sources":["../../model/ruleResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IAEzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}

package/dist/model/ruleResponseMetadata.d.ts

@@ -0,0 +1,7 @@
+export type RuleResponseMetadata = {
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    lastUpdate?: string;
+};
+//# sourceMappingURL=ruleResponseMetadata.d.ts.map

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

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

package/dist/model/searchParamsObject.d.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchParams } from './baseSearchParams';
-import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
-export declare type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
+import type { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
 //# sourceMappingURL=searchParamsObject.d.ts.map

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

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

package/dist/model/searchParamsQuery.d.ts

@@ -1,7 +1,7 @@
-export declare type SearchParamsQuery = {
-    /**
-     * The text to search in the index.
-     */
-    query?: string;
-};
+export type SearchParamsQuery = {
+    /**
+     * Text to search for in an index.
+     */
+    query?: string;
+};
 //# sourceMappingURL=searchParamsQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchParamsQuery.d.ts","sourceRoot":"","sources":["../../model/searchParamsQuery.ts"],"names":[],"mappings":"AAEA,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"searchParamsQuery.d.ts","sourceRoot":"","sources":["../../model/searchParamsQuery.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/searchRecommendRulesParams.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Recommend rules search parameters.
+ */
+export type SearchRecommendRulesParams = {
+    /**
+     * Full-text query.
+     */
+    query?: string;
+    /**
+     * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+     */
+    context?: string;
+    /**
+     * Requested page (the first page is page 0).
+     */
+    page?: number;
+    /**
+     * Maximum number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Restricts responses to enabled rules. When absent (default), _all_ rules are retrieved.
+     */
+    enabled?: boolean | null;
+    /**
+     * Request options to send with the API call.
+     */
+    _requestOptions?: Array<Record<string, any>>;
+};
+//# sourceMappingURL=searchRecommendRulesParams.d.ts.map

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

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

package/dist/model/searchRecommendRulesResponse.d.ts

@@ -0,0 +1,20 @@
+import type { RuleResponse } from './ruleResponse';
+export type SearchRecommendRulesResponse = {
+    /**
+     * Fetched rules.
+     */
+    hits: RuleResponse[];
+    /**
+     * Number of fetched rules.
+     */
+    nbHits: number;
+    /**
+     * Current page.
+     */
+    page: number;
+    /**
+     * Number of pages.
+     */
+    nbPages: number;
+};
+//# sourceMappingURL=searchRecommendRulesResponse.d.ts.map

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

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

package/dist/model/semanticSearch.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ */
+export type SemanticSearch = {
+    /**
+     * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+     */
+    eventSources?: string[] | null;
+};
+//# sourceMappingURL=semanticSearch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"semanticSearch.d.ts","sourceRoot":"","sources":["../../model/semanticSearch.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC,CAAC"}

package/dist/model/snippetResult.d.ts

@@ -1,3 +1,3 @@
-import type { SnippetResultOption } from './snippetResultOption';
-export declare type SnippetResult = SnippetResultOption | SnippetResultOption[];
+import type { SnippetResultOption } from './snippetResultOption';
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];
 //# sourceMappingURL=snippetResult.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,EAAE,CAAC"}

package/dist/model/snippetResultOption.d.ts

@@ -1,12 +1,12 @@
-import type { MatchLevel } from './matchLevel';
-/**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
- */
-export declare type SnippetResultOption = {
-    /**
-     * Markup text with occurrences highlighted.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-};
+import type { MatchLevel } from './matchLevel';
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+    /**
+     * Markup text with `facetQuery` matches highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+};
 //# sourceMappingURL=snippetResultOption.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}
+{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}

package/dist/model/sortRemainingBy.d.ts

@@ -1,5 +1,5 @@
-/**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
- */
-export declare type SortRemainingBy = 'alpha' | 'count' | 'hidden';
+/**
+ * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ */
+export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

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

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