@algolia/client-search 5.0.0-alpha.73 → 5.0.0-alpha.76

package/dist/model/baseSearchResponse.d.ts

@@ -3,35 +3,35 @@ import type { FacetsStats } from './facetsStats';
 import type { RenderingContent } from './renderingContent';
 export type BaseSearchResponse = {
     /**
-     * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
+     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
      */
     abTestID?: number;
     /**
-     * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
+     * Variant ID. This is only included in the response for indices that are part of an A/B test.
      */
     abTestVariantID?: number;
     /**
-     * The computed geo location.
+     * Computed geographical location.
      */
     aroundLatLng?: string;
     /**
-     * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
+     * Automatically-computed radius.
      */
     automaticRadius?: string;
     /**
-     * Whether the facet count is exhaustive or approximate.
+     * Indicates whether the facet count is exhaustive (exact) or approximate.
      */
     exhaustiveFacetsCount?: boolean;
     /**
-     * Indicate if the nbHits count was exhaustive or approximate.
+     * Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.
      */
     exhaustiveNbHits: boolean;
     /**
-     * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
+     * Indicates whether the search for typos was exhaustive (exact) or approximate.
      */
     exhaustiveTypo?: boolean;
     /**
-     * A mapping of each facet name to the corresponding facet counts.
+     * Mapping of each facet name to the corresponding facet counts.
      */
     facets?: Record<string, Record<string, number>>;
     /**
@@ -39,7 +39,7 @@ export type BaseSearchResponse = {
      */
     facets_stats?: Record<string, FacetsStats>;
     /**
-     * Set the number of hits per page.
+     * Number of hits per page.
      */
     hitsPerPage: number;
     /**
@@ -47,36 +47,36 @@ export type BaseSearchResponse = {
      */
     index?: string;
     /**
-     * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
+     * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
      */
     indexUsed?: string;
     /**
-     * Used to return warnings about the query.
+     * Warnings about the query.
      */
     message?: string;
     /**
-     * Number of hits that the search query matched.
+     * Number of hits the search query matched.
      */
     nbHits: number;
     /**
-     * Number of pages available for the current query.
+     * Number of pages of results for the current query.
      */
     nbPages: number;
     /**
-     * The number of hits selected and sorted by the relevant sort algorithm.
+     * Number of hits selected and sorted by the relevant sort algorithm.
      */
     nbSortedHits?: number;
     /**
-     * Specify the page to retrieve.
+     * Page to retrieve (the first page is `0`, not `1`).
      */
     page: number;
     /**
-     * A url-encoded string of all search parameters.
+     * URL-encoded string of all search parameters.
      */
     params: string;
     redirect?: BaseSearchResponseRedirect;
     /**
-     * The query string that will be searched, after normalization.
+     * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
      */
     parsedQuery?: string;
     /**
@@ -84,15 +84,15 @@ export type BaseSearchResponse = {
      */
     processingTimeMS: number;
     /**
-     * The text to search in the index.
+     * Text to search for in an index.
      */
     query: string;
     /**
-     * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
+     * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
      */
     queryAfterRemoval?: string;
     /**
-     * Actual host name of the server that processed the request.
+     * Host name of the server that processed the request.
      */
     serverUsed?: string;
     /**

package/dist/model/baseSearchResponseRedirect.d.ts

@@ -1,6 +1,6 @@
 import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
 /**
- * This parameter is for internal use only.
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
  */
 export type BaseSearchResponseRedirect = {
     index?: RedirectRuleIndexMetadata[];

package/dist/model/batchAssignUserIdsParams.d.ts

@@ -3,11 +3,11 @@
  */
 export type BatchAssignUserIdsParams = {
     /**
-     * Name of the cluster.
+     * Cluster name.
      */
     cluster: string;
     /**
-     * UserIDs to assign. Note you cannot move users with this method.
+     * User IDs to assign.
      */
     users: string[];
 };

package/dist/model/batchDictionaryEntriesParams.d.ts

@@ -1,14 +1,14 @@
 import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
 /**
- * The `batchDictionaryEntries` parameters.
+ * `batchDictionaryEntries` parameters.
  */
 export type BatchDictionaryEntriesParams = {
     /**
-     * When `true`, start the batch by removing all the custom entries from the dictionary.
+     * Incidates whether to replace all custom entries in the dictionary with the ones sent with this request.
      */
     clearExistingDictionaryEntries?: boolean;
     /**
-     * List of operations to batch. Each operation is described by an `action` and a `body`.
+     * Operations to batch.
      */
     requests: BatchDictionaryEntriesRequest[];
 };

package/dist/model/batchParams.d.ts

@@ -1,6 +1,6 @@
 import type { MultipleBatchRequest } from './multipleBatchRequest';
 /**
- * The `multipleBatch` parameters.
+ * Batch parameters.
  */
 export type BatchParams = {
     requests: MultipleBatchRequest[];

package/dist/model/batchRequest.d.ts

@@ -2,7 +2,7 @@ import type { Action } from './action';
 export type BatchRequest = {
     action: Action;
     /**
-     * Arguments to the operation (depends on the type of the operation).
+     * Operation arguments (varies with specified `action`).
      */
     body: Record<string, any>;
 };

package/dist/model/batchResponse.d.ts

@@ -1,10 +1,10 @@
 export type BatchResponse = {
     /**
-     * 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;
     /**
-     * List of objectID.
+     * Unique object (record) identifiers.
      */
     objectIDs: string[];
 };

package/dist/model/batchWriteParams.d.ts

@@ -1,6 +1,6 @@
 import type { BatchRequest } from './batchRequest';
 /**
- * The `batch` parameters.
+ * Batch parameters.
  */
 export type BatchWriteParams = {
     requests: BatchRequest[];

package/dist/model/builtInOperation.d.ts

@@ -5,7 +5,7 @@ import type { BuiltInOperationType } from './builtInOperationType';
 export type BuiltInOperation = {
     _operation: BuiltInOperationType;
     /**
-     * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
+     * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, `Add` or `Remove` value.
      */
     value: string;
 };

package/dist/model/builtInOperationType.d.ts

@@ -1,5 +1,5 @@
 /**
- * The operation to apply on the attribute.
+ * Operation to apply to the attribute.
  */
 export type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
 //# sourceMappingURL=builtInOperationType.d.ts.map