@algolia/recommend 5.0.0-alpha.106 → 5.0.0-alpha.107

package/model/promoteObjectID.ts

@@ -5,12 +5,12 @@
  */
 export type PromoteObjectID = {
   /**
-   * Unique identifier of the record to promote.
+   * Unique record identifier.
    */
   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 in the search results where you want to show the promoted records.
    */
   position: number;
 };

package/model/promoteObjectIDs.ts

@@ -5,12 +5,12 @@
  */
 export type PromoteObjectIDs = {
   /**
-   * Unique identifiers of the records to promote.
+   * Object IDs of the records you want to promote.  The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
    */
   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 in the search results where you want to show the promoted records.
    */
   position: number;
 };

package/model/queryType.ts

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

package/model/rankingInfo.ts

@@ -3,14 +3,17 @@
 import type { MatchedGeoLocation } from './matchedGeoLocation';
 import type { Personalization } from './personalization';
 
+/**
+ * Object with detailed information about the record\'s ranking.
+ */
 export type RankingInfo = {
   /**
-   * This field is reserved for advanced usage.
+   * Whether a filter matched the query.
    */
   filters: number;
 
   /**
-   * Position of the most important matched attribute in the attributes to index list.
+   * Position of the first matched word in the best matching attribute of the record.
    */
   firstMatchedWord: number;
 
@@ -39,27 +42,27 @@ export type RankingInfo = {
   nbTypos: number;
 
   /**
-   * Present and set to true if a Rule promoted the hit.
+   * Whether the record was promoted by a rule.
    */
   promoted: boolean;
 
   /**
-   * When the query contains more than one word, the sum of the distances between matched words (in meters).
+   * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
    */
   proximityDistance?: number;
 
   /**
-   * Custom ranking for the object, expressed as a single integer value.
+   * Overall ranking of the record, expressed as a single integer. This attribute is internal.
    */
   userScore: number;
 
   /**
-   * Number of matched words, including prefixes and typos.
+   * Number of matched words.
    */
   words: number;
 
   /**
-   * Wether the record are promoted by the re-ranking strategy.
+   * Whether the record is re-ranked.
    */
   promotedByReRanking?: boolean;
 };

package/model/reRankingApplyFilter.ts

@@ -3,6 +3,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * 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.
+ * Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
 export type ReRankingApplyFilter = MixedSearchFilters[] | string;

package/model/recommendHit.ts

@@ -9,17 +9,17 @@ import type { SnippetResult } from './snippetResult';
  */
 export type RecommendHit = Record<string, any> & {
   /**
-   * Unique object identifier.
+   * Unique record identifier.
    */
   objectID: string;
 
   /**
-   * Show highlighted section and words matched on a query.
+   * Surround words that match the query with HTML tags for highlighting.
    */
   _highlightResult?: Record<string, HighlightResult>;
 
   /**
-   * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+   * Snippets that show the context around a matching search query.
    */
   _snippetResult?: Record<string, SnippetResult>;
 

package/model/recommendationsHits.ts

@@ -6,7 +6,7 @@ export type RecommendationsHits = {
   hits: RecommendationsHit[];
 
   /**
-   * Text to search for in an index.
+   * Search query.
    */
   query?: string;
 

package/model/removeStopWords.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * 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.
+ * Removes stop words from the search query.  Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.  You should only use this feature for the languages used in your index.
  */
 export type RemoveStopWords = string[] | boolean;

package/model/removeWordsIfNoResults.ts

@@ -1,7 +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.
 
 /**
- * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
+ * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  <dl> <dt><code>none</code></dt> <dd>No words are removed when a query doesn\'t return results.</dd> <dt><code>lastWords</code></dt> <dd>Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed.</dd> <dt><code>firstWords</code></dt> <dd>Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed.</dd> <dt><code>allOptional</code></dt> <dd>Treat all words as optional.</dd> </dl>  For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
  */
 export type RemoveWordsIfNoResults =
   | 'allOptional'

package/model/renderingContent.ts

@@ -3,7 +3,7 @@
 import type { FacetOrdering } from './facetOrdering';
 
 /**
- * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
+ * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
  */
 export type RenderingContent = {
   facetOrdering?: FacetOrdering;

package/model/searchParamsQuery.ts

@@ -2,7 +2,7 @@
 
 export type SearchParamsQuery = {
   /**
-   * Text to search for in an index.
+   * Search query.
    */
   query?: string;
 };

package/model/searchRecommendRulesParams.ts

@@ -5,7 +5,7 @@
  */
 export type SearchRecommendRulesParams = {
   /**
-   * Full-text query.
+   * Search query.
    */
   query?: string;
 
@@ -15,7 +15,7 @@ export type SearchRecommendRulesParams = {
   context?: string;
 
   /**
-   * Requested page (the first page is page 0).
+   * Requested page of the API response.
    */
   page?: number;
 

package/model/searchRecommendRulesResponse.ts

@@ -9,17 +9,17 @@ export type SearchRecommendRulesResponse = {
   hits: RuleResponse[];
 
   /**
-   * Number of hits the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 
   /**
-   * Page to retrieve (the first page is `0`, not `1`).
+   * Page of search results to retrieve.
    */
   page: number;
 
   /**
-   * Number of pages of results for the current query.
+   * Number of pages of results.
    */
   nbPages: number;
 };

package/model/semanticSearch.ts

@@ -1,11 +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.
 
 /**
- * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
  */
 export type SemanticSearch = {
   /**
-   * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+   * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
    */
   eventSources?: string[] | null;
 };

package/model/snippetResultOption.ts

@@ -3,11 +3,11 @@
 import type { MatchLevel } from './matchLevel';
 
 /**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ * Snippets that show the context around a matching search query.
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with `facetQuery` matches highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 

package/model/sortRemainingBy.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  <dl> <dt><code>count</code></dt> <dd> Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Sort facet values alphabetically.</dd> <dt><code>hidden</code></dt> <dd>Don\'t show facet values that aren\'t explicitly positioned.</dd> </dl>.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/model/tagFilters.ts

@@ -3,6 +3,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
+ * Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
  */
 export type TagFilters = MixedSearchFilters[] | string;

package/model/taskStatus.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * _published_ if the task has been processed, _notPublished_ otherwise.
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
  */
 export type TaskStatus = 'notPublished' | 'published';

package/model/typoTolerance.ts

@@ -3,6 +3,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;

package/model/typoToleranceEnum.ts

@@ -1,3 +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.
 
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
 export type TypoToleranceEnum = 'min' | 'strict';

package/model/value.ts

@@ -4,7 +4,7 @@ import type { SortRemainingBy } from './sortRemainingBy';
 
 export type Value = {
   /**
-   * 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/recommend",
-  "version": "5.0.0-alpha.106",
+  "version": "5.0.0-alpha.107",
   "description": "JavaScript client for recommend",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.107",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.107",
-    "@algolia/requester-node-http": "5.0.0-alpha.107"
+    "@algolia/client-common": "5.0.0-alpha.108",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.108",
+    "@algolia/requester-node-http": "5.0.0-alpha.108"
   },
   "devDependencies": {
-    "@types/node": "20.11.24",
-    "rollup": "4.12.0",
-    "typescript": "5.3.3"
+    "@types/node": "20.11.25",
+    "rollup": "4.12.1",
+    "typescript": "5.4.2"
   },
   "engines": {
     "node": ">= 14.0.0"