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: Sources/AlgoliaSearchClient/Models/Search/Response/SearchResponse/SearchResponse.swift
+32-26Lines changed: 32 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -13,59 +13,59 @@ public struct SearchResponse {
13
13
The hits returned by the search. Hits are ordered according to the ranking or sorting of the index being queried.
14
14
Hits are made of the schemaless JSON objects that you stored in the index.
15
15
*/
16
-
publiclethits:[Hit<JSON>]
16
+
publicvarhits:[Hit<JSON>]
17
17
18
18
/**
19
19
The number of hits matched by the query.
20
20
*/
21
-
publicletnbHits:Int?
21
+
publicvarnbHits:Int?
22
22
23
23
/**
24
24
Index of the current page (zero-based). See the Query.page search parameter.
25
25
- Not returned if you use offset/length for pagination.
26
26
*/
27
-
publicletpage:Int?
27
+
publicvarpage:Int?
28
28
29
29
/**
30
30
The maximum number of hits returned per page. See the Query.hitsPerPage search parameter.
31
31
- Not returned if you use offset & length for pagination.
32
32
*/
33
-
publiclethitsPerPage:Int?
33
+
publicvarhitsPerPage:Int?
34
34
35
35
/**
36
36
Alternative to page (zero-based). Is returned only when Query.offset Query.length is specified.
37
37
*/
38
-
publicletoffset:Int?
38
+
publicvaroffset:Int?
39
39
40
40
/**
41
41
Alternative to hitsPerPageOrNull (zero-based). Is returned only when Query.offset Query.length is specified.
42
42
*/
43
-
publicletlength:Int?
43
+
publicvarlength:Int?
44
44
45
45
/**
46
46
Array of userData object. Only returned if at least one query rule containing a custom userData
47
47
consequence was applied.
48
48
*/
49
-
publicletuserData:[JSON]?
49
+
publicvaruserData:[JSON]?
50
50
51
51
/**
52
52
The number of returned pages. Calculation is based on the total number of hits (nbHits) divided by the number of
53
53
hits per page (hitsPerPage), rounded up to the nearest integer.
54
54
- Not returned if you use offset & length for pagination.
55
55
*/
56
-
publicletnbPages:Int?
56
+
publicvarnbPages:Int?
57
57
58
58
/**
59
59
Time the server took to process the request, in milliseconds. This does not include network time.
60
60
*/
61
-
publicletprocessingTimeMS:TimeInterval?
61
+
publicvarprocessingTimeMS:TimeInterval?
62
62
63
63
/**
64
64
Whether the nbHits is exhaustive (true) or approximate (false). An approximation is done when the query takes
65
65
more than 50ms to be processed (this can happen when using complex filters on millions on records).
66
66
- See the related [discussion](https://www.algolia.com/doc/faq/index-configuration/my-facet-and-hit-counts-are-not-accurate/)
67
67
*/
68
-
publicletexhaustiveNbHits:Bool?
68
+
publicvarexhaustiveNbHits:Bool?
69
69
70
70
/**
71
71
Whether the facet count is exhaustive (true) or approximate (false).
@@ -76,56 +76,56 @@ public struct SearchResponse {
76
76
/**
77
77
An echo of the query text. See the Query.query search parameter.
78
78
*/
79
-
publicletquery:String?
79
+
publicvarquery:String?
80
80
81
81
/**
82
82
A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
83
83
- The removed parts are surrounded by <em> tags.
84
84
- Only returned when Query.removeWordsIfNoResults or Settings.removeWordsIfNoResults is set to RemoveWordIfNoResults.LastWords or RemoveWordIfNoResults.FirstWords.
85
85
*/
86
-
publicletqueryAfterRemoval:String?
86
+
publicvarqueryAfterRemoval:String?
87
87
88
88
/**
89
89
A url-encoded string of all Query parameters.
90
90
*/
91
-
publicletparams:String?
91
+
publicvarparams:String?
92
92
93
93
/**
94
94
Used to return warnings about the query.
95
95
*/
96
-
publicletmessage:String?
96
+
publicvarmessage:String?
97
97
98
98
/**
99
99
The computed geo location.
100
100
- Only returned when Query.aroundLatLngViaIP or Query.aroundLatLng is set.
101
101
*/
102
-
publicletaroundLatLng:Point?
102
+
publicvararoundLatLng:Point?
103
103
104
104
/**
105
105
The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
106
106
- Only returned for geo queries without an explicitly specified Query.aroundRadius.
107
107
*/
108
-
publicletautomaticRadius:Double?
108
+
publicvarautomaticRadius:Double?
109
109
110
110
/**
111
111
Actual host name of the server that processed the request. Our DNS supports automatic failover and load
112
112
balancing, so this may differ from the host name used in the request.
113
113
- Returned only if Query.getRankingInfo is set to true.
114
114
*/
115
-
publicletserverUsed:String?
115
+
publicvarserverUsed:String?
116
116
117
117
/**
118
118
Index name used for the query. In case of A/B test, the index targeted isn’t always the index used by the query.
119
119
- Returned only if Query.getRankingInfo is set to true.
120
120
*/
121
-
publicletindexUsed:IndexName?
121
+
publicvarindexUsed:IndexName?
122
122
123
123
/**
124
124
In case of A/B test, reports the variant ID used. The variant ID is the position in the array of variants
125
125
(starting at 1).
126
126
- Returned only if [Query.getRankingInfo] is set to true.
127
127
*/
128
-
publicletabTestVariantID:Int?
128
+
publicvarabTestVariantID:Int?
129
129
130
130
/**
131
131
The query string that will be searched, after
@@ -135,7 +135,7 @@ public struct SearchResponse {
135
135
(see Query.advancedSyntax or Settings.advancedSyntax).
136
136
- Returned only if Query.getRankingInfo is set to true.
137
137
*/
138
-
publicletparsedQuery:String?
138
+
publicvarparsedQuery:String?
139
139
140
140
/**
141
141
A mapping of each facet name to the corresponding facet counts.
@@ -192,16 +192,16 @@ public struct SearchResponse {
192
192
/**
193
193
Returned only by the EndpointSearch.browse method.
194
194
*/
195
-
publicletcursor:Cursor?
195
+
publicvarcursor:Cursor?
196
196
197
-
publicletindexName:IndexName?
197
+
publicvarindexName:IndexName?
198
198
199
-
publicletprocessed:Bool?
199
+
publicvarprocessed:Bool?
200
200
201
201
/**
202
202
Identifies the query uniquely. Can be used by InsightsEvent.
203
203
*/
204
-
publicletqueryID:QueryID?
204
+
publicvarqueryID:QueryID?
205
205
206
206
/**
207
207
A mapping of each facet name to the corresponding facet counts for hierarchical facets.
@@ -223,10 +223,16 @@ public struct SearchResponse {
223
223
/**
224
224
Meta-information as to how the query was processed.
0 commit comments