@algolia/recommend 5.7.0 → 5.8.1

package/model/baseIndexSettings.ts

@@ -4,14 +4,14 @@ 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 attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive.  **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))`.
+   * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive.  **Modifiers**  - `filterOnly(\"ATTRIBUTE\")`.   Allows the attribute to be used as a filter but doesn\'t evaluate 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[];
+  attributesForFaceting?: Array<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/).
+   * 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 be 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[];
+  replicas?: Array<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.
@@ -21,22 +21,22 @@ export type BaseIndexSettings = {
   /**
    * 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. Attribute names are case-sensitive.
    */
-  unretrievableAttributes?: string[];
+  unretrievableAttributes?: Array<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[];
+  disableTypoToleranceOnWords?: Array<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. Attribute names are case-sensitive.
    */
-  attributesToTransliterate?: string[];
+  attributesToTransliterate?: Array<string>;
 
   /**
    * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
    */
-  camelCaseAttributes?: string[];
+  camelCaseAttributes?: Array<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). Attribute names are case-sensitive.  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`). Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
@@ -46,12 +46,12 @@ export type BaseIndexSettings = {
   /**
    * 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[];
+  indexLanguages?: Array<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). Attribute names are case-sensitive.
    */
-  disablePrefixOnAttributes?: string[];
+  disablePrefixOnAttributes?: Array<string>;
 
   /**
    * Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
@@ -59,9 +59,9 @@ export type BaseIndexSettings = {
   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). Attribute names are case-sensitive.  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 `!=`.
+   * 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). Attribute names are case-sensitive.  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  To turn off filtering for all numeric attributes, specify 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[];
+  numericAttributesForFiltering?: Array<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.
@@ -69,9 +69,9 @@ export type BaseIndexSettings = {
   separatorsToIndex?: string;
 
   /**
-   * Attributes used for searching. Attribute names are case-sensitive.  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.
+   * Attributes used for searching. Attribute names are case-sensitive.  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 a modifier, matches at the beginning of an attribute rank higher than matches at the end.
    */
-  searchableAttributes?: string[];
+  searchableAttributes?: Array<string>;
 
   /**
    * An object with custom data.  You can store up to 32kB as custom data.
@@ -81,7 +81,7 @@ export type BaseIndexSettings = {
   /**
    * 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>>;
+  customNormalization?: { [key: string]: { [key: string]: string } };
 
   /**
    * Attribute that should be used to establish groups of results. Attribute names are case-sensitive.  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.

package/model/baseRecommendIndexSettings.ts

@@ -17,12 +17,12 @@ export type BaseRecommendIndexSettings = {
   /**
    * Attributes to include in the API response.  To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive.  - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
    */
-  attributesToRetrieve?: string[];
+  attributesToRetrieve?: Array<string>;
 
   /**
    * Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
    */
-  ranking?: string[];
+  ranking?: Array<string>;
 
   /**
    * Relevancy threshold below which less relevant results aren\'t included in the results.  You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
@@ -32,12 +32,12 @@ export type BaseRecommendIndexSettings = {
   /**
    * Attributes to highlight.  By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive.  With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI.  For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
    */
-  attributesToHighlight?: string[];
+  attributesToHighlight?: Array<string>;
 
   /**
    * Attributes for which to enable snippets. Attribute names are case-sensitive.  Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
    */
-  attributesToSnippet?: string[];
+  attributesToSnippet?: Array<string>;
 
   /**
    * HTML tag to insert before the highlighted parts in all highlighted results and snippets.
@@ -79,7 +79,7 @@ export type BaseRecommendIndexSettings = {
   /**
    * Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive.  Returning only exact matches can help when:  - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many.   This can happen with attributes that are long blocks of text, such as product descriptions.  Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
    */
-  disableTypoToleranceOnAttributes?: string[];
+  disableTypoToleranceOnAttributes?: Array<string>;
 
   ignorePlurals?: IgnorePlurals;
 
@@ -88,7 +88,7 @@ export type BaseRecommendIndexSettings = {
   /**
    * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.  **You should always specify a query 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/).
    */
-  queryLanguages?: SupportedLanguage[];
+  queryLanguages?: Array<SupportedLanguage>;
 
   /**
    * Whether to split compound words in the query into their building blocks.  For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
@@ -115,31 +115,31 @@ export type BaseRecommendIndexSettings = {
   advancedSyntax?: boolean;
 
   /**
-   * Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
+   * Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
    */
-  optionalWords?: string[];
+  optionalWords?: Array<string>;
 
   /**
-   * Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
+   * Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
    */
-  disableExactOnAttributes?: string[];
+  disableExactOnAttributes?: Array<string>;
 
   exactOnSingleWordQuery?: ExactOnSingleWordQuery;
 
   /**
    * Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  - `singleWordSynonym`.   Single-word synonyms, such as \"NY/NYC\" are considered exact matches.  - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
    */
-  alternativesAsExact?: AlternativesAsExact[];
+  alternativesAsExact?: Array<AlternativesAsExact>;
 
   /**
    * Advanced search syntax features you want to support.  - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\".  This setting only has an effect if `advancedSyntax` is true.
    */
-  advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
+  advancedSyntaxFeatures?: Array<AdvancedSyntaxFeatures>;
 
   distinct?: Distinct;
 
   /**
-   * Whether to replace a highlighted word with the matched synonym.  By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted.  With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurences of \"house\" are replaced by \"home\" in the highlighted response.
+   * Whether to replace a highlighted word with the matched synonym.  By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted.  With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of \"house\" are replaced by \"home\" in the highlighted response.
    */
   replaceSynonymsInHighlight?: boolean;
 
@@ -151,7 +151,7 @@ export type BaseRecommendIndexSettings = {
   /**
    * Properties to include in the API response of `search` and `browse` requests.  By default, all response properties are included. To reduce the response size, you can select, which attributes should be included.  You can\'t exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.  Don\'t exclude properties that you might need in your search UI.
    */
-  responseFields?: string[];
+  responseFields?: Array<string>;
 
   /**
    * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).

package/model/baseRecommendSearchParams.ts

@@ -35,12 +35,12 @@ export type BaseRecommendSearchParams = {
   /**
    * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
    */
-  restrictSearchableAttributes?: string[];
+  restrictSearchableAttributes?: Array<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[];
+  facets?: Array<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`.
@@ -48,7 +48,7 @@ export type BaseRecommendSearchParams = {
   facetingAfterDistinct?: boolean;
 
   /**
-   * 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`.
+   * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within a 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;
 
@@ -69,22 +69,22 @@ export type BaseRecommendSearchParams = {
   /**
    * 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[][];
+  insideBoundingBox?: Array<Array<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[][];
+  insidePolygon?: Array<Array<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?: SupportedLanguage[];
+  naturalLanguages?: Array<SupportedLanguage>;
 
   /**
    * 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[];
+  ruleContexts?: Array<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).
@@ -119,7 +119,7 @@ export type BaseRecommendSearchParams = {
   /**
    * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
-  analyticsTags?: string[];
+  analyticsTags?: Array<string>;
 
   /**
    * Whether to include this search when calculating processing-time percentiles.

package/model/baseSearchResponse.ts

@@ -46,12 +46,12 @@ export type BaseSearchResponse = Record<string, any> & {
   /**
    * Facet counts.
    */
-  facets?: Record<string, Record<string, number>>;
+  facets?: { [key: string]: { [key: string]: number } };
 
   /**
    * Statistics for numerical facets.
    */
-  facets_stats?: Record<string, FacetStats>;
+  facets_stats?: { [key: string]: FacetStats };
 
   /**
    * Index name used for the query.

package/model/booleanString.ts

@@ -1,3 +1,3 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-export type BooleanString = 'false' | 'true';
+export type BooleanString = 'true' | 'false';

package/model/clientMethodProps.ts

@@ -1,9 +1,11 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { RecommendModels } from './recommendModels';
-import type { RecommendRule } from './recommendRule';
+import { RecommendModels } from '../model/recommendModels';
+import { RecommendRule } from '../model/recommendRule';
+
+import { SearchRecommendRulesParams } from '../model/searchRecommendRulesParams';
+
 import type { RecommendationsRequest } from './recommendationsRequest';
-import type { SearchRecommendRulesParams } from './searchRecommendRulesParams';
 
 /**
  * Properties for the `batchRecommendRules` method.
@@ -17,7 +19,7 @@ export type BatchRecommendRulesProps = {
    * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
    */
   model: RecommendModels;
-  recommendRule?: RecommendRule[];
+  recommendRule?: Array<RecommendRule>;
 };
 
 /**
@@ -31,7 +33,7 @@ export type CustomDeleteProps = {
   /**
    * Query parameters to apply to the current query.
    */
