algoliasearch 5.0.0-alpha.72 → 5.0.0-alpha.75

package/dist/client-search/model/createdAtResponse.d.ts

@@ -1,9 +1,9 @@
 /**
- * The response with a createdAt timestamp.
+ * Response and creation timestamp.
  */
 export type CreatedAtResponse = {
     /**
-     * Date of creation (ISO-8601 format).
+     * Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     createdAt: string;
 };

package/dist/client-search/model/cursor.d.ts

@@ -1,6 +1,6 @@
 export type Cursor = {
     /**
-     * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
+     * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached, `cursor` is absent from the response.
      */
     cursor?: string;
 };

package/dist/client-search/model/deleteApiKeyResponse.d.ts

@@ -1,6 +1,6 @@
 export type DeleteApiKeyResponse = {
     /**
-     * Date of deletion (ISO-8601 format).
+     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     deletedAt: string;
 };

package/dist/client-search/model/deleteByParams.d.ts

@@ -5,22 +5,22 @@ import type { TagFilters } from './tagFilters';
 export type DeleteByParams = {
     facetFilters?: FacetFilters;
     /**
-     * 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;
     numericFilters?: NumericFilters;
     tagFilters?: TagFilters;
     /**
-     * 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;
     aroundRadius?: AroundRadius;
     /**
-     * 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[];
 };

package/dist/client-search/model/deleteSourceResponse.d.ts

@@ -1,6 +1,6 @@
 export type DeleteSourceResponse = {
     /**
-     * Date of deletion (ISO-8601 format).
+     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     deletedAt: string;
 };

package/dist/client-search/model/deletedAtResponse.d.ts

@@ -1,13 +1,13 @@
 /**
- * The response with a taskID and a deletedAt timestamp.
+ * Response, taskID, and deletion timestamp.
  */
 export type DeletedAtResponse = {
     /**
-     * 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;
     /**
-     * Date of deletion (ISO-8601 format).
+     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     deletedAt: string;
 };

package/dist/client-search/model/dictionaryEntry.d.ts

@@ -1,26 +1,26 @@
 import type { DictionaryEntryState } from './dictionaryEntryState';
 /**
- * A dictionary entry.
+ * Dictionary entry.
  */
 export type DictionaryEntry = Record<string, any> & {
     /**
-     * Unique identifier of the object.
+     * Unique identifier for a dictionary object.
      */
     objectID: string;
     /**
-     * Language ISO code supported by the dictionary (e.g., \"en\" for English).
+     * [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
      */
     language: string;
     /**
-     * The word of the dictionary entry.
+     * Dictionary entry word. Usage depends on the type of dictionary entry. **`stopwordEntry`** The stop word you want to add or update. If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`. **`compoundEntry`** When `decomposition` is empty: adds `word` as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into \"kopf\" and \"kino\". When `decomposition` isn\'t empty: creates a decomposition exception. For example, when decomposition is set to the [\"hund\", \"hutte\"] exception, \"hundehutte\" decomposes into “hund” and “hutte”, discarding the linking \"e\".
      */
     word?: string;
     /**
-     * The words of the dictionary entry.
+     * Compound dictionary [word declensions](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/). If the entry already exists in Algolia\'s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`.
      */
     words?: string[];
     /**
-     * A decomposition of the word of the dictionary entry.
+     * For compound entries, governs the behavior of the `word` parameter.
      */
     decomposition?: string[];
     state?: DictionaryEntryState;

package/dist/client-search/model/dictionaryEntryState.d.ts

@@ -1,5 +1,5 @@
 /**
- * The state of the dictionary entry.
+ * Indicates whether a dictionary entry is active (`enabled`) or inactive (`disabled`).
  */
 export type DictionaryEntryState = 'disabled' | 'enabled';
 //# sourceMappingURL=dictionaryEntryState.d.ts.map

package/dist/client-search/model/dictionaryLanguage.d.ts

@@ -3,8 +3,8 @@
  */
 export type DictionaryLanguage = {
     /**
-     * When nbCustomEntries is set to 0, the user didn\'t customize the dictionary. The dictionary is still supported with standard, Algolia-provided entries.
+     * If `0`, the dictionary hasn\'t been customized and only contains standard entries provided by Algolia. If `null`, that feature isn\'t available or isn\'t supported for that language.
      */
-    nbCustomEntires?: number;
+    nbCustomEntries?: number;
 };
 //# sourceMappingURL=dictionaryLanguage.d.ts.map

package/dist/client-search/model/dictionarySettingsParams.d.ts

@@ -1,6 +1,6 @@
 import type { StandardEntries } from './standardEntries';
 /**
- * Disable the builtin Algolia entries for a type of dictionary per language.
+ * Enable or turn off the built-in Algolia stop words for a specific language.
  */
 export type DictionarySettingsParams = {
     disableStandardEntries: StandardEntries;

package/dist/client-search/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/client-search/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/client-search/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/client-search/model/facetHits.d.ts

@@ -1,14 +1,14 @@
 export type FacetHits = {
     /**
-     * Raw value of the facet.
+     * Facet value.
      */
     value: string;
     /**
-     * Markup text with occurrences highlighted.
+     * Markup text with `facetQuery` matches highlighted.
      */
     highlighted: string;
     /**
-     * How many objects contain this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the counts may not be exhaustive.
+     * Number of records containing this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the [counts may not be exhaustive](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
      */
     count: number;
 };

package/dist/client-search/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/client-search/model/facets.d.ts

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

package/dist/client-search/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/client-search/model/fetchedIndex.d.ts

@@ -8,7 +8,7 @@ export type FetchedIndex = {
      */
     createdAt: 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;
     /**

package/dist/client-search/model/getObjectsParams.d.ts

@@ -1,6 +1,6 @@
 import type { GetObjectsRequest } from './getObjectsRequest';
 /**
- * The `getObjects` parameters.
+ * Request parameters.
  */
 export type GetObjectsParams = {
     requests: GetObjectsRequest[];

package/dist/client-search/model/getObjectsRequest.d.ts

@@ -1,17 +1,17 @@
 /**
- * GetObjects operation on an index.
+ * Record retrieval operation.
  */
 export type GetObjectsRequest = {
     /**
-     * List of attributes to retrieve. By default, all retrievable attributes are returned.
+     * Attributes to retrieve. If not specified, all retrievable attributes are returned.
      */
     attributesToRetrieve?: string[];
     /**
-     * ID of the object within that index.
+     * Record\'s objectID.
      */
     objectID: string;
     /**
-     * Name of the index containing the object.
+     * Name of the index containing the required records.
      */
     indexName: string;
 };

package/dist/client-search/model/getObjectsResponse.d.ts

@@ -1,6 +1,6 @@
 export type GetObjectsResponse<T = Record<string, any>> = {
     /**
-     * List of results fetched.
+     * Retrieved results.
      */
     results: T[];
 };

package/dist/client-search/model/getTopUserIdsResponse.d.ts

@@ -1,10 +1,10 @@
 import type { UserId } from './userId';
 /**
- * Array of userIDs and clusters.
+ * User IDs and clusters.
  */
 export type GetTopUserIdsResponse = {
     /**
-     * Mapping of cluster names to top users.
+     * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
      */
     topUsers: Array<Record<string, UserId[]>>;
 };

package/dist/client-search/model/hasPendingMappingsResponse.d.ts

@@ -1,10 +1,10 @@
 export type HasPendingMappingsResponse = {
     /**
-     * If there is any clusters with pending mapping state.
+     * Indicates whether there are clusters undergoing migration, creation, or deletion.
      */
     pending: boolean;
     /**
-     * Describe cluster pending (migrating, creating, deleting) mapping state.
+     * Cluster pending mapping state: migrating, creating, deleting.
      */
     clusters?: Record<string, string[]>;
 };

package/dist/client-search/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/client-search/model/hit.d.ts

@@ -6,7 +6,7 @@ import type { SnippetResult } from './snippetResult';
  */
 export type Hit<T = Record<string, any>> = T & {
     /**
-     * Unique identifier of the object.
+     * Unique object identifier.
      */
     objectID: string;
     /**

package/dist/client-search/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/client-search/model/indexSettings.d.ts

@@ -1,7 +1,7 @@
 import type { BaseIndexSettings } from './baseIndexSettings';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
 /**
- * The Algolia index settings.
+ * Algolia index settings.
  */
 export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;
 //# sourceMappingURL=indexSettings.d.ts.map

package/dist/client-search/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/client-search/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/client-search/model/languages.d.ts

@@ -1,6 +1,6 @@
 import type { DictionaryLanguage } from './dictionaryLanguage';
 /**
- * A dictionary language.
+ * Dictionary language.
  */
 export type Languages = {
     plurals: DictionaryLanguage | null;

package/dist/client-search/model/listApiKeysResponse.d.ts

@@ -1,7 +1,7 @@
 import type { GetApiKeyResponse } from './getApiKeyResponse';
 export type ListApiKeysResponse = {
     /**
-     * List of api keys.
+     * API keys.
      */
     keys: GetApiKeyResponse[];
 };

package/dist/client-search/model/listClustersResponse.d.ts

@@ -1,9 +1,9 @@
 /**
- * Array of clusters.
+ * Clusters.
  */
 export type ListClustersResponse = {
     /**
-     * Mapping of cluster names to top users.
+     * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
      */
     topUsers: string[];
 };

package/dist/client-search/model/listIndicesResponse.d.ts

@@ -1,7 +1,7 @@
 import type { FetchedIndex } from './fetchedIndex';
 export type ListIndicesResponse = {
     /**
-     * List of the fetched indices.
+     * All indices in your Algolia application.
      */
     items: FetchedIndex[];
     /**

package/dist/client-search/model/listUserIdsResponse.d.ts

@@ -1,10 +1,10 @@
 import type { UserId } from './userId';
 /**
- * UserIDs data.
+ * User ID data.
  */
 export type ListUserIdsResponse = {
     /**
-     * List of userIDs.
+     * User IDs.
      */
     userIDs: UserId[];
 };