@algolia/recommend 5.0.0-alpha.72 → 5.0.0-alpha.75

package/dist/model/deletedAtResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Response, taskID, and deletion timestamp.
+ */
+export type DeletedAtResponse = {
+    /**
+     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+     */
+    taskID: number;
+    /**
+     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    deletedAt: string;
+};
+//# sourceMappingURL=deletedAtResponse.d.ts.map

package/dist/model/deletedAtResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deletedAtResponse.d.ts","sourceRoot":"","sources":["../../model/deletedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/distinct.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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;
 //# sourceMappingURL=distinct.d.ts.map

package/dist/model/edit.d.ts

@@ -0,0 +1,13 @@
+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;
+};
+//# sourceMappingURL=edit.d.ts.map

package/dist/model/edit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"edit.d.ts","sourceRoot":"","sources":["../../model/edit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/editType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Type of edit.
+ */
+export type EditType = 'remove' | 'replace';
+//# sourceMappingURL=editType.d.ts.map

package/dist/model/editType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editType.d.ts","sourceRoot":"","sources":["../../model/editType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC"}

package/dist/model/exactOnSingleWordQuery.d.ts

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

package/dist/model/facetFilters.d.ts

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

package/dist/model/facetOrdering.d.ts

@@ -1,12 +1,12 @@
 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/dist/model/facets.d.ts

@@ -1,5 +1,5 @@
 /**
- * The ordering of facets (widgets).
+ * Ordering of facets (widgets).
  */
 export type Facets = {
     /**

package/dist/model/facetsStats.d.ts

@@ -1,18 +1,18 @@
 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/dist/model/getRecommendTaskResponse.d.ts

@@ -0,0 +1,5 @@
+import type { TaskStatus } from './taskStatus';
+export type GetRecommendTaskResponse = {
+    status: TaskStatus;
+};
+//# sourceMappingURL=getRecommendTaskResponse.d.ts.map

package/dist/model/getRecommendTaskResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRecommendTaskResponse.d.ts","sourceRoot":"","sources":["../../model/getRecommendTaskResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC;CACpB,CAAC"}

package/dist/model/getRecommendationsParams.d.ts

@@ -1,10 +1,10 @@
 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/dist/model/highlightResultOption.d.ts

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

package/dist/model/ignorePlurals.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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;
 //# sourceMappingURL=ignorePlurals.d.ts.map

package/dist/model/index.d.ts

@@ -1,7 +1,10 @@
 export * from './advancedSyntaxFeatures';
 export * from './alternativesAsExact';
+export * from './anchoring';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
+export * from './automaticFacetFilter';
+export * from './automaticFacetFilters';
 export * from './baseRecommendRequest';
 export * from './baseRecommendationRequest';
 export * from './baseSearchParams';
@@ -9,13 +12,23 @@ export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
 export * from './baseSearchResponseRedirect';
 export * from './baseTrendingRequest';
+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 './facetFilters';
 export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
+export * from './getRecommendTaskResponse';
 export * from './getRecommendationsParams';
 export * from './getRecommendationsResponse';
 export * from './highlightResult';
@@ -29,12 +42,17 @@ 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 './recommendationsRequest';
@@ -44,12 +62,17 @@ 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 './snippetResult';
 export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './tagFilters';
+export * from './taskStatus';
 export * from './trendingModels';
 export * from './trendingRequest';
 export * from './typoTolerance';

package/dist/model/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6CAA6C,CAAC;AAC5D,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6CAA6C,CAAC;AAC5D,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}

package/dist/model/indexSettingsAsSearchParams.d.ts

@@ -12,43 +12,43 @@ import type { RenderingContent } from './renderingContent';
 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[];
     /**
-     * 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.
+     * Restricts a query to only look at a subset of your [searchable attributes](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/).
      */
     restrictSearchableAttributes?: string[];
     /**
-     * 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;
     /**
@@ -60,15 +60,15 @@ 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;
     typoTolerance?: TypoTolerance;
@@ -77,29 +77,29 @@ 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[];
     ignorePlurals?: IgnorePlurals;
     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;
     queryType?: QueryType;
@@ -107,33 +107,33 @@ export type IndexSettingsAsSearchParams = {
     mode?: Mode;
     semanticSearch?: IndexSettingsAsSearchParamsSemanticSearch;
     /**
-     * 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[];
     /**
-     * Enriches the API’s response with meta-information as to how the query was processed.
+     * Enriches the API\'s response with information about how the query was processed.
      */
     explain?: string[];
     distinct?: Distinct;
     /**
-     * Name of the de-duplication attribute to be used with the distinct feature.
+     * Name of the deduplication attribute to be used with Algolia\'s [_distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).
      */
     attributeForDistinct?: string;
     /**
@@ -145,19 +145,19 @@ export type IndexSettingsAsSearchParams = {
      */
     replaceSynonymsInHighlight?: boolean;
     /**
-     * Precision of the proximity ranking criterion.
+     * Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity).
      */
     minProximity?: number;
     /**
-     * Choose which fields to return in the API response. This parameters applies to search and browse queries.
+     * Attributes to include in the API response for search and browse queries.
      */
     responseFields?: string[];
     /**
-     * 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.
+     * 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).
      */
     maxFacetHits?: number;
     /**
-     * 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;

package/dist/model/indexSettingsAsSearchParamsSemanticSearch.d.ts

@@ -1,9 +1,9 @@
 /**
- * The settings relevant for configuration of the semantic search engine. These settings are only used when the mode is set to \'neuralSearch\'.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
  */
 export type IndexSettingsAsSearchParamsSemanticSearch = {
     /**
-     * When null, the current index / replica group will be used as the event source.
+     * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
      */
     eventSources?: string[] | null;
 };

package/dist/model/mode.d.ts

@@ -1,5 +1,5 @@
 /**
- * The search mode that the index will use to query for results.
+ * Search mode the index will use to query for results.
  */
 export type Mode = 'keywordSearch' | 'neuralSearch';
 //# sourceMappingURL=mode.d.ts.map

package/dist/model/numericFilters.d.ts

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

package/dist/model/optionalFilters.d.ts

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

package/dist/model/params.d.ts

@@ -0,0 +1,13 @@
+import type { AutomaticFacetFilters } from './automaticFacetFilters';
+import type { ConsequenceQuery } from './consequenceQuery';
+import type { RenderingContent } from './renderingContent';
+/**
+ * Additional search parameters.
+ */
+export type Params = {
+    query?: ConsequenceQuery;
+    automaticFacetFilters?: AutomaticFacetFilters;
+    automaticOptionalFacetFilters?: AutomaticFacetFilters;
+    renderingContent?: RenderingContent;
+};
+//# sourceMappingURL=params.d.ts.map

package/dist/model/params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../model/params.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAE9C,6BAA6B,CAAC,EAAE,qBAAqB,CAAC;IAEtD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}

package/dist/model/promote.d.ts

@@ -0,0 +1,4 @@
+import type { PromoteObjectID } from './promoteObjectID';
+import type { PromoteObjectIDs } from './promoteObjectIDs';
+export type Promote = PromoteObjectID | PromoteObjectIDs;
+//# sourceMappingURL=promote.d.ts.map

package/dist/model/promote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promote.d.ts","sourceRoot":"","sources":["../../model/promote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC"}

package/dist/model/promoteObjectID.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Record to promote.
+ */
+export type PromoteObjectID = {
+    /**
+     * Unique identifier of the record to promote.
+     */
+    objectID: string;
+    /**
+     * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
+     */
+    position: number;
+};
+//# sourceMappingURL=promoteObjectID.d.ts.map

package/dist/model/promoteObjectID.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promoteObjectID.d.ts","sourceRoot":"","sources":["../../model/promoteObjectID.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/promoteObjectIDs.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Records to promote.
+ */
+export type PromoteObjectIDs = {
+    /**
+     * Unique identifiers of the records to promote.
+     */
+    objectIDs: string[];
+    /**
+     * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
+     */
+    position: number;
+};
+//# sourceMappingURL=promoteObjectIDs.d.ts.map

package/dist/model/promoteObjectIDs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promoteObjectIDs.d.ts","sourceRoot":"","sources":["../../model/promoteObjectIDs.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/queryType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Controls if and how query words are interpreted as prefixes.
+ * Determines how query words are [interpreted as prefixes](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';
 //# sourceMappingURL=queryType.d.ts.map

package/dist/model/reRankingApplyFilter.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ * When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
  */
 export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

package/dist/model/recommendHit.d.ts

@@ -2,11 +2,11 @@ import type { HighlightResult } from './highlightResult';
 import type { RankingInfo } from './rankingInfo';
 import type { SnippetResult } from './snippetResult';
 /**
- * A Recommend hit.
+ * Recommend hit.
  */
 export type RecommendHit = Record<string, any> & {
     /**
-     * Unique identifier of the object.
+     * Unique object identifier.
      */
     objectID: string;
     /**
@@ -20,7 +20,7 @@ export type RecommendHit = Record<string, any> & {
     _rankingInfo?: RankingInfo;
     _distinctSeqID?: number;
     /**
-     * The recommendation score.
+     * Recommendation score.
      */
     _score: number;
 };

package/dist/model/recommendModels.d.ts

@@ -0,0 +1,2 @@
+export type RecommendModels = 'bought-together' | 'related-products' | 'trending-facets' | 'trending-items';
+//# sourceMappingURL=recommendModels.d.ts.map

package/dist/model/recommendModels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendModels.d.ts","sourceRoot":"","sources":["../../model/recommendModels.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,CAAC"}

package/dist/model/recommendationModels.d.ts

@@ -1,5 +1,5 @@
 /**
- * The recommendation model to use.
+ * Recommendation model.
  */
 export type RecommendationModels = 'bought-together' | 'related-products';
 //# sourceMappingURL=recommendationModels.d.ts.map

package/dist/model/redirectRuleIndexMetadata.d.ts

@@ -13,7 +13,7 @@ export type RedirectRuleIndexMetadata = {
      */
     reason: string;
     /**
-     * Status for the redirect rule.
+     * Redirect rule status.
      */
     succeed: boolean;
     data: RedirectRuleIndexMetadataData;

package/dist/model/redirectRuleIndexMetadataData.d.ts

@@ -1,5 +1,5 @@
 /**
- * Data for the redirect rule.
+ * Redirect rule data.
  */
 export type RedirectRuleIndexMetadataData = {
     ruleObjectID: string;

package/dist/model/removeStopWords.d.ts

@@ -1,5 +1,5 @@
 /**
- * Removes stop (common) words from the query before executing it. RemoveStopWords 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 stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ * Removes stop (common) words from the query before executing it. `removeStopWords` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. 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 stop words feature, allowing stop words to be taken into account in a search.
  */
 export type RemoveStopWords = string[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map