algoliasearch 5.0.0-alpha.106 → 5.0.0-alpha.108

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

@@ -4,7 +4,7 @@ export type LogQuery = {
      */
     index_name?: string;
     /**
-     * User identifier.
+     * A user identifier.
      */
     user_token?: string;
     /**

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

@@ -1,5 +1,5 @@
 /**
- * Indicates how well the attribute matched the search query.
+ * Whether the whole query string matches or only a part.
  */
 export type MatchLevel = 'full' | 'none' | 'partial';
 //# sourceMappingURL=matchLevel.d.ts.map

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

@@ -1,5 +1,5 @@
 /**
- * Search mode the index will use to query for results.
+ * Search mode the index will use to query for results.  This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
  */
 export type Mode = 'keywordSearch' | 'neuralSearch';
 //# sourceMappingURL=mode.d.ts.map

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

@@ -1,10 +1,10 @@
 export type MultipleBatchResponse = {
     /**
-     * TaskIDs per index.
+     * Task IDs. One for each index.
      */
     taskID: Record<string, number>;
     /**
-     * Unique object (record) identifiers.
+     * Unique record identifiers.
      */
     objectIDs: string[];
 };

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

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
+ * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
  */
 export type NumericFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=numericFilters.d.ts.map

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

@@ -3,11 +3,11 @@ import type { ScopeType } from './scopeType';
 export type OperationIndexParams = {
     operation: OperationType;
     /**
-     * Algolia index name.
+     * Index name.
      */
     destination: string;
     /**
-     * **This only applies to the _copy_ operation.**  If you omit `scope`, the copy command copies all records, settings, synonyms, and rules.  If you specify `scope`, only the specified scopes are copied.
+     * **Only for copying.**  If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules.
      */
     scope?: ScopeType[];
 };

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

@@ -1,5 +1,5 @@
 /**
- * Operation to perform (_move_ or _copy_).
+ * Operation to perform on the index.
  */
 export type OperationType = 'copy' | 'move';
 //# sourceMappingURL=operationType.d.ts.map

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

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * 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.
+ * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
  */
 export type OptionalFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=optionalFilters.d.ts.map

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

@@ -2,7 +2,7 @@ import type { AutomaticFacetFilters } from './automaticFacetFilters';
 import type { ConsequenceQuery } from './consequenceQuery';
 import type { RenderingContent } from './renderingContent';
 /**
- * Additional search parameters.
+ * Parameters to apply to this search.  You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
  */
 export type Params = {
     query?: ConsequenceQuery;

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

@@ -3,11 +3,11 @@
  */
 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/dist/client-search/model/promoteObjectIDs.d.ts

@@ -3,11 +3,11 @@
  */
 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/dist/client-search/model/queryType.d.ts

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

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

@@ -1,12 +1,15 @@
 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;
     /**
@@ -28,23 +31,23 @@ 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/dist/client-search/model/rankingInfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../../../client-search/model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../../../client-search/model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}

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

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

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

@@ -1,5 +1,6 @@
+import type { SupportedLanguage } from './supportedLanguage';
 /**
- * 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;
+export type RemoveStopWords = SupportedLanguage[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

package/dist/client-search/model/removeStopWords.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"removeStopWords.d.ts","sourceRoot":"","sources":["../../../../client-search/model/removeStopWords.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC"}
+{"version":3,"file":"removeStopWords.d.ts","sourceRoot":"","sources":["../../../../client-search/model/removeStopWords.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAC"}

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

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

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

@@ -1,6 +1,6 @@
 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/dist/client-search/model/rule.d.ts

@@ -6,24 +6,24 @@ import type { TimeRange } from './timeRange';
  */
 export type Rule = {
     /**
-     * Unique identifier for a rule object.
+     * Unique identifier of a rule object.
      */
     objectID: string;
     /**
-     * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
+     * Conditions that trigger a rule.  Some consequences require specific conditions or don\'t require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
      */
     conditions?: Condition[];
     consequence?: Consequence;
     /**
-     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+     * Description of the rule\'s purpose to help you distinguish between different rules.
      */
     description?: string;
     /**
-     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+     * Whether the rule is active.
      */
     enabled?: boolean;
     /**
-     * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
+     * Time periods when the rule is active.
      */
     validity?: TimeRange[];
 };

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

@@ -1,14 +1,14 @@
 export type SaveObjectResponse = {
     /**
-     * Date of creation (ISO-8601 format).
+     * Timestamp when the record was added, in ISO 8601 format.
      */
     createdAt: string;
     /**
-     * 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`.
+     * 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](#tag/Indices/operation/getTask) and this `taskID`.
      */
     taskID: number;
     /**
-     * Unique object identifier.
+     * Unique record identifier.
      */
     objectID?: string;
 };

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

@@ -1,6 +1,6 @@
 export type SaveSynonymResponse = {
     /**
-     * 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`.
+     * 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](#tag/Indices/operation/getTask) and this `taskID`.
      */
     taskID: number;
     /**

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

@@ -1,22 +1,20 @@
+import type { SupportedLanguage } from './supportedLanguage';
 /**
- * `searchDictionaryEntries` parameters.
+ * Search parameter.
  */
 export type SearchDictionaryEntriesParams = {
     /**
-     * Text to search for in an index.
+     * Search query.
      */
     query: string;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page?: number;
     /**
      * Number of hits per page.
      */
     hitsPerPage?: number;
-    /**
-     * [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;
+    language?: SupportedLanguage;
 };
 //# sourceMappingURL=searchDictionaryEntriesParams.d.ts.map

package/dist/client-search/model/searchDictionaryEntriesParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"searchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC9B,CAAC"}

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

@@ -0,0 +1,20 @@
+import type { DictionaryEntry } from './dictionaryEntry';
+export type SearchDictionaryEntriesResponse = {
+    /**
+     * Dictionary entries matching the search criteria.
+     */
+    hits: DictionaryEntry[];
+    /**
+     * Requested page of the API response.
+     */
+    page: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+    /**
+     * Number of pages of results.
+     */
+    nbPages: number;
+};
+//# sourceMappingURL=searchDictionaryEntriesResponse.d.ts.map

package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchDictionaryEntriesResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchDictionaryEntriesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;OAEG;IACH,IAAI,EAAE,eAAe,EAAE,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

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

@@ -8,7 +8,7 @@ export type SearchForFacetValuesRequest = {
      */
     facetQuery?: string;
     /**
-     * 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).
+     * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
      */
     maxFacetHits?: number;
 };

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

@@ -1,5 +1,8 @@
 import type { FacetHits } from './facetHits';
 export type SearchForFacetValuesResponse = {
+    /**
+     * Matching facet values.
+     */
     facetHits: FacetHits[];
     /**
      * See the `facetsCount` field of the `exhaustive` object in the response.

package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchForFacetValuesResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchForFacetValuesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAE,SAAS,EAAE,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}
+{"version":3,"file":"searchForFacetValuesResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchForFacetValuesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,SAAS,EAAE,SAAS,EAAE,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}

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

@@ -5,7 +5,7 @@ export type SearchForFacetsOptions = {
      */
     facet: string;
     /**
-     * Algolia index name.
+     * Index name.
      */
     indexName: string;
     /**
@@ -13,7 +13,7 @@ export type SearchForFacetsOptions = {
      */
     facetQuery?: string;
     /**
-     * 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).
+     * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
      */
     maxFacetHits?: number;
     type: SearchTypeFacet;

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

@@ -1,7 +1,7 @@
 import type { SearchTypeDefault } from './searchTypeDefault';
 export type SearchForHitsOptions = {
     /**
-     * Algolia index name.
+     * Index name.
      */
     indexName: string;
     type?: SearchTypeDefault;

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

@@ -1,8 +1,11 @@
 import type { Hit } from './hit';
 export type SearchHits<T = Record<string, any>> = Record<string, any> & {
+    /**
+     * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+     */
     hits: Array<Hit<T>>;
     /**
-     * Text to search for in an index.
+     * Search query.
      */
     query: string;
     /**

package/dist/client-search/model/searchHits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACtE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACtE;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

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

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

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

@@ -4,16 +4,16 @@ import type { Anchoring } from './anchoring';
  */
 export type SearchRulesParams = {
     /**
-     * Rule object query.
+     * Search query for rules.
      */
     query?: string;
     anchoring?: Anchoring;
     /**
-     * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+     * Only return rules that match the context (exact match).
      */
     context?: string;
     /**
-     * Requested page (the first page is page 0).
+     * Requested page of the API response.
      */
     page?: number;
     /**
@@ -21,12 +21,8 @@ export type SearchRulesParams = {
      */
     hitsPerPage?: number;
     /**
-     * Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved.
+     * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
      */
     enabled?: boolean | null;
-    /**
-     * Request options to send with the API call.
-     */
-    requestOptions?: Array<Record<string, any>>;
 };
 //# sourceMappingURL=searchRulesParams.d.ts.map

package/dist/client-search/model/searchRulesParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC7C,CAAC"}
+{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC1B,CAAC"}

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

@@ -1,11 +1,11 @@
 import type { Rule } from './rule';
 export type SearchRulesResponse = {
     /**
-     * Fetched rules.
+     * Rules that matched the search criteria.
      */
     hits: Rule[];
     /**
-     * Number of fetched rules.
+     * Number of rules that matched the search criteria.
      */
     nbHits: number;
     /**

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

@@ -1,5 +1,5 @@
 /**
- * - `none`: executes all queries. - `stopIfEnoughMatches`: executes queries one by one, stopping further query execution as soon as a query matches at least the `hitsPerPage` number of results.
+ * Strategy for multiple search queries:  - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
  */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 //# sourceMappingURL=searchStrategy.d.ts.map

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

@@ -1,12 +1,12 @@
 import type { SynonymType } from './synonymType';
 export type SearchSynonymsParams = {
     /**
-     * Text to search for in an index.
+     * Search query.
      */
     query?: string;
     type?: SynonymType;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page?: number;
     /**

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

@@ -1,11 +1,11 @@
 import type { SynonymHit } from './synonymHit';
 export type SearchSynonymsResponse = Record<string, any> & {
     /**
-     * Synonym objects.
+     * Matching synonyms.
      */
     hits: SynonymHit[];
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
     nbHits: number;
 };

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

@@ -11,7 +11,7 @@ export type SearchUserIdsParams = {
      */
     clusterName?: string;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page?: number;
     /**

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

@@ -8,11 +8,11 @@ export type SearchUserIdsResponse = {
      */
     hits: UserHit[];
     /**
-     * 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;
     /**

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

@@ -2,23 +2,23 @@ import type { SearchParamsObject } from './searchParamsObject';
 export type SecuredAPIKeyRestrictions = {
     searchParams?: SearchParamsObject;
     /**
-     * Filters that apply to every search made with the secured API key. You can add extra filters at search time with the filters query parameter. For example, if you set the filter group:admin on your generated API key, and you add groups:press OR groups:visitors with the filters query parameter, your final search filter is equivalent to groups:admin AND (groups:press OR groups:visitors).
+     * Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
      */
     filters?: string;
     /**
-     * Unix timestamp used to set the expiration date of the API key.
+     * Timestamp in [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time) when the API key should expire.
      */
     validUntil?: number;
     /**
-     * Index names that can be queried.
+     * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
      */
     restrictIndices?: string[];
     /**
-     * IPv4 network allowed to use the generated key. Use this to protect against API key leaking and reuse. You can only provide a single source, but you can specify a range of IPs (for example, 192.168.1.0/24).
+     * IP network that are allowed to use this key.  You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
      */
     restrictSources?: string;
     /**
-     * Unique user IP address. This can be useful when you want to impose a rate limit on specific users. By default, rate limits are set based on the IP address. This can become an issue when several users search from the same IP address. To avoid this, you can set a unique userToken for each user when generating their API key. This lets you restrict each user to a maximum number of API calls per hour, even if they share their IP with another user. Specifying the userToken in a secured API key is also a good security practice as it ensures users don\'t change it. Many features like Analytics, Personalization, and Dynamic Re-ranking rely on the authenticity of user identifiers. Setting the userToken at the API key level ensures that downstream services work as expected and prevents abuse.
+     * Pseudonymous user identifier to restrict usage of this API key to specific users.  By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
      */
     userToken?: string;
 };

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

@@ -1,9 +1,9 @@
 /**
- * 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;
 };