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

package/model/facetFilters.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * Filter hits by facet value.
+ * 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 = MixedSearchFilters[] | string;

package/model/facetOrdering.ts

@@ -1,16 +1,16 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { Facets } from './facets';
 import type { Value } from './value';
 
 /**
- * Defining how facets should be ordered.
+ * Order of facet names and facet values in your UI.
  */
 export type FacetOrdering = {
   facets?: Facets;
 
   /**
-   * The ordering of facet values, within an individual list.
+   * Order of facet values. One object for each facet.
    */
   values?: Record<string, Value>;
 };

package/model/facets.ts

@@ -1,11 +1,11 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * The ordering of facets (widgets).
+ * Order of facet names.
  */
 export type Facets = {
   /**
-   * Pinned order of facet lists.
+   * 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[];
 };

package/model/facetsStats.ts

@@ -1,23 +1,23 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 FacetsStats = {
   /**
-   * The minimum value in the result set.
+   * Minimum value in the results.
    */
   min?: number;
 
   /**
-   * The maximum value in the result set.
+   * Maximum value in the results.
    */
   max?: number;
 
   /**
-   * The average facet value in the result set.
+   * Average facet value in the results.
    */
   avg?: number;
 
   /**
-   * The sum of all values in the result set.
+   * Sum of all values in the results.
    */
   sum?: number;
 };

package/model/fallbackParams.ts

@@ -0,0 +1,5 @@
+// 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 { SearchParamsObject } from './searchParamsObject';
+
+export type FallbackParams = Record<string, any> & SearchParamsObject;

package/model/fbtModel.ts

@@ -0,0 +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.
+
+/**
+ * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
+ */
+export type FbtModel = 'bought-together';

package/model/frequentlyBoughtTogether.ts

@@ -0,0 +1,12 @@
+// 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 { FbtModel } from './fbtModel';
+
+export type FrequentlyBoughtTogether = {
+  model: FbtModel;
+
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+};

package/model/getRecommendTaskResponse.ts

@@ -0,0 +1,7 @@
+// 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 { TaskStatus } from './taskStatus';
+
+export type GetRecommendTaskResponse = {
+  status: TaskStatus;
+};

package/model/getRecommendationsParams.ts

@@ -1,13 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { RecommendationsRequest } from './recommendationsRequest';
 
 /**
- * The `getRecommendations` parameters.
+ * Recommend request body.
  */
 export type GetRecommendationsParams = {
   /**
-   * The `getRecommendations` requests.
+   * Recommendation request with parameters depending on the requested model.
    */
   requests: RecommendationsRequest[];
 };

package/model/getRecommendationsResponse.ts

@@ -1,7 +1,7 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { RecommendationsResponse } from './recommendationsResponse';
+import type { RecommendationsResults } from './recommendationsResults';
 
 export type GetRecommendationsResponse = {
-  results?: RecommendationsResponse[];
+  results?: RecommendationsResults[];
 };

package/model/hideConsequenceObject.ts

@@ -0,0 +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.
+
+/**
+ * Object ID of the recommendation you want to exclude.
+ */
+export type HideConsequenceObject = {
+  /**
+   * Unique record identifier.
+   */
+  objectID?: string;
+};

package/model/highlightResult.ts

@@ -1,5 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { HighlightResultOption } from './highlightResultOption';
 
-export type HighlightResult = HighlightResultOption | HighlightResultOption[];
+export type HighlightResult =
+  | HighlightResultOption
+  | HighlightResultOption[]
+  | Record<string, HighlightResultOption>;

package/model/highlightResultOption.ts

@@ -1,20 +1,20 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { MatchLevel } from './matchLevel';
 
 /**
- * Show highlighted section and words matched on a query.
+ * Surround words that match the query with HTML tags for highlighting.
  */
 export type HighlightResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 
   matchLevel: MatchLevel;
 
   /**
-   * List of words from the query that matched the object.
+   * List of matched words from the search query.
    */
   matchedWords: string[];
 

package/model/ignorePlurals.ts

