@coveo/quantic 3.29.5-pre.cefa2bd755 → 3.29.5-pre.d80db02f3e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -8
  2. package/force-app/main/default/staticresources/coveoheadless/definitions/api/api-client-utils.d.ts +1 -1
  3. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +2 -2
  4. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +2 -2
  5. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +2 -2
  6. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +93 -3
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts +1051 -0
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +2 -2
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +2 -2
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts +2 -2
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts +4 -4
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts +2 -2
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +0 -2
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts +0 -2005
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-state.d.ts +0 -5
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +0 -3
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/types/fetch-static-state.d.ts +4 -0
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/build.d.ts +3 -0
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/common/types/engine.d.ts +3 -0
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-commerce-next.index.d.ts +3 -3
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/build-factory.d.ts +4 -3
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/hydrated-state-factory.d.ts +1 -1
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-hydrated-state-factory.d.ts +1 -1
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/recommendation-static-state-factory.d.ts +2 -1
  25. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/factories/static-state-factory.d.ts +2 -1
  26. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/build.d.ts +38 -7
  27. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/controller-definitions.d.ts +40 -2
  28. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/engine.d.ts +15 -8
  29. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/fetch-static-state.d.ts +3 -3
  30. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/types/utilities.d.ts +6 -0
  31. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/utils/controller-wiring.d.ts +8 -0
  32. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/utils/engine-wiring.d.ts +5 -0
  33. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/validation/controller-validation.d.ts +1 -0
  34. package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/common/types/fetch-static-state.d.ts +1 -3
  35. package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -10
  36. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -9
  37. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
  38. package/package.json +2 -2
  39. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer-mocks.d.ts +0 -1997
  40. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/utils/testingUtils.d.ts +0 -8
  41. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/answer-api-selectors.d.ts +0 -74
