@algolia/recommend 5.0.0-alpha.8 → 5.0.0-alpha.81

package/dist/builds/browser.d.ts

@@ -1,6 +1,6 @@
-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';
+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;
 //# sourceMappingURL=browser.d.ts.map

package/dist/builds/node.d.ts

@@ -1,6 +1,6 @@
-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';
+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;
 //# sourceMappingURL=node.d.ts.map

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 @@
+/**
+ * Whether the pattern parameter matches the beginning (`startsWith`) or end (`endsWith`) of the query string, is an exact match (`is`), or a partial match (`contains`).
+ */
+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 geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
+ */
+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,5 @@
+export type AroundPrecisionFromValueInner = {
+    from?: number;
+    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,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,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](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius) for a geographical search (in meters).
+ */
+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,2 @@
-export declare type AroundRadiusAll = 'all';
+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,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC"}

package/dist/model/automaticFacetFilter.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Automatic facet Filter.
+ */
+export type AutomaticFacetFilter = {
+    /**
+     * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
+     */
+    facet: string;
+    /**
+     * Score for the filter. Typically used for optional or disjunctive filters.
+     */
+    score?: number;
+    /**
+     * Whether the filter is disjunctive (true) or conjunctive (false).
+     */
+    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';
+/**
+ * Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
+ */
+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 = {
+    /**
+     * Algolia 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 object 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/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,119 @@
-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 = {
+    /**
+     * Overrides the query parameter and performs a more generic search.
+     */
+    similarQuery?: string;
+    /**
+     * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
+     */
+    filters?: string;
+    facetFilters?: FacetFilters;
+    optionalFilters?: OptionalFilters;
+    numericFilters?: NumericFilters;
+    tagFilters?: TagFilters;
+    /**
+     * Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
+     */
+    sumOrFiltersScores?: boolean;
+    /**
+     * Restricts a query to only look at a subset of your [searchable attributes](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/).
+     */
+    restrictSearchableAttributes?: string[];
+    /**
+     * Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
+     */
+    facets?: string[];
+    /**
+     * Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
+     */
+    facetingAfterDistinct?: boolean;
+    /**
+     * Page to retrieve (the first page is `0`, not `1`).
+     */
+    page?: number;
+    /**
+     * Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
+     */
+    offset?: number;
+    /**
+     * Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
+     */
+    length?: number;
+    /**
+     * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
+     */
+    aroundLatLng?: string;
+    /**
+     * Search for entries around a location. The location is automatically computed from the requester\'s IP address.
+     */
+    aroundLatLngViaIP?: boolean;
+    aroundRadius?: AroundRadius;
+    aroundPrecision?: AroundPrecision;
+    /**
+     * Minimum radius (in meters) used for a geographical search when `aroundRadius` isn\'t set.
+     */
+    minimumAroundRadius?: number;
+    /**
+     * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+     */
+    insideBoundingBox?: number[];
+    /**
+     * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+     */
+    insidePolygon?: number[];
+    /**
+     * Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
+     */
+    naturalLanguages?: string[];
+    /**
+     * Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
+     */
+    ruleContexts?: string[];
+    /**
+     * Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
+     */
+    personalizationImpact?: number;
+    /**
+     * Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
+     */
+    userToken?: string;
+    /**
+     * Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
+     */
+    getRankingInfo?: boolean;
+    /**
+     * Enriches the API\'s response with information about how the query was processed.
+     */
+    explain?: string[];
+    /**
+     * Whether to take into account an index\'s synonyms for a particular search.
+     */
+    synonyms?: boolean;
+    /**
+     * Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
+     */
+    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 or exclude a query from the processing-time percentile computation.
+     */
+    percentileComputation?: boolean;
+    /**
+     * Incidates whether this search will be considered in A/B testing.
+     */
+    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,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,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;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"}