@@ -1,6 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { SupportedLanguage } from './supportedLanguage';
 
 /**
- * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ * 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 = string[] | boolean;
+export type IgnorePlurals = SupportedLanguage[] | boolean;

package/model/index.ts

@@ -1,54 +1,93 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 * from './advancedSyntaxFeatures';
 export * from './alternativesAsExact';
+export * from './aroundPrecision';
+export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
+export * from './autoFacetFilter';
 export * from './baseRecommendRequest';
-export * from './baseRecommendationRequest';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
-export * from './baseTrendingRequest';
+export * from './boughtTogetherQuery';
+export * from './condition';
+export * from './consequence';
+export * from './deletedAtResponse';
 export * from './distinct';
 export * from './errorBase';
 export * from './exactOnSingleWordQuery';
+export * from './exhaustive';
 export * from './facetFilters';
 export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
+export * from './fallbackParams';
+export * from './fbtModel';
+export * from './frequentlyBoughtTogether';
+export * from './getRecommendTaskResponse';
 export * from './getRecommendationsParams';
 export * from './getRecommendationsResponse';
+export * from './hideConsequenceObject';
 export * from './highlightResult';
 export * from './highlightResultOption';
 export * from './ignorePlurals';
 export * from './indexSettingsAsSearchParams';
+export * from './lookingSimilar';
+export * from './lookingSimilarModel';
+export * from './lookingSimilarQuery';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
 export * from './mixedSearchFilters';
+export * from './mode';
 export * from './numericFilters';
 export * from './optionalFilters';
+export * from './paramsConsequence';
 export * from './personalization';
+export * from './promoteConsequenceObject';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
 export * from './recommendHit';
-export * from './recommendHits';
-export * from './recommendationModels';
-export * from './recommendationRequest';
+export * from './recommendModels';
+export * from './recommendRule';
+export * from './recommendRuleMetadata';
+export * from './recommendationsHit';
+export * from './recommendationsHits';
 export * from './recommendationsRequest';
-export * from './recommendationsResponse';
+export * from './recommendationsResults';
+export * from './recommendedForYou';
+export * from './recommendedForYouModel';
+export * from './recommendedForYouQuery';
+export * from './redirect';
+export * from './redirectRuleIndexMetadata';
+export * from './redirectRuleIndexMetadataData';
+export * from './relatedModel';
+export * from './relatedProducts';
+export * from './relatedQuery';
 export * from './removeStopWords';
 export * from './removeWordsIfNoResults';
 export * from './renderingContent';
+export * from './searchParams';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';
+export * from './searchRecommendRulesParams';
+export * from './searchRecommendRulesResponse';
+export * from './semanticSearch';
 export * from './snippetResult';
 export * from './snippetResultOption';
 export * from './sortRemainingBy';
+export * from './supportedLanguage';
 export * from './tagFilters';
-export * from './trendingModels';
-export * from './trendingRequest';
+export * from './taskStatus';
+export * from './trendingFacetHit';
+export * from './trendingFacets';
+export * from './trendingFacetsModel';
+export * from './trendingFacetsQuery';
+export * from './trendingItems';
+export * from './trendingItemsModel';
+export * from './trendingItemsQuery';
 export * from './typoTolerance';
 export * from './typoToleranceEnum';
 export * from './value';

package/model/indexSettingsAsSearchParams.ts

@@ -1,69 +1,58 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
 import type { AlternativesAsExact } from './alternativesAsExact';
 import type { Distinct } from './distinct';
 import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
 import type { IgnorePlurals } from './ignorePlurals';
+import type { Mode } from './mode';
 import type { QueryType } from './queryType';
+import type { ReRankingApplyFilter } from './reRankingApplyFilter';
 import type { RemoveStopWords } from './removeStopWords';
 import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
 import type { RenderingContent } from './renderingContent';
+import type { SemanticSearch } from './semanticSearch';
+import type { SupportedLanguage } from './supportedLanguage';
 import type { TypoTolerance } from './typoTolerance';
 
 export type IndexSettingsAsSearchParams = {
   /**
-   * The complete list of attributes that will be used for faceting.
-   */
-  attributesForFaceting?: string[];
-
-  /**
-   * List of attributes that can\'t be retrieved at query time.
-   */
-  unretrievableAttributes?: string[];
-
-  /**
-   * This parameter controls which attributes to retrieve and which not to retrieve.
+   * Attributes to include in the API response.  To reduce the size of your response, you can retrieve only some of the attributes.  - `*` 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[];
 
   /**
-   * Restricts a given query to look in only a subset of your searchable attributes.
-   */
-  restrictSearchableAttributes?: string[];
-
-  /**
-   * Controls how Algolia should sort your results.
+   * 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[];
 
   /**
-   * Specifies the custom ranking criterion.
+   * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **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.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
    */
   customRanking?: string[];
 
   /**
-   * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
+   * 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.
    */
   relevancyStrictness?: number;
 
   /**
-   * List of attributes to highlight.
+   * Attributes to highlight.  By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.  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[];
 
   /**
-   * List of attributes to snippet, with an optional maximum number of words to snippet.
+   * Attributes for which to enable snippets.  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[];
 
   /**
-   * The HTML string to insert before the highlighted parts in all highlight and snippet results.
+   * HTML tag to insert before the highlighted parts in all highlighted results and snippets.
    */
   highlightPreTag?: string;
 
   /**
-   * The HTML string to insert after the highlighted parts in all highlight and snippet results.
+   * HTML tag to insert after the highlighted parts in all highlighted results and snippets.
    */
   highlightPostTag?: string;
 
