@algolia/client-search 5.51.0 → 5.52.1

package/dist/fetch.d.ts

@@ -3173,7 +3173,7 @@ type AccountCopyIndexOptions = {
     batchSize?: number | undefined;
 };
 
-declare const apiClientVersion = "5.51.0";
+declare const apiClientVersion = "5.52.1";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3926,11 +3926,11 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
+     * Runs multiple search queries against one or more indices in a single API request.  Use cases include:  - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters.  If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
      *
      * Required API Key ACLs:
      *  - search
-     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
+     * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T>(searchMethodParams: SearchMethodParams | LegacySearchMethodProps, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;

package/dist/node.d.cts

@@ -3173,7 +3173,7 @@ type AccountCopyIndexOptions = {
     batchSize?: number | undefined;
 };
 
-declare const apiClientVersion = "5.51.0";
+declare const apiClientVersion = "5.52.1";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3926,11 +3926,11 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
+     * Runs multiple search queries against one or more indices in a single API request.  Use cases include:  - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters.  If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
      *
      * Required API Key ACLs:
      *  - search
-     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
+     * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T>(searchMethodParams: SearchMethodParams | LegacySearchMethodProps, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;

package/dist/node.d.ts

@@ -3173,7 +3173,7 @@ type AccountCopyIndexOptions = {
     batchSize?: number | undefined;
 };
 
-declare const apiClientVersion = "5.51.0";
+declare const apiClientVersion = "5.52.1";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3926,11 +3926,11 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
+     * Runs multiple search queries against one or more indices in a single API request.  Use cases include:  - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters.  If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
      *
      * Required API Key ACLs:
      *  - search
-     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
+     * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T>(searchMethodParams: SearchMethodParams | LegacySearchMethodProps, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;

package/dist/src/searchClient.cjs

@@ -25,7 +25,7 @@ __export(searchClient_exports, {
 });
 module.exports = __toCommonJS(searchClient_exports);
 var import_client_common = require("@algolia/client-common");
-var apiClientVersion = "5.51.0";
+var apiClientVersion = "5.52.1";
 function getDefaultHosts(appId) {
   return [
     {
@@ -2020,11 +2020,11 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
+     * Runs multiple search queries against one or more indices in a single API request.  Use cases include:  - Searching different indices, such as products and marketing content. - Run multiple queries on the same index with different parameters or filters.  If you know the expected result type, use the `searchForHits` or `searchForFacets` helper to simplify the response format.
      *
      * Required API Key ACLs:
      *  - search
-     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
+     * @param searchMethodParams - Multi-query search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search(searchMethodParams, requestOptions) {