You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/recommend/model/baseSearchResponse.ts
+22-9
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,11 @@
1
1
// 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.
* A/B test ID. This is only included in the response for indices that are part of an A/B test.
10
11
*/
@@ -25,18 +26,20 @@ export type BaseSearchResponse = {
25
26
*/
26
27
automaticRadius?: string;
27
28
29
+
exhaustive?: Exhaustive;
30
+
28
31
/**
29
-
* Indicates whether the facet count is exhaustive (exact) or approximate.
32
+
* See the `facetsCount` field of the `exhaustive` object in the response.
30
33
*/
31
34
exhaustiveFacetsCount?: boolean;
32
35
33
36
/**
34
-
* Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.
37
+
* See the `nbHits` field of the `exhaustive` object in the response.
35
38
*/
36
39
exhaustiveNbHits?: boolean;
37
40
38
41
/**
39
-
* Indicates whether the search for typos was exhaustive (exact) or approximate.
42
+
* See the `typo` field of the `exhaustive` object in the response.
40
43
*/
41
44
exhaustiveTypo?: boolean;
42
45
@@ -90,8 +93,6 @@ export type BaseSearchResponse = {
90
93
*/
91
94
page: number;
92
95
93
-
redirect?: BaseSearchResponseRedirect;
94
-
95
96
/**
96
97
* 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.
97
98
*/
@@ -102,11 +103,25 @@ export type BaseSearchResponse = {
102
103
*/
103
104
processingTimeMS: number;
104
105
106
+
/**
107
+
* Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
108
+
*/
109
+
processingTimingsMS?: Record<string,any>;
110
+
105
111
/**
106
112
* Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
107
113
*/
108
114
queryAfterRemoval?: string;
109
115
116
+
redirect?: Redirect;
117
+
118
+
renderingContent?: RenderingContent;
119
+
120
+
/**
121
+
* Time the server took to process the request, in milliseconds.
122
+
*/
123
+
serverTimeMS?: number;
124
+
110
125
/**
111
126
* Host name of the server that processed the request.
112
127
*/
@@ -116,6 +131,4 @@ export type BaseSearchResponse = {
// 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.
2
+
3
+
/**
4
+
* Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
5
+
*/
6
+
exporttypeExhaustive={
7
+
/**
8
+
* 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-).
9
+
*/
10
+
facetsCount?: boolean;
11
+
12
+
/**
13
+
* The value is `false` if not all facet values are retrieved.
14
+
*/
15
+
facetValues?: boolean;
16
+
17
+
/**
18
+
* 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.
19
+
*/
20
+
nbHits?: boolean;
21
+
22
+
/**
23
+
* 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.
24
+
*/
25
+
rulesMatch?: boolean;
26
+
27
+
/**
28
+
* 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.
0 commit comments