@@ -73,34 +62,34 @@ export type IndexSettingsAsSearchParams = {
   snippetEllipsisText?: string;
 
   /**
-   * Restrict highlighting and snippeting to items that matched the query.
+   * Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
    */
   restrictHighlightAndSnippetArrays?: boolean;
 
   /**
-   * Set the number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 
   /**
-   * Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
+   * Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
    */
   minWordSizefor1Typo?: number;
 
   /**
-   * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
+   * Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
    */
   minWordSizefor2Typos?: number;
 
   typoTolerance?: TypoTolerance;
 
   /**
-   * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
+   * Whether to allow typos on numbers in the search query.  Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.
    */
   allowTyposOnNumericTokens?: boolean;
 
   /**
-   * List of attributes on which you want to disable typo tolerance.
+   * Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).  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[];
 
@@ -109,27 +98,27 @@ export type IndexSettingsAsSearchParams = {
   removeStopWords?: RemoveStopWords;
 
   /**
-   * List of characters that the engine shouldn\'t automatically normalize.
+   * Characters for which diacritics should be preserved.  By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
    */
   keepDiacriticsOnCharacters?: string;
 
   /**
-   * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
+   * 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?: string[];
+  queryLanguages?: SupportedLanguage[];
 
   /**
-   * Splits compound words into their composing atoms in the query.
+   * Whether to split compound words 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.
    */
   decompoundQuery?: boolean;
 
   /**
-   * Whether Rules should be globally enabled.
+   * Whether to enable rules.
    */
   enableRules?: boolean;
 
   /**
-   * Enable the Personalization feature.
+   * Whether to enable Personalization.
    */
   enablePersonalization?: boolean;
 
@@ -137,69 +126,80 @@ export type IndexSettingsAsSearchParams = {
 
   removeWordsIfNoResults?: RemoveWordsIfNoResults;
 
+  mode?: Mode;
+
+  semanticSearch?: SemanticSearch;
+
   /**
-   * Enables the advanced query syntax.
+   * Whether to support phrase matching and excluding words from search queries.  Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
    */
   advancedSyntax?: boolean;
 
   /**
-   * A list of words that should be considered as optional when found in the query.
+   * 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).
    */
   optionalWords?: string[];
 
   /**
-   * List of attributes on which you want to disable the exact ranking criterion.
+   * 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).  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.
    */
   disableExactOnAttributes?: string[];
 
   exactOnSingleWordQuery?: ExactOnSingleWordQuery;
 
   /**
-   * List of alternatives that should be considered an exact match by the exact ranking criterion.
+   * 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[];
 
   /**
-   * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
+   * 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[];
 
   distinct?: Distinct;
 
   /**
-   * Name of the de-duplication attribute to be used with the distinct feature.
+   * 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.
    */
-  attributeForDistinct?: string;
+  replaceSynonymsInHighlight?: boolean;
 
   /**
-   * Whether to take into account an index\'s synonyms for a particular search.
+   * Minimum proximity score for two matching words.  This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart.  For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
    */
-  synonyms?: boolean;
+  minProximity?: number;
 
   /**
-   * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
+   * 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.
    */
-  replaceSynonymsInHighlight?: boolean;
+  responseFields?: string[];
 
   /**
-   * Precision of the proximity ranking criterion.
+   * 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).
    */
-  minProximity?: number;
+  maxFacetHits?: number;
 
   /**
-   * Choose which fields to return in the API response. This parameters applies to search and browse queries.
+   * Maximum number of facet values to return for each facet.
    */
-  responseFields?: string[];
+  maxValuesPerFacet?: number;
 
   /**
-   * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+   * Order in which to retrieve facet values.  - `count`.   Facet values are retrieved by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Retrieve facet values alphabetically.  This setting doesn\'t influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
    */
-  maxFacetHits?: number;
+  sortFacetValuesBy?: string;
 
   /**
-   * When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
+   * Whether the best matching attribute should be determined by minimum proximity.  This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
    */
   attributeCriteriaComputedByMinProximity?: boolean;
 
   renderingContent?: RenderingContent;
+
+  /**
+   * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).  This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+   */
+  enableReRanking?: boolean;
+
+  reRankingApplyFilter?: ReRankingApplyFilter | null;
 };

package/model/lookingSimilar.ts

@@ -0,0 +1,15 @@
+// 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 { FallbackParams } from './fallbackParams';
+import type { LookingSimilarModel } from './lookingSimilarModel';
+
+export type LookingSimilar = {
+  model: LookingSimilarModel;
+
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+
+  fallbackParameters?: FallbackParams;
+};

package/model/lookingSimilarModel.ts

@@ -0,0 +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.
+
+/**
+ * Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
+ */
+export type LookingSimilarModel = 'looking-similar';

package/model/lookingSimilarQuery.ts

@@ -0,0 +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.
+
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { LookingSimilar } from './lookingSimilar';
+
+export type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;