-
Notifications
You must be signed in to change notification settings - Fork 728
/
Copy pathtypes.ts
22297 lines (18940 loc) · 588 KB
/
types.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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/* eslint-disable @typescript-eslint/array-type */
/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-unused-vars */
/**
* We are still working on this type, it will arrive soon.
* If it's critical for you, please open an issue.
* https://github.com/elastic/elasticsearch-js
*/
export type TODO = Record<string, any>
export interface BulkCreateOperation extends BulkWriteOperation {
}
export interface BulkDeleteOperation extends BulkOperationBase {
}
export type BulkFailureStoreStatus = 'not_applicable_or_unknown' | 'used' | 'not_enabled' | 'failed'
export interface BulkIndexOperation extends BulkWriteOperation {
}
export interface BulkOperationBase {
_id?: Id
_index?: IndexName
routing?: Routing
if_primary_term?: long
if_seq_no?: SequenceNumber
version?: VersionNumber
version_type?: VersionType
}
export interface BulkOperationContainer {
index?: BulkIndexOperation
create?: BulkCreateOperation
update?: BulkUpdateOperation
delete?: BulkDeleteOperation
}
export type BulkOperationType = 'index' | 'create' | 'update' | 'delete'
export interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends RequestBase {
index?: IndexName
include_source_on_error?: boolean
list_executed_pipelines?: boolean
pipeline?: string
refresh?: Refresh
routing?: Routing
_source?: SearchSourceConfigParam
_source_excludes?: Fields
_source_includes?: Fields
timeout?: Duration
wait_for_active_shards?: WaitForActiveShards
require_alias?: boolean
require_data_stream?: boolean
operations?: (BulkOperationContainer | BulkUpdateAction<TDocument, TPartialDocument> | TDocument)[]
}
export interface BulkResponse {
errors: boolean
items: Partial<Record<BulkOperationType, BulkResponseItem>>[]
took: long
ingest_took?: long
}
export interface BulkResponseItem {
_id?: string | null
_index: string
status: integer
failure_store?: BulkFailureStoreStatus
error?: ErrorCause
_primary_term?: long
result?: string
_seq_no?: SequenceNumber
_shards?: ShardStatistics
_version?: VersionNumber
forced_refresh?: boolean
get?: InlineGet<Record<string, any>>
}
export interface BulkUpdateAction<TDocument = unknown, TPartialDocument = unknown> {
detect_noop?: boolean
doc?: TPartialDocument
doc_as_upsert?: boolean
script?: Script | string
scripted_upsert?: boolean
_source?: SearchSourceConfig
upsert?: TDocument
}
export interface BulkUpdateOperation extends BulkOperationBase {
require_alias?: boolean
retry_on_conflict?: integer
}
export interface BulkWriteOperation extends BulkOperationBase {
dynamic_templates?: Record<string, string>
pipeline?: string
require_alias?: boolean
}
export interface ClearScrollRequest extends RequestBase {
scroll_id?: ScrollIds
}
export interface ClearScrollResponse {
succeeded: boolean
num_freed: integer
}
export interface ClosePointInTimeRequest extends RequestBase {
id: Id
}
export interface ClosePointInTimeResponse {
succeeded: boolean
num_freed: integer
}
export interface CountRequest extends RequestBase {
index?: Indices
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
default_operator?: QueryDslOperator
df?: string
expand_wildcards?: ExpandWildcards
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
min_score?: double
preference?: string
routing?: Routing
terminate_after?: long
q?: string
query?: QueryDslQueryContainer
}
export interface CountResponse {
count: long
_shards: ShardStatistics
}
export interface CreateRequest<TDocument = unknown> extends RequestBase {
id: Id
index: IndexName
if_primary_term?: long
if_seq_no?: SequenceNumber
include_source_on_error?: boolean
op_type?: OpType
pipeline?: string
refresh?: Refresh
require_alias?: boolean
require_data_stream?: boolean
routing?: Routing
timeout?: Duration
version?: VersionNumber
version_type?: VersionType
wait_for_active_shards?: WaitForActiveShards
document?: TDocument
}
export type CreateResponse = WriteResponseBase
export interface DeleteRequest extends RequestBase {
id: Id
index: IndexName
if_primary_term?: long
if_seq_no?: SequenceNumber
refresh?: Refresh
routing?: Routing
timeout?: Duration
version?: VersionNumber
version_type?: VersionType
wait_for_active_shards?: WaitForActiveShards
}
export type DeleteResponse = WriteResponseBase
export interface DeleteByQueryRequest extends RequestBase {
index: Indices
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
conflicts?: Conflicts
default_operator?: QueryDslOperator
df?: string
expand_wildcards?: ExpandWildcards
from?: long
ignore_unavailable?: boolean
lenient?: boolean
preference?: string
refresh?: boolean
request_cache?: boolean
requests_per_second?: float
routing?: Routing
q?: string
scroll?: Duration
scroll_size?: long
search_timeout?: Duration
search_type?: SearchType
slices?: Slices
sort?: string[]
stats?: string[]
terminate_after?: long
timeout?: Duration
version?: boolean
wait_for_active_shards?: WaitForActiveShards
wait_for_completion?: boolean
max_docs?: long
query?: QueryDslQueryContainer
slice?: SlicedScroll
}
export interface DeleteByQueryResponse {
batches?: long
deleted?: long
failures?: BulkIndexByScrollFailure[]
noops?: long
requests_per_second?: float
retries?: Retries
slice_id?: integer
task?: TaskId
throttled?: Duration
throttled_millis?: DurationValue<UnitMillis>
throttled_until?: Duration
throttled_until_millis?: DurationValue<UnitMillis>
timed_out?: boolean
took?: DurationValue<UnitMillis>
total?: long
version_conflicts?: long
}
export interface DeleteByQueryRethrottleRequest extends RequestBase {
task_id: TaskId
requests_per_second?: float
}
export type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase
export interface DeleteScriptRequest extends RequestBase {
id: Id
master_timeout?: Duration
timeout?: Duration
}
export type DeleteScriptResponse = AcknowledgedResponseBase
export interface ExistsRequest extends RequestBase {
id: Id
index: IndexName
preference?: string
realtime?: boolean
refresh?: boolean
routing?: Routing
_source?: SearchSourceConfigParam
_source_excludes?: Fields
_source_includes?: Fields
stored_fields?: Fields
version?: VersionNumber
version_type?: VersionType
}
export type ExistsResponse = boolean
export interface ExistsSourceRequest extends RequestBase {
id: Id
index: IndexName
preference?: string
realtime?: boolean
refresh?: boolean
routing?: Routing
_source?: SearchSourceConfigParam
_source_excludes?: Fields
_source_includes?: Fields
version?: VersionNumber
version_type?: VersionType
}
export type ExistsSourceResponse = boolean
export interface ExplainExplanation {
description: string
details: ExplainExplanationDetail[]
value: float
}
export interface ExplainExplanationDetail {
description: string
details?: ExplainExplanationDetail[]
value: float
}
export interface ExplainRequest extends RequestBase {
id: Id
index: IndexName
analyzer?: string
analyze_wildcard?: boolean
default_operator?: QueryDslOperator
df?: string
lenient?: boolean
preference?: string
routing?: Routing
_source?: SearchSourceConfigParam
_source_excludes?: Fields
_source_includes?: Fields
stored_fields?: Fields
q?: string
query?: QueryDslQueryContainer
}
export interface ExplainResponse<TDocument = unknown> {
_index: IndexName
_id: Id
matched: boolean
explanation?: ExplainExplanationDetail
get?: InlineGet<TDocument>
}
export interface FieldCapsFieldCapability {
aggregatable: boolean
indices?: Indices
meta?: Metadata
non_aggregatable_indices?: Indices
non_searchable_indices?: Indices
searchable: boolean
type: string
metadata_field?: boolean
time_series_dimension?: boolean
time_series_metric?: MappingTimeSeriesMetricType
non_dimension_indices?: IndexName[]
metric_conflicts_indices?: IndexName[]
}
export interface FieldCapsRequest extends RequestBase {
index?: Indices
allow_no_indices?: boolean
expand_wildcards?: ExpandWildcards
ignore_unavailable?: boolean
include_unmapped?: boolean
filters?: string
types?: string[]
include_empty_fields?: boolean
fields?: Fields
index_filter?: QueryDslQueryContainer
runtime_mappings?: MappingRuntimeFields
}
export interface FieldCapsResponse {
indices: Indices
fields: Record<Field, Record<string, FieldCapsFieldCapability>>
}
export interface GetGetResult<TDocument = unknown> {
_index: IndexName
fields?: Record<string, any>
_ignored?: string[]
found: boolean
_id: Id
_primary_term?: long
_routing?: string
_seq_no?: SequenceNumber
_source?: TDocument
_version?: VersionNumber
}
export interface GetRequest extends RequestBase {
id: Id
index: IndexName
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
routing?: Routing
_source?: SearchSourceConfigParam
_source_excludes?: Fields
_source_includes?: Fields
stored_fields?: Fields
version?: VersionNumber
version_type?: VersionType
}
export type GetResponse<TDocument = unknown> = GetGetResult<TDocument>
export interface GetScriptRequest extends RequestBase {
id: Id
master_timeout?: Duration
}
export interface GetScriptResponse {
_id: Id
found: boolean
script?: StoredScript
}
export interface GetScriptContextContext {
methods: GetScriptContextContextMethod[]
name: Name
}
export interface GetScriptContextContextMethod {
name: Name
return_type: string
params: GetScriptContextContextMethodParam[]
}
export interface GetScriptContextContextMethodParam {
name: Name
type: string
}
export interface GetScriptContextRequest extends RequestBase {
}
export interface GetScriptContextResponse {
contexts: GetScriptContextContext[]
}
export interface GetScriptLanguagesLanguageContext {
contexts: string[]
language: ScriptLanguage
}
export interface GetScriptLanguagesRequest extends RequestBase {
}
export interface GetScriptLanguagesResponse {
language_contexts: GetScriptLanguagesLanguageContext[]
types_allowed: string[]
}
export interface GetSourceRequest extends RequestBase {
id: Id
index: IndexName
preference?: string
realtime?: boolean
refresh?: boolean
routing?: Routing
_source?: SearchSourceConfigParam
_source_excludes?: Fields
_source_includes?: Fields
stored_fields?: Fields
version?: VersionNumber
version_type?: VersionType
}
export type GetSourceResponse<TDocument = unknown> = TDocument
export interface HealthReportBaseIndicator {
status: HealthReportIndicatorHealthStatus
symptom: string
impacts?: HealthReportImpact[]
diagnosis?: HealthReportDiagnosis[]
}
export interface HealthReportDataStreamLifecycleDetails {
stagnating_backing_indices_count: integer
total_backing_indices_in_error: integer
stagnating_backing_indices?: HealthReportStagnatingBackingIndices[]
}
export interface HealthReportDataStreamLifecycleIndicator extends HealthReportBaseIndicator {
details?: HealthReportDataStreamLifecycleDetails
}
export interface HealthReportDiagnosis {
id: string
action: string
affected_resources: HealthReportDiagnosisAffectedResources
cause: string
help_url: string
}
export interface HealthReportDiagnosisAffectedResources {
indices?: Indices
nodes?: HealthReportIndicatorNode[]
slm_policies?: string[]
feature_states?: string[]
snapshot_repositories?: string[]
}
export interface HealthReportDiskIndicator extends HealthReportBaseIndicator {
details?: HealthReportDiskIndicatorDetails
}
export interface HealthReportDiskIndicatorDetails {
indices_with_readonly_block: long
nodes_with_enough_disk_space: long
nodes_over_high_watermark: long
nodes_over_flood_stage_watermark: long
nodes_with_unknown_disk_status: long
}
export interface HealthReportIlmIndicator extends HealthReportBaseIndicator {
details?: HealthReportIlmIndicatorDetails
}
export interface HealthReportIlmIndicatorDetails {
ilm_status: LifecycleOperationMode
policies: long
stagnating_indices: integer
}
export interface HealthReportImpact {
description: string
id: string
impact_areas: HealthReportImpactArea[]
severity: integer
}
export type HealthReportImpactArea = 'search' | 'ingest' | 'backup' | 'deployment_management'
export type HealthReportIndicatorHealthStatus = 'green' | 'yellow' | 'red' | 'unknown'
export interface HealthReportIndicatorNode {
name: string | null
node_id: string | null
}
export interface HealthReportIndicators {
master_is_stable?: HealthReportMasterIsStableIndicator
shards_availability?: HealthReportShardsAvailabilityIndicator
disk?: HealthReportDiskIndicator
repository_integrity?: HealthReportRepositoryIntegrityIndicator
data_stream_lifecycle?: HealthReportDataStreamLifecycleIndicator
ilm?: HealthReportIlmIndicator
slm?: HealthReportSlmIndicator
shards_capacity?: HealthReportShardsCapacityIndicator
}
export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator {
details?: HealthReportMasterIsStableIndicatorDetails
}
export interface HealthReportMasterIsStableIndicatorClusterFormationNode {
name?: string
node_id: string
cluster_formation_message: string
}
export interface HealthReportMasterIsStableIndicatorDetails {
current_master: HealthReportIndicatorNode
recent_masters: HealthReportIndicatorNode[]
exception_fetching_history?: HealthReportMasterIsStableIndicatorExceptionFetchingHistory
cluster_formation?: HealthReportMasterIsStableIndicatorClusterFormationNode[]
}
export interface HealthReportMasterIsStableIndicatorExceptionFetchingHistory {
message: string
stack_trace: string
}
export interface HealthReportRepositoryIntegrityIndicator extends HealthReportBaseIndicator {
details?: HealthReportRepositoryIntegrityIndicatorDetails
}
export interface HealthReportRepositoryIntegrityIndicatorDetails {
total_repositories?: long
corrupted_repositories?: long
corrupted?: string[]
}
export interface HealthReportRequest extends RequestBase {
feature?: string | string[]
timeout?: Duration
verbose?: boolean
size?: integer
}
export interface HealthReportResponse {
cluster_name: string
indicators: HealthReportIndicators
status?: HealthReportIndicatorHealthStatus
}
export interface HealthReportShardsAvailabilityIndicator extends HealthReportBaseIndicator {
details?: HealthReportShardsAvailabilityIndicatorDetails
}
export interface HealthReportShardsAvailabilityIndicatorDetails {
creating_primaries: long
creating_replicas: long
initializing_primaries: long
initializing_replicas: long
restarting_primaries: long
restarting_replicas: long
started_primaries: long
started_replicas: long
unassigned_primaries: long
unassigned_replicas: long
}
export interface HealthReportShardsCapacityIndicator extends HealthReportBaseIndicator {
details?: HealthReportShardsCapacityIndicatorDetails
}
export interface HealthReportShardsCapacityIndicatorDetails {
data: HealthReportShardsCapacityIndicatorTierDetail
frozen: HealthReportShardsCapacityIndicatorTierDetail
}
export interface HealthReportShardsCapacityIndicatorTierDetail {
max_shards_in_cluster: integer
current_used_shards?: integer
}
export interface HealthReportSlmIndicator extends HealthReportBaseIndicator {
details?: HealthReportSlmIndicatorDetails
}
export interface HealthReportSlmIndicatorDetails {
slm_status: LifecycleOperationMode
policies: long
unhealthy_policies?: HealthReportSlmIndicatorUnhealthyPolicies
}
export interface HealthReportSlmIndicatorUnhealthyPolicies {
count: long
invocations_since_last_success?: Record<string, long>
}
export interface HealthReportStagnatingBackingIndices {
index_name: IndexName
first_occurrence_timestamp: long
retry_count: integer
}
export interface IndexRequest<TDocument = unknown> extends RequestBase {
id?: Id
index: IndexName
if_primary_term?: long
if_seq_no?: SequenceNumber
include_source_on_error?: boolean
op_type?: OpType
pipeline?: string
refresh?: Refresh
routing?: Routing
timeout?: Duration
version?: VersionNumber
version_type?: VersionType
wait_for_active_shards?: WaitForActiveShards
require_alias?: boolean
document?: TDocument
}
export type IndexResponse = WriteResponseBase
export interface InfoRequest extends RequestBase {
}
export interface InfoResponse {
cluster_name: Name
cluster_uuid: Uuid
name: Name
tagline: string
version: ElasticsearchVersionInfo
}
export interface KnnSearchRequest extends RequestBase {
index: Indices
routing?: Routing
_source?: SearchSourceConfig
docvalue_fields?: (QueryDslFieldAndFormat | Field)[]
stored_fields?: Fields
fields?: Fields
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
knn: KnnSearchQuery
}
export interface KnnSearchResponse<TDocument = unknown> {
took: long
timed_out: boolean
_shards: ShardStatistics
hits: SearchHitsMetadata<TDocument>
fields?: Record<string, any>
max_score?: double
}
export interface KnnSearchQuery {
field: Field
query_vector: QueryVector
k: integer
num_candidates: integer
}
export interface MgetMultiGetError {
error: ErrorCause
_id: Id
_index: IndexName
}
export interface MgetOperation {
_id: Id
_index?: IndexName
routing?: Routing
_source?: SearchSourceConfig
stored_fields?: Fields
version?: VersionNumber
version_type?: VersionType
}
export interface MgetRequest extends RequestBase {
index?: IndexName
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
routing?: Routing
_source?: SearchSourceConfigParam
_source_excludes?: Fields
_source_includes?: Fields
stored_fields?: Fields
docs?: MgetOperation[]
ids?: Ids
}
export interface MgetResponse<TDocument = unknown> {
docs: MgetResponseItem<TDocument>[]
}
export type MgetResponseItem<TDocument = unknown> = GetGetResult<TDocument> | MgetMultiGetError
export interface MsearchMultiSearchItem<TDocument = unknown> extends SearchResponseBody<TDocument> {
status?: integer
}
export interface MsearchMultiSearchResult<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> {
took: long
responses: MsearchResponseItem<TDocument>[]
}
export interface MsearchMultisearchBody {
aggregations?: Record<string, AggregationsAggregationContainer>
aggs?: Record<string, AggregationsAggregationContainer>
collapse?: SearchFieldCollapse
query?: QueryDslQueryContainer
explain?: boolean
ext?: Record<string, any>
stored_fields?: Fields
docvalue_fields?: (QueryDslFieldAndFormat | Field)[]
knn?: KnnSearch | KnnSearch[]
from?: integer
highlight?: SearchHighlight
indices_boost?: Partial<Record<IndexName, double>>[]
min_score?: double
post_filter?: QueryDslQueryContainer
profile?: boolean
rescore?: SearchRescore | SearchRescore[]
script_fields?: Record<string, ScriptField>
search_after?: SortResults
size?: integer
sort?: Sort
_source?: SearchSourceConfig
fields?: (QueryDslFieldAndFormat | Field)[]
terminate_after?: long
stats?: string[]
timeout?: string
track_scores?: boolean
track_total_hits?: SearchTrackHits
version?: boolean
runtime_mappings?: MappingRuntimeFields
seq_no_primary_term?: boolean
pit?: SearchPointInTimeReference
suggest?: SearchSuggester
}
export interface MsearchMultisearchHeader {
allow_no_indices?: boolean
expand_wildcards?: ExpandWildcards
ignore_unavailable?: boolean
index?: Indices
preference?: string
request_cache?: boolean
routing?: Routing
search_type?: SearchType
ccs_minimize_roundtrips?: boolean
allow_partial_search_results?: boolean
ignore_throttled?: boolean
}
export interface MsearchRequest extends RequestBase {
index?: Indices
allow_no_indices?: boolean
ccs_minimize_roundtrips?: boolean
expand_wildcards?: ExpandWildcards
ignore_throttled?: boolean
ignore_unavailable?: boolean
include_named_queries_score?: boolean
max_concurrent_searches?: long
max_concurrent_shard_requests?: long
pre_filter_shard_size?: long
rest_total_hits_as_int?: boolean
routing?: Routing
search_type?: SearchType
typed_keys?: boolean
searches?: MsearchRequestItem[]
}
export type MsearchRequestItem = MsearchMultisearchHeader | MsearchMultisearchBody
export type MsearchResponse<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> = MsearchMultiSearchResult<TDocument, TAggregations>
export type MsearchResponseItem<TDocument = unknown> = MsearchMultiSearchItem<TDocument> | ErrorResponseBase
export interface MsearchTemplateRequest extends RequestBase {
index?: Indices
ccs_minimize_roundtrips?: boolean
max_concurrent_searches?: long
search_type?: SearchType
rest_total_hits_as_int?: boolean
typed_keys?: boolean
search_templates?: MsearchTemplateRequestItem[]
}
export type MsearchTemplateRequestItem = MsearchMultisearchHeader | MsearchTemplateTemplateConfig
export type MsearchTemplateResponse<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> = MsearchMultiSearchResult<TDocument, TAggregations>
export interface MsearchTemplateTemplateConfig {
explain?: boolean
id?: Id
params?: Record<string, any>
profile?: boolean
source?: string
}
export interface MtermvectorsOperation {
_id?: Id
_index?: IndexName
doc?: any
fields?: Fields
field_statistics?: boolean
filter?: TermvectorsFilter
offsets?: boolean
payloads?: boolean
positions?: boolean
routing?: Routing
term_statistics?: boolean
version?: VersionNumber
version_type?: VersionType
}
export interface MtermvectorsRequest extends RequestBase {
index?: IndexName
fields?: Fields
field_statistics?: boolean
offsets?: boolean
payloads?: boolean
positions?: boolean
preference?: string
realtime?: boolean
routing?: Routing
term_statistics?: boolean
version?: VersionNumber
version_type?: VersionType
docs?: MtermvectorsOperation[]
ids?: Id[]
}
export interface MtermvectorsResponse {
docs: MtermvectorsTermVectorsResult[]
}
export interface MtermvectorsTermVectorsResult {
_id?: Id
_index: IndexName
_version?: VersionNumber
took?: long
found?: boolean
term_vectors?: Record<Field, TermvectorsTermVector>
error?: ErrorCause
}
export interface OpenPointInTimeRequest extends RequestBase {
index: Indices
keep_alive: Duration
ignore_unavailable?: boolean
preference?: string
routing?: Routing
expand_wildcards?: ExpandWildcards
allow_partial_search_results?: boolean
max_concurrent_shard_requests?: integer
index_filter?: QueryDslQueryContainer
}
export interface OpenPointInTimeResponse {
_shards: ShardStatistics
id: Id
}
export interface PingRequest extends RequestBase {
}
export type PingResponse = boolean
export interface PutScriptRequest extends RequestBase {
id: Id
context?: Name
master_timeout?: Duration
timeout?: Duration
script: StoredScript
}
export type PutScriptResponse = AcknowledgedResponseBase
export interface RankEvalDocumentRating {
_id: Id
_index: IndexName
rating: integer
}
export interface RankEvalRankEvalHit {
_id: Id
_index: IndexName
_score: double
}
export interface RankEvalRankEvalHitItem {
hit: RankEvalRankEvalHit
rating?: double | null
}
export interface RankEvalRankEvalMetric {
precision?: RankEvalRankEvalMetricPrecision
recall?: RankEvalRankEvalMetricRecall
mean_reciprocal_rank?: RankEvalRankEvalMetricMeanReciprocalRank
dcg?: RankEvalRankEvalMetricDiscountedCumulativeGain
expected_reciprocal_rank?: RankEvalRankEvalMetricExpectedReciprocalRank
}
export interface RankEvalRankEvalMetricBase {
k?: integer
}
export interface RankEvalRankEvalMetricDetail {
metric_score: double
unrated_docs: RankEvalUnratedDocument[]
hits: RankEvalRankEvalHitItem[]
metric_details: Record<string, Record<string, any>>
}
export interface RankEvalRankEvalMetricDiscountedCumulativeGain extends RankEvalRankEvalMetricBase {
normalize?: boolean
}
export interface RankEvalRankEvalMetricExpectedReciprocalRank extends RankEvalRankEvalMetricBase {
maximum_relevance: integer
}
export interface RankEvalRankEvalMetricMeanReciprocalRank extends RankEvalRankEvalMetricRatingTreshold {
}
export interface RankEvalRankEvalMetricPrecision extends RankEvalRankEvalMetricRatingTreshold {
ignore_unlabeled?: boolean
}
export interface RankEvalRankEvalMetricRatingTreshold extends RankEvalRankEvalMetricBase {
relevant_rating_threshold?: integer
}
export interface RankEvalRankEvalMetricRecall extends RankEvalRankEvalMetricRatingTreshold {
}
export interface RankEvalRankEvalQuery {
query: QueryDslQueryContainer
size?: integer
}
export interface RankEvalRankEvalRequestItem {
id: Id
request?: RankEvalRankEvalQuery | QueryDslQueryContainer
ratings: RankEvalDocumentRating[]
template_id?: Id
params?: Record<string, any>
}
export interface RankEvalRequest extends RequestBase {
index?: Indices
allow_no_indices?: boolean
expand_wildcards?: ExpandWildcards
ignore_unavailable?: boolean