chore: generated code for commit daa9867c. [skip ci]

algolia/api-clients-automation@daa9867

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>
Co-authored-by: Mouaad Aallam <[email protected]>

Author: 3 people

packages/algoliasearch/lite/model/baseSearchResponse.ts

@@ -1,10 +1,11 @@
 // 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.
 
-import type { BaseSearchResponseRedirect } from './baseSearchResponseRedirect';
+import type { Exhaustive } from './exhaustive';
 import type { FacetsStats } from './facetsStats';
+import type { Redirect } from './redirect';
 import type { RenderingContent } from './renderingContent';
 
-export type BaseSearchResponse = {
+export type BaseSearchResponse = Record<string, any> & {
   /**
    * A/B test ID. This is only included in the response for indices that are part of an A/B test.
    */
@@ -25,18 +26,20 @@ export type BaseSearchResponse = {
    */
   automaticRadius?: string;
 
+  exhaustive?: Exhaustive;
+
   /**
-   * Indicates whether the facet count is exhaustive (exact) or approximate.
+   * See the `facetsCount` field of the `exhaustive` object in the response.
    */
   exhaustiveFacetsCount?: boolean;
 
   /**
-   * Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.
+   * See the `nbHits` field of the `exhaustive` object in the response.
    */
   exhaustiveNbHits?: boolean;
 
   /**
-   * Indicates whether the search for typos was exhaustive (exact) or approximate.
+   * See the `typo` field of the `exhaustive` object in the response.
    */
   exhaustiveTypo?: boolean;
 
@@ -90,8 +93,6 @@ export type BaseSearchResponse = {
    */
   page: number;
 
-  redirect?: BaseSearchResponseRedirect;
-
   /**
    * 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.
    */
@@ -102,11 +103,25 @@ export type BaseSearchResponse = {
    */
   processingTimeMS: number;
 
+  /**
+   * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
+   */
+  processingTimingsMS?: Record<string, any>;
+
   /**
    * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
    */
   queryAfterRemoval?: string;
 
+  redirect?: Redirect;
+
+  renderingContent?: RenderingContent;
+
+  /**
+   * Time the server took to process the request, in milliseconds.
+   */
+  serverTimeMS?: number;
+
   /**
    * Host name of the server that processed the request.
    */
@@ -116,6 +131,4 @@ export type BaseSearchResponse = {
    * Lets you store custom data in your indices.
    */
   userData?: any | null;
-
-  renderingContent?: RenderingContent;
 };

packages/algoliasearch/lite/model/exhaustive.ts

@@ -0,0 +1,31 @@
+// 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 certain properties of the search response are calculated exhaustive (exact) or approximated.
+ */
+export type Exhaustive = {
+  /**
+   * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+   */
+  facetsCount?: boolean;
+
+  /**
+   * The value is `false` if not all facet values are retrieved.
+   */
+  facetValues?: boolean;
+
+  /**
+   * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+   */
+  nbHits?: boolean;
+
+  /**
+   * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+   */
+  rulesMatch?: boolean;
+
+  /**
+   * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+   */
+  typo?: boolean;
+};

packages/algoliasearch/lite/model/index.ts

@@ -19,7 +19,6 @@ export * from './baseIndexSettings';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
-export * from './baseSearchResponseRedirect';
 export * from './browseParams';
 export * from './browseParamsObject';
 export * from './browseResponse';
@@ -43,6 +42,7 @@ export * from './edit';
 export * from './editType';
 export * from './errorBase';
 export * from './exactOnSingleWordQuery';
+export * from './exhaustive';
 export * from './facetFilters';
 export * from './facetHits';
 export * from './facetOrdering';
@@ -74,6 +74,7 @@ export * from './promoteObjectIDs';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
+export * from './redirect';
 export * from './redirectRuleIndexMetadata';
 export * from './redirectRuleIndexMetadataData';
 export * from './removeStopWords';

packages/algoliasearch/lite/model/baseSearchResponseRedirect.ts renamed to packages/algoliasearch/lite/model/redirect.ts

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

packages/algoliasearch/lite/model/searchHits.ts

@@ -2,7 +2,7 @@
 
 import type { Hit } from './hit';
 
-export type SearchHits<T = Record<string, any>> = {
+export type SearchHits<T = Record<string, any>> = Record<string, any> & {
   hits: Array<Hit<T>>;
 
   /**

packages/client-search/model/baseSearchResponse.ts

@@ -1,10 +1,11 @@
 // 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.
 
-import type { BaseSearchResponseRedirect } from './baseSearchResponseRedirect';
+import type { Exhaustive } from './exhaustive';
 import type { FacetsStats } from './facetsStats';
+import type { Redirect } from './redirect';
 import type { RenderingContent } from './renderingContent';
 
-export type BaseSearchResponse = {
+export type BaseSearchResponse = Record<string, any> & {
   /**
    * A/B test ID. This is only included in the response for indices that are part of an A/B test.
    */
@@ -25,18 +26,20 @@ export type BaseSearchResponse = {
    */
   automaticRadius?: string;
 
+  exhaustive?: Exhaustive;
+
   /**
-   * Indicates whether the facet count is exhaustive (exact) or approximate.
+   * See the `facetsCount` field of the `exhaustive` object in the response.
    */
   exhaustiveFacetsCount?: boolean;
 
   /**
-   * Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.
+   * See the `nbHits` field of the `exhaustive` object in the response.
    */
   exhaustiveNbHits?: boolean;
 
   /**
-   * Indicates whether the search for typos was exhaustive (exact) or approximate.
+   * See the `typo` field of the `exhaustive` object in the response.
    */
   exhaustiveTypo?: boolean;
 
@@ -90,8 +93,6 @@ export type BaseSearchResponse = {
    */
   page: number;
 
-  redirect?: BaseSearchResponseRedirect;
-
   /**
    * 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.
    */
@@ -102,11 +103,25 @@ export type BaseSearchResponse = {
    */
   processingTimeMS: number;
 
+  /**
+   * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
+   */
+  processingTimingsMS?: Record<string, any>;
+
   /**
    * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
    */
   queryAfterRemoval?: string;
 
+  redirect?: Redirect;
+
+  renderingContent?: RenderingContent;
+
+  /**
+   * Time the server took to process the request, in milliseconds.
+   */
+  serverTimeMS?: number;
+
   /**
    * Host name of the server that processed the request.
    */
@@ -116,6 +131,4 @@ export type BaseSearchResponse = {
    * Lets you store custom data in your indices.
    */
   userData?: any | null;
-
-  renderingContent?: RenderingContent;
 };

packages/client-search/model/exhaustive.ts

@@ -0,0 +1,31 @@
+// 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 certain properties of the search response are calculated exhaustive (exact) or approximated.
+ */
+export type Exhaustive = {
+  /**
+   * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+   */
+  facetsCount?: boolean;
+
+  /**
+   * The value is `false` if not all facet values are retrieved.
+   */
+  facetValues?: boolean;
+
+  /**
+   * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+   */
+  nbHits?: boolean;
+
+  /**
+   * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+   */
+  rulesMatch?: boolean;
+
+  /**
+   * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+   */
+  typo?: boolean;
+};

packages/client-search/model/index.ts

@@ -20,7 +20,6 @@ export * from './baseIndexSettings';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
-export * from './baseSearchResponseRedirect';
 export * from './batchAssignUserIdsParams';
 export * from './batchDictionaryEntriesParams';
 export * from './batchDictionaryEntriesRequest';
@@ -56,6 +55,7 @@ export * from './edit';
 export * from './editType';
 export * from './errorBase';
 export * from './exactOnSingleWordQuery';
+export * from './exhaustive';
 export * from './facetFilters';
 export * from './facetHits';
 export * from './facetOrdering';
@@ -103,6 +103,7 @@ export * from './promoteObjectIDs';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
+export * from './redirect';
 export * from './redirectRuleIndexMetadata';
 export * from './redirectRuleIndexMetadataData';
 export * from './removeStopWords';

packages/client-search/model/baseSearchResponseRedirect.ts renamed to packages/client-search/model/redirect.ts

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

packages/client-search/model/searchHits.ts

@@ -2,7 +2,7 @@
 
 import type { Hit } from './hit';
 
-export type SearchHits<T = Record<string, any>> = {
+export type SearchHits<T = Record<string, any>> = Record<string, any> & {
   hits: Array<Hit<T>>;
 
   /**