-  parameters?: Record<string, any>;
+  parameters?: { [key: string]: any };
 };
 
 /**
@@ -45,7 +47,7 @@ export type CustomGetProps = {
   /**
    * Query parameters to apply to the current query.
    */
-  parameters?: Record<string, any>;
+  parameters?: { [key: string]: any };
 };
 
 /**
@@ -59,7 +61,7 @@ export type CustomPostProps = {
   /**
    * Query parameters to apply to the current query.
    */
-  parameters?: Record<string, any>;
+  parameters?: { [key: string]: any };
   /**
    * Parameters to send with the custom request.
    */
@@ -77,7 +79,7 @@ export type CustomPutProps = {
   /**
    * Query parameters to apply to the current query.
    */
-  parameters?: Record<string, any>;
+  parameters?: { [key: string]: any };
   /**
    * Parameters to send with the custom request.
    */

package/model/consequence.ts

@@ -11,12 +11,12 @@ export type Consequence = {
   /**
    * Exclude items from recommendations.
    */
-  hide?: HideConsequenceObject[];
+  hide?: Array<HideConsequenceObject>;
 
   /**
    * Place items at specific positions in the list of recommendations.
    */
-  promote?: PromoteConsequenceObject[];
+  promote?: Array<PromoteConsequenceObject>;
 
   params?: ParamsConsequence;
 };

package/model/facetFilters.ts

@@ -3,4 +3,4 @@
 /**
  * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
-export type FacetFilters = FacetFilters[] | string;
+export type FacetFilters = Array<FacetFilters> | string;

package/model/facetOrdering.ts

@@ -12,5 +12,5 @@ export type FacetOrdering = {
   /**
    * Order of facet values. One object for each facet.
    */
-  values?: Record<string, Value>;
+  values?: { [key: string]: Value };
 };

