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

package/dist/builds/browser.d.ts

@@ -1,6 +1,24 @@
-import type { ClientOptions } from '@algolia/client-common';
-import type { RecommendClient } from '../src/recommendClient';
-export { apiClientVersion, RecommendClient } from '../src/recommendClient';
-export * from '../model';
-export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
+import type { ClientOptions } from '@algolia/client-common';
+export { apiClientVersion } from '../src/recommendClient';
+export * from '../model';
+/**
+ * The client type.
+ */
+export type RecommendClient = ReturnType<typeof recommendClient>;
+export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    readonly _ua: string;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    deleteRecommendRule({ indexName, model, objectID }: import("../model").DeleteRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    getRecommendRule({ indexName, model, objectID }: import("../model").GetRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RuleResponse>;
+    getRecommendStatus({ indexName, model, taskID }: import("../model").GetRecommendStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendTaskResponse>;
+    getRecommendations(getRecommendationsParams: import("../model").GetRecommendationsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendationsResponse>;
+    searchRecommendRules({ indexName, model, searchRecommendRulesParams, }: import("../model").SearchRecommendRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRecommendRulesResponse>;
+};
 //# sourceMappingURL=browser.d.ts.map

package/dist/builds/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAe5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CA8BjB"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAgB5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;EA+BxB"}

package/dist/builds/node.d.ts

@@ -1,6 +1,24 @@
-import type { ClientOptions } from '@algolia/client-common';
-import type { RecommendClient } from '../src/recommendClient';
-export { apiClientVersion, RecommendClient } from '../src/recommendClient';
-export * from '../model';
-export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
+import type { ClientOptions } from '@algolia/client-common';
+export { apiClientVersion } from '../src/recommendClient';
+export * from '../model';
+/**
+ * The client type.
+ */
+export type RecommendClient = ReturnType<typeof recommendClient>;
+export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    deleteRecommendRule({ indexName, model, objectID }: import("../model").DeleteRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    getRecommendRule({ indexName, model, objectID }: import("../model").GetRecommendRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RuleResponse>;
+    getRecommendStatus({ indexName, model, taskID }: import("../model").GetRecommendStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendTaskResponse>;
+    getRecommendations(getRecommendationsParams: import("../model").GetRecommendationsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetRecommendationsResponse>;
+    searchRecommendRules({ indexName, model, searchRecommendRulesParams, }: import("../model").SearchRecommendRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRecommendRulesResponse>;
+};
 //# sourceMappingURL=node.d.ts.map

package/dist/builds/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CAwBjB"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAY5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;EA2BxB"}

package/dist/model/advancedSyntaxFeatures.d.ts

@@ -1,2 +1,2 @@
-export declare type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
+export type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
 //# sourceMappingURL=advancedSyntaxFeatures.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"advancedSyntaxFeatures.d.ts","sourceRoot":"","sources":["../../model/advancedSyntaxFeatures.ts"],"names":[],"mappings":"AAEA,oBAAY,sBAAsB,GAAG,aAAa,GAAG,cAAc,CAAC"}
+{"version":3,"file":"advancedSyntaxFeatures.d.ts","sourceRoot":"","sources":["../../model/advancedSyntaxFeatures.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG,cAAc,CAAC"}

package/dist/model/alternativesAsExact.d.ts

@@ -1,2 +1,2 @@
-export declare type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
+export type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
 //# sourceMappingURL=alternativesAsExact.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"alternativesAsExact.d.ts","sourceRoot":"","sources":["../../model/alternativesAsExact.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAC3B,eAAe,GACf,mBAAmB,GACnB,mBAAmB,CAAC"}
+{"version":3,"file":"alternativesAsExact.d.ts","sourceRoot":"","sources":["../../model/alternativesAsExact.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAC3B,eAAe,GACf,mBAAmB,GACnB,mBAAmB,CAAC"}

package/dist/model/anchoring.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Which part of the search query the pattern should match:  - `startsWith`. The pattern must match the begginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query.  Empty queries are only allowed as pattern with `anchoring: is`.
+ */
+export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
+//# sourceMappingURL=anchoring.d.ts.map

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

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

package/dist/model/aroundPrecision.d.ts

@@ -0,0 +1,6 @@
+import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
+/**
+ * Precision of a coordinate-based search in meters to group results with similar distances.  The Geo ranking criterion considers all matches within the same range of distances to be equal.
+ */
+export type AroundPrecision = AroundPrecisionFromValueInner[] | number;
+//# sourceMappingURL=aroundPrecision.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aroundPrecision.d.ts","sourceRoot":"","sources":["../../model/aroundPrecision.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,6BAA6B,EAAE,GAAG,MAAM,CAAC"}

package/dist/model/aroundPrecisionFromValueInner.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Range object with lower and upper values in meters to define custom ranges.
+ */
+export type AroundPrecisionFromValueInner = {
+    /**
+     * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+     */
+    from?: number;
+    /**
+     * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+     */
+    value?: number;
+};
+//# sourceMappingURL=aroundPrecisionFromValueInner.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aroundPrecisionFromValueInner.d.ts","sourceRoot":"","sources":["../../model/aroundPrecisionFromValueInner.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/aroundRadius.d.ts

@@ -1,6 +1,6 @@
-import type { AroundRadiusAll } from './aroundRadiusAll';
-/**
- * Define the maximum radius for a geo search (in meters).
- */
-export declare type AroundRadius = AroundRadiusAll | number;
+import type { AroundRadiusAll } from './aroundRadiusAll';
+/**
+ * Maximum radius for a search around a central location.  This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
+ */
+export type AroundRadius = AroundRadiusAll | number;
 //# sourceMappingURL=aroundRadius.d.ts.map

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

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

package/dist/model/aroundRadiusAll.d.ts

@@ -1,2 +1,5 @@
-export declare type AroundRadiusAll = 'all';
+/**
+ * Return all records with a valid `_geoloc` attribute. Don\'t filter by distance.
+ */
+export type AroundRadiusAll = 'all';
 //# sourceMappingURL=aroundRadiusAll.d.ts.map

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

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

package/dist/model/automaticFacetFilter.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Filter or optional filter to be applied to the search.
+ */
+export type AutomaticFacetFilter = {
+    /**
+     * Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
+     */
+    facet: string;
+    /**
+     * Filter scores to give different weights to individual filters.
+     */
+    score?: number;
+    /**
+     * Whether the filter is disjunctive or conjunctive.  If true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation. If false, multiple occurences are combined with the logical `AND` operation.
+     */
+    disjunctive?: boolean;
+};
+//# sourceMappingURL=automaticFacetFilter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"automaticFacetFilter.d.ts","sourceRoot":"","sources":["../../model/automaticFacetFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC"}

package/dist/model/automaticFacetFilters.d.ts

@@ -0,0 +1,6 @@
+import type { AutomaticFacetFilter } from './automaticFacetFilter';
+/**
+ * Filter to be applied to the search.  You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies.
+ */
+export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
+//# sourceMappingURL=automaticFacetFilters.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"automaticFacetFilters.d.ts","sourceRoot":"","sources":["../../model/automaticFacetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,EAAE,GAAG,MAAM,EAAE,CAAC"}

package/dist/model/baseRecommendRequest.d.ts

@@ -1,18 +1,15 @@
-import type { SearchParamsObject } from './searchParamsObject';
-export declare type BaseRecommendRequest = {
-    /**
-     * The Algolia index name.
-     */
-    indexName: string;
-    /**
-     * The threshold to use when filtering recommendations by their score.
-     */
-    threshold: number;
-    /**
-     * The max number of recommendations to retrieve. If it\'s set to 0, all the recommendations of the objectID may be returned.
-     */
-    maxRecommendations?: number;
-    queryParameters?: SearchParamsObject;
-    fallbackParameters?: SearchParamsObject;
-};
+export type BaseRecommendRequest = {
+    /**
+     * Index name.
+     */
+    indexName: string;
+    /**
+     * Recommendations with a confidence score lower than `threshold` won\'t appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
+     */
+    threshold?: number;
+    /**
+     * Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
+     */
+    maxRecommendations?: number;
+};
 //# sourceMappingURL=baseRecommendRequest.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}
+{"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC"}

package/dist/model/baseRecommendationsQuery.d.ts

@@ -0,0 +1,12 @@
+import type { RecommendationModels } from './recommendationModels';
+import type { SearchParamsObject } from './searchParamsObject';
+export type BaseRecommendationsQuery = {
+    model: RecommendationModels;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    queryParameters?: SearchParamsObject;
+    fallbackParameters?: SearchParamsObject;
+};
+//# sourceMappingURL=baseRecommendationsQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseRecommendationsQuery.d.ts","sourceRoot":"","sources":["../../model/baseRecommendationsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,oBAAoB,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}

package/dist/model/baseRecommendedForYouQuery.d.ts

@@ -0,0 +1,8 @@
+import type { RecommendedForYouModel } from './recommendedForYouModel';
+import type { RecommendedForYouQueryParameters } from './recommendedForYouQueryParameters';
+export type BaseRecommendedForYouQuery = {
+    model: RecommendedForYouModel;
+    queryParameters?: RecommendedForYouQueryParameters;
+    fallbackParameters?: RecommendedForYouQueryParameters;
+};
+//# sourceMappingURL=baseRecommendedForYouQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseRecommendedForYouQuery.d.ts","sourceRoot":"","sources":["../../model/baseRecommendedForYouQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAE3F,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,sBAAsB,CAAC;IAE9B,eAAe,CAAC,EAAE,gCAAgC,CAAC;IAEnD,kBAAkB,CAAC,EAAE,gCAAgC,CAAC;CACvD,CAAC"}

package/dist/model/baseRecommendedForYouQueryParameters.d.ts

@@ -0,0 +1,7 @@
+export type BaseRecommendedForYouQueryParameters = {
+    /**
+     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
+     */
+    userToken: string;
+};
+//# sourceMappingURL=baseRecommendedForYouQueryParameters.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseRecommendedForYouQueryParameters.d.ts","sourceRoot":"","sources":["../../model/baseRecommendedForYouQueryParameters.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oCAAoC,GAAG;IACjD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/baseSearchParams.d.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
-import type { SearchParamsQuery } from './searchParamsQuery';
-export declare type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { SearchParamsQuery } from './searchParamsQuery';
+export type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
 //# sourceMappingURL=baseSearchParams.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"baseSearchParams.d.ts","sourceRoot":"","sources":["../../model/baseSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,oBAAY,gBAAgB,GAAG,4BAA4B,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"baseSearchParams.d.ts","sourceRoot":"","sources":["../../model/baseSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,GAAG,iBAAiB,CAAC"}

package/dist/model/baseSearchParamsWithoutQuery.d.ts

@@ -1,123 +1,115 @@
-import type { AroundRadius } from './aroundRadius';
-import type { FacetFilters } from './facetFilters';
-import type { NumericFilters } from './numericFilters';
-import type { OptionalFilters } from './optionalFilters';
-import type { ReRankingApplyFilter } from './reRankingApplyFilter';
-import type { TagFilters } from './tagFilters';
-export declare type BaseSearchParamsWithoutQuery = {
-    /**
-     * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
-     */
-    similarQuery?: string;
-    /**
-     * Filter the query with numeric, facet and/or tag filters.
-     */
-    filters?: string;
-    facetFilters?: FacetFilters;
-    optionalFilters?: OptionalFilters;
-    numericFilters?: NumericFilters;
-    tagFilters?: TagFilters;
-    /**
-     * Determines how to calculate the total score for filtering.
-     */
-    sumOrFiltersScores?: boolean;
-    /**
-     * Retrieve facets and their facet values.
-     */
-    facets?: string[];
-    /**
-     * Maximum number of facet values to return for each facet during a regular search.
-     */
-    maxValuesPerFacet?: number;
-    /**
-     * Force faceting to be applied after de-duplication (via the Distinct setting).
-     */
-    facetingAfterDistinct?: boolean;
-    /**
-     * Controls how facet values are fetched.
-     */
-    sortFacetValuesBy?: string;
-    /**
-     * Specify the page to retrieve.
-     */
-    page?: number;
-    /**
-     * Specify the offset of the first hit to return.
-     */
-    offset?: number;
-    /**
-     * Set the number of hits to retrieve (used only with offset).
-     */
-    length?: number;
-    /**
-     * Search for entries around a central geolocation, enabling a geo search within a circular area.
-     */
-    aroundLatLng?: string;
-    /**
-     * Search for entries around a given location automatically computed from the requester\'s IP address.
-     */
-    aroundLatLngViaIP?: boolean;
-    aroundRadius?: AroundRadius;
-    /**
-     * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
-     */
-    aroundPrecision?: number;
-    /**
-     * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
-     */
-    minimumAroundRadius?: number;
-    /**
-     * Search inside a rectangular area (in geo coordinates).
-     */
-    insideBoundingBox?: number[];
-    /**
-     * Search inside a polygon (in geo coordinates).
-     */
-    insidePolygon?: number[];
-    /**
-     * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
-     */
-    naturalLanguages?: string[];
-    /**
-     * Enables contextual rules.
-     */
-    ruleContexts?: string[];
-    /**
-     * Define the impact of the Personalization feature.
-     */
-    personalizationImpact?: number;
-    /**
-     * Associates a certain user token with the current search.
-     */
-    userToken?: string;
-    /**
-     * Retrieve detailed ranking information.
-     */
-    getRankingInfo?: boolean;
-    /**
-     * Enable the Click Analytics feature.
-     */
-    clickAnalytics?: boolean;
-    /**
-     * Whether the current query will be taken into account in the Analytics.
-     */
-    analytics?: boolean;
-    /**
-     * List of tags to apply to the query for analytics purposes.
-     */
-    analyticsTags?: string[];
-    /**
-     * Whether to include or exclude a query from the processing-time percentile computation.
-     */
-    percentileComputation?: boolean;
-    /**
-     * Whether this search should participate in running AB tests.
-     */
-    enableABTest?: boolean;
-    /**
-     * Whether this search should use AI Re-Ranking.
-     */
-    enableReRanking?: boolean;
-    reRankingApplyFilter?: ReRankingApplyFilter | null;
-};
+import type { AroundPrecision } from './aroundPrecision';
+import type { AroundRadius } from './aroundRadius';
+import type { FacetFilters } from './facetFilters';
+import type { NumericFilters } from './numericFilters';
+import type { OptionalFilters } from './optionalFilters';
+import type { TagFilters } from './tagFilters';
+export type BaseSearchParamsWithoutQuery = {
+    /**
+     * Keywords to be used instead of the search query to conduct a more broader search.  Using the `similarQuery` parameter changes other settings:  - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`.  Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
+     */
+    similarQuery?: string;
+    /**
+     * Filter the search so that only records with matching values are included in the results.  These filters are supported:  - **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;
+    facetFilters?: FacetFilters;
+    optionalFilters?: OptionalFilters;
+    numericFilters?: NumericFilters;
+    tagFilters?: TagFilters;
+    /**
+     * Whether to sum all filter scores.  If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
+     */
+    sumOrFiltersScores?: boolean;
+    /**
+     * Restricts a search to a subset of your searchable attributes.
+     */
+    restrictSearchableAttributes?: string[];
+    /**
+     * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.  To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
+     */
+    facets?: string[];
+    /**
+     * Whether faceting should be applied after deduplication with `distinct`.  This leads to accurate facet counts when using faceting in combination with `distinct`. It\'s usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
+     */
+    facetingAfterDistinct?: boolean;
+    /**
+     * Page of search results to retrieve.
+     */
+    page?: number;
+    /**
+     * Position of the first hit to retrieve.
+     */
+    offset?: number;
+    /**
+     * Number of hits to retrieve (used in combination with `offset`).
+     */
+    length?: number;
+    /**
+     * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
+     */
+    aroundLatLng?: string;
+    /**
+     * Whether to obtain the coordinates from the request\'s IP address.
+     */
+    aroundLatLngViaIP?: boolean;
+    aroundRadius?: AroundRadius;
+    aroundPrecision?: AroundPrecision;
+    /**
+     * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
+     */
+    minimumAroundRadius?: number;
+    /**
+     * Coordinates for a rectangular area in which to search.  Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
+     */
+    insideBoundingBox?: number[][];
+    /**
+     * Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored, if you also specify `insideBoundingBox`.
+     */
+    insidePolygon?: number[][];
+    /**
+     * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
+     */
+    naturalLanguages?: string[];
+    /**
+     * Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
+     */
+    ruleContexts?: string[];
+    /**
+     * Impact that Personalization should have on this search.  The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
+     */
+    personalizationImpact?: number;
+    /**
+     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
+     */
+    userToken?: string;
+    /**
+     * Whether the search response should include detailed ranking information.
+     */
+    getRankingInfo?: boolean;
+    /**
+     * Whether to take into account an index\'s synonyms for this search.
+     */
+    synonyms?: boolean;
+    /**
+     * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Whether this search will be included in Analytics.
+     */
+    analytics?: boolean;
+    /**
+     * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    analyticsTags?: string[];
+    /**
+     * Whether to include this search when calculating processing-time percentiles.
+     */
+    percentileComputation?: boolean;
+    /**
+     * Whether to enable A/B testing for this search.
+     */
+    enableABTest?: boolean;
+};
 //# sourceMappingURL=baseSearchParamsWithoutQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACpD,CAAC"}
+{"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC"}