@@ -0,0 +1,1051 @@
1
+ /** biome-ignore-all lint/suspicious/noExplicitAny: <mock> */
2
+ import type { StreamAnswerAPIState } from '../stream-answer-api-state.js';
3
+ export declare const streamAnswerAPIStateMock: StreamAnswerAPIState;
4
+ export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StreamAnswerAPIState;
5
+ export declare const streamAnswerAPIStateMockWithoutAnyTab: StreamAnswerAPIState;
6
+ export declare const streamAnswerAPIStateMockWithStaticFiltersSelected: StreamAnswerAPIState;
7
+ export declare const streamAnswerAPIStateMockWithNonValidFilters: StreamAnswerAPIState;
8
+ export declare const streamAnswerAPIStateMockWithoutAnyFilters: StreamAnswerAPIState;
9
+ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpression: StreamAnswerAPIState;
10
+ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWithEmptyCQ: {
11
+ advancedSearchQueries: {
12
+ cq: string;
13
+ cqWasSet?: boolean | undefined;
14
+ aq?: string | undefined;
15
+ aqWasSet?: boolean | undefined;
16
+ lq?: string | undefined;
17
+ lqWasSet?: boolean | undefined;
18
+ dq?: string | undefined;
19
+ dqWasSet?: boolean | undefined;
20
+ defaultFilters?: {
21
+ cq: string;
22
+ aq: string;
23
+ lq: string;
24
+ dq: string;
25
+ } | undefined;
26
+ };
27
+ searchHub: string;
28
+ pipeline: string;
29
+ answer: import("@reduxjs/toolkit/query").CombinedState<{
30
+ getAnswer: import("@reduxjs/toolkit/query").QueryDefinition<Partial<import("../../search/search/search-request.js").SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("../generated-answer-stream.js").GeneratedAnswerStream, "answer">;
31
+ }, never, "answer">;
32
+ configuration: import("../../../features/configuration/configuration-state.js").ConfigurationState;
33
+ facetSet?: import("../../../features/facets/facet-set/facet-set-state.js").FacetSetState | undefined;
34
+ dateFacetSet?: import("../../../features/facets/range-facets/date-facet-set/date-facet-set-state.js").DateFacetSetState | undefined;
35
+ numericFacetSet?: import("../../../features/facets/range-facets/numeric-facet-set/numeric-facet-set-state.js").NumericFacetSetState | undefined;
36
+ categoryFacetSet?: import("../../../features/facets/category-facet-set/category-facet-set-state.js").CategoryFacetSetState | undefined;
37
+ automaticFacetSet?: import("../../../features/facets/automatic-facet-set/automatic-facet-set-state.js").AutomaticFacetSetState | undefined;
38
+ facetOptions?: import("../../../features/facet-options/facet-options-state.js").FacetOptionsState | undefined;
39
+ query?: import("../../../features/query/query-state.js").QueryState | undefined;
40
+ tabSet?: import("../../../features/tab-set/tab-set-state.js").TabSetState | undefined;
41
+ staticFilterSet?: import("../../../features/static-filter-set/static-filter-set-state.js").StaticFilterSetState | undefined;
42
+ pagination?: import("../../../features/pagination/pagination-state.js").PaginationState | undefined;
43
+ sortCriteria?: string | undefined;
44
+ context?: import("../../../features/context/context-state.js").ContextState | undefined;
45
+ dictionaryFieldContext?: import("../../../features/dictionary-field-context/dictionary-field-context-state.js").DictionaryFieldContextState | undefined;
46
+ querySet?: import("../../../features/query-set/query-set-state.js").QuerySetState | undefined;
47
+ debug?: boolean | undefined;
48
+ facetSearchSet?: import("../../../features/facets/facet-search-set/specific/specific-facet-search-set-state.js").SpecificFacetSearchSetState | undefined;
49
+ categoryFacetSearchSet?: import("../../../features/facets/facet-search-set/category/category-facet-search-set-state.js").CategoryFacetSearchSetState | undefined;
50
+ standaloneSearchBoxSet?: import("../../../features/standalone-search-box-set/standalone-search-box-set-state.js").StandaloneSearchBoxSetState | undefined;
51
+ querySuggest?: import("../../../features/query-suggest/query-suggest-state.js").QuerySuggestSet | undefined;
52
+ search?: import("../../../features/search/search-state.js").SearchState | undefined;
53
+ resultPreview?: import("../../../features/result-preview/result-preview-state.js").ResultPreviewState | undefined;
54
+ didYouMean?: import("../../../features/did-you-mean/did-you-mean-state.js").DidYouMeanState | undefined;
55
+ fields?: import("../../../features/fields/fields-state.js").FieldsState | undefined;
56
+ facetOrder?: import("../../../features/facets/facet-order/facet-order-state.js").FacetOrderState | undefined;
57
+ version?: string | undefined;
58
+ history?: import("../../../app/undoable.js").StateWithHistory<import("../../../features/history/history-state.js").HistoryState> | undefined;
59
+ folding?: import("../../../features/folding/folding-state.js").FoldingState | undefined;
60
+ triggers?: import("../../../features/triggers/triggers-state.js").TriggerState | undefined;
61
+ questionAnswering?: import("../../../features/question-answering/question-answering-state.js").QuestionAnsweringState | undefined;
62
+ recentResults?: import("../../../features/recent-results/recent-results-state.js").RecentResultsState | undefined;
63
+ recentQueries?: import("../../../features/recent-queries/recent-queries-state.js").RecentQueriesState | undefined;
64
+ excerptLength?: import("../../../features/excerpt-length/excerpt-length-state.js").ExcerptLengthState | undefined;
65
+ generatedAnswer: import("../../../index.js").GeneratedAnswerState;
66
+ instantResults?: import("../../../features/instant-results/instant-results-state.js").InstantResultsState | undefined;
67
+ insightConfiguration?: import("../../../features/insight-configuration/insight-configuration-state.js").InsightConfigurationState | undefined;
68
+ };
69
+ export declare const streamAnswerAPIStateMockWithoutSearchAction: StreamAnswerAPIState;
70
+ export declare const expectedStreamAnswerAPIParam: {
71
+ q: string;
72
+ aq: string;
73
+ cq: string;
74
+ dq: string;
75
+ lq: string;
76
+ enableQuerySyntax: boolean;
77
+ context: {
78
+ testKey: string;
79
+ };
80
+ pipelineRuleParameters: {
81
+ mlGenerativeQuestionAnswering: {
82
+ responseFormat: {
83
+ contentFormat: string[];
84
+ };
85
+ citationsFieldToInclude: never[];
86
+ };
87
+ };
88
+ searchHub: string;
89
+ facets: ({
90
+ filterFacetCount: boolean;
91
+ injectionDepth: number;
92
+ numberOfValues: number;
93
+ sortCriteria: string;
94
+ resultsMustMatch: string;
95
+ type: string;
96
+ currentValues: never[];
97
+ freezeCurrentValues: boolean;
98
+ isFieldExpanded: boolean;
99
+ preventAutoSelect: boolean;
100
+ facetId: string;
101
+ field: string;
102
+ rangeAlgorithm?: undefined;
103
+ generateAutomaticRanges?: undefined;
104
+ delimitingCharacter?: undefined;
105
+ basePath?: undefined;
106
+ filterByBasePath?: undefined;
107
+ } | {
108
+ filterFacetCount: boolean;
109
+ injectionDepth: number;
110
+ numberOfValues: number;
111
+ sortCriteria: string;
112
+ rangeAlgorithm: string;
113
+ resultsMustMatch: string;
114
+ currentValues: {
115
+ start: string;
116
+ end: string;
117
+ endInclusive: boolean;
118
+ state: string;
119
+ }[];
120
+ preventAutoSelect: boolean;
121
+ type: string;
122
+ facetId: string;
123
+ field: string;
124
+ generateAutomaticRanges: boolean;
125
+ freezeCurrentValues?: undefined;
126
+ isFieldExpanded?: undefined;
127
+ delimitingCharacter?: undefined;
128
+ basePath?: undefined;
129
+ filterByBasePath?: undefined;
130
+ } | {
131
+ delimitingCharacter: string;
132
+ filterFacetCount: boolean;
133
+ injectionDepth: number;
134
+ numberOfValues: number;
135
+ sortCriteria: string;
136
+ basePath: never[];
137
+ filterByBasePath: boolean;
138
+ resultsMustMatch: string;
139
+ currentValues: never[];
140
+ preventAutoSelect: boolean;
141
+ type: string;
142
+ facetId: string;
143
+ field: string;
144
+ freezeCurrentValues?: undefined;
145
+ isFieldExpanded?: undefined;
146
+ rangeAlgorithm?: undefined;
147
+ generateAutomaticRanges?: undefined;
148
+ } | {
149
+ filterFacetCount: boolean;
150
+ injectionDepth: number;
151
+ numberOfValues: number;
152
+ sortCriteria: string;
153
+ rangeAlgorithm: string;
154
+ resultsMustMatch: string;
155
+ currentValues: {
156
+ endInclusive: boolean;
157
+ state: string;
158
+ start: number;
159
+ end: number;
160
+ }[];
161
+ preventAutoSelect: boolean;
162
+ type: string;
163
+ facetId: string;
164
+ field: string;
165
+ generateAutomaticRanges: boolean;
166
+ freezeCurrentValues?: undefined;
167
+ isFieldExpanded?: undefined;
168
+ delimitingCharacter?: undefined;
169
+ basePath?: undefined;
170
+ filterByBasePath?: undefined;
171
+ })[];
172
+ fieldsToInclude: string[];
173
+ queryCorrection: {
174
+ enabled: boolean;
175
+ options: {
176
+ automaticallyCorrect: string;
177
+ };
178
+ };
179
+ enableDidYouMean: boolean;
180
+ numberOfResults: number;
181
+ firstResult: number;
182
+ tab: string;
183
+ analytics: {
184
+ actionCause: string;
185
+ capture: boolean;
186
+ clientId: string;
187
+ clientTimestamp: string;
188
+ documentLocation: string;
189
+ documentReferrer: string;
190
+ originContext: string;
191
+ source: string[];
192
+ };
193
+ };
194
+ export declare const expectedStreamAnswerAPIParamWithATabWithAnExpression: {
195
+ cq: string;
196
+ tab: string;
197
+ q: string;
198
+ aq: string;
199
+ dq: string;
200
+ lq: string;
201
+ enableQuerySyntax: boolean;
202
+ context: {
203
+ testKey: string;
204
+ };
205
+ pipelineRuleParameters: {
206
+ mlGenerativeQuestionAnswering: {
207
+ responseFormat: {
208
+ contentFormat: string[];
209
+ };
210
+ citationsFieldToInclude: never[];
211
+ };
212
+ };
213
+ searchHub: string;
214
+ facets: ({
215
+ filterFacetCount: boolean;
216
+ injectionDepth: number;
217
+ numberOfValues: number;
218
+ sortCriteria: string;
219
+ resultsMustMatch: string;
220
+ type: string;
221
+ currentValues: never[];
222
+ freezeCurrentValues: boolean;
223
+ isFieldExpanded: boolean;
224
+ preventAutoSelect: boolean;
225
+ facetId: string;
226
+ field: string;
227
+ rangeAlgorithm?: undefined;
228
+ generateAutomaticRanges?: undefined;
229
+ delimitingCharacter?: undefined;
230
+ basePath?: undefined;
231
+ filterByBasePath?: undefined;
232
+ } | {
233
+ filterFacetCount: boolean;
234
+ injectionDepth: number;
235
+ numberOfValues: number;
236
+ sortCriteria: string;
237
+ rangeAlgorithm: string;
238
+ resultsMustMatch: string;
239
+ currentValues: {
240
+ start: string;
241
+ end: string;
242
+ endInclusive: boolean;
243
+ state: string;
244
+ }[];
245
+ preventAutoSelect: boolean;
246
+ type: string;
247
+ facetId: string;
248
+ field: string;
249
+ generateAutomaticRanges: boolean;
250
+ freezeCurrentValues?: undefined;
251
+ isFieldExpanded?: undefined;
252
+ delimitingCharacter?: undefined;
253
+ basePath?: undefined;
254
+ filterByBasePath?: undefined;
255
+ } | {
256
+ delimitingCharacter: string;
257
+ filterFacetCount: boolean;
258
+ injectionDepth: number;
259
+ numberOfValues: number;
260
+ sortCriteria: string;
261
+ basePath: never[];
262
+ filterByBasePath: boolean;
263
+ resultsMustMatch: string;
264
+ currentValues: never[];
265
+ preventAutoSelect: boolean;
266
+ type: string;
267
+ facetId: string;
268
+ field: string;
269
+ freezeCurrentValues?: undefined;
270
+ isFieldExpanded?: undefined;
271
+ rangeAlgorithm?: undefined;
272
+ generateAutomaticRanges?: undefined;
273
+ } | {
274
+ filterFacetCount: boolean;
275
+ injectionDepth: number;
276
+ numberOfValues: number;
277
+ sortCriteria: string;
278
+ rangeAlgorithm: string;
279
+ resultsMustMatch: string;
280
+ currentValues: {
281
+ endInclusive: boolean;
282
+ state: string;
283
+ start: number;
284
+ end: number;
285
+ }[];
286
+ preventAutoSelect: boolean;
287
+ type: string;
288
+ facetId: string;
289
+ field: string;
290
+ generateAutomaticRanges: boolean;
291
+ freezeCurrentValues?: undefined;
292
+ isFieldExpanded?: undefined;
293
+ delimitingCharacter?: undefined;
294
+ basePath?: undefined;
295
+ filterByBasePath?: undefined;
296
+ })[];
297
+ fieldsToInclude: string[];
298
+ queryCorrection: {
299
+ enabled: boolean;
300
+ options: {
301
+ automaticallyCorrect: string;
302
+ };
303
+ };
304
+ enableDidYouMean: boolean;
305
+ numberOfResults: number;
306
+ firstResult: number;
307
+ analytics: {
308
+ actionCause: string;
309
+ capture: boolean;
310
+ clientId: string;
311
+ clientTimestamp: string;
312
+ documentLocation: string;
313
+ documentReferrer: string;
314
+ originContext: string;
315
+ source: string[];
316
+ };
317
+ };
318
+ export declare const expectedStreamAnswerAPIParamWithoutAnyTab: {
319
+ tab: string;
320
+ q: string;
321
+ aq: string;
322
+ cq: string;
323
+ dq: string;
324
+ lq: string;
325
+ enableQuerySyntax: boolean;
326
+ context: {
327
+ testKey: string;
328
+ };
329
+ pipelineRuleParameters: {
330
+ mlGenerativeQuestionAnswering: {
331
+ responseFormat: {
332
+ contentFormat: string[];
333
+ };
334
+ citationsFieldToInclude: never[];
335
+ };
336
+ };
337
+ searchHub: string;
338
+ facets: ({
339
+ filterFacetCount: boolean;
340
+ injectionDepth: number;
341
+ numberOfValues: number;
342
+ sortCriteria: string;
343
+ resultsMustMatch: string;
344
+ type: string;
345
+ currentValues: never[];
346
+ freezeCurrentValues: boolean;
347
+ isFieldExpanded: boolean;
348
+ preventAutoSelect: boolean;
349
+ facetId: string;
350
+ field: string;
351
+ rangeAlgorithm?: undefined;
352
+ generateAutomaticRanges?: undefined;
353
+ delimitingCharacter?: undefined;
354
+ basePath?: undefined;
355
+ filterByBasePath?: undefined;
356
+ } | {
357
+ filterFacetCount: boolean;
358
+ injectionDepth: number;
359
+ numberOfValues: number;
360
+ sortCriteria: string;
361
+ rangeAlgorithm: string;
362
+ resultsMustMatch: string;
363
+ currentValues: {
364
+ start: string;
365
+ end: string;
366
+ endInclusive: boolean;
367
+ state: string;
368
+ }[];
369
+ preventAutoSelect: boolean;
370
+ type: string;
371
+ facetId: string;
372
+ field: string;
373
+ generateAutomaticRanges: boolean;
374
+ freezeCurrentValues?: undefined;
375
+ isFieldExpanded?: undefined;
376
+ delimitingCharacter?: undefined;
377
+ basePath?: undefined;
378
+ filterByBasePath?: undefined;
379
+ } | {
380
+ delimitingCharacter: string;
381
+ filterFacetCount: boolean;
382
+ injectionDepth: number;
383
+ numberOfValues: number;
384
+ sortCriteria: string;
385
+ basePath: never[];
386
+ filterByBasePath: boolean;
387
+ resultsMustMatch: string;
388
+ currentValues: never[];
389
+ preventAutoSelect: boolean;
390
+ type: string;
391
+ facetId: string;
392
+ field: string;
393
+ freezeCurrentValues?: undefined;
394
+ isFieldExpanded?: undefined;
395
+ rangeAlgorithm?: undefined;
396
+ generateAutomaticRanges?: undefined;
397
+ } | {
398
+ filterFacetCount: boolean;
399
+ injectionDepth: number;
400
+ numberOfValues: number;
401
+ sortCriteria: string;
402
+ rangeAlgorithm: string;
403
+ resultsMustMatch: string;
404
+ currentValues: {
405
+ endInclusive: boolean;
406
+ state: string;
407
+ start: number;
408
+ end: number;
409
+ }[];
410
+ preventAutoSelect: boolean;
411
+ type: string;
412
+ facetId: string;
413
+ field: string;
414
+ generateAutomaticRanges: boolean;
415
+ freezeCurrentValues?: undefined;
416
+ isFieldExpanded?: undefined;
417
+ delimitingCharacter?: undefined;
418
+ basePath?: undefined;
419
+ filterByBasePath?: undefined;
420
+ })[];
421
+ fieldsToInclude: string[];
422
+ queryCorrection: {
423
+ enabled: boolean;
424
+ options: {
425
+ automaticallyCorrect: string;
426
+ };
427
+ };
428
+ enableDidYouMean: boolean;
429
+ numberOfResults: number;
430
+ firstResult: number;
431
+ analytics: {
432
+ actionCause: string;
433
+ capture: boolean;
434
+ clientId: string;
435
+ clientTimestamp: string;
436
+ documentLocation: string;
437
+ documentReferrer: string;
438
+ originContext: string;
439
+ source: string[];
440
+ };
441
+ };
442
+ export declare const expectedStreamAnswerAPIParamWithStaticFiltersSelected: {
443
+ cq: string;
444
+ q: string;
445
+ aq: string;
446
+ dq: string;
447
+ lq: string;
448
+ enableQuerySyntax: boolean;
449
+ context: {
450
+ testKey: string;
451
+ };
452
+ pipelineRuleParameters: {
453
+ mlGenerativeQuestionAnswering: {
454
+ responseFormat: {
455
+ contentFormat: string[];
456
+ };
457
+ citationsFieldToInclude: never[];
458
+ };
459
+ };
460
+ searchHub: string;
461
+ facets: ({
462
+ filterFacetCount: boolean;
463
+ injectionDepth: number;
464
+ numberOfValues: number;
465
+ sortCriteria: string;
466
+ resultsMustMatch: string;
467
+ type: string;
468
+ currentValues: never[];
469
+ freezeCurrentValues: boolean;
470
+ isFieldExpanded: boolean;
471
+ preventAutoSelect: boolean;
472
+ facetId: string;
473
+ field: string;
474
+ rangeAlgorithm?: undefined;
475
+ generateAutomaticRanges?: undefined;
476
+ delimitingCharacter?: undefined;
477
+ basePath?: undefined;
478
+ filterByBasePath?: undefined;
479
+ } | {
480
+ filterFacetCount: boolean;
481
+ injectionDepth: number;
482
+ numberOfValues: number;
483
+ sortCriteria: string;
484
+ rangeAlgorithm: string;
485
+ resultsMustMatch: string;
486
+ currentValues: {
487
+ start: string;
488
+ end: string;
489
+ endInclusive: boolean;
490
+ state: string;
491
+ }[];
492
+ preventAutoSelect: boolean;
493
+ type: string;
494
+ facetId: string;
495
+ field: string;
496
+ generateAutomaticRanges: boolean;
497
+ freezeCurrentValues?: undefined;
498
+ isFieldExpanded?: undefined;
499
+ delimitingCharacter?: undefined;
500
+ basePath?: undefined;
501
+ filterByBasePath?: undefined;
502
+ } | {
503
+ delimitingCharacter: string;
504
+ filterFacetCount: boolean;
505
+ injectionDepth: number;
506
+ numberOfValues: number;
507
+ sortCriteria: string;
508
+ basePath: never[];
509
+ filterByBasePath: boolean;
510
+ resultsMustMatch: string;
511
+ currentValues: never[];
512
+ preventAutoSelect: boolean;
513
+ type: string;
514
+ facetId: string;
515
+ field: string;
516
+ freezeCurrentValues?: undefined;
517
+ isFieldExpanded?: undefined;
518
+ rangeAlgorithm?: undefined;
519
+ generateAutomaticRanges?: undefined;
520
+ } | {
521
+ filterFacetCount: boolean;
522
+ injectionDepth: number;
523
+ numberOfValues: number;
524
+ sortCriteria: string;
525
+ rangeAlgorithm: string;
526
+ resultsMustMatch: string;
527
+ currentValues: {
528
+ endInclusive: boolean;
529
+ state: string;
530
+ start: number;
531
+ end: number;
532
+ }[];
533
+ preventAutoSelect: boolean;
534
+ type: string;
535
+ facetId: string;
536
+ field: string;
537
+ generateAutomaticRanges: boolean;
538
+ freezeCurrentValues?: undefined;
539
+ isFieldExpanded?: undefined;
540
+ delimitingCharacter?: undefined;
541
+ basePath?: undefined;
542
+ filterByBasePath?: undefined;
543
+ })[];
544
+ fieldsToInclude: string[];
545
+ queryCorrection: {
546
+ enabled: boolean;
547
+ options: {
548
+ automaticallyCorrect: string;
549
+ };
550
+ };
551
+ enableDidYouMean: boolean;
552
+ numberOfResults: number;
553
+ firstResult: number;
554
+ tab: string;
555
+ analytics: {
556
+ actionCause: string;
557
+ capture: boolean;
558
+ clientId: string;
559
+ clientTimestamp: string;
560
+ documentLocation: string;
561
+ documentReferrer: string;
562
+ originContext: string;
563
+ source: string[];
564
+ };
565
+ };
566
+ export declare const expectedStreamAnswerAPIParamWithStaticFiltersAndTabExpression: {
567
+ cq: string;
568
+ q: string;
569
+ aq: string;
570
+ dq: string;
571
+ lq: string;
572
+ enableQuerySyntax: boolean;
573
+ context: {
574
+ testKey: string;
575
+ };
576
+ pipelineRuleParameters: {
577
+ mlGenerativeQuestionAnswering: {
578
+ responseFormat: {
579
+ contentFormat: string[];
580
+ };
581
+ citationsFieldToInclude: never[];
582
+ };
583
+ };
584
+ searchHub: string;
585
+ facets: ({
586
+ filterFacetCount: boolean;
587
+ injectionDepth: number;
588
+ numberOfValues: number;
589
+ sortCriteria: string;
590
+ resultsMustMatch: string;
591
+ type: string;
592
+ currentValues: never[];
593
+ freezeCurrentValues: boolean;
594
+ isFieldExpanded: boolean;
595
+ preventAutoSelect: boolean;
596
+ facetId: string;
597
+ field: string;
598
+ rangeAlgorithm?: undefined;
599
+ generateAutomaticRanges?: undefined;
600
+ delimitingCharacter?: undefined;
601
+ basePath?: undefined;
602
+ filterByBasePath?: undefined;
603
+ } | {
604
+ filterFacetCount: boolean;
605
+ injectionDepth: number;
606
+ numberOfValues: number;
607
+ sortCriteria: string;
608
+ rangeAlgorithm: string;
609
+ resultsMustMatch: string;
610
+ currentValues: {
611
+ start: string;
612
+ end: string;
613
+ endInclusive: boolean;
614
+ state: string;
615
+ }[];
616
+ preventAutoSelect: boolean;
617
+ type: string;
618
+ facetId: string;
619
+ field: string;
620
+ generateAutomaticRanges: boolean;
621
+ freezeCurrentValues?: undefined;
622
+ isFieldExpanded?: undefined;
623
+ delimitingCharacter?: undefined;
624
+ basePath?: undefined;
625
+ filterByBasePath?: undefined;
626
+ } | {
627
+ delimitingCharacter: string;
628
+ filterFacetCount: boolean;
629
+ injectionDepth: number;
630
+ numberOfValues: number;
631
+ sortCriteria: string;
632
+ basePath: never[];
633
+ filterByBasePath: boolean;
634
+ resultsMustMatch: string;
635
+ currentValues: never[];
636
+ preventAutoSelect: boolean;
637
+ type: string;
638
+ facetId: string;
639
+ field: string;
640
+ freezeCurrentValues?: undefined;
641
+ isFieldExpanded?: undefined;
642
+ rangeAlgorithm?: undefined;
643
+ generateAutomaticRanges?: undefined;
644
+ } | {
645
+ filterFacetCount: boolean;
646
+ injectionDepth: number;
647
+ numberOfValues: number;
648
+ sortCriteria: string;
649
+ rangeAlgorithm: string;
650
+ resultsMustMatch: string;
651
+ currentValues: {
652
+ endInclusive: boolean;
653
+ state: string;
654
+ start: number;
655
+ end: number;
656
+ }[];
657
+ preventAutoSelect: boolean;
658
+ type: string;
659
+ facetId: string;
660
+ field: string;
661
+ generateAutomaticRanges: boolean;
662
+ freezeCurrentValues?: undefined;
663
+ isFieldExpanded?: undefined;
664
+ delimitingCharacter?: undefined;
665
+ basePath?: undefined;
666
+ filterByBasePath?: undefined;
667
+ })[];
668
+ fieldsToInclude: string[];
669
+ queryCorrection: {
670
+ enabled: boolean;
671
+ options: {
672
+ automaticallyCorrect: string;
673
+ };
674
+ };
675
+ enableDidYouMean: boolean;
676
+ numberOfResults: number;
677
+ firstResult: number;
678
+ tab: string;
679
+ analytics: {
680
+ actionCause: string;
681
+ capture: boolean;
682
+ clientId: string;
683
+ clientTimestamp: string;
684
+ documentLocation: string;
685
+ documentReferrer: string;
686
+ originContext: string;
687
+ source: string[];
688
+ };
689
+ };
690
+ export declare const expectedStreamAnswerAPIParamWithStaticFiltersAndTabExpressionWithoutAdvancedCQ: {
691
+ cq: string;
692
+ q: string;
693
+ aq: string;
694
+ dq: string;
695
+ lq: string;
696
+ enableQuerySyntax: boolean;
697
+ context: {
698
+ testKey: string;
699
+ };
700
+ pipelineRuleParameters: {
701
+ mlGenerativeQuestionAnswering: {
702
+ responseFormat: {
703
+ contentFormat: string[];
704
+ };
705
+ citationsFieldToInclude: never[];
706
+ };
707
+ };
708
+ searchHub: string;
709
+ facets: ({
710
+ filterFacetCount: boolean;
711
+ injectionDepth: number;
712
+ numberOfValues: number;
713
+ sortCriteria: string;
714
+ resultsMustMatch: string;
715
+ type: string;
716
+ currentValues: never[];
717
+ freezeCurrentValues: boolean;
718
+ isFieldExpanded: boolean;
719
+ preventAutoSelect: boolean;
720
+ facetId: string;
721
+ field: string;
722
+ rangeAlgorithm?: undefined;
723
+ generateAutomaticRanges?: undefined;
724
+ delimitingCharacter?: undefined;
725
+ basePath?: undefined;
726
+ filterByBasePath?: undefined;
727
+ } | {
728
+ filterFacetCount: boolean;
729
+ injectionDepth: number;
730
+ numberOfValues: number;
731
+ sortCriteria: string;
732
+ rangeAlgorithm: string;
733
+ resultsMustMatch: string;
734
+ currentValues: {
735
+ start: string;
736
+ end: string;
737
+ endInclusive: boolean;
738
+ state: string;
739
+ }[];
740
+ preventAutoSelect: boolean;
741
+ type: string;
742
+ facetId: string;
743
+ field: string;
744
+ generateAutomaticRanges: boolean;
745
+ freezeCurrentValues?: undefined;
746
+ isFieldExpanded?: undefined;
747
+ delimitingCharacter?: undefined;
748
+ basePath?: undefined;
749
+ filterByBasePath?: undefined;
750
+ } | {
751
+ delimitingCharacter: string;
752
+ filterFacetCount: boolean;
753
+ injectionDepth: number;
754
+ numberOfValues: number;
755
+ sortCriteria: string;
756
+ basePath: never[];
757
+ filterByBasePath: boolean;
758
+ resultsMustMatch: string;
759
+ currentValues: never[];
760
+ preventAutoSelect: boolean;
761
+ type: string;
762
+ facetId: string;
763
+ field: string;
764
+ freezeCurrentValues?: undefined;
765
+ isFieldExpanded?: undefined;
766
+ rangeAlgorithm?: undefined;
767
+ generateAutomaticRanges?: undefined;
768
+ } | {
769
+ filterFacetCount: boolean;
770
+ injectionDepth: number;
771
+ numberOfValues: number;
772
+ sortCriteria: string;
773
+ rangeAlgorithm: string;
774
+ resultsMustMatch: string;
775
+ currentValues: {
776
+ endInclusive: boolean;
777
+ state: string;
778
+ start: number;
779
+ end: number;
780
+ }[];
781
+ preventAutoSelect: boolean;
782
+ type: string;
783
+ facetId: string;
784
+ field: string;
785
+ generateAutomaticRanges: boolean;
786
+ freezeCurrentValues?: undefined;
787
+ isFieldExpanded?: undefined;
788
+ delimitingCharacter?: undefined;
789
+ basePath?: undefined;
790
+ filterByBasePath?: undefined;
791
+ })[];
792
+ fieldsToInclude: string[];
793
+ queryCorrection: {
794
+ enabled: boolean;
795
+ options: {
796
+ automaticallyCorrect: string;
797
+ };
798
+ };
799
+ enableDidYouMean: boolean;
800
+ numberOfResults: number;
801
+ firstResult: number;
802
+ tab: string;
803
+ analytics: {
804
+ actionCause: string;
805
+ capture: boolean;
806
+ clientId: string;
807
+ clientTimestamp: string;
808
+ documentLocation: string;
809
+ documentReferrer: string;
810
+ originContext: string;
811
+ source: string[];
812
+ };
813
+ };
814
+ export declare const expectedStreamAnswerAPIParamWithoutSearchAction: {
815
+ analytics: {
816
+ actionCause: string;
817
+ capture: boolean;
818
+ clientId: string;
819
+ clientTimestamp: string;
820
+ documentLocation: string;
821
+ documentReferrer: string;
822
+ originContext: string;
823
+ source: string[];
824
+ };
825
+ q: string;
826
+ aq: string;
827
+ cq: string;
828
+ dq: string;
829
+ lq: string;
830
+ enableQuerySyntax: boolean;
831
+ context: {
832
+ testKey: string;
833
+ };
834
+ pipelineRuleParameters: {
835
+ mlGenerativeQuestionAnswering: {
836
+ responseFormat: {
837
+ contentFormat: string[];
838
+ };
839
+ citationsFieldToInclude: never[];
840
+ };
841
+ };
842
+ searchHub: string;
843
+ facets: ({
844
+ filterFacetCount: boolean;
845
+ injectionDepth: number;
846
+ numberOfValues: number;
847
+ sortCriteria: string;
848
+ resultsMustMatch: string;
849
+ type: string;
850
+ currentValues: never[];
851
+ freezeCurrentValues: boolean;
852
+ isFieldExpanded: boolean;
853
+ preventAutoSelect: boolean;
854
+ facetId: string;
855
+ field: string;
856
+ rangeAlgorithm?: undefined;
857
+ generateAutomaticRanges?: undefined;
858
+ delimitingCharacter?: undefined;
859
+ basePath?: undefined;
860
+ filterByBasePath?: undefined;
861
+ } | {
862
+ filterFacetCount: boolean;
863
+ injectionDepth: number;
864
+ numberOfValues: number;
865
+ sortCriteria: string;
866
+ rangeAlgorithm: string;
867
+ resultsMustMatch: string;
868
+ currentValues: {
869
+ start: string;
870
+ end: string;
871
+ endInclusive: boolean;
872
+ state: string;
873
+ }[];
874
+ preventAutoSelect: boolean;
875
+ type: string;
876
+ facetId: string;
877
+ field: string;
878
+ generateAutomaticRanges: boolean;
879
+ freezeCurrentValues?: undefined;
880
+ isFieldExpanded?: undefined;
881
+ delimitingCharacter?: undefined;
882
+ basePath?: undefined;
883
+ filterByBasePath?: undefined;
884
+ } | {
885
+ delimitingCharacter: string;
886
+ filterFacetCount: boolean;
887
+ injectionDepth: number;
888
+ numberOfValues: number;
889
+ sortCriteria: string;
890
+ basePath: never[];
891
+ filterByBasePath: boolean;
892
+ resultsMustMatch: string;
893
+ currentValues: never[];
894
+ preventAutoSelect: boolean;
895
+ type: string;
896
+ facetId: string;
897
+ field: string;
898
+ freezeCurrentValues?: undefined;
899
+ isFieldExpanded?: undefined;
900
+ rangeAlgorithm?: undefined;
901
+ generateAutomaticRanges?: undefined;
902
+ } | {
903
+ filterFacetCount: boolean;
904
+ injectionDepth: number;
905
+ numberOfValues: number;
906
+ sortCriteria: string;
907
+ rangeAlgorithm: string;
908
+ resultsMustMatch: string;
909
+ currentValues: {
910
+ endInclusive: boolean;
911
+ state: string;
912
+ start: number;
913
+ end: number;
914
+ }[];
915
+ preventAutoSelect: boolean;
916
+ type: string;
917
+ facetId: string;
918
+ field: string;
919
+ generateAutomaticRanges: boolean;
920
+ freezeCurrentValues?: undefined;
921
+ isFieldExpanded?: undefined;
922
+ delimitingCharacter?: undefined;
923
+ basePath?: undefined;
924
+ filterByBasePath?: undefined;
925
+ })[];
926
+ fieldsToInclude: string[];
927
+ queryCorrection: {
928
+ enabled: boolean;
929
+ options: {
930
+ automaticallyCorrect: string;
931
+ };
932
+ };
933
+ enableDidYouMean: boolean;
934
+ numberOfResults: number;
935
+ firstResult: number;
936
+ tab: string;
937
+ };
938
+ export declare const expectedStreamAnswerAPIParamForSelect: {
939
+ q: string;
940
+ aq: string;
941
+ cq: string;
942
+ dq: string;
943
+ lq: string;
944
+ enableQuerySyntax: boolean;
945
+ context: {
946
+ testKey: string;
947
+ };
948
+ pipelineRuleParameters: {
949
+ mlGenerativeQuestionAnswering: {
950
+ responseFormat: {
951
+ contentFormat: string[];
952
+ };
953
+ citationsFieldToInclude: never[];
954
+ };
955
+ };
956
+ searchHub: string;
957
+ facets: ({
958
+ filterFacetCount: boolean;
959
+ injectionDepth: number;
960
+ numberOfValues: number;
961
+ sortCriteria: string;
962
+ resultsMustMatch: string;
963
+ type: string;
964
+ currentValues: never[];
965
+ freezeCurrentValues: boolean;
966
+ isFieldExpanded: boolean;
967
+ preventAutoSelect: boolean;
968
+ facetId: string;
969
+ field: string;
970
+ rangeAlgorithm?: undefined;
971
+ generateAutomaticRanges?: undefined;
972
+ delimitingCharacter?: undefined;
973
+ basePath?: undefined;
974
+ filterByBasePath?: undefined;
975
+ } | {
976
+ filterFacetCount: boolean;
977
+ injectionDepth: number;
978
+ numberOfValues: number;
979
+ sortCriteria: string;
980
+ rangeAlgorithm: string;
981
+ resultsMustMatch: string;
982
+ currentValues: {
983
+ start: string;
984
+ end: string;
985
+ endInclusive: boolean;
986
+ state: string;
987
+ }[];
988
+ preventAutoSelect: boolean;
989
+ type: string;
990
+ facetId: string;
991
+ field: string;
992
+ generateAutomaticRanges: boolean;
993
+ freezeCurrentValues?: undefined;
994
+ isFieldExpanded?: undefined;
995
+ delimitingCharacter?: undefined;
996
+ basePath?: undefined;
997
+ filterByBasePath?: undefined;
998
+ } | {
999
+ delimitingCharacter: string;
1000
+ filterFacetCount: boolean;
1001
+ injectionDepth: number;
1002
+ numberOfValues: number;
1003
+ sortCriteria: string;
1004
+ basePath: never[];
1005
+ filterByBasePath: boolean;
1006
+ resultsMustMatch: string;
1007
+ currentValues: never[];
1008
+ preventAutoSelect: boolean;
1009
+ type: string;
1010
+ facetId: string;
1011
+ field: string;
1012
+ freezeCurrentValues?: undefined;
1013
+ isFieldExpanded?: undefined;
1014
+ rangeAlgorithm?: undefined;
1015
+ generateAutomaticRanges?: undefined;
1016
+ } | {
1017
+ filterFacetCount: boolean;
1018
+ injectionDepth: number;
1019
+ numberOfValues: number;
1020
+ sortCriteria: string;
1021
+ rangeAlgorithm: string;
1022
+ resultsMustMatch: string;
1023
+ currentValues: {
1024
+ endInclusive: boolean;
1025
+ state: string;
1026
+ start: number;
1027
+ end: number;
1028
+ }[];
1029
+ preventAutoSelect: boolean;
1030
+ type: string;
1031
+ facetId: string;
1032
+ field: string;
1033
+ generateAutomaticRanges: boolean;
1034
+ freezeCurrentValues?: undefined;
1035
+ isFieldExpanded?: undefined;
1036
+ delimitingCharacter?: undefined;
1037
+ basePath?: undefined;
1038
+ filterByBasePath?: undefined;
1039
+ })[];
1040
+ fieldsToInclude: string[];
1041
+ queryCorrection: {
1042
+ enabled: boolean;
1043
+ options: {
1044
+ automaticallyCorrect: string;
1045
+ };
1046
+ };
1047
+ enableDidYouMean: boolean;
1048
+ numberOfResults: number;
1049
+ firstResult: number;
1050
+ tab: string;
1051
+ };