@@ -3,102 +3,4 @@ import { BaseSearchResponseFacetsStats } from './baseSearchResponseFacetsStats';
33import { RecommendRecord } from './recommendRecord' ;
44import { RecommendationsResponseAllOf } from './recommendationsResponseAllOf' ;
55
6- export type RecommendationsResponse = {
7- /**
8- * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
9- */
10- abTestID ?: number ;
11- /**
12- * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used.
13- */
14- abTestVariantID ?: number ;
15- /**
16- * The computed geo location.
17- */
18- aroundLatLng ?: string ;
19- /**
20- * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
21- */
22- automaticRadius ?: string ;
23- /**
24- * Whether the facet count is exhaustive or approximate.
25- */
26- exhaustiveFacetsCount ?: boolean ;
27- /**
28- * Indicate if the nbHits count was exhaustive or approximate
29- */
30- exhaustiveNbHits : boolean ;
31- /**
32- * Indicate if the typo-tolerence search was exhaustive or approximate (only included when typo-tolerance is enabled)
33- */
34- exhaustiveTypo : boolean ;
35- /**
36- * A mapping of each facet name to the corresponding facet counts.
37- */
38- facets ?: { [ key : string ] : { [ key : string ] : string } } ;
39- /**
40- * Statistics for numerical facets.
41- */
42- facets_stats ?: { [ key : string ] : BaseSearchResponseFacetsStats } ;
43- /**
44- * Set the number of hits per page.
45- */
46- hitsPerPage : number ;
47- /**
48- * Index name used for the query.
49- */
50- index ?: string ;
51- /**
52- * Index name used for the query. In the case of an A/B test, the targeted index isn’t always the index used by the query.
53- */
54- indexUsed ?: string ;
55- /**
56- * Used to return warnings about the query.
57- */
58- message ?: string ;
59- /**
60- * Number of hits that the search query matched
61- */
62- nbHits : number ;
63- /**
64- * Number of pages available for the current query
65- */
66- nbPages : number ;
67- /**
68- * The number of hits selected and sorted by the relevant sort algorithm
69- */
70- nbSortedHits ?: number ;
71- /**
72- * Specify the page to retrieve.
73- */
74- page : number ;
75- /**
76- * A url-encoded string of all search parameters.
77- */
78- params : string ;
79- /**
80- * The query string that will be searched, after normalization.
81- */
82- parsedQuery ?: string ;
83- /**
84- * Time the server took to process the request, in milliseconds.
85- */
86- processingTimeMS : number ;
87- /**
88- * The text to search in the index.
89- */
90- query : string ;
91- /**
92- * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
93- */
94- queryAfterRemoval ?: string ;
95- /**
96- * Actual host name of the server that processed the request.
97- */
98- serverUsed ?: string ;
99- /**
100- * Lets you store custom data in your indices.
101- */
102- userData ?: { [ key : string ] : object } ;
103- hits : Array < RecommendRecord > ;
104- } ;
6+ export type RecommendationsResponse = BaseSearchResponse & RecommendationsResponseAllOf ;
0 commit comments