@algolia/recommend 5.0.0-alpha.9 → 5.0.0-alpha.90

package/model/distinct.ts

@@ -1,6 +1,6 @@
-// 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.
 
 /**
- * Enables de-duplication or grouping of results.
+ * Enables [deduplication or grouping of results (Algolia\'s _distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
  */
 export type Distinct = boolean | number;

package/model/edit.ts

@@ -0,0 +1,17 @@
+// 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 { EditType } from './editType';
+
+export type Edit = {
+  type?: EditType;
+
+  /**
+   * Text or patterns to remove from the query string.
+   */
+  delete?: string;
+
+  /**
+   * Text that should be inserted in place of the removed text inside the query string.
+   */
+  insert?: string;
+};

package/model/editType.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.
+
+/**
+ * Type of edit.
+ */
+export type EditType = 'remove' | 'replace';

package/model/errorBase.ts

@@ -1,4 +1,4 @@
-// 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.
 
 /**
  * Error.

package/model/exactOnSingleWordQuery.ts

@@ -1,6 +1,6 @@
-// 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.
 
 /**
- * Controls how the exact ranking criterion is computed when the query contains only one word.
+ * Determines how 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) is computed when the query contains only one word.
  */
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

package/model/exhaustive.ts

@@ -0,0 +1,31 @@
+// 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.
+
+/**
+ * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+ */
+export type Exhaustive = {
+  /**
+   * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+   */
+  facetsCount?: boolean;
+
+  /**
+   * The value is `false` if not all facet values are retrieved.
+   */
+  facetValues?: boolean;
+
+  /**
+   * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+   */
+  nbHits?: boolean;
+
+  /**
+   * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+   */
+  rulesMatch?: boolean;
+
+  /**
+   * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+   */
+  typo?: boolean;
+};

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 hits by facet value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
  */
 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.
+ * Defines the ordering of facets (widgets).
  */
 export type FacetOrdering = {
   facets?: Facets;
 
   /**
-   * The ordering of facet values, within an individual list.
+   * Ordering of facet values within an individual facet.
    */
   values?: Record<string, Value>;
 };

