algoliasearch 5.0.0-alpha.73 → 5.0.0-alpha.76

package/dist/lite/model/synonymHit.d.ts

@@ -4,20 +4,20 @@ import type { SynonymType } from './synonymType';
  */
 export type SynonymHit = {
     /**
-     * Unique identifier of the synonym object to be created or updated.
+     * Unique identifier of a synonym object.
      */
     objectID: string;
     type: SynonymType;
     /**
-     * Words or phrases to be considered equivalent.
+     * Words or phrases considered equivalent.
      */
     synonyms?: string[];
     /**
-     * Word or phrase to appear in query strings (for onewaysynonym).
+     * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
      */
     input?: string;
     /**
-     * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
+     * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
      */
     word?: string;
     /**
@@ -25,11 +25,11 @@ export type SynonymHit = {
      */
     corrections?: string[];
     /**
-     * Token to be put inside records.
+     * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
      */
     placeholder?: string;
     /**
-     * List of query words that will match the token.
+     * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
      */
     replacements?: string[];
 };

package/dist/lite/model/synonymType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type of the synonym object.
+ * Synonym type.
  */
 export type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
 //# sourceMappingURL=synonymType.d.ts.map

package/dist/lite/model/tagFilters.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * Filter hits by tags.
+ * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
  */
 export type TagFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=tagFilters.d.ts.map

package/dist/lite/model/taskStatus.d.ts

@@ -1,2 +1,5 @@
+/**
+ * _published_ if the task has been processed, _notPublished_ otherwise.
+ */
 export type TaskStatus = 'notPublished' | 'published';
 //# sourceMappingURL=taskStatus.d.ts.map

