algoliasearch 5.0.0-alpha.11 → 5.0.0-alpha.111

package/dist/client-search/model/automaticFacetFilters.d.ts

@@ -1,6 +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 declare type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
+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/client-search/model/automaticFacetFilters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"automaticFacetFilters.d.ts","sourceRoot":"","sources":["../../../../client-search/model/automaticFacetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,oBAAY,qBAAqB,GAAG,oBAAoB,EAAE,GAAG,MAAM,EAAE,CAAC"}
+{"version":3,"file":"automaticFacetFilters.d.ts","sourceRoot":"","sources":["../../../../client-search/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/client-search/model/baseGetApiKeyResponse.d.ts

@@ -1,11 +1,11 @@
-export declare type BaseGetApiKeyResponse = {
-    /**
-     * The API key.
-     */
-    value?: string;
-    /**
-     * Time of the event expressed in milliseconds since the Unix epoch.
-     */
-    createdAt: number;
-};
+export type BaseGetApiKeyResponse = {
+    /**
+     * API key.
+     */
+    value?: string;
+    /**
+     * Timestamp when the object was created, in milliseconds since the Unix epoch.
+     */
+    createdAt: number;
+};
 //# sourceMappingURL=baseGetApiKeyResponse.d.ts.map

package/dist/client-search/model/baseGetApiKeyResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseGetApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/baseGetApiKeyResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"baseGetApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/baseGetApiKeyResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/client-search/model/baseIndexSettings.d.ts

@@ -1,59 +1,72 @@
-export declare type BaseIndexSettings = {
-    /**
-     * Creates replicas, exact copies of an index.
-     */
-    replicas?: string[];
-    /**
-     * Set the maximum number of hits accessible via pagination.
-     */
-    paginationLimitedTo?: number;
-    /**
-     * A list of words for which you want to turn off typo tolerance.
-     */
-    disableTypoToleranceOnWords?: string[];
-    /**
-     * Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.
-     */
-    attributesToTransliterate?: string[];
-    /**
-     * List of attributes on which to do a decomposition of camel case words.
-     */
-    camelCaseAttributes?: string[];
-    /**
-     * Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.
-     */
-    decompoundedAttributes?: Record<string, any>;
-    /**
-     * Sets the languages at the index level for language-specific processing such as tokenization and normalization.
-     */
-    indexLanguages?: string[];
-    /**
-     * List of attributes on which you want to disable prefix matching.
-     */
-    disablePrefixOnAttributes?: string[];
-    /**
-     * Enables compression of large integer arrays.
-     */
-    allowCompressionOfIntegerArray?: boolean;
-    /**
-     * List of numeric attributes that can be used as numerical filters.
-     */
-    numericAttributesForFiltering?: string[];
-    /**
-     * Control which separators are indexed.
-     */
-    separatorsToIndex?: string;
-    /**
-     * The complete list of attributes used for searching.
-     */
-    searchableAttributes?: string[];
-    /**
-     * Lets you store custom data in your indices.
-     */
-    userData?: Record<string, any>;
-    /**
-     * Overrides Algolia\'s default normalization.
-     */
-    customNormalization?: Record<string, Record<string, string>>;
-};
+import type { SupportedLanguage } from './supportedLanguage';
+export type BaseIndexSettings = {
+    /**
+     * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are ways to categorize search results based on attributes. Facets can be used to let user filter search results. By default, no attribute is used for faceting.  **Modifiers**  - `filterOnly(\"ATTRIBUTE\")`.   Allows using this attribute as a filter, but doesn\'t evalue the facet values.  - `searchable(\"ATTRIBUTE\")`.   Allows searching for facet values.  - `afterDistinct(\"ATTRIBUTE\")`.   Evaluates the facet count _after_ deduplication with `distinct`.   This ensures accurate facet counts.   You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
+     */
+    attributesForFaceting?: string[];
+    /**
+     * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).  Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index.  **Modifier**  - `virtual(\"REPLICA\")`.   Create a virtual replica,   Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
+     */
+    replicas?: string[];
+    /**
+     * Maximum number of search results that can be obtained through pagination.  Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can\'t be guaranteed.
+     */
+    paginationLimitedTo?: number;
+    /**
+     * Attributes that can\'t be retrieved at query time.  This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results.
+     */
+    unretrievableAttributes?: string[];
+    /**
+     * Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+     */
+    disableTypoToleranceOnWords?: string[];
+    /**
+     * Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).  Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese.
+     */
+    attributesToTransliterate?: string[];
+    /**
+     * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
+     */
+    camelCaseAttributes?: string[];
+    /**
+     * Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding).  Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately.  You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).
+     */
+    decompoundedAttributes?: Record<string, any>;
+    /**
+     * Languages for language-specific processing steps, such as word detection and dictionary settings.  **You should always specify an indexing language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+     */
+    indexLanguages?: SupportedLanguage[];
+    /**
+     * Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
+     */
+    disablePrefixOnAttributes?: string[];
+    /**
+     * Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
+     */
+    allowCompressionOfIntegerArray?: boolean;
+    /**
+     * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  - `equalOnly(\"ATTRIBUTE\")`.   Support only filtering based on equality comparisons `=` and `!=`.
+     */
+    numericAttributesForFiltering?: string[];
+    /**
+     * Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren\'t indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
+     */
+    separatorsToIndex?: string;
+    /**
+     * Attributes used for searching.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  - `unordered(\"ATTRIBUTE\")`.   Ignore the position of a match within the attribute.  Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
+     */
+    searchableAttributes?: string[];
+    /**
+     * An object with custom data.  You can store up to 32&nbsp;kB as custom data.
+     */
+    userData?: any | null;
+    /**
+     * Characters and their normalized replacements. This overrides Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
+     */
+    customNormalization?: Record<string, Record<string, string>>;
+    /**
+     * Attribute that should be used to establish groups of results.  All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results.  If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
+     */
+    attributeForDistinct?: string;
+};
 //# sourceMappingURL=baseIndexSettings.d.ts.map

package/dist/client-search/model/baseIndexSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseIndexSettings.d.ts","sourceRoot":"","sources":["../../../../client-search/model/baseIndexSettings.ts"],"names":[],"mappings":"AAEA,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE7C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC9D,CAAC"}
+{"version":3,"file":"baseIndexSettings.d.ts","sourceRoot":"","sources":["../../../../client-search/model/baseIndexSettings.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE7C;;OAEG;IACH,cAAc,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAErC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAErC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE7D;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC"}

package/dist/client-search/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/client-search/model/baseSearchParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseSearchParams.d.ts","sourceRoot":"","sources":["../../../../client-search/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":["../../../../client-search/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/client-search/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 expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     */
+    filters?: string;
+    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/client-search/model/baseSearchParamsWithoutQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../../../client-search/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":["../../../../client-search/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"}