package/model/facets.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.
 
 /**
- * The ordering of facets (widgets).
+ * Ordering of facets (widgets).
  */
 export type Facets = {
   /**

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/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 parameters.
  */
 export type GetRecommendationsParams = {
   /**
-   * The `getRecommendations` requests.
+   * Request parameters depend on the model (recommendations or trending).
    */
   requests: RecommendationsRequest[];
 };

package/model/getRecommendationsResponse.ts

@@ -1,4 +1,4 @@
-// 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';
 

package/model/highlightResult.ts

@@ -1,4 +1,4 @@
-// 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';
 

package/model/highlightResultOption.ts

@@ -1,4 +1,4 @@
-// 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';
 
@@ -7,7 +7,7 @@ import type { MatchLevel } from './matchLevel';
  */
 export type HighlightResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Markup text with `facetQuery` matches highlighted.
    */
   value: string;
 

package/model/ignorePlurals.ts

@@ -1,6 +1,6 @@
-// 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.
 
 /**
- * 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).
+ * 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 feature, where singulars and plurals are considered equivalent (\"foot\" = \"feet\"). The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the ignore plurals feature, so that singulars and plurals aren\'t considered to be the same (\"foot\" will not find \"feet\").
  */
 export type IgnorePlurals = string[] | boolean;

package/model/index.ts

@@ -1,22 +1,39 @@
-// 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 './anchoring';
+export * from './aroundPrecision';
+export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
+export * from './automaticFacetFilter';
+export * from './automaticFacetFilters';
 export * from './baseRecommendRequest';
-export * from './baseRecommendationRequest';
+export * from './baseRecommendationsQuery';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
-export * from './baseTrendingRequest';
+export * from './baseTrendingFacetsQuery';
+export * from './baseTrendingItemsQuery';
+export * from './condition';
+export * from './consequence';
+export * from './consequenceHide';
+export * from './consequenceParams';
+export * from './consequenceQuery';
+export * from './consequenceQueryObject';
+export * from './deletedAtResponse';
 export * from './distinct';
+export * from './edit';
+export * from './editType';
 export * from './errorBase';
 export * from './exactOnSingleWordQuery';
+export * from './exhaustive';
 export * from './facetFilters';
 export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
+export * from './getRecommendTaskResponse';
 export * from './getRecommendationsParams';
 export * from './getRecommendationsResponse';
 export * from './highlightResult';
@@ -26,29 +43,46 @@ export * from './indexSettingsAsSearchParams';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
 export * from './mixedSearchFilters';
+export * from './mode';
 export * from './numericFilters';
 export * from './optionalFilters';
+export * from './params';
 export * from './personalization';
+export * from './promote';
+export * from './promoteObjectID';
+export * from './promoteObjectIDs';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
 export * from './recommendHit';
 export * from './recommendHits';
+export * from './recommendModels';
 export * from './recommendationModels';
-export * from './recommendationRequest';
+export * from './recommendationsQuery';
 export * from './recommendationsRequest';
 export * from './recommendationsResponse';
+export * from './redirect';
+export * from './redirectRuleIndexMetadata';
+export * from './redirectRuleIndexMetadataData';
 export * from './removeStopWords';
 export * from './removeWordsIfNoResults';
 export * from './renderingContent';
+export * from './ruleResponse';
+export * from './ruleResponseMetadata';
 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 './tagFilters';
-export * from './trendingModels';
-export * from './trendingRequest';
+export * from './taskStatus';
+export * from './trendingFacetsModel';
+export * from './trendingFacetsQuery';
+export * from './trendingItemsModel';
+export * from './trendingItemsQuery';
 export * from './typoTolerance';
 export * from './typoToleranceEnum';
 export * from './value';

package/model/indexSettingsAsSearchParams.ts

@@ -1,69 +1,62 @@
-// 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 { TypoTolerance } from './typoTolerance';
 
 export type IndexSettingsAsSearchParams = {
   /**
-   * The complete list of attributes that will be used for faceting.
+   * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/) and the [modifiers](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) that can be applied: `filterOnly`, `searchable`, and `afterDistinct`.
    */
   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. By default, the response includes all attributes.
    */
   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](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).
    */
   ranking?: string[];
 
   /**
-   * Specifies the custom ranking criterion.
+   * Specifies the [Custom ranking criterion](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Use the `asc` and `desc` modifiers to specify the ranking order: ascending or descending.
    */
   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.
    */
   relevancyStrictness?: number;
 
   /**
-   * List of attributes to highlight.
+   * Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (`highlightPreTag` and `highlightPostTag`).
    */
   attributesToHighlight?: string[];
 
   /**
-   * List of attributes to snippet, with an optional maximum number of words to snippet.
+   * Attributes to _snippet_. \'Snippeting\' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example: `body:20`.
    */
   attributesToSnippet?: string[];
 
   /**
-   * The HTML string to insert before the highlighted parts in all highlight and snippet results.
+   * HTML string to insert before the highlighted parts in all highlight and snippet results.
    */
   highlightPreTag?: string;
 
   /**
-   * The HTML string to insert after the highlighted parts in all highlight and snippet results.
+   * HTML string to insert after the highlighted parts in all highlight and snippet results.
    */
   highlightPostTag?: string;
 
@@ -78,17 +71,17 @@ export type IndexSettingsAsSearchParams = {
   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 query string 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 query string 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;
 
@@ -100,7 +93,7 @@ export type IndexSettingsAsSearchParams = {
   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/).
    */
   disableTypoToleranceOnAttributes?: string[];
 
@@ -109,27 +102,27 @@ export type IndexSettingsAsSearchParams = {
   removeStopWords?: RemoveStopWords;
 
   /**
-   * List of characters that the engine shouldn\'t automatically normalize.
+   * Characters that the engine shouldn\'t automatically [normalize](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
    */
   keepDiacriticsOnCharacters?: string;
 
   /**
-   * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
+   * Sets your user\'s search language. This adjusts language-specific settings and features such as `ignorePlurals`, `removeStopWords`, and [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) word detection.
    */
   queryLanguages?: string[];
 
   /**
-   * Splits compound words into their composing atoms in the query.
+   * [Splits compound words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words) into their component word parts in the query.
    */
   decompoundQuery?: boolean;
 
   /**
-   * Whether Rules should be globally enabled.
+   * Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.
    */
   enableRules?: boolean;
 
   /**
-   * Enable the Personalization feature.
+   * Incidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.
    */
   enablePersonalization?: boolean;
 
@@ -137,69 +130,80 @@ export type IndexSettingsAsSearchParams = {
 
   removeWordsIfNoResults?: RemoveWordsIfNoResults;
 
+  mode?: Mode;
+
+  semanticSearch?: SemanticSearch;
+
   /**
-   * Enables the advanced query syntax.
+   * Enables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).
    */
   advancedSyntax?: boolean;
 
   /**
-   * A list of words that should be considered as optional when found in the query.
+   * Words which should be considered [optional](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words) when found in a query.
    */
   optionalWords?: string[];
 
   /**
-   * List of attributes on which you want to disable the exact ranking criterion.
+   * 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).
    */
   disableExactOnAttributes?: string[];
 
   exactOnSingleWordQuery?: ExactOnSingleWordQuery;
 
   /**
-   * List of alternatives that should be considered an exact match by the exact ranking criterion.
+   * Alternatives that should be considered an exact match by [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).
    */
   alternativesAsExact?: AlternativesAsExact[];
 
   /**
-   * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
+   * Allows you to specify which advanced syntax features are active when `advancedSyntax` is enabled.
    */
   advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
 
   distinct?: Distinct;
 
   /**
-   * Name of the de-duplication attribute to be used with the distinct feature.
+   * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
    */
-  attributeForDistinct?: string;
+  replaceSynonymsInHighlight?: boolean;
 
   /**
-   * Whether to take into account an index\'s synonyms for a particular search.
+   * Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity).
    */
-  synonyms?: boolean;
+  minProximity?: number;
 
   /**
-   * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
+   * Attributes to include in the API response for search and browse queries.
    */
-  replaceSynonymsInHighlight?: boolean;
+  responseFields?: string[];
 
   /**
-   * Precision of the proximity ranking criterion.
+   * Maximum number of facet hits 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.
+   * Controls how facet values are fetched.
    */
-  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.
+   * When the [Attribute criterion is ranked above Proximity](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute-and-proximity-combinations) in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
    */
   attributeCriteriaComputedByMinProximity?: boolean;
 
   renderingContent?: RenderingContent;
+
+  /**
+   * Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
+   */
+  enableReRanking?: boolean;
+
+  reRankingApplyFilter?: ReRankingApplyFilter | null;
 };

package/model/matchLevel.ts

@@ -1,4 +1,4 @@
-// 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.
 
 /**
  * Indicates how well the attribute matched the search query.

package/model/matchedGeoLocation.ts

@@ -1,4 +1,4 @@
-// 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 MatchedGeoLocation = {
   /**

package/model/mixedSearchFilters.ts

@@ -1,3 +1,3 @@
-// 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 MixedSearchFilters = string[] | string;

package/model/mode.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.
+
+/**
+ * Search mode the index will use to query for results.
+ */
+export type Mode = 'keywordSearch' | 'neuralSearch';

package/model/numericFilters.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 on numeric attributes.
+ * [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
  */
 export type NumericFilters = MixedSearchFilters[] | string;

package/model/optionalFilters.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';
 
 /**
- * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
+ * Create filters to boost or demote records.   Records that match the filter are ranked higher for positive and lower for negative optional filters. In contrast to regular filters, records that don\'t match the optional filter are still included in the results, only their ranking is affected.
  */
 export type OptionalFilters = MixedSearchFilters[] | string;