package/dist/lite/model/taskStatus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"taskStatus.d.ts","sourceRoot":"","sources":["../../../lite/model/taskStatus.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,WAAW,CAAC"}
+{"version":3,"file":"taskStatus.d.ts","sourceRoot":"","sources":["../../../lite/model/taskStatus.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,WAAW,CAAC"}

package/dist/lite/model/typoTolerance.d.ts

@@ -1,6 +1,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 /**
- * Controls whether typo tolerance is enabled and how it is applied.
+ * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;
 //# sourceMappingURL=typoTolerance.d.ts.map

package/dist/lite/model/updatedRuleResponse.d.ts

@@ -1,14 +1,14 @@
 export type UpdatedRuleResponse = {
     /**
-     * Unique identifier of the object.
+     * Unique object identifier.
      */
     objectID: string;
     /**
-     * Date of last update (ISO-8601 format).
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     updatedAt: string;
     /**
-     * TaskID of the task to wait for.
+     * 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;
 };

package/dist/lite/model/userId.d.ts

@@ -1,5 +1,5 @@
 /**
- * A userID.
+ * Unique user ID.
  */
 export type UserId = {
     /**
@@ -7,7 +7,7 @@ export type UserId = {
      */
     userID: string;
     /**
-     * Cluster on which the user is assigned.
+     * Cluster to which the user is assigned.
      */
     clusterName: string;
     /**

package/dist/lite/src/liteClient.d.ts

@@ -2,7 +2,7 @@ import type { CreateClientOptions, RequestOptions } from '@algolia/client-common
 import type { PostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponses } from '../model/searchResponses';
-export declare const apiClientVersion = "5.0.0-alpha.73";
+export declare const apiClientVersion = "5.0.0-alpha.76";
 export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: import("@algolia/client-common").Transporter;
     /**
@@ -29,17 +29,17 @@ export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOpt
      *
      * @summary Send requests to the Algolia REST API.
      * @param post - The post object.
-     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param post.parameters - Query parameters to be applied to the current query.
-     * @param post.body - The parameters to send with the custom request.
+     * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param post.parameters - Query parameters to apply to the current query.
+     * @param post.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Perform a search operation targeting one or many indices.
+     * Send multiple search queries to one or more indices.
      *
      * @summary Search multiple indices.
-     * @param searchMethodParams - The `search` requests and strategy.
+     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;

package/lite/model/acl.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.
 
 /**
- * List of rights for the API key. The following rights can be used:  addObject: allows to add/update an object in the index (copy/move index are also allowed with this right). Analytics: allows to retrieve the analytics through the Analytics API. Browse: allows to retrieve all index content via the browse API. DeleteIndex: allows to delete or clear index content. DeleteObject: allows to delete objects from the index. EditSettings: allows to change index settings. ListIndexes: allows to list all accessible indices. Logs: allows to get the logs. Recommendation: Allows usage of the Personalization dashboard and the Recommendation API. Search: allows to search the index. SeeUnretrievableAttributes: disable unretrievableAttributes feature for all operations returning records. Settings: allows to get index settings.
+ * API key permissions:  `addObject`: required to add or update records, copy or move an index. `analytics`: required to access the Analytics API. `browse`: required to view records `deleteIndex`: required to delete indices. `deleteObject`: required to delete records. `editSettings`: required to change index settings. `listIndexes`: required to list indices. `logs`: required to access logs of search and indexing operations. `recommendation`: required to access the Personalization and Recommend APIs. `search`: required to search records `seeUnretrievableAttributes`: required to retrieve [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) for all operations that return records. `settings`: required to examine index settings.
  */
 export type Acl =
   | 'addObject'

package/lite/model/action.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.
 
 /**
- * Type of operation.
+ * Type of batch operation.
  */
 export type Action =
   | 'addObject'

package/lite/model/addApiKeyResponse.ts

@@ -2,12 +2,12 @@
 
 export type AddApiKeyResponse = {
   /**
-   * The API key.
+   * API key.
    */
   key: string;
 
   /**
-   * Date of creation (ISO-8601 format).
+   * Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   createdAt: string;
 };

package/lite/model/anchoring.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.
 
 /**
- * Whether the pattern parameter must match the beginning or the end of the query string, or both, or none.
+ * Whether the pattern parameter matches the beginning (`startsWith`) or end (`endsWith`) of the query string, is an exact match (`is`), or a partial match (`contains`).
  */
 export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';

package/lite/model/apiKey.ts

@@ -3,46 +3,46 @@
 import type { Acl } from './acl';
 
 /**
- * Api Key object.
+ * API key object.
  */
 export type ApiKey = {
   /**
-   * Set of permissions associated with the key.
+   * [Permissions](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl) associated with the key.
    */
   acl: Acl[];
 
   /**
-   * A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.
+   * Description of an API key for you and your team members.
    */
   description?: string;
 
   /**
-   * Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.
+   * Restricts this API key to a list of indices or index patterns. If the list is empty, all indices are allowed. Specify either an exact index name or a pattern with a leading or trailing wildcard character (or both). For example: - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\".
    */
   indexes?: string[];
 
   /**
-   * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
+   * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced. > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
    */
   maxHitsPerQuery?: number;
 
   /**
-   * Maximum number of API calls per hour allowed from a given IP address or a user token.
+   * Maximum number of API calls per hour allowed from a given IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). Each time an API call is performed with this key, a check is performed. If there were more than the specified number of calls within the last hour, the API returns an error with the status code `429` (Too Many Requests).  > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
    */
   maxQueriesPerIPPerHour?: number;
 
   /**
-   * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+   * Force some [query parameters](https://www.algolia.com/doc/api-reference/api-parameters/) to be applied for each query made with this API key. It\'s a URL-encoded query string.
    */
   queryParameters?: string;
 
   /**
-   * Restrict this new API key to specific referers. If empty or blank, defaults to all referers.
+   * Restrict this API key to specific [referrers](https://www.algolia.com/doc/guides/security/api-keys/in-depth/api-key-restrictions/#http-referrers). If empty, all referrers are allowed. For example: - `https://algolia.com/_*` matches all referrers starting with \"https://algolia.com/\" - `*.algolia.com` matches all referrers ending with \".algolia.com\" - `*algolia.com*` allows everything in the domain \"algolia.com\".
    */
   referers?: string[];
 
   /**
-   * Validity limit for this key in seconds. The key will automatically be removed after this period of time.
+   * Validity duration of a key (in seconds).  The key will automatically be removed after this time has expired. The default value of 0 never expires. Short-lived API keys are useful to grant temporary access to your data. For example, in mobile apps, you can\'t [control when users update your app](https://www.algolia.com/doc/guides/security/security-best-practices/#use-secured-api-keys-in-mobile-apps). So instead of encoding keys into your app as you would for a web app, you should dynamically fetch them from your mobile app\'s backend.
    */
   validity?: number;
 };

package/lite/model/aroundRadius.ts

@@ -3,6 +3,6 @@
 import type { AroundRadiusAll } from './aroundRadiusAll';
 
 /**
- * Define the maximum radius for a geo search (in meters).
+ * [Maximum radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius) for a geographical search (in meters).
  */
 export type AroundRadius = AroundRadiusAll | number;

package/lite/model/baseGetApiKeyResponse.ts

@@ -2,12 +2,12 @@
 
 export type BaseGetApiKeyResponse = {
   /**
-   * The API key.
+   * API key.
    */
   value?: string;
 
   /**
-   * Time of the event expressed in milliseconds since the Unix epoch.
+   * Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
    */
   createdAt: number;
 };

package/lite/model/baseIndexSettings.ts

@@ -2,67 +2,67 @@
 
 export type BaseIndexSettings = {
   /**
-   * Creates replicas, exact copies of an index.
+   * Creates [replicas](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/), which are copies of a primary index with the same records but different settings.
    */
   replicas?: string[];
 
   /**
-   * Set the maximum number of hits accessible via pagination.
+   * Maximum number of hits accessible through pagination.
    */
   paginationLimitedTo?: number;
 
   /**
-   * List of attributes that can\'t be retrieved at query time.
+   * Attributes that can\'t be retrieved at query time.
    */
   unretrievableAttributes?: string[];
 
   /**
-   * A list of words for which you want to turn off typo tolerance.
+   * Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
    */
   disableTypoToleranceOnWords?: string[];
 
   /**
-   * Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.
+   * Attributes in your index to which [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead) applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.
    */
   attributesToTransliterate?: string[];
 
   /**
-   * List of attributes on which to do a decomposition of camel case words.
+   * Attributes on which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
    */
   camelCaseAttributes?: string[];
 
   /**
-   * Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.
+   * Attributes in your index to which [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding) applies.
    */
   decompoundedAttributes?: Record<string, any>;
 
   /**
-   * Sets the languages at the index level for language-specific processing such as tokenization and normalization.
+   * Set the languages of your index, for language-specific processing steps such as [tokenization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/tokenization/) and [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
    */
   indexLanguages?: string[];
 
   /**
-   * List of attributes on which you want to disable prefix matching.
+   * Attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
    */
   disablePrefixOnAttributes?: string[];
 
   /**
-   * Enables compression of large integer arrays.
+   * Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.
    */
   allowCompressionOfIntegerArray?: boolean;
 
   /**
-   * List of numeric attributes that can be used as numerical filters.
+   * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
    */
   numericAttributesForFiltering?: string[];
 
   /**
-   * Control which separators are indexed.
+   * Controls which separators are added to an Algolia index as part of [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean). Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
    */
   separatorsToIndex?: string;
 
   /**
-   * The complete list of attributes used for searching.
+   * [Attributes used for searching](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/), including determining [if matches at the beginning of a word are important (ordered) or not (unordered)](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/how-to/configuring-searchable-attributes-the-right-way/#understanding-word-position).
    */
   searchableAttributes?: string[];
 
@@ -72,7 +72,7 @@ export type BaseIndexSettings = {
   userData?: Record<string, any>;
 
   /**
-   * Overrides Algolia\'s default normalization.
+   * A list of characters and their normalized replacements to override Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
    */
   customNormalization?: Record<string, Record<string, string>>;
 };

package/lite/model/baseSearchParamsWithoutQuery.ts

@@ -9,12 +9,12 @@ import type { TagFilters } from './tagFilters';
 
 export type BaseSearchParamsWithoutQuery = {
   /**
-   * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
+   * Overrides the query parameter and performs a more generic search.
    */
   similarQuery?: string;
 
   /**
-   * Filter the query with numeric, facet and/or tag filters.
+   * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
    */
   filters?: string;
 
@@ -27,22 +27,22 @@ export type BaseSearchParamsWithoutQuery = {
   tagFilters?: TagFilters;
 
   /**
-   * Determines how to calculate the total score for filtering.
+   * Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
    */
   sumOrFiltersScores?: boolean;
 
   /**
-   * Retrieve facets and their facet values.
+   * Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
    */
   facets?: string[];
 
   /**
-   * Maximum number of facet values to return for each facet during a regular search.
+   * Maximum number of facet values to return for each facet.
    */
   maxValuesPerFacet?: number;
 
   /**
-   * Force faceting to be applied after de-duplication (via the Distinct setting).
+   * Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
    */
   facetingAfterDistinct?: boolean;
 
@@ -52,89 +52,89 @@ export type BaseSearchParamsWithoutQuery = {
   sortFacetValuesBy?: string;
 
   /**
-   * Specify the page to retrieve.
+   * Page to retrieve (the first page is `0`, not `1`).
    */
   page?: number;
 
   /**
-   * Specify the offset of the first hit to return.
+   * Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
    */
   offset?: number;
 
   /**
-   * Set the number of hits to retrieve (used only with offset).
+   * Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
    */
   length?: number;
 
   /**
-   * Search for entries around a central geolocation, enabling a geo search within a circular area.
+   * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
    */
   aroundLatLng?: string;
 
   /**
-   * Search for entries around a given location automatically computed from the requester\'s IP address.
+   * Search for entries around a location. The location is automatically computed from the requester\'s IP address.
    */
   aroundLatLngViaIP?: boolean;
 
   aroundRadius?: AroundRadius;
 
   /**
-   * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
+   * Precision of a geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
    */
   aroundPrecision?: number;
 
   /**
-   * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
+   * Minimum radius (in meters) used for a geographical search when `aroundRadius` isn\'t set.
    */
   minimumAroundRadius?: number;
 
   /**
-   * Search inside a rectangular area (in geo coordinates).
+   * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
    */
   insideBoundingBox?: number[];
 
   /**
-   * Search inside a polygon (in geo coordinates).
+   * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
    */
   insidePolygon?: number[];
 
   /**
-   * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
+   * Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
    */
   naturalLanguages?: string[];
 
   /**
-   * Enables contextual rules.
+   * Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
    */
   ruleContexts?: string[];
 
   /**
-   * Define the impact of the Personalization feature.
+   * Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
    */
   personalizationImpact?: number;
 
   /**
-   * Associates a certain user token with the current search.
+   * Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
    */
   userToken?: string;
 
   /**
-   * Retrieve detailed ranking information.
+   * Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
    */
   getRankingInfo?: boolean;
 
   /**
-   * Enable the Click Analytics feature.
+   * Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
    */
   clickAnalytics?: boolean;
 
   /**
-   * Whether the current query will be taken into account in the Analytics.
+   * Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
    */
   analytics?: boolean;
 
   /**
-   * List of tags to apply to the query for analytics purposes.
+   * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   analyticsTags?: string[];
 
@@ -144,12 +144,12 @@ export type BaseSearchParamsWithoutQuery = {
   percentileComputation?: boolean;
 
   /**
-   * Whether this search should participate in running AB tests.
+   * Incidates whether this search will be considered in A/B testing.
    */
   enableABTest?: boolean;
 
   /**
-   * Whether this search should use AI Re-Ranking.
+   * Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
    */
   enableReRanking?: boolean;