-
Notifications
You must be signed in to change notification settings - Fork 215
/
baseSearchResponse.ts
139 lines (110 loc) · 3.32 KB
/
baseSearchResponse.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
// 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 { Exhaustive } from './exhaustive';
import type { FacetsStats } from './facetsStats';
import type { Redirect } from './redirect';
import type { RenderingContent } from './renderingContent';
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.
*/
abTestID?: number;
/**
* Variant ID. This is only included in the response for indices that are part of an A/B test.
*/
abTestVariantID?: number;
/**
* Computed geographical location.
*/
aroundLatLng?: string;
/**
* Automatically-computed radius.
*/
automaticRadius?: string;
exhaustive?: Exhaustive;
/**
* See the `facetsCount` field of the `exhaustive` object in the response.
*/
exhaustiveFacetsCount?: boolean;
/**
* See the `nbHits` field of the `exhaustive` object in the response.
*/
exhaustiveNbHits?: boolean;
/**
* See the `typo` field of the `exhaustive` object in the response.
*/
exhaustiveTypo?: boolean;
/**
* Mapping of each facet name to the corresponding facet counts.
*/
facets?: Record<string, Record<string, number>>;
/**
* Statistics for numerical facets.
*/
facets_stats?: Record<string, FacetsStats>;
/**
* Number of hits per page.
*/
hitsPerPage: number;
/**
* Index name used for the query.
*/
index?: string;
/**
* Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
*/
indexUsed?: string;
/**
* Warnings about the query.
*/
message?: string;
/**
* Number of hits the search query matched.
*/
nbHits: number;
/**
* Number of pages of results for the current query.
*/
nbPages: number;
/**
* Number of hits selected and sorted by the relevant sort algorithm.
*/
nbSortedHits?: number;
/**
* Page to retrieve (the first page is `0`, not `1`).
*/
page: number;
/**
* 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;
/**
* Time the server took to process the request, in milliseconds.
*/
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.
*/
serverUsed?: string;
/**
* Lets you store custom data in your indices.
*/
userData?: any | null;
/**
* Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
*/
queryID?: string;
};