package/model/getRecommendationsParams.ts

@@ -9,5 +9,5 @@ export type GetRecommendationsParams = {
   /**
    * Recommendation request with parameters depending on the requested model.
    */
-  requests: RecommendationsRequest[];
+  requests: Array<RecommendationsRequest>;
 };

package/model/getRecommendationsResponse.ts

@@ -3,5 +3,5 @@
 import type { RecommendationsResults } from './recommendationsResults';
 
 export type GetRecommendationsResponse = {
-  results: RecommendationsResults[];
+  results: Array<RecommendationsResults>;
 };

package/model/highlightResult.ts

@@ -2,4 +2,4 @@
 
 import type { HighlightResultOption } from './highlightResultOption';
 
-export type HighlightResult = HighlightResult[] | HighlightResultOption | { [key: string]: HighlightResult };
+export type HighlightResult = HighlightResultOption | { [key: string]: HighlightResult } | Array<HighlightResult>;

package/model/highlightResultOption.ts

@@ -16,7 +16,7 @@ export type HighlightResultOption = {
   /**
    * List of matched words from the search query.
    */
-  matchedWords: string[];
+  matchedWords: Array<string>;
 
   /**
    * Whether the entire attribute value is highlighted.

package/model/ignorePlurals.ts

@@ -6,4 +6,4 @@ import type { SupportedLanguage } from './supportedLanguage';
 /**
  * Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
  */
-export type IgnorePlurals = BooleanString | SupportedLanguage[] | boolean;
+export type IgnorePlurals = Array<SupportedLanguage> | BooleanString | boolean;

package/model/index.ts

@@ -6,6 +6,10 @@ export * from './aroundPrecision';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './autoFacetFilter';
+export * from './banner';
+export * from './bannerImage';
+export * from './bannerImageUrl';
+export * from './bannerLink';
 export * from './baseIndexSettings';
 export * from './baseRecommendIndexSettings';
 export * from './baseRecommendRequest';
@@ -13,6 +17,7 @@ export * from './baseRecommendSearchParams';
 export * from './baseSearchResponse';
 export * from './booleanString';
 export * from './boughtTogetherQuery';
+export * from './clientMethodProps';
 export * from './condition';
 export * from './consequence';
 export * from './deletedAtResponse';
@@ -26,9 +31,9 @@ export * from './facetStats';
 export * from './fallbackParams';
 export * from './fbtModel';
 export * from './frequentlyBoughtTogether';
-export * from './getRecommendTaskResponse';
 export * from './getRecommendationsParams';
 export * from './getRecommendationsResponse';
+export * from './getRecommendTaskResponse';
 export * from './hideConsequenceObject';
 export * from './highlightResult';
 export * from './highlightResultOption';
@@ -37,8 +42,8 @@ export * from './indexSettingsFacets';
 export * from './lookingSimilar';
 export * from './lookingSimilarModel';
 export * from './lookingSimilarQuery';
-export * from './matchLevel';
 export * from './matchedGeoLocation';
+export * from './matchLevel';
 export * from './numericFilters';
 export * from './optionalFilters';
 export * from './paramsConsequence';
@@ -47,13 +52,6 @@ export * from './promoteConsequenceObject';
 export * from './queryType';
 export * from './range';
 export * from './rankingInfo';
-export * from './reRankingApplyFilter';
-export * from './recommendHit';
-export * from './recommendIndexSettings';
-export * from './recommendModels';
-export * from './recommendRule';
-export * from './recommendSearchParams';
-export * from './recommendUpdatedAtResponse';
 export * from './recommendationsHit';
 export * from './recommendationsHits';
 export * from './recommendationsRequest';
@@ -61,6 +59,12 @@ export * from './recommendationsResults';
 export * from './recommendedForYou';
 export * from './recommendedForYouModel';
 export * from './recommendedForYouQuery';
+export * from './recommendHit';
+export * from './recommendIndexSettings';
+export * from './recommendModels';
+export * from './recommendRule';
+export * from './recommendSearchParams';
+export * from './recommendUpdatedAtResponse';
 export * from './redirect';
 export * from './redirectRuleIndexData';
 export * from './redirectRuleIndexMetadata';
@@ -71,6 +75,7 @@ export * from './relatedQuery';
 export * from './removeStopWords';
 export * from './removeWordsIfNoResults';
 export * from './renderingContent';
+export * from './reRankingApplyFilter';
 export * from './ruleMetadata';
 export * from './searchPagination';
 export * from './searchParamsQuery';
@@ -93,4 +98,4 @@ export * from './trendingItemsQuery';
 export * from './typoTolerance';
 export * from './typoToleranceEnum';
 export * from './value';
-export * from './clientMethodProps';
+export * from './widgets';

package/model/indexSettingsFacets.ts

@@ -7,5 +7,5 @@ export type IndexSettingsFacets = {
   /**
    * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
    */
-  order?: string[];
+  order?: Array<string>;
 };

package/model/matchLevel.ts

@@ -3,4 +3,4 @@
 /**
  * Whether the whole query string matches or only a part.
  */
-export type MatchLevel = 'full' | 'none' | 'partial';
+export type MatchLevel = 'none' | 'partial' | 'full';

package/model/numericFilters.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
+ * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
  */
-export type NumericFilters = NumericFilters[] | string;
+export type NumericFilters = Array<NumericFilters> | string;

package/model/optionalFilters.ts

@@ -3,4 +3,4 @@
 /**
  * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
  */
-export type OptionalFilters = OptionalFilters[] | string;
+export type OptionalFilters = Array<OptionalFilters> | string;

package/model/paramsConsequence.ts

@@ -9,7 +9,7 @@ export type ParamsConsequence = {
   /**
    * Filter recommendations that match or don\'t match the same `facet:facet_value` combination as the viewed item.
    */
-  automaticFacetFilters?: AutoFacetFilter[];
+  automaticFacetFilters?: Array<AutoFacetFilter>;
 
   /**
    * 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/).
@@ -19,5 +19,5 @@ export type ParamsConsequence = {
   /**
    * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.
    */
-  optionalFilters?: string[];
+  optionalFilters?: Array<string>;
 };

package/model/queryType.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Determines if and how query words are interpreted as prefixes.  By default, only the last query word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
+ * Determines if and how query words are interpreted as prefixes.  By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
  */
-export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+export type QueryType = 'prefixLast' | 'prefixAll' | 'prefixNone';

package/model/reRankingApplyFilter.ts

@@ -3,4 +3,4 @@
 /**
  * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
-export type ReRankingApplyFilter = ReRankingApplyFilter[] | string;
+export type ReRankingApplyFilter = Array<ReRankingApplyFilter> | string;

package/model/recommendHit.ts

@@ -16,12 +16,12 @@ export type RecommendHit = Record<string, any> & {
   /**
    * Surround words that match the query with HTML tags for highlighting.
    */
-  _highlightResult?: Record<string, HighlightResult>;
+  _highlightResult?: { [key: string]: HighlightResult };
 
   /**
    * Snippets that show the context around a matching search query.
    */
-  _snippetResult?: Record<string, SnippetResult>;
+  _snippetResult?: { [key: string]: SnippetResult };
 
   _rankingInfo?: RankingInfo;
 

package/model/recommendModels.ts

@@ -1,3 +1,3 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-export type RecommendModels = 'bought-together' | 'related-products' | 'trending-facets' | 'trending-items';
+export type RecommendModels = 'related-products' | 'bought-together' | 'trending-facets' | 'trending-items';

package/model/recommendRule.ts

@@ -33,5 +33,5 @@ export type RecommendRule = {
   /**
    * Time periods when the rule is active.
    */
-  validity?: TimeRange[];
+  validity?: Array<TimeRange>;
 };