@elastic/elasticsearch 9.0.2 → 9.1.0

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 (130) hide show
  1. package/README.md +38 -52
  2. package/catalog-info.yaml +2 -15
  3. package/lib/api/api/async_search.d.ts +4 -4
  4. package/lib/api/api/autoscaling.d.ts +4 -4
  5. package/lib/api/api/bulk.d.ts +2 -2
  6. package/lib/api/api/cat.d.ts +26 -26
  7. package/lib/api/api/ccr.d.ts +13 -13
  8. package/lib/api/api/clear_scroll.d.ts +1 -1
  9. package/lib/api/api/close_point_in_time.d.ts +1 -1
  10. package/lib/api/api/cluster.d.ts +17 -17
  11. package/lib/api/api/cluster.js +2 -0
  12. package/lib/api/api/cluster.js.map +1 -1
  13. package/lib/api/api/connector.d.ts +30 -30
  14. package/lib/api/api/count.d.ts +1 -1
  15. package/lib/api/api/create.d.ts +1 -1
  16. package/lib/api/api/create.js +0 -3
  17. package/lib/api/api/create.js.map +1 -1
  18. package/lib/api/api/dangling_indices.d.ts +3 -3
  19. package/lib/api/api/delete.d.ts +1 -1
  20. package/lib/api/api/delete_by_query.d.ts +1 -1
  21. package/lib/api/api/delete_by_query_rethrottle.d.ts +1 -1
  22. package/lib/api/api/delete_script.d.ts +1 -1
  23. package/lib/api/api/enrich.d.ts +5 -5
  24. package/lib/api/api/eql.d.ts +4 -4
  25. package/lib/api/api/eql.js +1 -0
  26. package/lib/api/api/eql.js.map +1 -1
  27. package/lib/api/api/esql.d.ts +16 -4
  28. package/lib/api/api/esql.js +84 -6
  29. package/lib/api/api/esql.js.map +1 -1
  30. package/lib/api/api/exists.d.ts +1 -1
  31. package/lib/api/api/exists_source.d.ts +1 -1
  32. package/lib/api/api/explain.d.ts +1 -1
  33. package/lib/api/api/features.d.ts +2 -2
  34. package/lib/api/api/field_caps.d.ts +1 -1
  35. package/lib/api/api/fleet.d.ts +3 -3
  36. package/lib/api/api/get.d.ts +1 -1
  37. package/lib/api/api/get_script.d.ts +1 -1
  38. package/lib/api/api/get_script_context.d.ts +1 -1
  39. package/lib/api/api/get_script_languages.d.ts +1 -1
  40. package/lib/api/api/get_source.d.ts +1 -1
  41. package/lib/api/api/get_source.js +0 -1
  42. package/lib/api/api/get_source.js.map +1 -1
  43. package/lib/api/api/graph.d.ts +1 -1
  44. package/lib/api/api/health_report.d.ts +1 -1
  45. package/lib/api/api/ilm.d.ts +11 -11
  46. package/lib/api/api/index.d.ts +1 -1
  47. package/lib/api/api/index.js +2 -1
  48. package/lib/api/api/index.js.map +1 -1
  49. package/lib/api/api/indices.d.ts +110 -68
  50. package/lib/api/api/indices.js +289 -3
  51. package/lib/api/api/indices.js.map +1 -1
  52. package/lib/api/api/inference.d.ts +54 -33
  53. package/lib/api/api/inference.js +236 -18
  54. package/lib/api/api/inference.js.map +1 -1
  55. package/lib/api/api/info.d.ts +2 -2
  56. package/lib/api/api/ingest.d.ts +9 -9
  57. package/lib/api/api/ingest.js +1 -3
  58. package/lib/api/api/ingest.js.map +1 -1
  59. package/lib/api/api/knn_search.d.ts +1 -1
  60. package/lib/api/api/license.d.ts +7 -7
  61. package/lib/api/api/license.js +1 -1
  62. package/lib/api/api/license.js.map +1 -1
  63. package/lib/api/api/logstash.d.ts +3 -3
  64. package/lib/api/api/mget.d.ts +1 -1
  65. package/lib/api/api/migration.d.ts +3 -3
  66. package/lib/api/api/ml.d.ts +73 -73
  67. package/lib/api/api/monitoring.d.ts +1 -1
  68. package/lib/api/api/msearch.d.ts +1 -1
  69. package/lib/api/api/msearch.js +1 -0
  70. package/lib/api/api/msearch.js.map +1 -1
  71. package/lib/api/api/msearch_template.d.ts +1 -1
  72. package/lib/api/api/mtermvectors.d.ts +1 -1
  73. package/lib/api/api/nodes.d.ts +7 -7
  74. package/lib/api/api/open_point_in_time.d.ts +1 -1
  75. package/lib/api/api/ping.d.ts +1 -1
  76. package/lib/api/api/profiling.d.ts +4 -4
  77. package/lib/api/api/put_script.d.ts +1 -1
  78. package/lib/api/api/query_rules.d.ts +8 -8
  79. package/lib/api/api/rank_eval.d.ts +1 -1
  80. package/lib/api/api/reindex.d.ts +2 -2
  81. package/lib/api/api/reindex.js +1 -0
  82. package/lib/api/api/reindex.js.map +1 -1
  83. package/lib/api/api/reindex_rethrottle.d.ts +1 -1
  84. package/lib/api/api/render_search_template.d.ts +1 -1
  85. package/lib/api/api/rollup.d.ts +9 -9
  86. package/lib/api/api/scroll.d.ts +1 -1
  87. package/lib/api/api/search.d.ts +1 -1
  88. package/lib/api/api/search_application.d.ts +10 -10
  89. package/lib/api/api/search_mvt.d.ts +2 -2
  90. package/lib/api/api/search_mvt.js +1 -0
  91. package/lib/api/api/search_mvt.js.map +1 -1
  92. package/lib/api/api/search_shards.d.ts +1 -1
  93. package/lib/api/api/search_template.d.ts +1 -1
  94. package/lib/api/api/searchable_snapshots.d.ts +4 -4
  95. package/lib/api/api/security.d.ts +66 -66
  96. package/lib/api/api/security.js +4 -6
  97. package/lib/api/api/security.js.map +1 -1
  98. package/lib/api/api/shutdown.d.ts +3 -3
  99. package/lib/api/api/simulate.d.ts +1 -1
  100. package/lib/api/api/slm.d.ts +9 -9
  101. package/lib/api/api/snapshot.d.ts +14 -14
  102. package/lib/api/api/snapshot.js +3 -1
  103. package/lib/api/api/snapshot.js.map +1 -1
  104. package/lib/api/api/sql.d.ts +6 -6
  105. package/lib/api/api/ssl.d.ts +1 -1
  106. package/lib/api/api/streams.d.ts +41 -0
  107. package/lib/api/api/streams.js +132 -0
  108. package/lib/api/api/streams.js.map +1 -0
  109. package/lib/api/api/synonyms.d.ts +8 -8
  110. package/lib/api/api/synonyms.js +9 -3
  111. package/lib/api/api/synonyms.js.map +1 -1
  112. package/lib/api/api/tasks.d.ts +3 -3
  113. package/lib/api/api/terms_enum.d.ts +1 -1
  114. package/lib/api/api/termvectors.d.ts +2 -2
  115. package/lib/api/api/text_structure.d.ts +4 -4
  116. package/lib/api/api/transform.d.ts +12 -12
  117. package/lib/api/api/update.d.ts +2 -2
  118. package/lib/api/api/update_by_query.d.ts +2 -2
  119. package/lib/api/api/update_by_query_rethrottle.d.ts +1 -1
  120. package/lib/api/api/watcher.d.ts +15 -15
  121. package/lib/api/api/xpack.d.ts +2 -2
  122. package/lib/api/index.d.ts +4 -0
  123. package/lib/api/index.js +14 -2
  124. package/lib/api/index.js.map +1 -1
  125. package/lib/api/types.d.ts +1756 -301
  126. package/lib/client.d.ts +1 -1
  127. package/lib/client.js +7 -11
  128. package/lib/client.js.map +1 -1
  129. package/package.json +13 -13
  130. package/renovate.json +4 -2
@@ -350,19 +350,8 @@ export interface CreateRequest<TDocument = unknown> extends RequestBase {
350
350
  * If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.
351
351
  * If the target doesn't exist and doesn’t match a data stream template, this request creates the index. */
352
352
  index: IndexName;
353
- /** Only perform the operation if the document has this primary term. */
354
- if_primary_term?: long;
355
- /** Only perform the operation if the document has this sequence number. */
356
- if_seq_no?: SequenceNumber;
357
353
  /** True or false if to include the document source in the error message in case of parsing errors. */
358
354
  include_source_on_error?: boolean;
359
- /** Set to `create` to only index the document if it does not already exist (put if absent).
360
- * If a document with the specified `_id` already exists, the indexing operation will fail.
361
- * The behavior is the same as using the `<index>/_create` endpoint.
362
- * If a document ID is specified, this paramater defaults to `index`.
363
- * Otherwise, it defaults to `create`.
364
- * If the request targets a data stream, an `op_type` of `create` is required. */
365
- op_type?: OpType;
366
355
  /** The ID of the pipeline to use to preprocess incoming documents.
367
356
  * If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request.
368
357
  * If a final pipeline is configured, it will always run regardless of the value of this parameter. */
@@ -402,10 +391,7 @@ export interface CreateRequest<TDocument = unknown> extends RequestBase {
402
391
  } & {
403
392
  id?: never;
404
393
  index?: never;
405
- if_primary_term?: never;
406
- if_seq_no?: never;
407
394
  include_source_on_error?: never;
408
- op_type?: never;
409
395
  pipeline?: never;
410
396
  refresh?: never;
411
397
  require_alias?: never;
@@ -423,10 +409,7 @@ export interface CreateRequest<TDocument = unknown> extends RequestBase {
423
409
  } & {
424
410
  id?: never;
425
411
  index?: never;
426
- if_primary_term?: never;
427
- if_seq_no?: never;
428
412
  include_source_on_error?: never;
429
- op_type?: never;
430
413
  pipeline?: never;
431
414
  refresh?: never;
432
415
  require_alias?: never;
@@ -1127,7 +1110,7 @@ export interface GetRequest extends RequestBase {
1127
1110
  /** The name of the index that contains the document. */
1128
1111
  index: IndexName;
1129
1112
  /** Indicates whether the request forces synthetic `_source`.
1130
- * Use this paramater to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance.
1113
+ * Use this parameter to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance.
1131
1114
  * Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index. */
1132
1115
  force_synthetic_source?: boolean;
1133
1116
  /** The node or shard the operation should be performed on.
@@ -1159,8 +1142,8 @@ export interface GetRequest extends RequestBase {
1159
1142
  /** A comma-separated list of stored fields to return as part of a hit.
1160
1143
  * If no fields are specified, no stored fields are included in the response.
1161
1144
  * If this field is specified, the `_source` parameter defaults to `false`.
1162
- * Only leaf fields can be retrieved with the `stored_field` option.
1163
- * Object fields can't be returned;if specified, the request fails. */
1145
+ * Only leaf fields can be retrieved with the `stored_fields` option.
1146
+ * Object fields can't be returned; if specified, the request fails. */
1164
1147
  stored_fields?: Fields;
1165
1148
  /** The version number for concurrency control.
1166
1149
  * It must match the current version of the document for the request to succeed. */
@@ -1297,8 +1280,6 @@ export interface GetSourceRequest extends RequestBase {
1297
1280
  _source_excludes?: Fields;
1298
1281
  /** A comma-separated list of source fields to include in the response. */
1299
1282
  _source_includes?: Fields;
1300
- /** A comma-separated list of stored fields to return as part of a hit. */
1301
- stored_fields?: Fields;
1302
1283
  /** The version number for concurrency control.
1303
1284
  * It must match the current version of the document for the request to succeed. */
1304
1285
  version?: VersionNumber;
@@ -1317,7 +1298,6 @@ export interface GetSourceRequest extends RequestBase {
1317
1298
  _source?: never;
1318
1299
  _source_excludes?: never;
1319
1300
  _source_includes?: never;
1320
- stored_fields?: never;
1321
1301
  version?: never;
1322
1302
  version_type?: never;
1323
1303
  });
@@ -1334,7 +1314,6 @@ export interface GetSourceRequest extends RequestBase {
1334
1314
  _source?: never;
1335
1315
  _source_excludes?: never;
1336
1316
  _source_includes?: never;
1337
- stored_fields?: never;
1338
1317
  version?: never;
1339
1318
  version_type?: never;
1340
1319
  };
@@ -1400,7 +1379,7 @@ export interface HealthReportImpact {
1400
1379
  severity: integer;
1401
1380
  }
1402
1381
  export type HealthReportImpactArea = 'search' | 'ingest' | 'backup' | 'deployment_management';
1403
- export type HealthReportIndicatorHealthStatus = 'green' | 'yellow' | 'red' | 'unknown';
1382
+ export type HealthReportIndicatorHealthStatus = 'green' | 'yellow' | 'red' | 'unknown' | 'unavailable';
1404
1383
  export interface HealthReportIndicatorNode {
1405
1384
  name: string | null;
1406
1385
  node_id: string | null;
@@ -1568,6 +1547,8 @@ export interface IndexRequest<TDocument = unknown> extends RequestBase {
1568
1547
  wait_for_active_shards?: WaitForActiveShards;
1569
1548
  /** If `true`, the destination must be an index alias. */
1570
1549
  require_alias?: boolean;
1550
+ /** If `true`, the request's actions must target a data stream (existing or to be created). */
1551
+ require_data_stream?: boolean;
1571
1552
  document?: TDocument;
1572
1553
  /** All values in `body` will be added to the request body. */
1573
1554
  body?: string | ({
@@ -1587,6 +1568,7 @@ export interface IndexRequest<TDocument = unknown> extends RequestBase {
1587
1568
  version_type?: never;
1588
1569
  wait_for_active_shards?: never;
1589
1570
  require_alias?: never;
1571
+ require_data_stream?: never;
1590
1572
  document?: never;
1591
1573
  });
1592
1574
  /** All values in `querystring` will be added to the request querystring. */
@@ -1607,6 +1589,7 @@ export interface IndexRequest<TDocument = unknown> extends RequestBase {
1607
1589
  version_type?: never;
1608
1590
  wait_for_active_shards?: never;
1609
1591
  require_alias?: never;
1592
+ require_data_stream?: never;
1610
1593
  document?: never;
1611
1594
  };
1612
1595
  }
@@ -2008,7 +1991,7 @@ export interface OpenPointInTimeRequest extends RequestBase {
2008
1991
  routing?: Routing;
2009
1992
  /** The type of index that wildcard patterns can match.
2010
1993
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
2011
- * It supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
1994
+ * It supports comma-separated values, such as `open,hidden`. */
2012
1995
  expand_wildcards?: ExpandWildcards;
2013
1996
  /** Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.
2014
1997
  * If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.
@@ -3207,7 +3190,7 @@ export interface SearchFieldSuggester {
3207
3190
  }
3208
3191
  export interface SearchHighlight extends SearchHighlightBase {
3209
3192
  encoder?: SearchHighlighterEncoder;
3210
- fields: Record<Field, SearchHighlightField>;
3193
+ fields: Partial<Record<Field, SearchHighlightField>> | Partial<Record<Field, SearchHighlightField>>[];
3211
3194
  }
3212
3195
  export interface SearchHighlightBase {
3213
3196
  type?: SearchHighlighterType;
@@ -3636,7 +3619,7 @@ export interface SearchShardProfile {
3636
3619
  index: IndexName;
3637
3620
  node_id: NodeId;
3638
3621
  searches: SearchSearchProfile[];
3639
- shard_id: long;
3622
+ shard_id: integer;
3640
3623
  }
3641
3624
  export interface SearchSmoothingModelContainer {
3642
3625
  /** A smoothing model that uses an additive smoothing where a constant (typically `1.0` or smaller) is added to all counts to balance weights. */
@@ -3649,11 +3632,20 @@ export interface SearchSmoothingModelContainer {
3649
3632
  export type SearchSourceConfig = boolean | SearchSourceFilter | Fields;
3650
3633
  export type SearchSourceConfigParam = boolean | Fields;
3651
3634
  export interface SearchSourceFilter {
3635
+ /** If `true`, vector fields are excluded from the returned source.
3636
+ *
3637
+ * This option takes precedence over `includes`: any vector field will
3638
+ * remain excluded even if it matches an `includes` rule. */
3639
+ exclude_vectors?: boolean;
3640
+ /** A list of fields to exclude from the returned source. */
3652
3641
  excludes?: Fields;
3653
- /** @alias excludes */
3642
+ /** A list of fields to exclude from the returned source.
3643
+ * @alias excludes */
3654
3644
  exclude?: Fields;
3645
+ /** A list of fields to include in the returned source. */
3655
3646
  includes?: Fields;
3656
- /** @alias includes */
3647
+ /** A list of fields to include in the returned source.
3648
+ * @alias includes */
3657
3649
  include?: Fields;
3658
3650
  }
3659
3651
  export type SearchStringDistance = 'internal' | 'damerau_levenshtein' | 'levenshtein' | 'jaro_winkler' | 'ngram';
@@ -3897,8 +3889,7 @@ export interface SearchShardsRequest extends RequestBase {
3897
3889
  allow_no_indices?: boolean;
3898
3890
  /** Type of index that wildcard patterns can match.
3899
3891
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
3900
- * Supports comma-separated values, such as `open,hidden`.
3901
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
3892
+ * Supports comma-separated values, such as `open,hidden`. */
3902
3893
  expand_wildcards?: ExpandWildcards;
3903
3894
  /** If `false`, the request returns an error if it targets a missing or closed index. */
3904
3895
  ignore_unavailable?: boolean;
@@ -3976,8 +3967,7 @@ export interface SearchTemplateRequest extends RequestBase {
3976
3967
  ccs_minimize_roundtrips?: boolean;
3977
3968
  /** The type of index that wildcard patterns can match.
3978
3969
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
3979
- * Supports comma-separated values, such as `open,hidden`.
3980
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
3970
+ * Supports comma-separated values, such as `open,hidden`. */
3981
3971
  expand_wildcards?: ExpandWildcards;
3982
3972
  /** If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. */
3983
3973
  ignore_throttled?: boolean;
@@ -4408,8 +4398,7 @@ export interface UpdateByQueryRequest extends RequestBase {
4408
4398
  df?: string;
4409
4399
  /** The type of index that wildcard patterns can match.
4410
4400
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
4411
- * It supports comma-separated values, such as `open,hidden`.
4412
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
4401
+ * It supports comma-separated values, such as `open,hidden`. */
4413
4402
  expand_wildcards?: ExpandWildcards;
4414
4403
  /** Skips the specified number of documents. */
4415
4404
  from?: long;
@@ -4725,6 +4714,11 @@ export interface DocStats {
4725
4714
  * This number is based on documents in Lucene segments.
4726
4715
  * Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged. */
4727
4716
  deleted?: long;
4717
+ /** Returns the total size in bytes of all documents in this stats.
4718
+ * This value may be more reliable than store_stats.size_in_bytes in estimating the index size. */
4719
+ total_size_in_bytes: long;
4720
+ /** Human readable total_size_in_bytes */
4721
+ total_size?: ByteSize;
4728
4722
  }
4729
4723
  export type Duration = string | -1 | 0;
4730
4724
  export type DurationLarge = string;
@@ -4748,7 +4742,10 @@ export interface ElasticsearchVersionInfo {
4748
4742
  /** The minimum node version with which the responding node can communicate.
4749
4743
  * Also the minimum version from which you can perform a rolling upgrade. */
4750
4744
  minimum_wire_compatibility_version: VersionString;
4751
- /** The Elasticsearch version number. */
4745
+ /** The Elasticsearch version number.
4746
+ *
4747
+ * ::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.
4748
+ * Serverless environments are versionless and automatically upgraded, so this value can be safely ignored. */
4752
4749
  number: string;
4753
4750
  }
4754
4751
  export interface ElasticsearchVersionMinInfo {
@@ -4764,7 +4761,7 @@ export interface ErrorCauseKeys {
4764
4761
  /** The type of error */
4765
4762
  type: string;
4766
4763
  /** A human-readable explanation of the error, in English. */
4767
- reason?: string;
4764
+ reason?: string | null;
4768
4765
  /** The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. */
4769
4766
  stack_trace?: string;
4770
4767
  caused_by?: ErrorCause;
@@ -4805,6 +4802,7 @@ export interface FielddataStats {
4805
4802
  memory_size?: ByteSize;
4806
4803
  memory_size_in_bytes: long;
4807
4804
  fields?: Record<Field, FieldMemoryUsage>;
4805
+ global_ordinals: GlobalOrdinalsStats;
4808
4806
  }
4809
4807
  export type Fields = Field | Field[];
4810
4808
  export interface FlushStats {
@@ -4856,8 +4854,18 @@ export interface GetStats {
4856
4854
  time_in_millis: DurationValue<UnitMillis>;
4857
4855
  total: long;
4858
4856
  }
4857
+ export interface GlobalOrdinalFieldStats {
4858
+ build_time_in_millis: UnitMillis;
4859
+ build_time?: string;
4860
+ shard_max_value_count: long;
4861
+ }
4862
+ export interface GlobalOrdinalsStats {
4863
+ build_time_in_millis: UnitMillis;
4864
+ build_time?: string;
4865
+ fields?: Record<Name, GlobalOrdinalFieldStats>;
4866
+ }
4859
4867
  export type GrokPattern = string;
4860
- export type HealthStatus = 'green' | 'GREEN' | 'yellow' | 'YELLOW' | 'red' | 'RED';
4868
+ export type HealthStatus = 'green' | 'GREEN' | 'yellow' | 'YELLOW' | 'red' | 'RED' | 'unknown' | 'unavailable';
4861
4869
  export type Host = string;
4862
4870
  export type HttpHeaders = Record<string, string | string[]>;
4863
4871
  export type IBDistribution = 'll' | 'spl';
@@ -4884,6 +4892,8 @@ export interface IndexingStats {
4884
4892
  index_failed: long;
4885
4893
  types?: Record<string, IndexingStats>;
4886
4894
  write_load?: double;
4895
+ recent_write_load?: double;
4896
+ peak_write_load?: double;
4887
4897
  }
4888
4898
  export type Indices = IndexName | IndexName[];
4889
4899
  export interface IndicesOptions {
@@ -4914,6 +4924,11 @@ export interface InlineGetKeys<TDocument = unknown> {
4914
4924
  export type InlineGet<TDocument = unknown> = InlineGetKeys<TDocument> & {
4915
4925
  [property: string]: any;
4916
4926
  };
4927
+ export interface InnerRetriever {
4928
+ retriever: RetrieverContainer;
4929
+ weight: float;
4930
+ normalizer: ScoreNormalizer;
4931
+ }
4917
4932
  export type Ip = string;
4918
4933
  export interface KnnQuery extends QueryDslQueryBase {
4919
4934
  /** The name of the vector field to search against */
@@ -4930,8 +4945,7 @@ export interface KnnQuery extends QueryDslQueryBase {
4930
4945
  filter?: QueryDslQueryContainer | QueryDslQueryContainer[];
4931
4946
  /** The minimum similarity for a vector to be considered a match */
4932
4947
  similarity?: float;
4933
- /** Apply oversampling and rescoring to quantized vectors *
4934
- * @experimental */
4948
+ /** Apply oversampling and rescoring to quantized vectors */
4935
4949
  rescore_vector?: RescoreVector;
4936
4950
  }
4937
4951
  export interface KnnRetriever extends RetrieverBase {
@@ -4947,8 +4961,7 @@ export interface KnnRetriever extends RetrieverBase {
4947
4961
  num_candidates: integer;
4948
4962
  /** The minimum similarity required for a document to be considered a match. */
4949
4963
  similarity?: float;
4950
- /** Apply oversampling and rescoring to quantized vectors *
4951
- * @experimental */
4964
+ /** Apply oversampling and rescoring to quantized vectors */
4952
4965
  rescore_vector?: RescoreVector;
4953
4966
  }
4954
4967
  export interface KnnSearch {
@@ -4970,8 +4983,7 @@ export interface KnnSearch {
4970
4983
  similarity?: float;
4971
4984
  /** If defined, each search hit will contain inner hits. */
4972
4985
  inner_hits?: SearchInnerHits;
4973
- /** Apply oversampling and rescoring to quantized vectors *
4974
- * @experimental */
4986
+ /** Apply oversampling and rescoring to quantized vectors */
4975
4987
  rescore_vector?: RescoreVector;
4976
4988
  }
4977
4989
  export interface LatLonGeoLocation {
@@ -4982,6 +4994,14 @@ export interface LatLonGeoLocation {
4982
4994
  }
4983
4995
  export type Level = 'cluster' | 'indices' | 'shards';
4984
4996
  export type LifecycleOperationMode = 'RUNNING' | 'STOPPING' | 'STOPPED';
4997
+ export interface LinearRetriever extends RetrieverBase {
4998
+ /** Inner retrievers. */
4999
+ retrievers?: InnerRetriever[];
5000
+ rank_window_size?: integer;
5001
+ query?: string;
5002
+ fields?: string[];
5003
+ normalizer?: ScoreNormalizer;
5004
+ }
4985
5005
  export type MapboxVectorTiles = ArrayBuffer;
4986
5006
  export interface MergesStats {
4987
5007
  current: long;
@@ -5056,6 +5076,13 @@ export type Normalization = 'no' | 'h1' | 'h2' | 'h3' | 'z';
5056
5076
  export type OpType = 'index' | 'create';
5057
5077
  export type Password = string;
5058
5078
  export type Percentage = string | float;
5079
+ export interface PinnedRetriever extends RetrieverBase {
5080
+ /** Inner retriever. */
5081
+ retriever: RetrieverContainer;
5082
+ ids?: string[];
5083
+ docs?: SpecifiedDocument[];
5084
+ rank_window_size?: integer;
5085
+ }
5059
5086
  export type PipelineName = string;
5060
5087
  export interface PluginStats {
5061
5088
  classname: string;
@@ -5099,6 +5126,8 @@ export interface RRFRetriever extends RetrieverBase {
5099
5126
  rank_constant?: integer;
5100
5127
  /** This value determines the size of the individual result sets per query. */
5101
5128
  rank_window_size?: integer;
5129
+ query?: string;
5130
+ fields?: string[];
5102
5131
  }
5103
5132
  export interface RankBase {
5104
5133
  }
@@ -5138,6 +5167,11 @@ export interface RescoreVector {
5138
5167
  /** Applies the specified oversample factor to k on the approximate kNN search */
5139
5168
  oversample: float;
5140
5169
  }
5170
+ export interface RescorerRetriever extends RetrieverBase {
5171
+ /** Inner retriever. */
5172
+ retriever: RetrieverContainer;
5173
+ rescore: SearchRescore | SearchRescore[];
5174
+ }
5141
5175
  export type Result = 'created' | 'updated' | 'deleted' | 'not_found' | 'noop';
5142
5176
  export interface Retries {
5143
5177
  /** The number of bulk actions retried. */
@@ -5150,6 +5184,8 @@ export interface RetrieverBase {
5150
5184
  filter?: QueryDslQueryContainer | QueryDslQueryContainer[];
5151
5185
  /** Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. */
5152
5186
  min_score?: float;
5187
+ /** Retriever name. */
5188
+ _name?: string;
5153
5189
  }
5154
5190
  export interface RetrieverContainer {
5155
5191
  /** A retriever that replaces the functionality of a traditional query. */
@@ -5162,6 +5198,13 @@ export interface RetrieverContainer {
5162
5198
  text_similarity_reranker?: TextSimilarityReranker;
5163
5199
  /** A retriever that replaces the functionality of a rule query. */
5164
5200
  rule?: RuleRetriever;
5201
+ /** A retriever that re-scores only the results produced by its child retriever. */
5202
+ rescorer?: RescorerRetriever;
5203
+ /** A retriever that supports the combination of different retrievers through a weighted linear combination. */
5204
+ linear?: LinearRetriever;
5205
+ /** A pinned retriever applies pinned documents to the underlying retriever.
5206
+ * This retriever will rewrite to a PinnedQueryBuilder. */
5207
+ pinned?: PinnedRetriever;
5165
5208
  }
5166
5209
  export type Routing = string;
5167
5210
  export interface RrfRank {
@@ -5172,7 +5215,7 @@ export interface RrfRank {
5172
5215
  }
5173
5216
  export interface RuleRetriever extends RetrieverBase {
5174
5217
  /** The ruleset IDs containing the rules this retriever is evaluating against. */
5175
- ruleset_ids: Id[];
5218
+ ruleset_ids: Id | Id[];
5176
5219
  /** The match criteria that will determine if a rule in the provided rulesets should be applied. */
5177
5220
  match_criteria: any;
5178
5221
  /** The retriever whose results rules should be applied to. */
@@ -5181,6 +5224,7 @@ export interface RuleRetriever extends RetrieverBase {
5181
5224
  rank_window_size?: integer;
5182
5225
  }
5183
5226
  export type ScalarValue = long | double | string | boolean | null;
5227
+ export type ScoreNormalizer = 'none' | 'minmax' | 'l2_norm';
5184
5228
  export interface ScoreSort {
5185
5229
  order?: SortOrder;
5186
5230
  }
@@ -5236,6 +5280,7 @@ export interface SearchStats {
5236
5280
  suggest_time?: Duration;
5237
5281
  suggest_time_in_millis: DurationValue<UnitMillis>;
5238
5282
  suggest_total: long;
5283
+ recent_search_load?: double;
5239
5284
  groups?: Record<string, SearchStats>;
5240
5285
  }
5241
5286
  export interface SearchTransform {
@@ -5260,7 +5305,6 @@ export interface SegmentsStats {
5260
5305
  fixed_bit_set_memory_in_bytes: long;
5261
5306
  /** Total amount of memory used by all index writers across all shards assigned to selected nodes. */
5262
5307
  index_writer_memory?: ByteSize;
5263
- index_writer_max_memory_in_bytes?: long;
5264
5308
  /** Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. */
5265
5309
  index_writer_memory_in_bytes: long;
5266
5310
  /** Unix timestamp, in milliseconds, of the most recently retried indexing request. */
@@ -5277,15 +5321,16 @@ export interface SegmentsStats {
5277
5321
  points_memory?: ByteSize;
5278
5322
  /** Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. */
5279
5323
  points_memory_in_bytes: long;
5280
- stored_memory?: ByteSize;
5281
5324
  /** Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. */
5282
5325
  stored_fields_memory_in_bytes: long;
5326
+ /** Total amount of memory used for stored fields across all shards assigned to selected nodes. */
5327
+ stored_fields_memory?: ByteSize;
5283
5328
  /** Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. */
5284
5329
  terms_memory_in_bytes: long;
5285
5330
  /** Total amount of memory used for terms across all shards assigned to selected nodes. */
5286
5331
  terms_memory?: ByteSize;
5287
5332
  /** Total amount of memory used for term vectors across all shards assigned to selected nodes. */
5288
- term_vectory_memory?: ByteSize;
5333
+ term_vectors_memory?: ByteSize;
5289
5334
  /** Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. */
5290
5335
  term_vectors_memory_in_bytes: long;
5291
5336
  /** Total amount of memory used by all version maps across all shards assigned to selected nodes. */
@@ -5336,6 +5381,10 @@ export type SortOptions = SortOptionsKeys & {
5336
5381
  };
5337
5382
  export type SortOrder = 'asc' | 'desc';
5338
5383
  export type SortResults = FieldValue[];
5384
+ export interface SpecifiedDocument {
5385
+ index?: IndexName;
5386
+ id: Id;
5387
+ }
5339
5388
  export interface StandardRetriever extends RetrieverBase {
5340
5389
  /** Defines a query to retrieve a set of top documents. */
5341
5390
  query?: QueryDslQueryContainer;
@@ -5382,7 +5431,7 @@ export interface TaskFailure {
5382
5431
  status: string;
5383
5432
  reason: ErrorCause;
5384
5433
  }
5385
- export type TaskId = string | integer;
5434
+ export type TaskId = string;
5386
5435
  export interface TextEmbedding {
5387
5436
  model_id: string;
5388
5437
  model_text: string;
@@ -5395,14 +5444,22 @@ export interface TextSimilarityReranker extends RetrieverBase {
5395
5444
  /** Unique identifier of the inference endpoint created using the inference API. */
5396
5445
  inference_id?: string;
5397
5446
  /** The text snippet used as the basis for similarity comparison */
5398
- inference_text?: string;
5447
+ inference_text: string;
5399
5448
  /** The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text */
5400
- field?: string;
5449
+ field: string;
5401
5450
  }
5402
5451
  export type ThreadType = 'cpu' | 'wait' | 'block' | 'gpu' | 'mem';
5403
5452
  export type TimeOfDay = string;
5404
5453
  export type TimeUnit = 'nanos' | 'micros' | 'ms' | 's' | 'm' | 'h' | 'd';
5405
5454
  export type TimeZone = string;
5455
+ export interface TokenPruningConfig {
5456
+ /** Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. */
5457
+ tokens_freq_ratio_threshold?: integer;
5458
+ /** Tokens whose weight is less than this threshold are considered nonsignificant and pruned. */
5459
+ tokens_weight_threshold?: float;
5460
+ /** Whether to only score pruned tokens, vs only scoring kept tokens. */
5461
+ only_score_pruned_tokens?: boolean;
5462
+ }
5406
5463
  export interface TopLeftBottomRightGeoBounds {
5407
5464
  top_left: GeoLocation;
5408
5465
  bottom_right: GeoLocation;
@@ -5744,6 +5801,9 @@ export interface AggregationsBoxPlotAggregate extends AggregationsAggregateBase
5744
5801
  export interface AggregationsBoxplotAggregation extends AggregationsMetricAggregationBase {
5745
5802
  /** Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. */
5746
5803
  compression?: double;
5804
+ /** The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).
5805
+ * To use an implementation optimized for accuracy, set this parameter to high_accuracy instead. */
5806
+ execution_hint?: AggregationsTDigestExecutionHint;
5747
5807
  }
5748
5808
  export interface AggregationsBucketAggregationBase {
5749
5809
  }
@@ -6104,9 +6164,10 @@ export interface AggregationsFiltersAggregation extends AggregationsBucketAggreg
6104
6164
  keyed?: boolean;
6105
6165
  }
6106
6166
  export interface AggregationsFiltersBucketKeys extends AggregationsMultiBucketBase {
6167
+ key?: string;
6107
6168
  }
6108
6169
  export type AggregationsFiltersBucket = AggregationsFiltersBucketKeys & {
6109
- [property: string]: AggregationsAggregate | long;
6170
+ [property: string]: AggregationsAggregate | string | long;
6110
6171
  };
6111
6172
  export interface AggregationsFormatMetricAggregationBase extends AggregationsMetricAggregationBase {
6112
6173
  format?: string;
@@ -6489,6 +6550,9 @@ export interface AggregationsMedianAbsoluteDeviationAggregate extends Aggregatio
6489
6550
  export interface AggregationsMedianAbsoluteDeviationAggregation extends AggregationsFormatMetricAggregationBase {
6490
6551
  /** Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. */
6491
6552
  compression?: double;
6553
+ /** The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).
6554
+ * To use an implementation optimized for accuracy, set this parameter to high_accuracy instead. */
6555
+ execution_hint?: AggregationsTDigestExecutionHint;
6492
6556
  }
6493
6557
  export interface AggregationsMetricAggregationBase {
6494
6558
  /** The field on which to run the aggregation. */
@@ -6953,7 +7017,11 @@ export interface AggregationsSumBucketAggregation extends AggregationsPipelineAg
6953
7017
  export interface AggregationsTDigest {
6954
7018
  /** Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. */
6955
7019
  compression?: integer;
7020
+ /** The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).
7021
+ * To use an implementation optimized for accuracy, set this parameter to high_accuracy instead. */
7022
+ execution_hint?: AggregationsTDigestExecutionHint;
6956
7023
  }
7024
+ export type AggregationsTDigestExecutionHint = 'default' | 'high_accuracy';
6957
7025
  export interface AggregationsTDigestPercentileRanksAggregate extends AggregationsPercentilesAggregateBase {
6958
7026
  }
6959
7027
  export interface AggregationsTDigestPercentilesAggregate extends AggregationsPercentilesAggregateBase {
@@ -7172,6 +7240,9 @@ export interface AnalysisArabicAnalyzer {
7172
7240
  export interface AnalysisArabicNormalizationTokenFilter extends AnalysisTokenFilterBase {
7173
7241
  type: 'arabic_normalization';
7174
7242
  }
7243
+ export interface AnalysisArabicStemTokenFilter extends AnalysisTokenFilterBase {
7244
+ type: 'arabic_stem';
7245
+ }
7175
7246
  export interface AnalysisArmenianAnalyzer {
7176
7247
  type: 'armenian';
7177
7248
  stopwords?: AnalysisStopWords;
@@ -7195,11 +7266,17 @@ export interface AnalysisBengaliAnalyzer {
7195
7266
  stopwords_path?: string;
7196
7267
  stem_exclusion?: string[];
7197
7268
  }
7269
+ export interface AnalysisBengaliNormalizationTokenFilter extends AnalysisTokenFilterBase {
7270
+ type: 'bengali_normalization';
7271
+ }
7198
7272
  export interface AnalysisBrazilianAnalyzer {
7199
7273
  type: 'brazilian';
7200
7274
  stopwords?: AnalysisStopWords;
7201
7275
  stopwords_path?: string;
7202
7276
  }
7277
+ export interface AnalysisBrazilianStemTokenFilter extends AnalysisTokenFilterBase {
7278
+ type: 'brazilian_stem';
7279
+ }
7203
7280
  export interface AnalysisBulgarianAnalyzer {
7204
7281
  type: 'bulgarian';
7205
7282
  stopwords?: AnalysisStopWords;
@@ -7310,6 +7387,9 @@ export interface AnalysisCzechAnalyzer {
7310
7387
  stopwords_path?: string;
7311
7388
  stem_exclusion?: string[];
7312
7389
  }
7390
+ export interface AnalysisCzechStemTokenFilter extends AnalysisTokenFilterBase {
7391
+ type: 'czech_stem';
7392
+ }
7313
7393
  export interface AnalysisDanishAnalyzer {
7314
7394
  type: 'danish';
7315
7395
  stopwords?: AnalysisStopWords;
@@ -7335,6 +7415,9 @@ export interface AnalysisDutchAnalyzer {
7335
7415
  stopwords_path?: string;
7336
7416
  stem_exclusion?: string[];
7337
7417
  }
7418
+ export interface AnalysisDutchStemTokenFilter extends AnalysisTokenFilterBase {
7419
+ type: 'dutch_stem';
7420
+ }
7338
7421
  export type AnalysisEdgeNGramSide = 'front' | 'back';
7339
7422
  export interface AnalysisEdgeNGramTokenFilter extends AnalysisTokenFilterBase {
7340
7423
  type: 'edge_ngram';
@@ -7416,6 +7499,9 @@ export interface AnalysisFrenchAnalyzer {
7416
7499
  stopwords_path?: string;
7417
7500
  stem_exclusion?: string[];
7418
7501
  }
7502
+ export interface AnalysisFrenchStemTokenFilter extends AnalysisTokenFilterBase {
7503
+ type: 'french_stem';
7504
+ }
7419
7505
  export interface AnalysisGalicianAnalyzer {
7420
7506
  type: 'galician';
7421
7507
  stopwords?: AnalysisStopWords;
@@ -7431,6 +7517,9 @@ export interface AnalysisGermanAnalyzer {
7431
7517
  export interface AnalysisGermanNormalizationTokenFilter extends AnalysisTokenFilterBase {
7432
7518
  type: 'german_normalization';
7433
7519
  }
7520
+ export interface AnalysisGermanStemTokenFilter extends AnalysisTokenFilterBase {
7521
+ type: 'german_stem';
7522
+ }
7434
7523
  export interface AnalysisGreekAnalyzer {
7435
7524
  type: 'greek';
7436
7525
  stopwords?: AnalysisStopWords;
@@ -7495,16 +7584,16 @@ export type AnalysisIcuCollationStrength = 'primary' | 'secondary' | 'tertiary'
7495
7584
  export interface AnalysisIcuCollationTokenFilter extends AnalysisTokenFilterBase {
7496
7585
  type: 'icu_collation';
7497
7586
  alternate?: AnalysisIcuCollationAlternate;
7498
- case_first?: AnalysisIcuCollationCaseFirst;
7499
- case_level?: boolean;
7587
+ caseFirst?: AnalysisIcuCollationCaseFirst;
7588
+ caseLevel?: boolean;
7500
7589
  country?: string;
7501
7590
  decomposition?: AnalysisIcuCollationDecomposition;
7502
- hiragana_quaternary_mode?: boolean;
7591
+ hiraganaQuaternaryMode?: boolean;
7503
7592
  language?: string;
7504
7593
  numeric?: boolean;
7505
7594
  rules?: string;
7506
7595
  strength?: AnalysisIcuCollationStrength;
7507
- variable_top?: string;
7596
+ variableTop?: string;
7508
7597
  variant?: string;
7509
7598
  }
7510
7599
  export interface AnalysisIcuFoldingTokenFilter extends AnalysisTokenFilterBase {
@@ -7790,6 +7879,7 @@ export interface AnalysisPatternReplaceTokenFilter extends AnalysisTokenFilterBa
7790
7879
  type: 'pattern_replace';
7791
7880
  /** If `true`, all substrings matching the pattern parameter’s regular expression are replaced. If `false`, the filter replaces only the first matching substring in each token. Defaults to `true`. */
7792
7881
  all?: boolean;
7882
+ flags?: string;
7793
7883
  /** Regular expression, written in Java’s regular expression syntax. The filter replaces token substrings matching this pattern with the substring in the `replacement` parameter. */
7794
7884
  pattern: string;
7795
7885
  /** Replacement substring. Defaults to an empty substring (`""`). */
@@ -7809,6 +7899,9 @@ export interface AnalysisPersianAnalyzer {
7809
7899
  export interface AnalysisPersianNormalizationTokenFilter extends AnalysisTokenFilterBase {
7810
7900
  type: 'persian_normalization';
7811
7901
  }
7902
+ export interface AnalysisPersianStemTokenFilter extends AnalysisTokenFilterBase {
7903
+ type: 'persian_stem';
7904
+ }
7812
7905
  export type AnalysisPhoneticEncoder = 'metaphone' | 'double_metaphone' | 'soundex' | 'refined_soundex' | 'caverphone1' | 'caverphone2' | 'cologne' | 'nysiis' | 'koelnerphonetik' | 'haasephonetik' | 'beider_morse' | 'daitch_mokotoff';
7813
7906
  export type AnalysisPhoneticLanguage = 'any' | 'common' | 'cyrillic' | 'english' | 'french' | 'german' | 'hebrew' | 'hungarian' | 'polish' | 'romanian' | 'russian' | 'spanish';
7814
7907
  export type AnalysisPhoneticNameType = 'generic' | 'ashkenazi' | 'sephardic';
@@ -7854,6 +7947,9 @@ export interface AnalysisRussianAnalyzer {
7854
7947
  stopwords_path?: string;
7855
7948
  stem_exclusion?: string[];
7856
7949
  }
7950
+ export interface AnalysisRussianStemTokenFilter extends AnalysisTokenFilterBase {
7951
+ type: 'russian_stem';
7952
+ }
7857
7953
  export interface AnalysisScandinavianFoldingTokenFilter extends AnalysisTokenFilterBase {
7858
7954
  type: 'scandinavian_folding';
7859
7955
  }
@@ -8018,7 +8114,7 @@ export type AnalysisTokenFilter = string | AnalysisTokenFilterDefinition;
8018
8114
  export interface AnalysisTokenFilterBase {
8019
8115
  version?: VersionString;
8020
8116
  }
8021
- export type AnalysisTokenFilterDefinition = AnalysisApostropheTokenFilter | AnalysisArabicNormalizationTokenFilter | AnalysisAsciiFoldingTokenFilter | AnalysisCjkBigramTokenFilter | AnalysisCjkWidthTokenFilter | AnalysisClassicTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDecimalDigitTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisFlattenGraphTokenFilter | AnalysisGermanNormalizationTokenFilter | AnalysisHindiNormalizationTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisIndicNormalizationTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKeywordRepeatTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMinHashTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPersianNormalizationTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisScandinavianFoldingTokenFilter | AnalysisScandinavianNormalizationTokenFilter | AnalysisSerbianNormalizationTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisSoraniNormalizationTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisJaStopTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter;
8117
+ export type AnalysisTokenFilterDefinition = AnalysisApostropheTokenFilter | AnalysisArabicStemTokenFilter | AnalysisArabicNormalizationTokenFilter | AnalysisAsciiFoldingTokenFilter | AnalysisBengaliNormalizationTokenFilter | AnalysisBrazilianStemTokenFilter | AnalysisCjkBigramTokenFilter | AnalysisCjkWidthTokenFilter | AnalysisClassicTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisCzechStemTokenFilter | AnalysisDecimalDigitTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisDutchStemTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisFlattenGraphTokenFilter | AnalysisFrenchStemTokenFilter | AnalysisGermanNormalizationTokenFilter | AnalysisGermanStemTokenFilter | AnalysisHindiNormalizationTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisIndicNormalizationTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKeywordRepeatTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMinHashTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPersianNormalizationTokenFilter | AnalysisPersianStemTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisRussianStemTokenFilter | AnalysisScandinavianFoldingTokenFilter | AnalysisScandinavianNormalizationTokenFilter | AnalysisSerbianNormalizationTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisSoraniNormalizationTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisJaStopTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter;
8022
8118
  export type AnalysisTokenizer = string | AnalysisTokenizerDefinition;
8023
8119
  export interface AnalysisTokenizerBase {
8024
8120
  version?: VersionString;
@@ -8100,6 +8196,7 @@ export interface AnalysisWordDelimiterTokenFilterBase extends AnalysisTokenFilte
8100
8196
  export interface MappingAggregateMetricDoubleProperty extends MappingPropertyBase {
8101
8197
  type: 'aggregate_metric_double';
8102
8198
  default_metric: string;
8199
+ ignore_malformed?: boolean;
8103
8200
  metrics: string[];
8104
8201
  time_series_metric?: MappingTimeSeriesMetricType;
8105
8202
  }
@@ -8135,6 +8232,21 @@ export interface MappingByteNumberProperty extends MappingNumberPropertyBase {
8135
8232
  type: 'byte';
8136
8233
  null_value?: byte;
8137
8234
  }
8235
+ export interface MappingChunkingSettings {
8236
+ /** The chunking strategy: `sentence` or `word`. */
8237
+ strategy: string;
8238
+ /** The maximum size of a chunk in words.
8239
+ * This value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). */
8240
+ max_chunk_size: integer;
8241
+ /** The number of overlapping words for chunks.
8242
+ * It is applicable only to a `word` chunking strategy.
8243
+ * This value cannot be higher than half the `max_chunk_size` value. */
8244
+ overlap?: integer;
8245
+ /** The number of overlapping sentences for chunks.
8246
+ * It is applicable only for a `sentence` chunking strategy.
8247
+ * It can be either `1` or `0`. */
8248
+ sentence_overlap?: integer;
8249
+ }
8138
8250
  export interface MappingCompletionProperty extends MappingDocValuesPropertyBase {
8139
8251
  analyzer?: string;
8140
8252
  contexts?: MappingSuggestContext[];
@@ -8214,6 +8326,15 @@ export interface MappingDenseVectorIndexOptions {
8214
8326
  m?: integer;
8215
8327
  /** The type of kNN algorithm to use. */
8216
8328
  type: MappingDenseVectorIndexOptionsType;
8329
+ /** The rescore vector options. This is only applicable to `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`, `bbq_flat`, `int4_flat`, and `int8_flat` index types. */
8330
+ rescore_vector?: MappingDenseVectorIndexOptionsRescoreVector;
8331
+ }
8332
+ export interface MappingDenseVectorIndexOptionsRescoreVector {
8333
+ /** The oversampling factor to use when searching for the nearest neighbor. This is only applicable to the quantized formats: `bbq_*`, `int4_*`, and `int8_*`.
8334
+ * When provided, `oversample * k` vectors will be gathered and then their scores will be re-computed with the original vectors.
8335
+ *
8336
+ * valid values are between `1.0` and `10.0` (inclusive), or `0` exactly to disable oversampling. */
8337
+ oversample: float;
8217
8338
  }
8218
8339
  export type MappingDenseVectorIndexOptionsType = 'bbq_flat' | 'bbq_hnsw' | 'flat' | 'hnsw' | 'int4_flat' | 'int4_hnsw' | 'int8_flat' | 'int8_hnsw';
8219
8340
  export interface MappingDenseVectorProperty extends MappingPropertyBase {
@@ -8314,6 +8435,7 @@ export interface MappingFlattenedProperty extends MappingPropertyBase {
8314
8435
  null_value?: string;
8315
8436
  similarity?: string;
8316
8437
  split_queries_on_whitespace?: boolean;
8438
+ time_series_dimensions?: string[];
8317
8439
  type: 'flattened';
8318
8440
  }
8319
8441
  export interface MappingFloatNumberProperty extends MappingNumberPropertyBase {
@@ -8324,6 +8446,7 @@ export interface MappingFloatRangeProperty extends MappingRangePropertyBase {
8324
8446
  type: 'float_range';
8325
8447
  }
8326
8448
  export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw';
8449
+ export type MappingGeoPointMetricType = 'gauge' | 'counter' | 'position';
8327
8450
  export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase {
8328
8451
  ignore_malformed?: boolean;
8329
8452
  ignore_z_value?: boolean;
@@ -8332,6 +8455,7 @@ export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase {
8332
8455
  on_script_error?: MappingOnScriptError;
8333
8456
  script?: Script | ScriptSource;
8334
8457
  type: 'geo_point';
8458
+ time_series_metric?: MappingGeoPointMetricType;
8335
8459
  }
8336
8460
  export interface MappingGeoShapeProperty extends MappingDocValuesPropertyBase {
8337
8461
  coerce?: boolean;
@@ -8483,7 +8607,7 @@ export interface MappingPointProperty extends MappingDocValuesPropertyBase {
8483
8607
  null_value?: string;
8484
8608
  type: 'point';
8485
8609
  }
8486
- export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | MappingFlattenedProperty | MappingNestedProperty | MappingObjectProperty | MappingPassthroughObjectProperty | MappingSemanticTextProperty | MappingSparseVectorProperty | MappingCompletionProperty | MappingConstantKeywordProperty | MappingCountedKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingTokenCountProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingPointProperty | MappingShapeProperty | MappingByteNumberProperty | MappingDoubleNumberProperty | MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingScaledFloatNumberProperty | MappingShortNumberProperty | MappingUnsignedLongNumberProperty | MappingDateRangeProperty | MappingDoubleRangeProperty | MappingFloatRangeProperty | MappingIntegerRangeProperty | MappingIpRangeProperty | MappingLongRangeProperty | MappingIcuCollationProperty;
8610
+ export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | MappingFlattenedProperty | MappingNestedProperty | MappingObjectProperty | MappingPassthroughObjectProperty | MappingRankVectorProperty | MappingSemanticTextProperty | MappingSparseVectorProperty | MappingCompletionProperty | MappingConstantKeywordProperty | MappingCountedKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingTokenCountProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingPointProperty | MappingShapeProperty | MappingByteNumberProperty | MappingDoubleNumberProperty | MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingScaledFloatNumberProperty | MappingShortNumberProperty | MappingUnsignedLongNumberProperty | MappingDateRangeProperty | MappingDoubleRangeProperty | MappingFloatRangeProperty | MappingIntegerRangeProperty | MappingIpRangeProperty | MappingLongRangeProperty | MappingIcuCollationProperty;
8487
8611
  export interface MappingPropertyBase {
8488
8612
  /** Metadata about the field. */
8489
8613
  meta?: Record<string, string>;
@@ -8506,6 +8630,12 @@ export interface MappingRankFeaturesProperty extends MappingPropertyBase {
8506
8630
  positive_score_impact?: boolean;
8507
8631
  type: 'rank_features';
8508
8632
  }
8633
+ export type MappingRankVectorElementType = 'byte' | 'float' | 'bit';
8634
+ export interface MappingRankVectorProperty extends MappingPropertyBase {
8635
+ type: 'rank_vectors';
8636
+ element_type?: MappingRankVectorElementType;
8637
+ dims?: integer;
8638
+ }
8509
8639
  export interface MappingRoutingField {
8510
8640
  required: boolean;
8511
8641
  }
@@ -8561,6 +8691,10 @@ export interface MappingSemanticTextProperty {
8561
8691
  * You can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint.
8562
8692
  * If not specified, the inference endpoint defined by inference_id will be used at both index and query time. */
8563
8693
  search_inference_id?: Id;
8694
+ /** Settings for chunking text into smaller passages. If specified, these will override the
8695
+ * chunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated,
8696
+ * they will not be applied to existing documents until they are reindexed. */
8697
+ chunking_settings?: MappingChunkingSettings;
8564
8698
  }
8565
8699
  export interface MappingShapeProperty extends MappingDocValuesPropertyBase {
8566
8700
  coerce?: boolean;
@@ -8585,8 +8719,23 @@ export interface MappingSourceField {
8585
8719
  mode?: MappingSourceFieldMode;
8586
8720
  }
8587
8721
  export type MappingSourceFieldMode = 'disabled' | 'stored' | 'synthetic';
8722
+ export interface MappingSparseVectorIndexOptions {
8723
+ /** Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.
8724
+ * If prune is true but the pruning_config is not specified, pruning will occur but default values will be used.
8725
+ * Default: false */
8726
+ prune?: boolean;
8727
+ /** Optional pruning configuration.
8728
+ * If enabled, this will omit non-significant tokens from the query in order to improve query performance.
8729
+ * This is only used if prune is set to true.
8730
+ * If prune is set to true but pruning_config is not specified, default values will be used. */
8731
+ pruning_config?: TokenPruningConfig;
8732
+ }
8588
8733
  export interface MappingSparseVectorProperty extends MappingPropertyBase {
8734
+ store?: boolean;
8589
8735
  type: 'sparse_vector';
8736
+ /** Additional index options for the sparse vector field that controls the
8737
+ * token pruning behavior of the sparse vector field. */
8738
+ index_options?: MappingSparseVectorIndexOptions;
8590
8739
  }
8591
8740
  export type MappingSubobjects = boolean | 'true' | 'false' | 'auto';
8592
8741
  export interface MappingSuggestContext {
@@ -8883,7 +9032,7 @@ export type QueryDslGeoDistanceQuery = QueryDslGeoDistanceQueryKeys & {
8883
9032
  };
8884
9033
  export type QueryDslGeoExecution = 'memory' | 'indexed';
8885
9034
  export interface QueryDslGeoGridQuery extends QueryDslQueryBase {
8886
- geogrid?: GeoTile;
9035
+ geotile?: GeoTile;
8887
9036
  geohash?: GeoHash;
8888
9037
  geohex?: GeoHexCell;
8889
9038
  }
@@ -8978,6 +9127,8 @@ export interface QueryDslIntervalsContainer {
8978
9127
  match?: QueryDslIntervalsMatch;
8979
9128
  /** Matches terms that start with a specified set of characters. */
8980
9129
  prefix?: QueryDslIntervalsPrefix;
9130
+ range?: QueryDslIntervalsRange;
9131
+ regexp?: QueryDslIntervalsRegexp;
8981
9132
  /** Matches terms using a wildcard pattern. */
8982
9133
  wildcard?: QueryDslIntervalsWildcard;
8983
9134
  }
@@ -9053,9 +9204,35 @@ export interface QueryDslIntervalsQuery extends QueryDslQueryBase {
9053
9204
  match?: QueryDslIntervalsMatch;
9054
9205
  /** Matches terms that start with a specified set of characters. */
9055
9206
  prefix?: QueryDslIntervalsPrefix;
9207
+ range?: QueryDslIntervalsRange;
9208
+ regexp?: QueryDslIntervalsRegexp;
9056
9209
  /** Matches terms using a wildcard pattern. */
9057
9210
  wildcard?: QueryDslIntervalsWildcard;
9058
9211
  }
9212
+ export interface QueryDslIntervalsRange {
9213
+ /** Analyzer used to analyze the `prefix`. */
9214
+ analyzer?: string;
9215
+ /** Lower term, either gte or gt must be provided. */
9216
+ gte?: string;
9217
+ /** Lower term, either gte or gt must be provided. */
9218
+ gt?: string;
9219
+ /** Upper term, either lte or lt must be provided. */
9220
+ lte?: string;
9221
+ /** Upper term, either lte or lt must be provided. */
9222
+ lt?: string;
9223
+ /** If specified, match intervals from this field rather than the top-level field.
9224
+ * The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. */
9225
+ use_field?: Field;
9226
+ }
9227
+ export interface QueryDslIntervalsRegexp {
9228
+ /** Analyzer used to analyze the `prefix`. */
9229
+ analyzer?: string;
9230
+ /** Regex pattern. */
9231
+ pattern: string;
9232
+ /** If specified, match intervals from this field rather than the top-level field.
9233
+ * The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. */
9234
+ use_field?: Field;
9235
+ }
9059
9236
  export interface QueryDslIntervalsWildcard {
9060
9237
  /** Analyzer used to analyze the `pattern`.
9061
9238
  * Defaults to the top-level field's analyzer. */
@@ -9529,8 +9706,6 @@ export interface QueryDslRangeQueryBase<T = unknown> extends QueryDslQueryBase {
9529
9706
  lt?: T;
9530
9707
  /** Less than or equal to. */
9531
9708
  lte?: T;
9532
- from?: T | null;
9533
- to?: T | null;
9534
9709
  }
9535
9710
  export type QueryDslRangeRelation = 'within' | 'contains' | 'intersects';
9536
9711
  export interface QueryDslRankFeatureFunction {
@@ -9578,7 +9753,8 @@ export interface QueryDslRegexpQuery extends QueryDslQueryBase {
9578
9753
  }
9579
9754
  export interface QueryDslRuleQuery extends QueryDslQueryBase {
9580
9755
  organic: QueryDslQueryContainer;
9581
- ruleset_ids: Id[];
9756
+ ruleset_ids?: Id | Id[];
9757
+ ruleset_id?: string;
9582
9758
  match_criteria: any;
9583
9759
  }
9584
9760
  export interface QueryDslScriptQuery extends QueryDslQueryBase {
@@ -9753,15 +9929,13 @@ export interface QueryDslSparseVectorQuery extends QueryDslQueryBase {
9753
9929
  query?: string;
9754
9930
  /** Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.
9755
9931
  * If prune is true but the pruning_config is not specified, pruning will occur but default values will be used.
9756
- * Default: false
9757
- * @experimental */
9932
+ * Default: false */
9758
9933
  prune?: boolean;
9759
9934
  /** Optional pruning configuration.
9760
9935
  * If enabled, this will omit non-significant tokens from the query in order to improve query performance.
9761
9936
  * This is only used if prune is set to true.
9762
- * If prune is set to true but pruning_config is not specified, default values will be used.
9763
- * @experimental */
9764
- pruning_config?: QueryDslTokenPruningConfig;
9937
+ * If prune is set to true but pruning_config is not specified, default values will be used. */
9938
+ pruning_config?: TokenPruningConfig;
9765
9939
  }
9766
9940
  export interface QueryDslTermQuery extends QueryDslQueryBase {
9767
9941
  /** Term you wish to find in the provided field. */
@@ -9801,17 +9975,9 @@ export interface QueryDslTextExpansionQuery extends QueryDslQueryBase {
9801
9975
  model_text: string;
9802
9976
  /** Token pruning configurations
9803
9977
  * @experimental */
9804
- pruning_config?: QueryDslTokenPruningConfig;
9978
+ pruning_config?: TokenPruningConfig;
9805
9979
  }
9806
9980
  export type QueryDslTextQueryType = 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix';
9807
- export interface QueryDslTokenPruningConfig {
9808
- /** Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. */
9809
- tokens_freq_ratio_threshold?: integer;
9810
- /** Tokens whose weight is less than this threshold are considered nonsignificant and pruned. */
9811
- tokens_weight_threshold?: float;
9812
- /** Whether to only score pruned tokens, vs only scoring kept tokens. */
9813
- only_score_pruned_tokens?: boolean;
9814
- }
9815
9981
  export interface QueryDslTypeQuery extends QueryDslQueryBase {
9816
9982
  value: string;
9817
9983
  }
@@ -9830,9 +9996,9 @@ export interface QueryDslUntypedRangeQuery extends QueryDslRangeQueryBase<any> {
9830
9996
  }
9831
9997
  export interface QueryDslWeightedTokensQuery extends QueryDslQueryBase {
9832
9998
  /** The tokens representing this query */
9833
- tokens: Record<string, float>;
9999
+ tokens: Record<string, float> | Record<string, float>[];
9834
10000
  /** Token pruning configurations */
9835
- pruning_config?: QueryDslTokenPruningConfig;
10001
+ pruning_config?: TokenPruningConfig;
9836
10002
  }
9837
10003
  export interface QueryDslWildcardQuery extends QueryDslQueryBase {
9838
10004
  /** Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. */
@@ -10392,8 +10558,18 @@ export type CatCatDfaColumn = 'assignment_explanation' | 'ae' | 'create_time' |
10392
10558
  export type CatCatDfaColumns = CatCatDfaColumn | CatCatDfaColumn[];
10393
10559
  export type CatCatNodeColumn = 'build' | 'b' | 'completion.size' | 'cs' | 'completionSize' | 'cpu' | 'disk.avail' | 'd' | 'disk' | 'diskAvail' | 'disk.total' | 'dt' | 'diskTotal' | 'disk.used' | 'du' | 'diskUsed' | 'disk.used_percent' | 'dup' | 'diskUsedPercent' | 'fielddata.evictions' | 'fe' | 'fielddataEvictions' | 'fielddata.memory_size' | 'fm' | 'fielddataMemory' | 'file_desc.current' | 'fdc' | 'fileDescriptorCurrent' | 'file_desc.max' | 'fdm' | 'fileDescriptorMax' | 'file_desc.percent' | 'fdp' | 'fileDescriptorPercent' | 'flush.total' | 'ft' | 'flushTotal' | 'flush.total_time' | 'ftt' | 'flushTotalTime' | 'get.current' | 'gc' | 'getCurrent' | 'get.exists_time' | 'geti' | 'getExistsTime' | 'get.exists_total' | 'geto' | 'getExistsTotal' | 'get.missing_time' | 'gmti' | 'getMissingTime' | 'get.missing_total' | 'gmto' | 'getMissingTotal' | 'get.time' | 'gti' | 'getTime' | 'get.total' | 'gto' | 'getTotal' | 'heap.current' | 'hc' | 'heapCurrent' | 'heap.max' | 'hm' | 'heapMax' | 'heap.percent' | 'hp' | 'heapPercent' | 'http_address' | 'http' | 'id' | 'nodeId' | 'indexing.delete_current' | 'idc' | 'indexingDeleteCurrent' | 'indexing.delete_time' | 'idti' | 'indexingDeleteTime' | 'indexing.delete_total' | 'idto' | 'indexingDeleteTotal' | 'indexing.index_current' | 'iic' | 'indexingIndexCurrent' | 'indexing.index_failed' | 'iif' | 'indexingIndexFailed' | 'indexing.index_failed_due_to_version_conflict' | 'iifvc' | 'indexingIndexFailedDueToVersionConflict' | 'indexing.index_time' | 'iiti' | 'indexingIndexTime' | 'indexing.index_total' | 'iito' | 'indexingIndexTotal' | 'ip' | 'i' | 'jdk' | 'j' | 'load_1m' | 'l' | 'load_5m' | 'l' | 'load_15m' | 'l' | 'mappings.total_count' | 'mtc' | 'mappingsTotalCount' | 'mappings.total_estimated_overhead_in_bytes' | 'mteo' | 'mappingsTotalEstimatedOverheadInBytes' | 'master' | 'm' | 'merges.current' | 'mc' | 'mergesCurrent' | 'merges.current_docs' | 'mcd' | 'mergesCurrentDocs' | 'merges.current_size' | 'mcs' | 'mergesCurrentSize' | 'merges.total' | 'mt' | 'mergesTotal' | 'merges.total_docs' | 'mtd' | 'mergesTotalDocs' | 'merges.total_size' | 'mts' | 'mergesTotalSize' | 'merges.total_time' | 'mtt' | 'mergesTotalTime' | 'name' | 'n' | 'node.role' | 'r' | 'role' | 'nodeRole' | 'pid' | 'p' | 'port' | 'po' | 'query_cache.memory_size' | 'qcm' | 'queryCacheMemory' | 'query_cache.evictions' | 'qce' | 'queryCacheEvictions' | 'query_cache.hit_count' | 'qchc' | 'queryCacheHitCount' | 'query_cache.miss_count' | 'qcmc' | 'queryCacheMissCount' | 'ram.current' | 'rc' | 'ramCurrent' | 'ram.max' | 'rm' | 'ramMax' | 'ram.percent' | 'rp' | 'ramPercent' | 'refresh.total' | 'rto' | 'refreshTotal' | 'refresh.time' | 'rti' | 'refreshTime' | 'request_cache.memory_size' | 'rcm' | 'requestCacheMemory' | 'request_cache.evictions' | 'rce' | 'requestCacheEvictions' | 'request_cache.hit_count' | 'rchc' | 'requestCacheHitCount' | 'request_cache.miss_count' | 'rcmc' | 'requestCacheMissCount' | 'script.compilations' | 'scrcc' | 'scriptCompilations' | 'script.cache_evictions' | 'scrce' | 'scriptCacheEvictions' | 'search.fetch_current' | 'sfc' | 'searchFetchCurrent' | 'search.fetch_time' | 'sfti' | 'searchFetchTime' | 'search.fetch_total' | 'sfto' | 'searchFetchTotal' | 'search.open_contexts' | 'so' | 'searchOpenContexts' | 'search.query_current' | 'sqc' | 'searchQueryCurrent' | 'search.query_time' | 'sqti' | 'searchQueryTime' | 'search.query_total' | 'sqto' | 'searchQueryTotal' | 'search.scroll_current' | 'scc' | 'searchScrollCurrent' | 'search.scroll_time' | 'scti' | 'searchScrollTime' | 'search.scroll_total' | 'scto' | 'searchScrollTotal' | 'segments.count' | 'sc' | 'segmentsCount' | 'segments.fixed_bitset_memory' | 'sfbm' | 'fixedBitsetMemory' | 'segments.index_writer_memory' | 'siwm' | 'segmentsIndexWriterMemory' | 'segments.memory' | 'sm' | 'segmentsMemory' | 'segments.version_map_memory' | 'svmm' | 'segmentsVersionMapMemory' | 'shard_stats.total_count' | 'sstc' | 'shards' | 'shardStatsTotalCount' | 'suggest.current' | 'suc' | 'suggestCurrent' | 'suggest.time' | 'suti' | 'suggestTime' | 'suggest.total' | 'suto' | 'suggestTotal' | 'uptime' | 'u' | 'version' | 'v' | string;
10394
10560
  export type CatCatNodeColumns = CatCatNodeColumn | CatCatNodeColumn[];
10561
+ export type CatCatRecoveryColumn = 'index' | 'i' | 'idx' | 'shard' | 's' | 'sh' | 'time' | 't' | 'ti' | 'primaryOrReplica' | 'type' | 'stage' | 'st' | 'source_host' | 'shost' | 'source_node' | 'snode' | 'target_host' | 'thost' | 'target_node' | 'tnode' | 'repository' | 'tnode' | 'snapshot' | 'snap' | 'files' | 'f' | 'files_recovered' | 'fr' | 'files_percent' | 'fp' | 'files_total' | 'tf' | 'bytes' | 'b' | 'bytes_recovered' | 'br' | 'bytes_percent' | 'bp' | 'bytes_total' | 'tb' | 'translog_ops' | 'to' | 'translog_ops_recovered' | 'tor' | 'translog_ops_percent' | 'top' | 'start_time' | 'start' | 'start_time_millis' | 'start_millis' | 'stop_time' | 'stop' | 'stop_time_millis' | 'stop_millis' | string;
10562
+ export type CatCatRecoveryColumns = CatCatRecoveryColumn | CatCatRecoveryColumn[];
10395
10563
  export interface CatCatRequestBase extends RequestBase, SpecUtilsCommonCatQueryParameters {
10396
10564
  }
10565
+ export type CatCatSegmentsColumn = 'index' | 'i' | 'idx' | 'shard' | 's' | 'sh' | 'prirep' | 'p' | 'pr' | 'primaryOrReplica' | 'ip' | 'segment' | 'generation' | 'docs.count' | 'docs.deleted' | 'size' | 'size.memory' | 'committed' | 'searchable' | 'version' | 'compound' | 'id' | string;
10566
+ export type CatCatSegmentsColumns = CatCatSegmentsColumn | CatCatSegmentsColumn[];
10567
+ export type CatCatShardColumn = 'completion.size' | 'cs' | 'completionSize' | 'dataset.size' | 'dense_vector.value_count' | 'dvc' | 'denseVectorCount' | 'docs' | 'd' | 'dc' | 'fielddata.evictions' | 'fe' | 'fielddataEvictions' | 'fielddata.memory_size' | 'fm' | 'fielddataMemory' | 'flush.total' | 'ft' | 'flushTotal' | 'flush.total_time' | 'ftt' | 'flushTotalTime' | 'get.current' | 'gc' | 'getCurrent' | 'get.exists_time' | 'geti' | 'getExistsTime' | 'get.exists_total' | 'geto' | 'getExistsTotal' | 'get.missing_time' | 'gmti' | 'getMissingTime' | 'get.missing_total' | 'gmto' | 'getMissingTotal' | 'get.time' | 'gti' | 'getTime' | 'get.total' | 'gto' | 'getTotal' | 'id' | 'index' | 'i' | 'idx' | 'indexing.delete_current' | 'idc' | 'indexingDeleteCurrent' | 'indexing.delete_time' | 'idti' | 'indexingDeleteTime' | 'indexing.delete_total' | 'idto' | 'indexingDeleteTotal' | 'indexing.index_current' | 'iic' | 'indexingIndexCurrent' | 'indexing.index_failed_due_to_version_conflict' | 'iifvc' | 'indexingIndexFailedDueToVersionConflict' | 'indexing.index_failed' | 'iif' | 'indexingIndexFailed' | 'indexing.index_time' | 'iiti' | 'indexingIndexTime' | 'indexing.index_total' | 'iito' | 'indexingIndexTotal' | 'ip' | 'merges.current' | 'mc' | 'mergesCurrent' | 'merges.current_docs' | 'mcd' | 'mergesCurrentDocs' | 'merges.current_size' | 'mcs' | 'mergesCurrentSize' | 'merges.total' | 'mt' | 'mergesTotal' | 'merges.total_docs' | 'mtd' | 'mergesTotalDocs' | 'merges.total_size' | 'mts' | 'mergesTotalSize' | 'merges.total_time' | 'mtt' | 'mergesTotalTime' | 'node' | 'n' | 'prirep' | 'p' | 'pr' | 'primaryOrReplica' | 'query_cache.evictions' | 'qce' | 'queryCacheEvictions' | 'query_cache.memory_size' | 'qcm' | 'queryCacheMemory' | 'recoverysource.type' | 'rs' | 'refresh.time' | 'rti' | 'refreshTime' | 'refresh.total' | 'rto' | 'refreshTotal' | 'search.fetch_current' | 'sfc' | 'searchFetchCurrent' | 'search.fetch_time' | 'sfti' | 'searchFetchTime' | 'search.fetch_total' | 'sfto' | 'searchFetchTotal' | 'search.open_contexts' | 'so' | 'searchOpenContexts' | 'search.query_current' | 'sqc' | 'searchQueryCurrent' | 'search.query_time' | 'sqti' | 'searchQueryTime' | 'search.query_total' | 'sqto' | 'searchQueryTotal' | 'search.scroll_current' | 'scc' | 'searchScrollCurrent' | 'search.scroll_time' | 'scti' | 'searchScrollTime' | 'search.scroll_total' | 'scto' | 'searchScrollTotal' | 'segments.count' | 'sc' | 'segmentsCount' | 'segments.fixed_bitset_memory' | 'sfbm' | 'fixedBitsetMemory' | 'segments.index_writer_memory' | 'siwm' | 'segmentsIndexWriterMemory' | 'segments.memory' | 'sm' | 'segmentsMemory' | 'segments.version_map_memory' | 'svmm' | 'segmentsVersionMapMemory' | 'seq_no.global_checkpoint' | 'sqg' | 'globalCheckpoint' | 'seq_no.local_checkpoint' | 'sql' | 'localCheckpoint' | 'seq_no.max' | 'sqm' | 'maxSeqNo' | 'shard' | 's' | 'sh' | 'dsparse_vector.value_count' | 'svc' | 'sparseVectorCount' | 'state' | 'st' | 'store' | 'sto' | 'suggest.current' | 'suc' | 'suggestCurrent' | 'suggest.time' | 'suti' | 'suggestTime' | 'suggest.total' | 'suto' | 'suggestTotal' | 'sync_id' | 'unassigned.at' | 'ua' | 'unassigned.details' | 'ud' | 'unassigned.for' | 'uf' | 'unassigned.reason' | 'ur' | string;
10568
+ export type CatCatShardColumns = CatCatShardColumn | CatCatShardColumn[];
10569
+ export type CatCatSnapshotsColumn = 'id' | 'snapshot' | 'repository' | 're' | 'repo' | 'status' | 's' | 'start_epoch' | 'ste' | 'startEpoch' | 'start_time' | 'sti' | 'startTime' | 'end_epoch' | 'ete' | 'endEpoch' | 'end_time' | 'eti' | 'endTime' | 'duration' | 'dur' | 'indices' | 'i' | 'successful_shards' | 'ss' | 'failed_shards' | 'fs' | 'total_shards' | 'ts' | 'reason' | 'r' | string;
10570
+ export type CatCatSnapshotsColumns = CatCatSnapshotsColumn | CatCatSnapshotsColumn[];
10571
+ export type CatCatThreadPoolColumn = 'active' | 'a' | 'completed' | 'c' | 'core' | 'cr' | 'ephemeral_id' | 'eid' | 'host' | 'h' | 'ip' | 'i' | 'keep_alive' | 'k' | 'largest' | 'l' | 'max' | 'mx' | 'name' | 'node_id' | 'id' | 'node_name' | 'pid' | 'p' | 'pool_size' | 'psz' | 'port' | 'po' | 'queue' | 'q' | 'queue_size' | 'qs' | 'rejected' | 'r' | 'size' | 'sz' | 'type' | 't' | string;
10572
+ export type CatCatThreadPoolColumns = CatCatThreadPoolColumn | CatCatThreadPoolColumn[];
10397
10573
  export type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'dfid' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v';
10398
10574
  export type CatCatTrainedModelsColumns = CatCatTrainedModelsColumn | CatCatTrainedModelsColumn[];
10399
10575
  export type CatCatTransformColumn = 'changes_last_detection_time' | 'cldt' | 'checkpoint' | 'cp' | 'checkpoint_duration_time_exp_avg' | 'cdtea' | 'checkpointTimeExpAvg' | 'checkpoint_progress' | 'c' | 'checkpointProgress' | 'create_time' | 'ct' | 'createTime' | 'delete_time' | 'dtime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'documents_deleted' | 'docd' | 'documents_indexed' | 'doci' | 'docs_per_second' | 'dps' | 'documents_processed' | 'docp' | 'frequency' | 'f' | 'id' | 'index_failure' | 'if' | 'index_time' | 'itime' | 'index_total' | 'it' | 'indexed_documents_exp_avg' | 'idea' | 'last_search_time' | 'lst' | 'lastSearchTime' | 'max_page_search_size' | 'mpsz' | 'pages_processed' | 'pp' | 'pipeline' | 'p' | 'processed_documents_exp_avg' | 'pdea' | 'processing_time' | 'pt' | 'reason' | 'r' | 'search_failure' | 'sf' | 'search_time' | 'stime' | 'search_total' | 'st' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'transform_type' | 'tt' | 'trigger_count' | 'tc' | 'version' | 'v';
@@ -13938,13 +14114,14 @@ export interface CatRecoveryRequest extends CatCatRequestBase {
13938
14114
  bytes?: Bytes;
13939
14115
  /** If `true`, the response includes detailed information about shard recoveries. */
13940
14116
  detailed?: boolean;
13941
- /** List of columns to appear in the response. Supports simple wildcards. */
13942
- h?: Names;
13943
- /** List of columns that determine how the table should be sorted.
14117
+ /** A comma-separated list of columns names to display.
14118
+ * It supports simple wildcards. */
14119
+ h?: CatCatRecoveryColumns;
14120
+ /** A comma-separated list of column names or aliases that determines the sort order.
13944
14121
  * Sorting defaults to ascending and can be changed by setting `:asc`
13945
14122
  * or `:desc` as a suffix to the column name. */
13946
14123
  s?: Names;
13947
- /** Unit used to display time values. */
14124
+ /** The unit used to display time values. */
13948
14125
  time?: TimeUnit;
13949
14126
  /** All values in `body` will be added to the request body. */
13950
14127
  body?: string | ({
@@ -14025,9 +14202,10 @@ export interface CatSegmentsRequest extends CatCatRequestBase {
14025
14202
  index?: Indices;
14026
14203
  /** The unit used to display byte values. */
14027
14204
  bytes?: Bytes;
14028
- /** List of columns to appear in the response. Supports simple wildcards. */
14029
- h?: Names;
14030
- /** List of columns that determine how the table should be sorted.
14205
+ /** A comma-separated list of columns names to display.
14206
+ * It supports simple wildcards. */
14207
+ h?: CatCatSegmentsColumns;
14208
+ /** A comma-separated list of column names or aliases that determines the sort order.
14031
14209
  * Sorting defaults to ascending and can be changed by setting `:asc`
14032
14210
  * or `:desc` as a suffix to the column name. */
14033
14211
  s?: Names;
@@ -14207,14 +14385,14 @@ export interface CatShardsRequest extends CatCatRequestBase {
14207
14385
  /** The unit used to display byte values. */
14208
14386
  bytes?: Bytes;
14209
14387
  /** List of columns to appear in the response. Supports simple wildcards. */
14210
- h?: Names;
14211
- /** List of columns that determine how the table should be sorted.
14388
+ h?: CatCatShardColumns;
14389
+ /** A comma-separated list of column names or aliases that determines the sort order.
14212
14390
  * Sorting defaults to ascending and can be changed by setting `:asc`
14213
14391
  * or `:desc` as a suffix to the column name. */
14214
14392
  s?: Names;
14215
- /** Period to wait for a connection to the master node. */
14393
+ /** The period to wait for a connection to the master node. */
14216
14394
  master_timeout?: Duration;
14217
- /** Unit used to display time values. */
14395
+ /** The unit used to display time values. */
14218
14396
  time?: TimeUnit;
14219
14397
  /** All values in `body` will be added to the request body. */
14220
14398
  body?: string | ({
@@ -14859,8 +15037,9 @@ export interface CatSnapshotsRequest extends CatCatRequestBase {
14859
15037
  repository?: Names;
14860
15038
  /** If `true`, the response does not include information from unavailable snapshots. */
14861
15039
  ignore_unavailable?: boolean;
14862
- /** List of columns to appear in the response. Supports simple wildcards. */
14863
- h?: Names;
15040
+ /** A comma-separated list of columns names to display.
15041
+ * It supports simple wildcards. */
15042
+ h?: CatCatSnapshotsColumns;
14864
15043
  /** List of columns that determine how the table should be sorted.
14865
15044
  * Sorting defaults to ascending and can be changed by setting `:asc`
14866
15045
  * or `:desc` as a suffix to the column name. */
@@ -15195,8 +15374,8 @@ export interface CatThreadPoolRequest extends CatCatRequestBase {
15195
15374
  * Accepts wildcard expressions. */
15196
15375
  thread_pool_patterns?: Names;
15197
15376
  /** List of columns to appear in the response. Supports simple wildcards. */
15198
- h?: Names;
15199
- /** List of columns that determine how the table should be sorted.
15377
+ h?: CatCatThreadPoolColumns;
15378
+ /** A comma-separated list of column names or aliases that determines the sort order.
15200
15379
  * Sorting defaults to ascending and can be changed by setting `:asc`
15201
15380
  * or `:desc` as a suffix to the column name. */
15202
15381
  s?: Names;
@@ -15207,7 +15386,7 @@ export interface CatThreadPoolRequest extends CatCatRequestBase {
15207
15386
  * from the cluster state of the master node. In both cases the coordinating
15208
15387
  * node will send requests for further information to each selected node. */
15209
15388
  local?: boolean;
15210
- /** Period to wait for a connection to the master node. */
15389
+ /** The period to wait for a connection to the master node. */
15211
15390
  master_timeout?: Duration;
15212
15391
  /** All values in `body` will be added to the request body. */
15213
15392
  body?: string | ({
@@ -16240,6 +16419,7 @@ export interface ClusterComponentTemplateSummary {
16240
16419
  mappings?: MappingTypeMapping;
16241
16420
  aliases?: Record<string, IndicesAliasDefinition>;
16242
16421
  lifecycle?: IndicesDataStreamLifecycleWithRollover;
16422
+ data_stream_options?: IndicesDataStreamOptionsTemplate | null;
16243
16423
  }
16244
16424
  export interface ClusterAllocationExplainAllocationDecision {
16245
16425
  decider: string;
@@ -16466,6 +16646,8 @@ export interface ClusterGetComponentTemplateRequest extends RequestBase {
16466
16646
  name?: Name;
16467
16647
  /** If `true`, returns settings in flat format. */
16468
16648
  flat_settings?: boolean;
16649
+ /** Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys */
16650
+ settings_filter?: string | string[];
16469
16651
  /** Return all default configurations for the component template (default: false) */
16470
16652
  include_defaults?: boolean;
16471
16653
  /** If `true`, the request retrieves information from the local node only.
@@ -16480,6 +16662,7 @@ export interface ClusterGetComponentTemplateRequest extends RequestBase {
16480
16662
  } & {
16481
16663
  name?: never;
16482
16664
  flat_settings?: never;
16665
+ settings_filter?: never;
16483
16666
  include_defaults?: never;
16484
16667
  local?: never;
16485
16668
  master_timeout?: never;
@@ -16490,6 +16673,7 @@ export interface ClusterGetComponentTemplateRequest extends RequestBase {
16490
16673
  } & {
16491
16674
  name?: never;
16492
16675
  flat_settings?: never;
16676
+ settings_filter?: never;
16493
16677
  include_defaults?: never;
16494
16678
  local?: never;
16495
16679
  master_timeout?: never;
@@ -16529,8 +16713,11 @@ export interface ClusterGetSettingsRequest extends RequestBase {
16529
16713
  };
16530
16714
  }
16531
16715
  export interface ClusterGetSettingsResponse {
16716
+ /** The settings that persist after the cluster restarts. */
16532
16717
  persistent: Record<string, any>;
16718
+ /** The settings that do not persist after the cluster restarts. */
16533
16719
  transient: Record<string, any>;
16720
+ /** The default setting values. */
16534
16721
  defaults?: Record<string, any>;
16535
16722
  }
16536
16723
  export interface ClusterHealthHealthResponseBody {
@@ -16760,6 +16947,8 @@ export interface ClusterPutComponentTemplateRequest extends RequestBase {
16760
16947
  name: Name;
16761
16948
  /** If `true`, this request cannot replace or update existing component templates. */
16762
16949
  create?: boolean;
16950
+ /** User defined reason for create the component template. */
16951
+ cause?: string;
16763
16952
  /** Period to wait for a connection to the master node.
16764
16953
  * If no response is received before the timeout expires, the request fails and returns an error. */
16765
16954
  master_timeout?: Duration;
@@ -16783,6 +16972,7 @@ export interface ClusterPutComponentTemplateRequest extends RequestBase {
16783
16972
  } & {
16784
16973
  name?: never;
16785
16974
  create?: never;
16975
+ cause?: never;
16786
16976
  master_timeout?: never;
16787
16977
  template?: never;
16788
16978
  version?: never;
@@ -16795,6 +16985,7 @@ export interface ClusterPutComponentTemplateRequest extends RequestBase {
16795
16985
  } & {
16796
16986
  name?: never;
16797
16987
  create?: never;
16988
+ cause?: never;
16798
16989
  master_timeout?: never;
16799
16990
  template?: never;
16800
16991
  version?: never;
@@ -16810,7 +17001,9 @@ export interface ClusterPutSettingsRequest extends RequestBase {
16810
17001
  master_timeout?: Duration;
16811
17002
  /** Explicit operation timeout */
16812
17003
  timeout?: Duration;
17004
+ /** The settings that persist after the cluster restarts. */
16813
17005
  persistent?: Record<string, any>;
17006
+ /** The settings that do not persist after the cluster restarts. */
16814
17007
  transient?: Record<string, any>;
16815
17008
  /** All values in `body` will be added to the request body. */
16816
17009
  body?: string | ({
@@ -17116,20 +17309,41 @@ export interface ClusterStatsCharFilterTypes {
17116
17309
  filter_types: ClusterStatsFieldTypes[];
17117
17310
  /** Contains statistics about tokenizer types used in selected nodes. */
17118
17311
  tokenizer_types: ClusterStatsFieldTypes[];
17312
+ /** Contains statistics about synonyms types used in selected nodes. */
17313
+ synonyms: Record<Name, ClusterStatsSynonymsStats>;
17119
17314
  }
17120
17315
  export interface ClusterStatsClusterFileSystem {
17316
+ path?: string;
17317
+ mount?: string;
17318
+ type?: string;
17121
17319
  /** Total number of bytes available to JVM in file stores across all selected nodes.
17122
17320
  * Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.
17123
17321
  * This is the actual amount of free disk space the selected Elasticsearch nodes can use. */
17124
- available_in_bytes: long;
17322
+ available_in_bytes?: long;
17323
+ /** Total number of bytes available to JVM in file stores across all selected nodes.
17324
+ * Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.
17325
+ * This is the actual amount of free disk space the selected Elasticsearch nodes can use. */
17326
+ available?: ByteSize;
17327
+ /** Total number, in bytes, of unallocated bytes in file stores across all selected nodes. */
17328
+ free_in_bytes?: long;
17125
17329
  /** Total number of unallocated bytes in file stores across all selected nodes. */
17126
- free_in_bytes: long;
17330
+ free?: ByteSize;
17127
17331
  /** Total size, in bytes, of all file stores across all selected nodes. */
17128
- total_in_bytes: long;
17332
+ total_in_bytes?: long;
17333
+ /** Total size of all file stores across all selected nodes. */
17334
+ total?: ByteSize;
17335
+ low_watermark_free_space?: ByteSize;
17336
+ low_watermark_free_space_in_bytes?: long;
17337
+ high_watermark_free_space?: ByteSize;
17338
+ high_watermark_free_space_in_bytes?: long;
17339
+ flood_stage_free_space?: ByteSize;
17340
+ flood_stage_free_space_in_bytes?: long;
17341
+ frozen_flood_stage_free_space?: ByteSize;
17342
+ frozen_flood_stage_free_space_in_bytes?: long;
17129
17343
  }
17130
17344
  export interface ClusterStatsClusterIndices {
17131
17345
  /** Contains statistics about analyzers and analyzer components used in selected nodes. */
17132
- analysis: ClusterStatsCharFilterTypes;
17346
+ analysis?: ClusterStatsCharFilterTypes;
17133
17347
  /** Contains statistics about memory used for completion in selected nodes. */
17134
17348
  completion: CompletionStats;
17135
17349
  /** Total number of indices with shards assigned to selected nodes. */
@@ -17140,6 +17354,10 @@ export interface ClusterStatsClusterIndices {
17140
17354
  fielddata: FielddataStats;
17141
17355
  /** Contains statistics about the query cache of selected nodes. */
17142
17356
  query_cache: QueryCacheStats;
17357
+ /** Holds a snapshot of the search usage statistics.
17358
+ * Used to hold the stats for a single node that's part of a ClusterStatsNodeResponse, as well as to
17359
+ * accumulate stats for the entire cluster and return them as part of the ClusterStatsResponse. */
17360
+ search: ClusterStatsSearchUsageStats;
17143
17361
  /** Contains statistics about segments in selected nodes. */
17144
17362
  segments: SegmentsStats;
17145
17363
  /** Contains statistics about indices with shards assigned to selected nodes. */
@@ -17147,9 +17365,13 @@ export interface ClusterStatsClusterIndices {
17147
17365
  /** Contains statistics about the size of shards assigned to selected nodes. */
17148
17366
  store: StoreStats;
17149
17367
  /** Contains statistics about field mappings in selected nodes. */
17150
- mappings: ClusterStatsFieldTypesMappings;
17368
+ mappings?: ClusterStatsFieldTypesMappings;
17151
17369
  /** Contains statistics about analyzers and analyzer components used in selected nodes. */
17152
17370
  versions?: ClusterStatsIndicesVersions[];
17371
+ /** Contains statistics about indexed dense vector */
17372
+ dense_vector: ClusterStatsDenseVectorStats;
17373
+ /** Contains statistics about indexed sparse vector */
17374
+ sparse_vector: ClusterStatsSparseVectorStats;
17153
17375
  }
17154
17376
  export interface ClusterStatsClusterIndicesShards {
17155
17377
  /** Contains statistics about shards assigned to selected nodes. */
@@ -17176,6 +17398,8 @@ export interface ClusterStatsClusterIngest {
17176
17398
  export interface ClusterStatsClusterJvm {
17177
17399
  /** Uptime duration, in milliseconds, since JVM last started. */
17178
17400
  max_uptime_in_millis: DurationValue<UnitMillis>;
17401
+ /** Uptime duration since JVM last started. */
17402
+ max_uptime?: Duration;
17179
17403
  /** Contains statistics about memory used by selected nodes. */
17180
17404
  mem: ClusterStatsClusterJvmMemory;
17181
17405
  /** Number of active threads in use by JVM across all selected nodes. */
@@ -17186,8 +17410,12 @@ export interface ClusterStatsClusterJvm {
17186
17410
  export interface ClusterStatsClusterJvmMemory {
17187
17411
  /** Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. */
17188
17412
  heap_max_in_bytes: long;
17413
+ /** Maximum amount of memory available for use by the heap across all selected nodes. */
17414
+ heap_max?: ByteSize;
17189
17415
  /** Memory, in bytes, currently in use by the heap across all selected nodes. */
17190
17416
  heap_used_in_bytes: long;
17417
+ /** Memory currently in use by the heap across all selected nodes. */
17418
+ heap_used?: ByteSize;
17191
17419
  }
17192
17420
  export interface ClusterStatsClusterJvmVersion {
17193
17421
  /** Always `true`. All distributions come with a bundled Java Development Kit (JDK). */
@@ -17213,20 +17441,22 @@ export interface ClusterStatsClusterNetworkTypes {
17213
17441
  transport_types: Record<string, integer>;
17214
17442
  }
17215
17443
  export interface ClusterStatsClusterNodeCount {
17216
- coordinating_only: integer;
17217
- data: integer;
17218
- data_cold: integer;
17219
- data_content: integer;
17220
- data_frozen?: integer;
17221
- data_hot: integer;
17222
- data_warm: integer;
17223
- ingest: integer;
17224
- master: integer;
17225
- ml: integer;
17226
- remote_cluster_client: integer;
17227
17444
  total: integer;
17228
- transform: integer;
17229
- voting_only: integer;
17445
+ coordinating_only?: integer;
17446
+ data?: integer;
17447
+ data_cold?: integer;
17448
+ data_content?: integer;
17449
+ data_frozen?: integer;
17450
+ data_hot?: integer;
17451
+ data_warm?: integer;
17452
+ index?: integer;
17453
+ ingest?: integer;
17454
+ master?: integer;
17455
+ ml?: integer;
17456
+ remote_cluster_client?: integer;
17457
+ search?: integer;
17458
+ transform?: integer;
17459
+ voting_only?: integer;
17230
17460
  }
17231
17461
  export interface ClusterStatsClusterNodes {
17232
17462
  /** Contains counts for nodes selected by the request’s node filters. */
@@ -17324,6 +17554,27 @@ export interface ClusterStatsClusterShardMetrics {
17324
17554
  /** Minimum number of shards in an index, counting only shards assigned to selected nodes. */
17325
17555
  min: double;
17326
17556
  }
17557
+ export interface ClusterStatsClusterSnapshotStats {
17558
+ current_counts: ClusterStatsSnapshotCurrentCounts;
17559
+ repositories: Record<Name, ClusterStatsPerRepositoryStats>;
17560
+ }
17561
+ export interface ClusterStatsDenseVectorOffHeapStats {
17562
+ total_size_bytes: long;
17563
+ total_size?: ByteSize;
17564
+ total_veb_size_bytes: long;
17565
+ total_veb_size?: ByteSize;
17566
+ total_vec_size_bytes: long;
17567
+ total_vec_size?: ByteSize;
17568
+ total_veq_size_bytes: long;
17569
+ total_veq_size?: ByteSize;
17570
+ total_vex_size_bytes: long;
17571
+ total_vex_size?: ByteSize;
17572
+ fielddata?: Record<string, Record<string, long>>;
17573
+ }
17574
+ export interface ClusterStatsDenseVectorStats {
17575
+ value_count: long;
17576
+ off_heap?: ClusterStatsDenseVectorOffHeapStats;
17577
+ }
17327
17578
  export interface ClusterStatsFieldTypes {
17328
17579
  /** The name for the field type in selected nodes. */
17329
17580
  name: Name;
@@ -17332,50 +17583,44 @@ export interface ClusterStatsFieldTypes {
17332
17583
  /** The number of indices containing the field type in selected nodes. */
17333
17584
  index_count: integer;
17334
17585
  /** For dense_vector field types, number of indexed vector types in selected nodes. */
17335
- indexed_vector_count?: long;
17586
+ indexed_vector_count?: integer;
17336
17587
  /** For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. */
17337
- indexed_vector_dim_max?: long;
17588
+ indexed_vector_dim_max?: integer;
17338
17589
  /** For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. */
17339
- indexed_vector_dim_min?: long;
17590
+ indexed_vector_dim_min?: integer;
17340
17591
  /** The number of fields that declare a script. */
17341
17592
  script_count?: integer;
17593
+ /** For dense_vector field types, count of mappings by index type */
17594
+ vector_index_type_count?: Record<Name, integer>;
17595
+ /** For dense_vector field types, count of mappings by similarity */
17596
+ vector_similarity_type_count?: Record<Name, integer>;
17597
+ /** For dense_vector field types, count of mappings by element type */
17598
+ vector_element_type_count?: Record<Name, integer>;
17342
17599
  }
17343
17600
  export interface ClusterStatsFieldTypesMappings {
17344
17601
  /** Contains statistics about field data types used in selected nodes. */
17345
17602
  field_types: ClusterStatsFieldTypes[];
17346
17603
  /** Contains statistics about runtime field data types used in selected nodes. */
17347
- runtime_field_types?: ClusterStatsRuntimeFieldTypes[];
17604
+ runtime_field_types: ClusterStatsRuntimeFieldTypes[];
17348
17605
  /** Total number of fields in all non-system indices. */
17349
- total_field_count?: integer;
17606
+ total_field_count?: long;
17350
17607
  /** Total number of fields in all non-system indices, accounting for mapping deduplication. */
17351
- total_deduplicated_field_count?: integer;
17608
+ total_deduplicated_field_count?: long;
17352
17609
  /** Total size of all mappings after deduplication and compression. */
17353
17610
  total_deduplicated_mapping_size?: ByteSize;
17354
17611
  /** Total size of all mappings, in bytes, after deduplication and compression. */
17355
17612
  total_deduplicated_mapping_size_in_bytes?: long;
17613
+ /** Source mode usage count. */
17614
+ source_modes: Record<Name, integer>;
17356
17615
  }
17357
17616
  export interface ClusterStatsIndexingPressure {
17358
- memory: ClusterStatsIndexingPressureMemory;
17359
- }
17360
- export interface ClusterStatsIndexingPressureMemory {
17361
- current: ClusterStatsIndexingPressureMemorySummary;
17362
- limit_in_bytes: long;
17363
- total: ClusterStatsIndexingPressureMemorySummary;
17364
- }
17365
- export interface ClusterStatsIndexingPressureMemorySummary {
17366
- all_in_bytes: long;
17367
- combined_coordinating_and_primary_in_bytes: long;
17368
- coordinating_in_bytes: long;
17369
- coordinating_rejections?: long;
17370
- primary_in_bytes: long;
17371
- primary_rejections?: long;
17372
- replica_in_bytes: long;
17373
- replica_rejections?: long;
17617
+ memory: NodesIndexingPressureMemory;
17374
17618
  }
17375
17619
  export interface ClusterStatsIndicesVersions {
17376
17620
  index_count: integer;
17377
17621
  primary_shard_count: integer;
17378
17622
  total_primary_bytes: long;
17623
+ total_primary_size?: ByteSize;
17379
17624
  version: VersionString;
17380
17625
  }
17381
17626
  export interface ClusterStatsNodePackagingType {
@@ -17389,17 +17634,31 @@ export interface ClusterStatsNodePackagingType {
17389
17634
  export interface ClusterStatsOperatingSystemMemoryInfo {
17390
17635
  /** Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. */
17391
17636
  adjusted_total_in_bytes?: long;
17637
+ /** Total amount of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. */
17638
+ adjusted_total?: ByteSize;
17392
17639
  /** Amount, in bytes, of free physical memory across all selected nodes. */
17393
17640
  free_in_bytes: long;
17641
+ /** Amount of free physical memory across all selected nodes. */
17642
+ free?: ByteSize;
17394
17643
  /** Percentage of free physical memory across all selected nodes. */
17395
17644
  free_percent: integer;
17396
17645
  /** Total amount, in bytes, of physical memory across all selected nodes. */
17397
17646
  total_in_bytes: long;
17647
+ /** Total amount of physical memory across all selected nodes. */
17648
+ total?: ByteSize;
17398
17649
  /** Amount, in bytes, of physical memory in use across all selected nodes. */
17399
17650
  used_in_bytes: long;
17651
+ /** Amount of physical memory in use across all selected nodes. */
17652
+ used?: ByteSize;
17400
17653
  /** Percentage of physical memory in use across all selected nodes. */
17401
17654
  used_percent: integer;
17402
17655
  }
17656
+ export interface ClusterStatsPerRepositoryStats {
17657
+ type: string;
17658
+ oldest_start_time_millis: UnitMillis;
17659
+ oldest_start_time?: DateFormat;
17660
+ current_counts: ClusterStatsRepositoryStatsCurrentCounts;
17661
+ }
17403
17662
  export interface ClusterStatsRemoteClusterInfo {
17404
17663
  /** The UUID of the remote cluster. */
17405
17664
  cluster_uuid: string;
@@ -17408,7 +17667,7 @@ export interface ClusterStatsRemoteClusterInfo {
17408
17667
  /** The `skip_unavailable` setting used for this remote cluster. */
17409
17668
  skip_unavailable: boolean;
17410
17669
  /** Transport compression setting used for this remote cluster. */
17411
- transport_compress: string;
17670
+ 'transport.compress': string;
17412
17671
  /** Health status of the cluster, based on the state of its primary and replica shards. */
17413
17672
  status: HealthStatus;
17414
17673
  /** The list of Elasticsearch versions used by the nodes on the remote cluster. */
@@ -17432,6 +17691,21 @@ export interface ClusterStatsRemoteClusterInfo {
17432
17691
  /** Total amount of physical memory across the nodes of the remote cluster, as a human-readable string. */
17433
17692
  mem_total?: string;
17434
17693
  }
17694
+ export interface ClusterStatsRepositoryStatsCurrentCounts {
17695
+ snapshots: integer;
17696
+ clones: integer;
17697
+ finalizations: integer;
17698
+ deletions: integer;
17699
+ snapshot_deletions: integer;
17700
+ active_deletions: integer;
17701
+ shards: ClusterStatsRepositoryStatsShards;
17702
+ }
17703
+ export interface ClusterStatsRepositoryStatsShards {
17704
+ total: integer;
17705
+ complete: integer;
17706
+ incomplete: integer;
17707
+ states: Record<ClusterStatsShardState, integer>;
17708
+ }
17435
17709
  export interface ClusterStatsRequest extends RequestBase {
17436
17710
  /** Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. */
17437
17711
  node_id?: NodeIds;
@@ -17489,6 +17763,29 @@ export interface ClusterStatsRuntimeFieldTypes {
17489
17763
  /** Total number of accesses to _source for the scripts that define the current runtime field data type. */
17490
17764
  source_total: integer;
17491
17765
  }
17766
+ export interface ClusterStatsSearchUsageStats {
17767
+ total: long;
17768
+ queries: Record<Name, long>;
17769
+ rescorers: Record<Name, long>;
17770
+ sections: Record<Name, long>;
17771
+ retrievers: Record<Name, long>;
17772
+ }
17773
+ export type ClusterStatsShardState = 'INIT' | 'SUCCESS' | 'FAILED' | 'ABORTED' | 'MISSING' | 'WAITING' | 'QUEUED' | 'PAUSED_FOR_NODE_REMOVAL';
17774
+ export interface ClusterStatsSnapshotCurrentCounts {
17775
+ /** Snapshots currently in progress */
17776
+ snapshots: integer;
17777
+ /** Incomplete shard snapshots */
17778
+ shard_snapshots: integer;
17779
+ /** Snapshots deletions in progress */
17780
+ snapshot_deletions: integer;
17781
+ /** Sum of snapshots and snapshot_deletions */
17782
+ concurrent_operations: integer;
17783
+ /** Cleanups in progress, not counted in concurrent_operations as they are not concurrent */
17784
+ cleanups: integer;
17785
+ }
17786
+ export interface ClusterStatsSparseVectorStats {
17787
+ value_count: long;
17788
+ }
17492
17789
  export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase {
17493
17790
  /** Name of the cluster, based on the cluster name setting. */
17494
17791
  cluster_name: Name;
@@ -17498,13 +17795,21 @@ export interface ClusterStatsStatsResponseBase extends NodesNodesResponseBase {
17498
17795
  indices: ClusterStatsClusterIndices;
17499
17796
  /** Contains statistics about nodes selected by the request’s node filters. */
17500
17797
  nodes: ClusterStatsClusterNodes;
17798
+ /** Contains stats on repository feature usage exposed in cluster stats for telemetry. */
17799
+ repositories: Record<Name, Record<Name, long>>;
17800
+ /** Contains stats cluster snapshots. */
17801
+ snapshots: ClusterStatsClusterSnapshotStats;
17501
17802
  /** Health status of the cluster, based on the state of its primary and replica shards. */
17502
- status: HealthStatus;
17803
+ status?: HealthStatus;
17503
17804
  /** Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. */
17504
17805
  timestamp: long;
17505
17806
  /** Cross-cluster stats */
17506
17807
  ccs: ClusterStatsCCSStats;
17507
17808
  }
17809
+ export interface ClusterStatsSynonymsStats {
17810
+ count: integer;
17811
+ index_count: integer;
17812
+ }
17508
17813
  export interface ConnectorConnector {
17509
17814
  api_key_id?: string;
17510
17815
  api_key_secret_id?: string;
@@ -18851,8 +19156,12 @@ export interface EqlGetStatusResponse {
18851
19156
  export interface EqlSearchRequest extends RequestBase {
18852
19157
  /** The name of the index to scope the operation */
18853
19158
  index: Indices;
19159
+ /** Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) */
18854
19160
  allow_no_indices?: boolean;
19161
+ /** Whether to expand wildcard expression to concrete indices that are open, closed or both. */
18855
19162
  expand_wildcards?: ExpandWildcards;
19163
+ /** Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution */
19164
+ ccs_minimize_roundtrips?: boolean;
18856
19165
  /** If true, missing or closed indices are not included in the response. */
18857
19166
  ignore_unavailable?: boolean;
18858
19167
  /** EQL query you wish to run. */
@@ -18896,6 +19205,7 @@ export interface EqlSearchRequest extends RequestBase {
18896
19205
  index?: never;
18897
19206
  allow_no_indices?: never;
18898
19207
  expand_wildcards?: never;
19208
+ ccs_minimize_roundtrips?: never;
18899
19209
  ignore_unavailable?: never;
18900
19210
  query?: never;
18901
19211
  case_sensitive?: never;
@@ -18922,6 +19232,7 @@ export interface EqlSearchRequest extends RequestBase {
18922
19232
  index?: never;
18923
19233
  allow_no_indices?: never;
18924
19234
  expand_wildcards?: never;
19235
+ ccs_minimize_roundtrips?: never;
18925
19236
  ignore_unavailable?: never;
18926
19237
  query?: never;
18927
19238
  case_sensitive?: never;
@@ -18945,7 +19256,13 @@ export interface EqlSearchRequest extends RequestBase {
18945
19256
  export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>;
18946
19257
  export type EqlSearchResultPosition = 'tail' | 'head';
18947
19258
  export interface EsqlAsyncEsqlResult extends EsqlEsqlResult {
19259
+ /** The ID of the async query, to be used in subsequent requests to check the status or retrieve results.
19260
+ *
19261
+ * Also available in the `X-Elasticsearch-Async-Id` HTTP header. */
18948
19262
  id?: string;
19263
+ /** Indicates whether the async query is still running or has completed.
19264
+ *
19265
+ * Also available in the `X-Elasticsearch-Async-Is-Running` HTTP header. */
18949
19266
  is_running: boolean;
18950
19267
  }
18951
19268
  export interface EsqlEsqlClusterDetails {
@@ -18953,6 +19270,7 @@ export interface EsqlEsqlClusterDetails {
18953
19270
  indices: string;
18954
19271
  took?: DurationValue<UnitMillis>;
18955
19272
  _shards?: EsqlEsqlShardInfo;
19273
+ failures?: EsqlEsqlShardFailure[];
18956
19274
  }
18957
19275
  export interface EsqlEsqlClusterInfo {
18958
19276
  total: integer;
@@ -18983,8 +19301,8 @@ export interface EsqlEsqlResult {
18983
19301
  profile?: any;
18984
19302
  }
18985
19303
  export interface EsqlEsqlShardFailure {
18986
- shard: Id;
18987
- index: IndexName;
19304
+ shard: integer;
19305
+ index: IndexName | null;
18988
19306
  node?: NodeId;
18989
19307
  reason: ErrorCause;
18990
19308
  }
@@ -18993,7 +19311,6 @@ export interface EsqlEsqlShardInfo {
18993
19311
  successful?: integer;
18994
19312
  skipped?: integer;
18995
19313
  failed?: integer;
18996
- failures?: EsqlEsqlShardFailure[];
18997
19314
  }
18998
19315
  export interface EsqlTableValuesContainer {
18999
19316
  integer?: EsqlTableValuesIntegerValue[];
@@ -19006,22 +19323,24 @@ export type EsqlTableValuesKeywordValue = string | string[];
19006
19323
  export type EsqlTableValuesLongDouble = double | double[];
19007
19324
  export type EsqlTableValuesLongValue = long | long[];
19008
19325
  export interface EsqlAsyncQueryRequest extends RequestBase {
19326
+ /** If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
19327
+ * If `false`, the query will fail if there are any failures.
19328
+ *
19329
+ * To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. */
19330
+ allow_partial_results?: boolean;
19009
19331
  /** The character to use between values within a CSV row.
19010
19332
  * It is valid only for the CSV format. */
19011
19333
  delimiter?: string;
19012
19334
  /** Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
19013
19335
  * If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. */
19014
19336
  drop_null_columns?: boolean;
19015
- /** A short version of the Accept header, for example `json` or `yaml`. */
19337
+ /** A short version of the Accept header, e.g. json, yaml.
19338
+ *
19339
+ * `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
19340
+ *
19341
+ * For async requests, nothing will be returned if the async query doesn't finish within the timeout.
19342
+ * The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively. */
19016
19343
  format?: EsqlEsqlFormat;
19017
- /** The period for which the query and its results are stored in the cluster.
19018
- * The default period is five days.
19019
- * When this period expires, the query and its results are deleted, even if the query is still ongoing.
19020
- * If the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value. */
19021
- keep_alive?: Duration;
19022
- /** Indicates whether the query and its results are stored in the cluster.
19023
- * If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter. */
19024
- keep_on_completion?: boolean;
19025
19344
  /** By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. */
19026
19345
  columnar?: boolean;
19027
19346
  /** Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. */
@@ -19048,15 +19367,22 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
19048
19367
  * If the query completes during this period, results are returned
19049
19368
  * Otherwise, a query ID is returned that can later be used to retrieve the results. */
19050
19369
  wait_for_completion_timeout?: Duration;
19370
+ /** The period for which the query and its results are stored in the cluster.
19371
+ * The default period is five days.
19372
+ * When this period expires, the query and its results are deleted, even if the query is still ongoing.
19373
+ * If the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value. */
19374
+ keep_alive?: Duration;
19375
+ /** Indicates whether the query and its results are stored in the cluster.
19376
+ * If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter. */
19377
+ keep_on_completion?: boolean;
19051
19378
  /** All values in `body` will be added to the request body. */
19052
19379
  body?: string | ({
19053
19380
  [key: string]: any;
19054
19381
  } & {
19382
+ allow_partial_results?: never;
19055
19383
  delimiter?: never;
19056
19384
  drop_null_columns?: never;
19057
19385
  format?: never;
19058
- keep_alive?: never;
19059
- keep_on_completion?: never;
19060
19386
  columnar?: never;
19061
19387
  filter?: never;
19062
19388
  locale?: never;
@@ -19066,16 +19392,17 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
19066
19392
  tables?: never;
19067
19393
  include_ccs_metadata?: never;
19068
19394
  wait_for_completion_timeout?: never;
19395
+ keep_alive?: never;
19396
+ keep_on_completion?: never;
19069
19397
  });
19070
19398
  /** All values in `querystring` will be added to the request querystring. */
19071
19399
  querystring?: {
19072
19400
  [key: string]: any;
19073
19401
  } & {
19402
+ allow_partial_results?: never;
19074
19403
  delimiter?: never;
19075
19404
  drop_null_columns?: never;
19076
19405
  format?: never;
19077
- keep_alive?: never;
19078
- keep_on_completion?: never;
19079
19406
  columnar?: never;
19080
19407
  filter?: never;
19081
19408
  locale?: never;
@@ -19085,6 +19412,8 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
19085
19412
  tables?: never;
19086
19413
  include_ccs_metadata?: never;
19087
19414
  wait_for_completion_timeout?: never;
19415
+ keep_alive?: never;
19416
+ keep_on_completion?: never;
19088
19417
  };
19089
19418
  }
19090
19419
  export type EsqlAsyncQueryResponse = EsqlAsyncEsqlResult;
@@ -19115,6 +19444,8 @@ export interface EsqlAsyncQueryGetRequest extends RequestBase {
19115
19444
  /** Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
19116
19445
  * If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. */
19117
19446
  drop_null_columns?: boolean;
19447
+ /** A short version of the Accept header, for example `json` or `yaml`. */
19448
+ format?: EsqlEsqlFormat;
19118
19449
  /** The period for which the query and its results are stored in the cluster.
19119
19450
  * When this period expires, the query and its results are deleted, even if the query is still ongoing. */
19120
19451
  keep_alive?: Duration;
@@ -19129,6 +19460,7 @@ export interface EsqlAsyncQueryGetRequest extends RequestBase {
19129
19460
  } & {
19130
19461
  id?: never;
19131
19462
  drop_null_columns?: never;
19463
+ format?: never;
19132
19464
  keep_alive?: never;
19133
19465
  wait_for_completion_timeout?: never;
19134
19466
  });
@@ -19138,6 +19470,7 @@ export interface EsqlAsyncQueryGetRequest extends RequestBase {
19138
19470
  } & {
19139
19471
  id?: never;
19140
19472
  drop_null_columns?: never;
19473
+ format?: never;
19141
19474
  keep_alive?: never;
19142
19475
  wait_for_completion_timeout?: never;
19143
19476
  };
@@ -19167,14 +19500,66 @@ export interface EsqlAsyncQueryStopRequest extends RequestBase {
19167
19500
  };
19168
19501
  }
19169
19502
  export type EsqlAsyncQueryStopResponse = EsqlEsqlResult;
19503
+ export interface EsqlGetQueryRequest extends RequestBase {
19504
+ /** The query ID */
19505
+ id: Id;
19506
+ /** All values in `body` will be added to the request body. */
19507
+ body?: string | ({
19508
+ [key: string]: any;
19509
+ } & {
19510
+ id?: never;
19511
+ });
19512
+ /** All values in `querystring` will be added to the request querystring. */
19513
+ querystring?: {
19514
+ [key: string]: any;
19515
+ } & {
19516
+ id?: never;
19517
+ };
19518
+ }
19519
+ export interface EsqlGetQueryResponse {
19520
+ id: long;
19521
+ node: NodeId;
19522
+ start_time_millis: long;
19523
+ running_time_nanos: long;
19524
+ query: string;
19525
+ coordinating_node: NodeId;
19526
+ data_nodes: NodeId[];
19527
+ }
19528
+ export interface EsqlListQueriesBody {
19529
+ id: long;
19530
+ node: NodeId;
19531
+ start_time_millis: long;
19532
+ running_time_nanos: long;
19533
+ query: string;
19534
+ }
19535
+ export interface EsqlListQueriesRequest extends RequestBase {
19536
+ /** All values in `body` will be added to the request body. */
19537
+ body?: string | {
19538
+ [key: string]: any;
19539
+ };
19540
+ /** All values in `querystring` will be added to the request querystring. */
19541
+ querystring?: {
19542
+ [key: string]: any;
19543
+ };
19544
+ }
19545
+ export interface EsqlListQueriesResponse {
19546
+ queries: Record<TaskId, EsqlListQueriesBody>;
19547
+ }
19170
19548
  export interface EsqlQueryRequest extends RequestBase {
19171
- /** A short version of the Accept header, e.g. json, yaml. */
19549
+ /** A short version of the Accept header, e.g. json, yaml.
19550
+ *
19551
+ * `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response. */
19172
19552
  format?: EsqlEsqlFormat;
19173
19553
  /** The character to use between values within a CSV row. Only valid for the CSV format. */
19174
19554
  delimiter?: string;
19175
19555
  /** Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
19176
19556
  * Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. */
19177
19557
  drop_null_columns?: boolean;
19558
+ /** If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
19559
+ * If `false`, the query will fail if there are any failures.
19560
+ *
19561
+ * To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. */
19562
+ allow_partial_results?: boolean;
19178
19563
  /** By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. */
19179
19564
  columnar?: boolean;
19180
19565
  /** Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. */
@@ -19203,6 +19588,7 @@ export interface EsqlQueryRequest extends RequestBase {
19203
19588
  format?: never;
19204
19589
  delimiter?: never;
19205
19590
  drop_null_columns?: never;
19591
+ allow_partial_results?: never;
19206
19592
  columnar?: never;
19207
19593
  filter?: never;
19208
19594
  locale?: never;
@@ -19219,6 +19605,7 @@ export interface EsqlQueryRequest extends RequestBase {
19219
19605
  format?: never;
19220
19606
  delimiter?: never;
19221
19607
  drop_null_columns?: never;
19608
+ allow_partial_results?: never;
19222
19609
  columnar?: never;
19223
19610
  filter?: never;
19224
19611
  locale?: never;
@@ -19913,6 +20300,7 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
19913
20300
  step_time_millis?: EpochTime<UnitMillis>;
19914
20301
  phase_execution?: IlmExplainLifecycleLifecycleExplainPhaseExecution;
19915
20302
  time_since_index_creation?: Duration;
20303
+ skip: boolean;
19916
20304
  }
19917
20305
  export interface IlmExplainLifecycleLifecycleExplainPhaseExecution {
19918
20306
  phase_definition?: IlmPhase;
@@ -20252,6 +20640,9 @@ export interface IndicesDataStream {
20252
20640
  replicated?: boolean;
20253
20641
  /** If `true`, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too. */
20254
20642
  rollover_on_write: boolean;
20643
+ /** The settings specific to this data stream that will take precedence over the settings in the matching index
20644
+ * template. */
20645
+ settings: IndicesIndexSettings;
20255
20646
  /** Health status of the data stream.
20256
20647
  * This health status is based on the state of the primary and replica shards of the stream’s backing indices. */
20257
20648
  status: HealthStatus;
@@ -20262,6 +20653,24 @@ export interface IndicesDataStream {
20262
20653
  template: Name;
20263
20654
  /** Information about the `@timestamp` field in the data stream. */
20264
20655
  timestamp_field: IndicesDataStreamTimestampField;
20656
+ /** The index mode for the data stream that will be used for newly created backing indices. */
20657
+ index_mode?: IndicesIndexMode;
20658
+ }
20659
+ export interface IndicesDataStreamFailureStore {
20660
+ /** If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store
20661
+ * that's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will
20662
+ * not remove any existing data from the failure store. */
20663
+ enabled?: boolean;
20664
+ /** If defined, it specifies the lifecycle configuration for the failure store of this data stream. */
20665
+ lifecycle?: IndicesFailureStoreLifecycle;
20666
+ }
20667
+ export interface IndicesDataStreamFailureStoreTemplate {
20668
+ /** If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store
20669
+ * that's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will
20670
+ * not remove any existing data from the failure store. */
20671
+ enabled?: boolean | null;
20672
+ /** If defined, it specifies the lifecycle configuration for the failure store of this data stream. */
20673
+ lifecycle?: IndicesFailureStoreLifecycleTemplate | null;
20265
20674
  }
20266
20675
  export interface IndicesDataStreamIndex {
20267
20676
  /** Name of the backing index. */
@@ -20274,6 +20683,8 @@ export interface IndicesDataStreamIndex {
20274
20683
  managed_by?: IndicesManagedBy;
20275
20684
  /** Indicates if ILM should take precedence over DSL in case both are configured to manage this index. */
20276
20685
  prefer_ilm?: boolean;
20686
+ /** The index mode of this backing index of the data stream. */
20687
+ index_mode?: IndicesIndexMode;
20277
20688
  }
20278
20689
  export interface IndicesDataStreamLifecycle {
20279
20690
  /** If defined, every document added to this data stream will be stored at least for this time frame.
@@ -20308,6 +20719,13 @@ export interface IndicesDataStreamLifecycleWithRollover extends IndicesDataStrea
20308
20719
  * The contents of this field are subject to change. */
20309
20720
  rollover?: IndicesDataStreamLifecycleRolloverConditions;
20310
20721
  }
20722
+ export interface IndicesDataStreamOptions {
20723
+ /** If defined, it specifies configuration for the failure store of this data stream. */
20724
+ failure_store?: IndicesDataStreamFailureStore;
20725
+ }
20726
+ export interface IndicesDataStreamOptionsTemplate {
20727
+ failure_store?: IndicesDataStreamFailureStoreTemplate | null;
20728
+ }
20311
20729
  export interface IndicesDataStreamTimestampField {
20312
20730
  /** Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream. */
20313
20731
  name: Field;
@@ -20331,12 +20749,31 @@ export interface IndicesFailureStore {
20331
20749
  indices: IndicesDataStreamIndex[];
20332
20750
  rollover_on_write: boolean;
20333
20751
  }
20752
+ export interface IndicesFailureStoreLifecycle {
20753
+ /** If defined, every document added to this data stream will be stored at least for this time frame.
20754
+ * Any time after this duration the document could be deleted.
20755
+ * When empty, every document in this data stream will be stored indefinitely. */
20756
+ data_retention?: Duration;
20757
+ /** If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
20758
+ * that's disabled (enabled: `false`) will have no effect on the data stream. */
20759
+ enabled?: boolean;
20760
+ }
20761
+ export interface IndicesFailureStoreLifecycleTemplate {
20762
+ /** If defined, every document added to this data stream will be stored at least for this time frame.
20763
+ * Any time after this duration the document could be deleted.
20764
+ * When empty, every document in this data stream will be stored indefinitely. */
20765
+ data_retention?: Duration | null;
20766
+ /** If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
20767
+ * that's disabled (enabled: `false`) will have no effect on the data stream. */
20768
+ enabled?: boolean;
20769
+ }
20334
20770
  export interface IndicesFielddataFrequencyFilter {
20335
20771
  max: double;
20336
20772
  min: double;
20337
20773
  min_segment_size: integer;
20338
20774
  }
20339
20775
  export type IndicesIndexCheckOnStartup = boolean | 'true' | 'false' | 'checksum';
20776
+ export type IndicesIndexMode = 'standard' | 'time_series' | 'logsdb' | 'lookup';
20340
20777
  export interface IndicesIndexRouting {
20341
20778
  allocation?: IndicesIndexRoutingAllocation;
20342
20779
  rebalance?: IndicesIndexRoutingRebalance;
@@ -20404,7 +20841,8 @@ export interface IndicesIndexSettingsKeys {
20404
20841
  max_shingle_diff?: integer;
20405
20842
  blocks?: IndicesIndexSettingBlocks;
20406
20843
  max_refresh_listeners?: integer;
20407
- /** Settings to define analyzers, tokenizers, token filters and character filters. */
20844
+ /** Settings to define analyzers, tokenizers, token filters and character filters.
20845
+ * Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices. */
20408
20846
  analyze?: IndicesSettingsAnalyze;
20409
20847
  highlight?: IndicesSettingsHighlight;
20410
20848
  max_terms_count?: integer;
@@ -20543,6 +20981,7 @@ export interface IndicesIndexTemplateSummary {
20543
20981
  /** Configuration options for the index. */
20544
20982
  settings?: IndicesIndexSettings;
20545
20983
  lifecycle?: IndicesDataStreamLifecycleWithRollover;
20984
+ data_stream_options?: IndicesDataStreamOptionsTemplate | null;
20546
20985
  }
20547
20986
  export interface IndicesIndexVersioning {
20548
20987
  created?: VersionString;
@@ -20568,6 +21007,7 @@ export interface IndicesIndexingSlowlogTresholds {
20568
21007
  * Log and the thresholds are configured in the same way as the search slowlog. */
20569
21008
  index?: IndicesSlowlogTresholdLevels;
20570
21009
  }
21010
+ export type IndicesIndicesBlockOptions = 'metadata' | 'read' | 'read_only' | 'write';
20571
21011
  export type IndicesManagedBy = 'Index Lifecycle Management' | 'Data stream lifecycle' | 'Unmanaged';
20572
21012
  export interface IndicesMappingLimitSettings {
20573
21013
  coerce?: boolean;
@@ -20730,6 +21170,8 @@ export interface IndicesStorage {
20730
21170
  * setting is useful, for example, if you are in an environment where you can not control the ability to create a lot
20731
21171
  * of memory maps so you need disable the ability to use memory-mapping. */
20732
21172
  allow_mmap?: boolean;
21173
+ /** How often store statistics are refreshed */
21174
+ stats_refresh_interval?: Duration;
20733
21175
  }
20734
21176
  export type IndicesStorageType = 'fs' | 'niofs' | 'mmapfs' | 'hybridfs' | string;
20735
21177
  export interface IndicesTemplateMapping {
@@ -20769,8 +21211,7 @@ export interface IndicesTranslogRetention {
20769
21211
  * indices created in Elasticsearch versions 7.0.0 and later. */
20770
21212
  age?: Duration;
20771
21213
  }
20772
- export type IndicesAddBlockIndicesBlockOptions = 'metadata' | 'read' | 'read_only' | 'write';
20773
- export interface IndicesAddBlockIndicesBlockStatus {
21214
+ export interface IndicesAddBlockAddIndicesBlockStatus {
20774
21215
  name: IndexName;
20775
21216
  blocked: boolean;
20776
21217
  }
@@ -20781,7 +21222,7 @@ export interface IndicesAddBlockRequest extends RequestBase {
20781
21222
  * You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. */
20782
21223
  index: IndexName;
20783
21224
  /** The block type to add to the index. */
20784
- block: IndicesAddBlockIndicesBlockOptions;
21225
+ block: IndicesIndicesBlockOptions;
20785
21226
  /** If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
20786
21227
  * This behavior applies even if the request targets other open indices.
20787
21228
  * For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. */
@@ -20828,7 +21269,7 @@ export interface IndicesAddBlockRequest extends RequestBase {
20828
21269
  export interface IndicesAddBlockResponse {
20829
21270
  acknowledged: boolean;
20830
21271
  shards_acknowledged: boolean;
20831
- indices: IndicesAddBlockIndicesBlockStatus[];
21272
+ indices: IndicesAddBlockAddIndicesBlockStatus[];
20832
21273
  }
20833
21274
  export interface IndicesAnalyzeAnalyzeDetail {
20834
21275
  analyzer?: IndicesAnalyzeAnalyzerDetail;
@@ -20961,8 +21402,7 @@ export interface IndicesClearCacheRequest extends RequestBase {
20961
21402
  allow_no_indices?: boolean;
20962
21403
  /** Type of index that wildcard patterns can match.
20963
21404
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
20964
- * Supports comma-separated values, such as `open,hidden`.
20965
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
21405
+ * Supports comma-separated values, such as `open,hidden`. */
20966
21406
  expand_wildcards?: ExpandWildcards;
20967
21407
  /** If `true`, clears the fields cache.
20968
21408
  * Use the `fields` parameter to clear the cache of specific fields only. */
@@ -21066,8 +21506,7 @@ export interface IndicesCloseRequest extends RequestBase {
21066
21506
  allow_no_indices?: boolean;
21067
21507
  /** Type of index that wildcard patterns can match.
21068
21508
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
21069
- * Supports comma-separated values, such as `open,hidden`.
21070
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
21509
+ * Supports comma-separated values, such as `open,hidden`. */
21071
21510
  expand_wildcards?: ExpandWildcards;
21072
21511
  /** If `false`, the request returns an error if it targets a missing or closed index. */
21073
21512
  ignore_unavailable?: boolean;
@@ -21302,8 +21741,7 @@ export interface IndicesDeleteRequest extends RequestBase {
21302
21741
  allow_no_indices?: boolean;
21303
21742
  /** Type of index that wildcard patterns can match.
21304
21743
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
21305
- * Supports comma-separated values, such as `open,hidden`.
21306
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
21744
+ * Supports comma-separated values, such as `open,hidden`. */
21307
21745
  expand_wildcards?: ExpandWildcards;
21308
21746
  /** If `false`, the request returns an error if it targets a missing or closed index. */
21309
21747
  ignore_unavailable?: boolean;
@@ -21337,6 +21775,9 @@ export interface IndicesDeleteRequest extends RequestBase {
21337
21775
  };
21338
21776
  }
21339
21777
  export type IndicesDeleteResponse = IndicesResponseBase;
21778
+ export interface IndicesDeleteAliasIndicesAliasesResponseBody extends AcknowledgedResponseBase {
21779
+ errors?: boolean;
21780
+ }
21340
21781
  export interface IndicesDeleteAliasRequest extends RequestBase {
21341
21782
  /** Comma-separated list of data streams or indices used to limit the request.
21342
21783
  * Supports wildcards (`*`). */
@@ -21369,7 +21810,7 @@ export interface IndicesDeleteAliasRequest extends RequestBase {
21369
21810
  timeout?: never;
21370
21811
  };
21371
21812
  }
21372
- export type IndicesDeleteAliasResponse = AcknowledgedResponseBase;
21813
+ export type IndicesDeleteAliasResponse = IndicesDeleteAliasIndicesAliasesResponseBody;
21373
21814
  export interface IndicesDeleteDataLifecycleRequest extends RequestBase {
21374
21815
  /** A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams */
21375
21816
  name: DataStreamNames;
@@ -21424,6 +21865,35 @@ export interface IndicesDeleteDataStreamRequest extends RequestBase {
21424
21865
  };
21425
21866
  }
21426
21867
  export type IndicesDeleteDataStreamResponse = AcknowledgedResponseBase;
21868
+ export interface IndicesDeleteDataStreamOptionsRequest extends RequestBase {
21869
+ /** A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams */
21870
+ name: DataStreamNames;
21871
+ /** Whether wildcard expressions should get expanded to open or closed indices (default: open) */
21872
+ expand_wildcards?: ExpandWildcards;
21873
+ /** Specify timeout for connection to master */
21874
+ master_timeout?: Duration;
21875
+ /** Explicit timestamp for the document */
21876
+ timeout?: Duration;
21877
+ /** All values in `body` will be added to the request body. */
21878
+ body?: string | ({
21879
+ [key: string]: any;
21880
+ } & {
21881
+ name?: never;
21882
+ expand_wildcards?: never;
21883
+ master_timeout?: never;
21884
+ timeout?: never;
21885
+ });
21886
+ /** All values in `querystring` will be added to the request querystring. */
21887
+ querystring?: {
21888
+ [key: string]: any;
21889
+ } & {
21890
+ name?: never;
21891
+ expand_wildcards?: never;
21892
+ master_timeout?: never;
21893
+ timeout?: never;
21894
+ };
21895
+ }
21896
+ export type IndicesDeleteDataStreamOptionsResponse = AcknowledgedResponseBase;
21427
21897
  export interface IndicesDeleteIndexTemplateRequest extends RequestBase {
21428
21898
  /** Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. */
21429
21899
  name: Names;
@@ -21553,8 +22023,7 @@ export interface IndicesExistsRequest extends RequestBase {
21553
22023
  allow_no_indices?: boolean;
21554
22024
  /** Type of index that wildcard patterns can match.
21555
22025
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
21556
- * Supports comma-separated values, such as `open,hidden`.
21557
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
22026
+ * Supports comma-separated values, such as `open,hidden`. */
21558
22027
  expand_wildcards?: ExpandWildcards;
21559
22028
  /** If `true`, returns settings in flat format. */
21560
22029
  flat_settings?: boolean;
@@ -21601,8 +22070,7 @@ export interface IndicesExistsAliasRequest extends RequestBase {
21601
22070
  allow_no_indices?: boolean;
21602
22071
  /** Type of index that wildcard patterns can match.
21603
22072
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
21604
- * Supports comma-separated values, such as `open,hidden`.
21605
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
22073
+ * Supports comma-separated values, such as `open,hidden`. */
21606
22074
  expand_wildcards?: ExpandWildcards;
21607
22075
  /** If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. */
21608
22076
  ignore_unavailable?: boolean;
@@ -21817,8 +22285,7 @@ export interface IndicesFlushRequest extends RequestBase {
21817
22285
  allow_no_indices?: boolean;
21818
22286
  /** Type of index that wildcard patterns can match.
21819
22287
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
21820
- * Supports comma-separated values, such as `open,hidden`.
21821
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
22288
+ * Supports comma-separated values, such as `open,hidden`. */
21822
22289
  expand_wildcards?: ExpandWildcards;
21823
22290
  /** If `true`, the request forces a flush even if there are no changes to commit to the index. */
21824
22291
  force?: boolean;
@@ -21957,9 +22424,6 @@ export interface IndicesGetRequest extends RequestBase {
21957
22424
  };
21958
22425
  }
21959
22426
  export type IndicesGetResponse = Record<IndexName, IndicesIndexState>;
21960
- export interface IndicesGetAliasIndexAliases {
21961
- aliases: Record<string, IndicesAliasDefinition>;
21962
- }
21963
22427
  export interface IndicesGetAliasRequest extends RequestBase {
21964
22428
  /** Comma-separated list of aliases to retrieve.
21965
22429
  * Supports wildcards (`*`).
@@ -21974,8 +22438,7 @@ export interface IndicesGetAliasRequest extends RequestBase {
21974
22438
  allow_no_indices?: boolean;
21975
22439
  /** Type of index that wildcard patterns can match.
21976
22440
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
21977
- * Supports comma-separated values, such as `open,hidden`.
21978
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
22441
+ * Supports comma-separated values, such as `open,hidden`. */
21979
22442
  expand_wildcards?: ExpandWildcards;
21980
22443
  /** If `false`, the request returns an error if it targets a missing or closed index. */
21981
22444
  ignore_unavailable?: boolean;
@@ -22006,6 +22469,16 @@ export interface IndicesGetAliasRequest extends RequestBase {
22006
22469
  };
22007
22470
  }
22008
22471
  export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>;
22472
+ export interface IndicesGetAliasIndexAliases {
22473
+ aliases: Record<string, IndicesAliasDefinition>;
22474
+ }
22475
+ export interface IndicesGetAliasNotFoundAliasesKeys {
22476
+ error: string;
22477
+ status: number;
22478
+ }
22479
+ export type IndicesGetAliasNotFoundAliases = IndicesGetAliasNotFoundAliasesKeys & {
22480
+ [property: string]: IndicesGetAliasIndexAliases | string | number;
22481
+ };
22009
22482
  export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
22010
22483
  name: DataStreamName;
22011
22484
  lifecycle?: IndicesDataStreamLifecycleWithRollover;
@@ -22016,8 +22489,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase {
22016
22489
  * To target all data streams, omit this parameter or use `*` or `_all`. */
22017
22490
  name: DataStreamNames;
22018
22491
  /** Type of data stream that wildcard patterns can match.
22019
- * Supports comma-separated values, such as `open,hidden`.
22020
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
22492
+ * Supports comma-separated values, such as `open,hidden`. */
22021
22493
  expand_wildcards?: ExpandWildcards;
22022
22494
  /** If `true`, return all default settings in the response. */
22023
22495
  include_defaults?: boolean;
@@ -22111,6 +22583,74 @@ export interface IndicesGetDataStreamRequest extends RequestBase {
22111
22583
  export interface IndicesGetDataStreamResponse {
22112
22584
  data_streams: IndicesDataStream[];
22113
22585
  }
22586
+ export interface IndicesGetDataStreamOptionsDataStreamWithOptions {
22587
+ name: DataStreamName;
22588
+ options?: IndicesDataStreamOptions;
22589
+ }
22590
+ export interface IndicesGetDataStreamOptionsRequest extends RequestBase {
22591
+ /** Comma-separated list of data streams to limit the request.
22592
+ * Supports wildcards (`*`).
22593
+ * To target all data streams, omit this parameter or use `*` or `_all`. */
22594
+ name: DataStreamNames;
22595
+ /** Type of data stream that wildcard patterns can match.
22596
+ * Supports comma-separated values, such as `open,hidden`. */
22597
+ expand_wildcards?: ExpandWildcards;
22598
+ /** Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. */
22599
+ master_timeout?: Duration;
22600
+ /** All values in `body` will be added to the request body. */
22601
+ body?: string | ({
22602
+ [key: string]: any;
22603
+ } & {
22604
+ name?: never;
22605
+ expand_wildcards?: never;
22606
+ master_timeout?: never;
22607
+ });
22608
+ /** All values in `querystring` will be added to the request querystring. */
22609
+ querystring?: {
22610
+ [key: string]: any;
22611
+ } & {
22612
+ name?: never;
22613
+ expand_wildcards?: never;
22614
+ master_timeout?: never;
22615
+ };
22616
+ }
22617
+ export interface IndicesGetDataStreamOptionsResponse {
22618
+ data_streams: IndicesGetDataStreamOptionsDataStreamWithOptions[];
22619
+ }
22620
+ export interface IndicesGetDataStreamSettingsDataStreamSettings {
22621
+ /** The name of the data stream. */
22622
+ name: string;
22623
+ /** The settings specific to this data stream */
22624
+ settings: IndicesIndexSettings;
22625
+ /** The settings specific to this data stream merged with the settings from its template. These `effective_settings`
22626
+ * are the settings that will be used when a new index is created for this data stream. */
22627
+ effective_settings: IndicesIndexSettings;
22628
+ }
22629
+ export interface IndicesGetDataStreamSettingsRequest extends RequestBase {
22630
+ /** A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`). */
22631
+ name: Indices;
22632
+ /** The period to wait for a connection to the master node. If no response is
22633
+ * received before the timeout expires, the request fails and returns an
22634
+ * error. */
22635
+ master_timeout?: Duration;
22636
+ /** All values in `body` will be added to the request body. */
22637
+ body?: string | ({
22638
+ [key: string]: any;
22639
+ } & {
22640
+ name?: never;
22641
+ master_timeout?: never;
22642
+ });
22643
+ /** All values in `querystring` will be added to the request querystring. */
22644
+ querystring?: {
22645
+ [key: string]: any;
22646
+ } & {
22647
+ name?: never;
22648
+ master_timeout?: never;
22649
+ };
22650
+ }
22651
+ export interface IndicesGetDataStreamSettingsResponse {
22652
+ data_streams: IndicesGetDataStreamSettingsDataStreamSettings[];
22653
+ }
22114
22654
  export interface IndicesGetFieldMappingRequest extends RequestBase {
22115
22655
  /** Comma-separated list or wildcard expression of fields used to limit returned information.
22116
22656
  * Supports wildcards (`*`). */
@@ -22124,15 +22664,12 @@ export interface IndicesGetFieldMappingRequest extends RequestBase {
22124
22664
  allow_no_indices?: boolean;
22125
22665
  /** Type of index that wildcard patterns can match.
22126
22666
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
22127
- * Supports comma-separated values, such as `open,hidden`.
22128
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
22667
+ * Supports comma-separated values, such as `open,hidden`. */
22129
22668
  expand_wildcards?: ExpandWildcards;
22130
22669
  /** If `false`, the request returns an error if it targets a missing or closed index. */
22131
22670
  ignore_unavailable?: boolean;
22132
22671
  /** If `true`, return all default settings in the response. */
22133
22672
  include_defaults?: boolean;
22134
- /** If `true`, the request retrieves information from the local node only. */
22135
- local?: boolean;
22136
22673
  /** All values in `body` will be added to the request body. */
22137
22674
  body?: string | ({
22138
22675
  [key: string]: any;
@@ -22143,7 +22680,6 @@ export interface IndicesGetFieldMappingRequest extends RequestBase {
22143
22680
  expand_wildcards?: never;
22144
22681
  ignore_unavailable?: never;
22145
22682
  include_defaults?: never;
22146
- local?: never;
22147
22683
  });
22148
22684
  /** All values in `querystring` will be added to the request querystring. */
22149
22685
  querystring?: {
@@ -22155,7 +22691,6 @@ export interface IndicesGetFieldMappingRequest extends RequestBase {
22155
22691
  expand_wildcards?: never;
22156
22692
  ignore_unavailable?: never;
22157
22693
  include_defaults?: never;
22158
- local?: never;
22159
22694
  };
22160
22695
  }
22161
22696
  export type IndicesGetFieldMappingResponse = Record<IndexName, IndicesGetFieldMappingTypeFieldMappings>;
@@ -22215,8 +22750,7 @@ export interface IndicesGetMappingRequest extends RequestBase {
22215
22750
  allow_no_indices?: boolean;
22216
22751
  /** Type of index that wildcard patterns can match.
22217
22752
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
22218
- * Supports comma-separated values, such as `open,hidden`.
22219
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
22753
+ * Supports comma-separated values, such as `open,hidden`. */
22220
22754
  expand_wildcards?: ExpandWildcards;
22221
22755
  /** If `false`, the request returns an error if it targets a missing or closed index. */
22222
22756
  ignore_unavailable?: boolean;
@@ -22475,8 +23009,7 @@ export interface IndicesOpenRequest extends RequestBase {
22475
23009
  allow_no_indices?: boolean;
22476
23010
  /** Type of index that wildcard patterns can match.
22477
23011
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
22478
- * Supports comma-separated values, such as `open,hidden`.
22479
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
23012
+ * Supports comma-separated values, such as `open,hidden`. */
22480
23013
  expand_wildcards?: ExpandWildcards;
22481
23014
  /** If `false`, the request returns an error if it targets a missing or closed index. */
22482
23015
  ignore_unavailable?: boolean;
@@ -22608,8 +23141,7 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase {
22608
23141
  * To target all data streams use `*` or `_all`. */
22609
23142
  name: DataStreamNames;
22610
23143
  /** Type of data stream that wildcard patterns can match.
22611
- * Supports comma-separated values, such as `open,hidden`.
22612
- * Valid values are: `all`, `hidden`, `open`, `closed`, `none`. */
23144
+ * Supports comma-separated values, such as `open,hidden`. */
22613
23145
  expand_wildcards?: ExpandWildcards;
22614
23146
  /** Period to wait for a connection to the master node. If no response is
22615
23147
  * received before the timeout expires, the request fails and returns an
@@ -22653,6 +23185,114 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase {
22653
23185
  };
22654
23186
  }
22655
23187
  export type IndicesPutDataLifecycleResponse = AcknowledgedResponseBase;
23188
+ export interface IndicesPutDataStreamOptionsRequest extends RequestBase {
23189
+ /** Comma-separated list of data streams used to limit the request.
23190
+ * Supports wildcards (`*`).
23191
+ * To target all data streams use `*` or `_all`. */
23192
+ name: DataStreamNames;
23193
+ /** Type of data stream that wildcard patterns can match.
23194
+ * Supports comma-separated values, such as `open,hidden`. */
23195
+ expand_wildcards?: ExpandWildcards;
23196
+ /** Period to wait for a connection to the master node. If no response is
23197
+ * received before the timeout expires, the request fails and returns an
23198
+ * error. */
23199
+ master_timeout?: Duration;
23200
+ /** Period to wait for a response.
23201
+ * If no response is received before the timeout expires, the request fails and returns an error. */
23202
+ timeout?: Duration;
23203
+ /** If defined, it will update the failure store configuration of every data stream resolved by the name expression. */
23204
+ failure_store?: IndicesDataStreamFailureStore;
23205
+ /** All values in `body` will be added to the request body. */
23206
+ body?: string | ({
23207
+ [key: string]: any;
23208
+ } & {
23209
+ name?: never;
23210
+ expand_wildcards?: never;
23211
+ master_timeout?: never;
23212
+ timeout?: never;
23213
+ failure_store?: never;
23214
+ });
23215
+ /** All values in `querystring` will be added to the request querystring. */
23216
+ querystring?: {
23217
+ [key: string]: any;
23218
+ } & {
23219
+ name?: never;
23220
+ expand_wildcards?: never;
23221
+ master_timeout?: never;
23222
+ timeout?: never;
23223
+ failure_store?: never;
23224
+ };
23225
+ }
23226
+ export type IndicesPutDataStreamOptionsResponse = AcknowledgedResponseBase;
23227
+ export interface IndicesPutDataStreamSettingsDataStreamSettingsError {
23228
+ index: IndexName;
23229
+ /** A message explaining why the settings could not be applied to specific indices. */
23230
+ error: string;
23231
+ }
23232
+ export interface IndicesPutDataStreamSettingsIndexSettingResults {
23233
+ /** The list of settings that were applied to the data stream but not to backing indices. These will be applied to
23234
+ * the write index the next time the data stream is rolled over. */
23235
+ applied_to_data_stream_only: string[];
23236
+ /** The list of settings that were applied to the data stream and to all of its backing indices. These settings will
23237
+ * also be applied to the write index the next time the data stream is rolled over. */
23238
+ applied_to_data_stream_and_backing_indices: string[];
23239
+ errors?: IndicesPutDataStreamSettingsDataStreamSettingsError[];
23240
+ }
23241
+ export interface IndicesPutDataStreamSettingsRequest extends RequestBase {
23242
+ /** A comma-separated list of data streams or data stream patterns. */
23243
+ name: Indices;
23244
+ /** If `true`, the request does not actually change the settings on any data streams or indices. Instead, it
23245
+ * simulates changing the settings and reports back to the user what would have happened had these settings
23246
+ * actually been applied. */
23247
+ dry_run?: boolean;
23248
+ /** The period to wait for a connection to the master node. If no response is
23249
+ * received before the timeout expires, the request fails and returns an
23250
+ * error. */
23251
+ master_timeout?: Duration;
23252
+ /** The period to wait for a response. If no response is received before the
23253
+ * timeout expires, the request fails and returns an error. */
23254
+ timeout?: Duration;
23255
+ settings?: IndicesIndexSettings;
23256
+ /** All values in `body` will be added to the request body. */
23257
+ body?: string | ({
23258
+ [key: string]: any;
23259
+ } & {
23260
+ name?: never;
23261
+ dry_run?: never;
23262
+ master_timeout?: never;
23263
+ timeout?: never;
23264
+ settings?: never;
23265
+ });
23266
+ /** All values in `querystring` will be added to the request querystring. */
23267
+ querystring?: {
23268
+ [key: string]: any;
23269
+ } & {
23270
+ name?: never;
23271
+ dry_run?: never;
23272
+ master_timeout?: never;
23273
+ timeout?: never;
23274
+ settings?: never;
23275
+ };
23276
+ }
23277
+ export interface IndicesPutDataStreamSettingsResponse {
23278
+ data_streams: IndicesPutDataStreamSettingsUpdatedDataStreamSettings[];
23279
+ }
23280
+ export interface IndicesPutDataStreamSettingsUpdatedDataStreamSettings {
23281
+ /** The data stream name. */
23282
+ name: IndexName;
23283
+ /** If the settings were successfully applied to the data stream (or would have been, if running in `dry_run`
23284
+ * mode), it is `true`. If an error occurred, it is `false`. */
23285
+ applied_to_data_stream: boolean;
23286
+ /** A message explaining why the settings could not be applied to the data stream. */
23287
+ error?: string;
23288
+ /** The settings that are specfic to this data stream that will override any settings from the matching index template. */
23289
+ settings: IndicesIndexSettings;
23290
+ /** The settings that are effective on this data stream, taking into account the settings from the matching index
23291
+ * template and the settings specific to this data stream. */
23292
+ effective_settings: IndicesIndexSettings;
23293
+ /** Information about whether and where each setting was applied. */
23294
+ index_settings_results: IndicesPutDataStreamSettingsIndexSettingResults;
23295
+ }
22656
23296
  export interface IndicesPutIndexTemplateIndexTemplateMapping {
22657
23297
  /** Aliases to add.
22658
23298
  * If the index template includes a `data_stream` object, these are data stream aliases.
@@ -22762,8 +23402,7 @@ export interface IndicesPutMappingRequest extends RequestBase {
22762
23402
  allow_no_indices?: boolean;
22763
23403
  /** Type of index that wildcard patterns can match.
22764
23404
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
22765
- * Supports comma-separated values, such as `open,hidden`.
22766
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
23405
+ * Supports comma-separated values, such as `open,hidden`. */
22767
23406
  expand_wildcards?: ExpandWildcards;
22768
23407
  /** If `false`, the request returns an error if it targets a missing or closed index. */
22769
23408
  ignore_unavailable?: boolean;
@@ -23046,6 +23685,15 @@ export interface IndicesRecoveryRequest extends RequestBase {
23046
23685
  active_only?: boolean;
23047
23686
  /** If `true`, the response includes detailed information about shard recoveries. */
23048
23687
  detailed?: boolean;
23688
+ /** If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
23689
+ * This behavior applies even if the request targets other open indices. */
23690
+ allow_no_indices?: boolean;
23691
+ /** Type of index that wildcard patterns can match.
23692
+ * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
23693
+ * Supports comma-separated values, such as `open,hidden`. */
23694
+ expand_wildcards?: ExpandWildcards;
23695
+ /** If `false`, the request returns an error if it targets a missing or closed index. */
23696
+ ignore_unavailable?: boolean;
23049
23697
  /** All values in `body` will be added to the request body. */
23050
23698
  body?: string | ({
23051
23699
  [key: string]: any;
@@ -23053,6 +23701,9 @@ export interface IndicesRecoveryRequest extends RequestBase {
23053
23701
  index?: never;
23054
23702
  active_only?: never;
23055
23703
  detailed?: never;
23704
+ allow_no_indices?: never;
23705
+ expand_wildcards?: never;
23706
+ ignore_unavailable?: never;
23056
23707
  });
23057
23708
  /** All values in `querystring` will be added to the request querystring. */
23058
23709
  querystring?: {
@@ -23061,6 +23712,9 @@ export interface IndicesRecoveryRequest extends RequestBase {
23061
23712
  index?: never;
23062
23713
  active_only?: never;
23063
23714
  detailed?: never;
23715
+ allow_no_indices?: never;
23716
+ expand_wildcards?: never;
23717
+ ignore_unavailable?: never;
23064
23718
  };
23065
23719
  }
23066
23720
  export type IndicesRecoveryResponse = Record<IndexName, IndicesRecoveryRecoveryStatus>;
@@ -23106,8 +23760,7 @@ export interface IndicesRefreshRequest extends RequestBase {
23106
23760
  allow_no_indices?: boolean;
23107
23761
  /** Type of index that wildcard patterns can match.
23108
23762
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
23109
- * Supports comma-separated values, such as `open,hidden`.
23110
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
23763
+ * Supports comma-separated values, such as `open,hidden`. */
23111
23764
  expand_wildcards?: ExpandWildcards;
23112
23765
  /** If `false`, the request returns an error if it targets a missing or closed index. */
23113
23766
  ignore_unavailable?: boolean;
@@ -23173,6 +23826,66 @@ export interface IndicesReloadSearchAnalyzersRequest extends RequestBase {
23173
23826
  };
23174
23827
  }
23175
23828
  export type IndicesReloadSearchAnalyzersResponse = IndicesReloadSearchAnalyzersReloadResult;
23829
+ export interface IndicesRemoveBlockRemoveIndicesBlockStatus {
23830
+ name: IndexName;
23831
+ unblocked?: boolean;
23832
+ exception?: ErrorCause;
23833
+ }
23834
+ export interface IndicesRemoveBlockRequest extends RequestBase {
23835
+ /** A comma-separated list or wildcard expression of index names used to limit the request.
23836
+ * By default, you must explicitly name the indices you are removing blocks from.
23837
+ * To allow the removal of blocks from indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.
23838
+ * You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. */
23839
+ index: IndexName;
23840
+ /** The block type to remove from the index. */
23841
+ block: IndicesIndicesBlockOptions;
23842
+ /** If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
23843
+ * This behavior applies even if the request targets other open indices.
23844
+ * For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. */
23845
+ allow_no_indices?: boolean;
23846
+ /** The type of index that wildcard patterns can match.
23847
+ * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
23848
+ * It supports comma-separated values, such as `open,hidden`. */
23849
+ expand_wildcards?: ExpandWildcards;
23850
+ /** If `false`, the request returns an error if it targets a missing or closed index. */
23851
+ ignore_unavailable?: boolean;
23852
+ /** The period to wait for the master node.
23853
+ * If the master node is not available before the timeout expires, the request fails and returns an error.
23854
+ * It can also be set to `-1` to indicate that the request should never timeout. */
23855
+ master_timeout?: Duration;
23856
+ /** The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
23857
+ * If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
23858
+ * It can also be set to `-1` to indicate that the request should never timeout. */
23859
+ timeout?: Duration;
23860
+ /** All values in `body` will be added to the request body. */
23861
+ body?: string | ({
23862
+ [key: string]: any;
23863
+ } & {
23864
+ index?: never;
23865
+ block?: never;
23866
+ allow_no_indices?: never;
23867
+ expand_wildcards?: never;
23868
+ ignore_unavailable?: never;
23869
+ master_timeout?: never;
23870
+ timeout?: never;
23871
+ });
23872
+ /** All values in `querystring` will be added to the request querystring. */
23873
+ querystring?: {
23874
+ [key: string]: any;
23875
+ } & {
23876
+ index?: never;
23877
+ block?: never;
23878
+ allow_no_indices?: never;
23879
+ expand_wildcards?: never;
23880
+ ignore_unavailable?: never;
23881
+ master_timeout?: never;
23882
+ timeout?: never;
23883
+ };
23884
+ }
23885
+ export interface IndicesRemoveBlockResponse {
23886
+ acknowledged: boolean;
23887
+ indices: IndicesRemoveBlockRemoveIndicesBlockStatus[];
23888
+ }
23176
23889
  export interface IndicesResolveClusterRequest extends RequestBase {
23177
23890
  /** A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve.
23178
23891
  * Resources on remote clusters can be specified using the `<cluster>`:`<name>` syntax.
@@ -23189,7 +23902,6 @@ export interface IndicesResolveClusterRequest extends RequestBase {
23189
23902
  /** Type of index that wildcard patterns can match.
23190
23903
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
23191
23904
  * Supports comma-separated values, such as `open,hidden`.
23192
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
23193
23905
  * NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
23194
23906
  * options to the `_resolve/cluster` API endpoint that takes no index expression. */
23195
23907
  expand_wildcards?: ExpandWildcards;
@@ -23254,8 +23966,7 @@ export interface IndicesResolveIndexRequest extends RequestBase {
23254
23966
  name: Names;
23255
23967
  /** Type of index that wildcard patterns can match.
23256
23968
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
23257
- * Supports comma-separated values, such as `open,hidden`.
23258
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
23969
+ * Supports comma-separated values, such as `open,hidden`. */
23259
23970
  expand_wildcards?: ExpandWildcards;
23260
23971
  /** If `false`, the request returns an error if it targets a missing or closed index. */
23261
23972
  ignore_unavailable?: boolean;
@@ -23410,8 +24121,7 @@ export interface IndicesSegmentsRequest extends RequestBase {
23410
24121
  allow_no_indices?: boolean;
23411
24122
  /** Type of index that wildcard patterns can match.
23412
24123
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
23413
- * Supports comma-separated values, such as `open,hidden`.
23414
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
24124
+ * Supports comma-separated values, such as `open,hidden`. */
23415
24125
  expand_wildcards?: ExpandWildcards;
23416
24126
  /** If `false`, the request returns an error if it targets a missing or closed index. */
23417
24127
  ignore_unavailable?: boolean;
@@ -24080,8 +24790,7 @@ export interface IndicesValidateQueryRequest extends RequestBase {
24080
24790
  df?: string;
24081
24791
  /** Type of index that wildcard patterns can match.
24082
24792
  * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
24083
- * Supports comma-separated values, such as `open,hidden`.
24084
- * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
24793
+ * Supports comma-separated values, such as `open,hidden`. */
24085
24794
  expand_wildcards?: ExpandWildcards;
24086
24795
  /** If `true`, the response returns detailed information if an error has occurred. */
24087
24796
  explain?: boolean;
@@ -24245,6 +24954,51 @@ export interface InferenceAmazonBedrockTaskSettings {
24245
24954
  top_p?: float;
24246
24955
  }
24247
24956
  export type InferenceAmazonBedrockTaskType = 'completion' | 'text_embedding';
24957
+ export type InferenceAmazonSageMakerApi = 'openai' | 'elastic';
24958
+ export interface InferenceAmazonSageMakerServiceSettings {
24959
+ /** A valid AWS access key that has permissions to use Amazon SageMaker and access to models for invoking requests. */
24960
+ access_key: string;
24961
+ /** The name of the SageMaker endpoint. */
24962
+ endpoint_name: string;
24963
+ /** The API format to use when calling SageMaker.
24964
+ * Elasticsearch will convert the POST _inference request to this data format when invoking the SageMaker endpoint. */
24965
+ api: InferenceAmazonSageMakerApi;
24966
+ /** The region that your endpoint or Amazon Resource Name (ARN) is deployed in.
24967
+ * The list of available regions per model can be found in the Amazon SageMaker documentation. */
24968
+ region: string;
24969
+ /** A valid AWS secret key that is paired with the `access_key`.
24970
+ * For information about creating and managing access and secret keys, refer to the AWS documentation. */
24971
+ secret_key: string;
24972
+ /** The model ID when calling a multi-model endpoint. */
24973
+ target_model?: string;
24974
+ /** The container to directly invoke when calling a multi-container endpoint. */
24975
+ target_container_hostname?: string;
24976
+ /** The inference component to directly invoke when calling a multi-component endpoint. */
24977
+ inference_component_name?: string;
24978
+ /** The maximum number of inputs in each batch. This value is used by inference ingestion pipelines
24979
+ * when processing semantic values. It correlates to the number of times the SageMaker endpoint is
24980
+ * invoked (one per batch of input). */
24981
+ batch_size?: integer;
24982
+ /** The number of dimensions returned by the text embedding models. If this value is not provided, then
24983
+ * it is guessed by making invoking the endpoint for the `text_embedding` task. */
24984
+ dimensions?: integer;
24985
+ }
24986
+ export type InferenceAmazonSageMakerServiceType = 'amazon_sagemaker';
24987
+ export interface InferenceAmazonSageMakerTaskSettings {
24988
+ /** The AWS custom attributes passed verbatim through to the model running in the SageMaker Endpoint.
24989
+ * Values will be returned in the `X-elastic-sagemaker-custom-attributes` header. */
24990
+ custom_attributes?: string;
24991
+ /** The optional JMESPath expression used to override the EnableExplanations provided during endpoint creation. */
24992
+ enable_explanations?: string;
24993
+ /** The capture data ID when enabled in the endpoint. */
24994
+ inference_id?: string;
24995
+ /** The stateful session identifier for a new or existing session.
24996
+ * New sessions will be returned in the `X-elastic-sagemaker-new-session-id` header.
24997
+ * Closed sessions will be returned in the `X-elastic-sagemaker-closed-session-id` header. */
24998
+ session_id?: string;
24999
+ /** Specifies the variant when running with multi-variant Endpoints. */
25000
+ target_variant?: string;
25001
+ }
24248
25002
  export interface InferenceAnthropicServiceSettings {
24249
25003
  /** A valid API key for the Anthropic API. */
24250
25004
  api_key: string;
@@ -24361,7 +25115,7 @@ export interface InferenceAzureOpenAITaskSettings {
24361
25115
  user?: string;
24362
25116
  }
24363
25117
  export type InferenceAzureOpenAITaskType = 'completion' | 'text_embedding';
24364
- export type InferenceCohereEmbeddingType = 'byte' | 'float' | 'int8';
25118
+ export type InferenceCohereEmbeddingType = 'binary' | 'bit' | 'byte' | 'float' | 'int8';
24365
25119
  export type InferenceCohereInputType = 'classification' | 'clustering' | 'ingest' | 'search';
24366
25120
  export interface InferenceCohereServiceSettings {
24367
25121
  /** A valid API key for your Cohere account.
@@ -24373,6 +25127,8 @@ export interface InferenceCohereServiceSettings {
24373
25127
  * If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. */
24374
25128
  api_key: string;
24375
25129
  /** For a `text_embedding` task, the types of embeddings you want to get back.
25130
+ * Use `binary` for binary embeddings, which are encoded as bytes with signed int8 precision.
25131
+ * Use `bit` for binary embeddings, which are encoded as bytes with signed int8 precision (this is a synonym of `binary`).
24376
25132
  * Use `byte` for signed int8 embeddings (this is a synonym of `int8`).
24377
25133
  * Use `float` for the default float embeddings.
24378
25134
  * Use `int8` for signed int8 embeddings. */
@@ -24462,6 +25218,240 @@ export interface InferenceContentObject {
24462
25218
  /** The type of content. */
24463
25219
  type: string;
24464
25220
  }
25221
+ export interface InferenceCustomRequestParams {
25222
+ /** The body structure of the request. It requires passing in the string-escaped result of the JSON format HTTP request body.
25223
+ * For example:
25224
+ * ```
25225
+ * "request": "{\"input\":${input}}"
25226
+ * ```
25227
+ * > info
25228
+ * > The content string needs to be a single line except when using the Kibana console. */
25229
+ content: string;
25230
+ }
25231
+ export interface InferenceCustomResponseParams {
25232
+ /** Specifies the JSON parser that is used to parse the response from the custom service.
25233
+ * Different task types require different json_parser parameters.
25234
+ * For example:
25235
+ * ```
25236
+ * # text_embedding
25237
+ * # For a response like this:
25238
+ *
25239
+ * {
25240
+ * "object": "list",
25241
+ * "data": [
25242
+ * {
25243
+ * "object": "embedding",
25244
+ * "index": 0,
25245
+ * "embedding": [
25246
+ * 0.014539449,
25247
+ * -0.015288644
25248
+ * ]
25249
+ * }
25250
+ * ],
25251
+ * "model": "text-embedding-ada-002-v2",
25252
+ * "usage": {
25253
+ * "prompt_tokens": 8,
25254
+ * "total_tokens": 8
25255
+ * }
25256
+ * }
25257
+ *
25258
+ * # the json_parser definition should look like this:
25259
+ *
25260
+ * "response":{
25261
+ * "json_parser":{
25262
+ * "text_embeddings":"$.data[*].embedding[*]"
25263
+ * }
25264
+ * }
25265
+ *
25266
+ * # sparse_embedding
25267
+ * # For a response like this:
25268
+ *
25269
+ * {
25270
+ * "request_id": "75C50B5B-E79E-4930-****-F48DBB392231",
25271
+ * "latency": 22,
25272
+ * "usage": {
25273
+ * "token_count": 11
25274
+ * },
25275
+ * "result": {
25276
+ * "sparse_embeddings": [
25277
+ * {
25278
+ * "index": 0,
25279
+ * "embedding": [
25280
+ * {
25281
+ * "token_id": 6,
25282
+ * "weight": 0.101
25283
+ * },
25284
+ * {
25285
+ * "token_id": 163040,
25286
+ * "weight": 0.28417
25287
+ * }
25288
+ * ]
25289
+ * }
25290
+ * ]
25291
+ * }
25292
+ * }
25293
+ *
25294
+ * # the json_parser definition should look like this:
25295
+ *
25296
+ * "response":{
25297
+ * "json_parser":{
25298
+ * "token_path":"$.result.sparse_embeddings[*].embedding[*].token_id",
25299
+ * "weight_path":"$.result.sparse_embeddings[*].embedding[*].weight"
25300
+ * }
25301
+ * }
25302
+ *
25303
+ * # rerank
25304
+ * # For a response like this:
25305
+ *
25306
+ * {
25307
+ * "results": [
25308
+ * {
25309
+ * "index": 3,
25310
+ * "relevance_score": 0.999071,
25311
+ * "document": "abc"
25312
+ * },
25313
+ * {
25314
+ * "index": 4,
25315
+ * "relevance_score": 0.7867867,
25316
+ * "document": "123"
25317
+ * },
25318
+ * {
25319
+ * "index": 0,
25320
+ * "relevance_score": 0.32713068,
25321
+ * "document": "super"
25322
+ * }
25323
+ * ],
25324
+ * }
25325
+ *
25326
+ * # the json_parser definition should look like this:
25327
+ *
25328
+ * "response":{
25329
+ * "json_parser":{
25330
+ * "reranked_index":"$.result.scores[*].index", // optional
25331
+ * "relevance_score":"$.result.scores[*].score",
25332
+ * "document_text":"xxx" // optional
25333
+ * }
25334
+ * }
25335
+ *
25336
+ * # completion
25337
+ * # For a response like this:
25338
+ *
25339
+ * {
25340
+ * "id": "chatcmpl-B9MBs8CjcvOU2jLn4n570S5qMJKcT",
25341
+ * "object": "chat.completion",
25342
+ * "created": 1741569952,
25343
+ * "model": "gpt-4.1-2025-04-14",
25344
+ * "choices": [
25345
+ * {
25346
+ * "index": 0,
25347
+ * "message": {
25348
+ * "role": "assistant",
25349
+ * "content": "Hello! How can I assist you today?",
25350
+ * "refusal": null,
25351
+ * "annotations": []
25352
+ * },
25353
+ * "logprobs": null,
25354
+ * "finish_reason": "stop"
25355
+ * }
25356
+ * ]
25357
+ * }
25358
+ *
25359
+ * # the json_parser definition should look like this:
25360
+ *
25361
+ * "response":{
25362
+ * "json_parser":{
25363
+ * "completion_result":"$.choices[*].message.content"
25364
+ * }
25365
+ * } */
25366
+ json_parser: any;
25367
+ }
25368
+ export interface InferenceCustomServiceSettings {
25369
+ /** Specifies the HTTPS header parameters – such as `Authentication` or `Contet-Type` – that are required to access the custom service.
25370
+ * For example:
25371
+ * ```
25372
+ * "headers":{
25373
+ * "Authorization": "Bearer ${api_key}",
25374
+ * "Content-Type": "application/json;charset=utf-8"
25375
+ * }
25376
+ * ``` */
25377
+ headers?: any;
25378
+ /** Specifies the input type translation values that are used to replace the `${input_type}` template in the request body.
25379
+ * For example:
25380
+ * ```
25381
+ * "input_type": {
25382
+ * "translation": {
25383
+ * "ingest": "do_ingest",
25384
+ * "search": "do_search"
25385
+ * },
25386
+ * "default": "a_default"
25387
+ * },
25388
+ * ```
25389
+ * If the subsequent inference requests come from a search context, the `search` key will be used and the template will be replaced with `do_search`.
25390
+ * If it comes from the ingest context `do_ingest` is used. If it's a different context that is not specified, the default value will be used. If no default is specified an empty string is used.
25391
+ * `translation` can be:
25392
+ * * `classification`
25393
+ * * `clustering`
25394
+ * * `ingest`
25395
+ * * `search` */
25396
+ input_type?: any;
25397
+ /** Specifies the query parameters as a list of tuples. The arrays inside the `query_parameters` must have two items, a key and a value.
25398
+ * For example:
25399
+ * ```
25400
+ * "query_parameters":[
25401
+ * ["param_key", "some_value"],
25402
+ * ["param_key", "another_value"],
25403
+ * ["other_key", "other_value"]
25404
+ * ]
25405
+ * ```
25406
+ * If the base url is `https://www.elastic.co` it results in: `https://www.elastic.co?param_key=some_value&param_key=another_value&other_key=other_value`. */
25407
+ query_parameters?: any;
25408
+ /** The request configuration object. */
25409
+ request: InferenceCustomRequestParams;
25410
+ /** The response configuration object. */
25411
+ response: InferenceCustomResponseParams;
25412
+ /** Specifies secret parameters, like `api_key` or `api_token`, that are required to access the custom service.
25413
+ * For example:
25414
+ * ```
25415
+ * "secret_parameters":{
25416
+ * "api_key":"<api_key>"
25417
+ * }
25418
+ * ``` */
25419
+ secret_parameters: any;
25420
+ /** The URL endpoint to use for the requests. */
25421
+ url?: string;
25422
+ }
25423
+ export type InferenceCustomServiceType = 'custom';
25424
+ export interface InferenceCustomTaskSettings {
25425
+ /** Specifies parameters that are required to run the custom service. The parameters depend on the model your custom service uses.
25426
+ * For example:
25427
+ * ```
25428
+ * "task_settings":{
25429
+ * "parameters":{
25430
+ * "input_type":"query",
25431
+ * "return_token":true
25432
+ * }
25433
+ * }
25434
+ * ``` */
25435
+ parameters?: any;
25436
+ }
25437
+ export type InferenceCustomTaskType = 'text_embedding' | 'sparse_embedding' | 'rerank' | 'completion';
25438
+ export interface InferenceDeepSeekServiceSettings {
25439
+ /** A valid API key for your DeepSeek account.
25440
+ * You can find or create your DeepSeek API keys on the DeepSeek API key page.
25441
+ *
25442
+ * IMPORTANT: You need to provide the API key only once, during the inference model creation.
25443
+ * The get inference endpoint API does not retrieve your API key.
25444
+ * After creating the inference model, you cannot change the associated API key.
25445
+ * If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. */
25446
+ api_key: string;
25447
+ /** For a `completion` or `chat_completion` task, the name of the model to use for the inference task.
25448
+ *
25449
+ * For the available `completion` and `chat_completion` models, refer to the [DeepSeek Models & Pricing docs](https://api-docs.deepseek.com/quick_start/pricing). */
25450
+ model_id: string;
25451
+ /** The URL endpoint to use for the requests. Defaults to `https://api.deepseek.com/chat/completions`. */
25452
+ url?: string;
25453
+ }
25454
+ export type InferenceDeepSeekServiceType = 'deepseek';
24465
25455
  export interface InferenceDeleteInferenceEndpointResult extends AcknowledgedResponseBase {
24466
25456
  pipelines: string[];
24467
25457
  }
@@ -24554,7 +25544,7 @@ export interface InferenceGoogleVertexAITaskSettings {
24554
25544
  /** For a `rerank` task, the number of the top N documents that should be returned. */
24555
25545
  top_n?: integer;
24556
25546
  }
24557
- export type InferenceGoogleVertexAITaskType = 'rerank' | 'text_embedding';
25547
+ export type InferenceGoogleVertexAITaskType = 'rerank' | 'text_embedding' | 'completion' | 'chat_completion';
24558
25548
  export interface InferenceHuggingFaceServiceSettings {
24559
25549
  /** A valid access token for your HuggingFace account.
24560
25550
  * You can create or find your access tokens on the HuggingFace settings page.
@@ -24565,13 +25555,28 @@ export interface InferenceHuggingFaceServiceSettings {
24565
25555
  * If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. */
24566
25556
  api_key: string;
24567
25557
  /** This setting helps to minimize the number of rate limit errors returned from Hugging Face.
24568
- * By default, the `hugging_face` service sets the number of requests allowed per minute to 3000. */
25558
+ * By default, the `hugging_face` service sets the number of requests allowed per minute to 3000 for all supported tasks.
25559
+ * Hugging Face does not publish a universal rate limit — actual limits may vary.
25560
+ * It is recommended to adjust this value based on the capacity and limits of your specific deployment environment. */
24569
25561
  rate_limit?: InferenceRateLimitSetting;
24570
- /** The URL endpoint to use for the requests. */
25562
+ /** The URL endpoint to use for the requests.
25563
+ * For `completion` and `chat_completion` tasks, the deployed model must be compatible with the Hugging Face Chat Completion interface (see the linked external documentation for details). The endpoint URL for the request must include `/v1/chat/completions`.
25564
+ * If the model supports the OpenAI Chat Completion schema, a toggle should appear in the interface. Enabling this toggle doesn't change any model behavior, it reveals the full endpoint URL needed (which should include `/v1/chat/completions`) when configuring the inference endpoint in Elasticsearch. If the model doesn't support this schema, the toggle may not be shown. */
24571
25565
  url: string;
25566
+ /** The name of the HuggingFace model to use for the inference task.
25567
+ * For `completion` and `chat_completion` tasks, this field is optional but may be required for certain models — particularly when using serverless inference endpoints.
25568
+ * For the `text_embedding` task, this field should not be included. Otherwise, the request will fail. */
25569
+ model_id?: string;
24572
25570
  }
24573
25571
  export type InferenceHuggingFaceServiceType = 'hugging_face';
24574
- export type InferenceHuggingFaceTaskType = 'text_embedding';
25572
+ export interface InferenceHuggingFaceTaskSettings {
25573
+ /** For a `rerank` task, return doc text within the results. */
25574
+ return_documents?: boolean;
25575
+ /** For a `rerank` task, the number of most relevant documents to return.
25576
+ * It defaults to the number of the documents. */
25577
+ top_n?: integer;
25578
+ }
25579
+ export type InferenceHuggingFaceTaskType = 'chat_completion' | 'completion' | 'rerank' | 'text_embedding';
24575
25580
  export interface InferenceInferenceChunkingSettings {
24576
25581
  /** The maximum size of a chunk in words.
24577
25582
  * This value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). */
@@ -24603,6 +25608,120 @@ export interface InferenceInferenceEndpointInfo extends InferenceInferenceEndpoi
24603
25608
  /** The task type */
24604
25609
  task_type: InferenceTaskType;
24605
25610
  }
25611
+ export interface InferenceInferenceEndpointInfoAlibabaCloudAI extends InferenceInferenceEndpoint {
25612
+ /** The inference Id */
25613
+ inference_id: string;
25614
+ /** The task type */
25615
+ task_type: InferenceTaskTypeAlibabaCloudAI;
25616
+ }
25617
+ export interface InferenceInferenceEndpointInfoAmazonBedrock extends InferenceInferenceEndpoint {
25618
+ /** The inference Id */
25619
+ inference_id: string;
25620
+ /** The task type */
25621
+ task_type: InferenceTaskTypeAmazonBedrock;
25622
+ }
25623
+ export interface InferenceInferenceEndpointInfoAmazonSageMaker extends InferenceInferenceEndpoint {
25624
+ /** The inference Id */
25625
+ inference_id: string;
25626
+ /** The task type */
25627
+ task_type: InferenceTaskTypeAmazonSageMaker;
25628
+ }
25629
+ export interface InferenceInferenceEndpointInfoAnthropic extends InferenceInferenceEndpoint {
25630
+ /** The inference Id */
25631
+ inference_id: string;
25632
+ /** The task type */
25633
+ task_type: InferenceTaskTypeAnthropic;
25634
+ }
25635
+ export interface InferenceInferenceEndpointInfoAzureAIStudio extends InferenceInferenceEndpoint {
25636
+ /** The inference Id */
25637
+ inference_id: string;
25638
+ /** The task type */
25639
+ task_type: InferenceTaskTypeAzureAIStudio;
25640
+ }
25641
+ export interface InferenceInferenceEndpointInfoAzureOpenAI extends InferenceInferenceEndpoint {
25642
+ /** The inference Id */
25643
+ inference_id: string;
25644
+ /** The task type */
25645
+ task_type: InferenceTaskTypeAzureOpenAI;
25646
+ }
25647
+ export interface InferenceInferenceEndpointInfoCohere extends InferenceInferenceEndpoint {
25648
+ /** The inference Id */
25649
+ inference_id: string;
25650
+ /** The task type */
25651
+ task_type: InferenceTaskTypeCohere;
25652
+ }
25653
+ export interface InferenceInferenceEndpointInfoCustom extends InferenceInferenceEndpoint {
25654
+ /** The inference Id */
25655
+ inference_id: string;
25656
+ /** The task type */
25657
+ task_type: InferenceTaskTypeCustom;
25658
+ }
25659
+ export interface InferenceInferenceEndpointInfoDeepSeek extends InferenceInferenceEndpoint {
25660
+ /** The inference Id */
25661
+ inference_id: string;
25662
+ /** The task type */
25663
+ task_type: InferenceTaskTypeDeepSeek;
25664
+ }
25665
+ export interface InferenceInferenceEndpointInfoELSER extends InferenceInferenceEndpoint {
25666
+ /** The inference Id */
25667
+ inference_id: string;
25668
+ /** The task type */
25669
+ task_type: InferenceTaskTypeELSER;
25670
+ }
25671
+ export interface InferenceInferenceEndpointInfoElasticsearch extends InferenceInferenceEndpoint {
25672
+ /** The inference Id */
25673
+ inference_id: string;
25674
+ /** The task type */
25675
+ task_type: InferenceTaskTypeElasticsearch;
25676
+ }
25677
+ export interface InferenceInferenceEndpointInfoGoogleAIStudio extends InferenceInferenceEndpoint {
25678
+ /** The inference Id */
25679
+ inference_id: string;
25680
+ /** The task type */
25681
+ task_type: InferenceTaskTypeGoogleAIStudio;
25682
+ }
25683
+ export interface InferenceInferenceEndpointInfoGoogleVertexAI extends InferenceInferenceEndpoint {
25684
+ /** The inference Id */
25685
+ inference_id: string;
25686
+ /** The task type */
25687
+ task_type: InferenceTaskTypeGoogleVertexAI;
25688
+ }
25689
+ export interface InferenceInferenceEndpointInfoHuggingFace extends InferenceInferenceEndpoint {
25690
+ /** The inference Id */
25691
+ inference_id: string;
25692
+ /** The task type */
25693
+ task_type: InferenceTaskTypeHuggingFace;
25694
+ }
25695
+ export interface InferenceInferenceEndpointInfoJinaAi extends InferenceInferenceEndpoint {
25696
+ /** The inference Id */
25697
+ inference_id: string;
25698
+ /** The task type */
25699
+ task_type: InferenceTaskTypeJinaAi;
25700
+ }
25701
+ export interface InferenceInferenceEndpointInfoMistral extends InferenceInferenceEndpoint {
25702
+ /** The inference Id */
25703
+ inference_id: string;
25704
+ /** The task type */
25705
+ task_type: InferenceTaskTypeMistral;
25706
+ }
25707
+ export interface InferenceInferenceEndpointInfoOpenAI extends InferenceInferenceEndpoint {
25708
+ /** The inference Id */
25709
+ inference_id: string;
25710
+ /** The task type */
25711
+ task_type: InferenceTaskTypeOpenAI;
25712
+ }
25713
+ export interface InferenceInferenceEndpointInfoVoyageAI extends InferenceInferenceEndpoint {
25714
+ /** The inference Id */
25715
+ inference_id: string;
25716
+ /** The task type */
25717
+ task_type: InferenceTaskTypeVoyageAI;
25718
+ }
25719
+ export interface InferenceInferenceEndpointInfoWatsonx extends InferenceInferenceEndpoint {
25720
+ /** The inference Id */
25721
+ inference_id: string;
25722
+ /** The task type */
25723
+ task_type: InferenceTaskTypeWatsonx;
25724
+ }
24606
25725
  export interface InferenceInferenceResult {
24607
25726
  text_embedding_bytes?: InferenceTextEmbeddingByteResult[];
24608
25727
  text_embedding_bits?: InferenceTextEmbeddingByteResult[];
@@ -24652,13 +25771,47 @@ export interface InferenceJinaAITaskSettings {
24652
25771
  export type InferenceJinaAITaskType = 'rerank' | 'text_embedding';
24653
25772
  export type InferenceJinaAITextEmbeddingTask = 'classification' | 'clustering' | 'ingest' | 'search';
24654
25773
  export interface InferenceMessage {
24655
- /** The content of the message. */
25774
+ /** The content of the message.
25775
+ *
25776
+ * String example:
25777
+ * ```
25778
+ * {
25779
+ * "content": "Some string"
25780
+ * }
25781
+ * ```
25782
+ *
25783
+ * Object example:
25784
+ * ```
25785
+ * {
25786
+ * "content": [
25787
+ * {
25788
+ * "text": "Some text",
25789
+ * "type": "text"
25790
+ * }
25791
+ * ]
25792
+ * }
25793
+ * ``` */
24656
25794
  content?: InferenceMessageContent;
24657
- /** The role of the message author. */
25795
+ /** The role of the message author. Valid values are `user`, `assistant`, `system`, and `tool`. */
24658
25796
  role: string;
24659
- /** The tool call that this message is responding to. */
25797
+ /** Only for `tool` role messages. The tool call that this message is responding to. */
24660
25798
  tool_call_id?: Id;
24661
- /** The tool calls generated by the model. */
25799
+ /** Only for `assistant` role messages. The tool calls generated by the model. If it's specified, the `content` field is optional.
25800
+ * Example:
25801
+ * ```
25802
+ * {
25803
+ * "tool_calls": [
25804
+ * {
25805
+ * "id": "call_KcAjWtAww20AihPHphUh46Gd",
25806
+ * "type": "function",
25807
+ * "function": {
25808
+ * "name": "get_current_weather",
25809
+ * "arguments": "{\"location\":\"Boston, MA\"}"
25810
+ * }
25811
+ * }
25812
+ * ]
25813
+ * }
25814
+ * ``` */
24662
25815
  tool_calls?: InferenceToolCall[];
24663
25816
  }
24664
25817
  export type InferenceMessageContent = string | InferenceContentObject[];
@@ -24674,14 +25827,14 @@ export interface InferenceMistralServiceSettings {
24674
25827
  /** The maximum number of tokens per input before chunking occurs. */
24675
25828
  max_input_tokens?: integer;
24676
25829
  /** The name of the model to use for the inference task.
24677
- * Refer to the Mistral models documentation for the list of available text embedding models. */
25830
+ * Refer to the Mistral models documentation for the list of available models. */
24678
25831
  model: string;
24679
25832
  /** This setting helps to minimize the number of rate limit errors returned from the Mistral API.
24680
25833
  * By default, the `mistral` service sets the number of requests allowed per minute to 240. */
24681
25834
  rate_limit?: InferenceRateLimitSetting;
24682
25835
  }
24683
25836
  export type InferenceMistralServiceType = 'mistral';
24684
- export type InferenceMistralTaskType = 'text_embedding';
25837
+ export type InferenceMistralTaskType = 'text_embedding' | 'completion' | 'chat_completion';
24685
25838
  export interface InferenceOpenAIServiceSettings {
24686
25839
  /** A valid API key of your OpenAI account.
24687
25840
  * You can find your OpenAI API keys in your OpenAI account under the API keys section.
@@ -24723,7 +25876,25 @@ export interface InferenceRankedDocument {
24723
25876
  text?: string;
24724
25877
  }
24725
25878
  export interface InferenceRateLimitSetting {
24726
- /** The number of requests allowed per minute. */
25879
+ /** The number of requests allowed per minute.
25880
+ * By default, the number of requests allowed per minute is set by each service as follows:
25881
+ *
25882
+ * * `alibabacloud-ai-search` service: `1000`
25883
+ * * `anthropic` service: `50`
25884
+ * * `azureaistudio` service: `240`
25885
+ * * `azureopenai` service and task type `text_embedding`: `1440`
25886
+ * * `azureopenai` service and task type `completion`: `120`
25887
+ * * `cohere` service: `10000`
25888
+ * * `elastic` service and task type `chat_completion`: `240`
25889
+ * * `googleaistudio` service: `360`
25890
+ * * `googlevertexai` service: `30000`
25891
+ * * `hugging_face` service: `3000`
25892
+ * * `jinaai` service: `2000`
25893
+ * * `mistral` service: `240`
25894
+ * * `openai` service and task type `text_embedding`: `3000`
25895
+ * * `openai` service and task type `completion`: `500`
25896
+ * * `voyageai` service: `2000`
25897
+ * * `watsonxai` service: `120` */
24727
25898
  requests_per_minute?: integer;
24728
25899
  }
24729
25900
  export interface InferenceRequestChatCompletion {
@@ -24739,9 +25910,46 @@ export interface InferenceRequestChatCompletion {
24739
25910
  stop?: string[];
24740
25911
  /** The sampling temperature to use. */
24741
25912
  temperature?: float;
24742
- /** Controls which tool is called by the model. */
25913
+ /** Controls which tool is called by the model.
25914
+ * String representation: One of `auto`, `none`, or `requrired`. `auto` allows the model to choose between calling tools and generating a message. `none` causes the model to not call any tools. `required` forces the model to call one or more tools.
25915
+ * Example (object representation):
25916
+ * ```
25917
+ * {
25918
+ * "tool_choice": {
25919
+ * "type": "function",
25920
+ * "function": {
25921
+ * "name": "get_current_weather"
25922
+ * }
25923
+ * }
25924
+ * }
25925
+ * ``` */
24743
25926
  tool_choice?: InferenceCompletionToolType;
24744
- /** A list of tools that the model can call. */
25927
+ /** A list of tools that the model can call.
25928
+ * Example:
25929
+ * ```
25930
+ * {
25931
+ * "tools": [
25932
+ * {
25933
+ * "type": "function",
25934
+ * "function": {
25935
+ * "name": "get_price_of_item",
25936
+ * "description": "Get the current price of an item",
25937
+ * "parameters": {
25938
+ * "type": "object",
25939
+ * "properties": {
25940
+ * "item": {
25941
+ * "id": "12345"
25942
+ * },
25943
+ * "unit": {
25944
+ * "type": "currency"
25945
+ * }
25946
+ * }
25947
+ * }
25948
+ * }
25949
+ * }
25950
+ * ]
25951
+ * }
25952
+ * ``` */
24745
25953
  tools?: InferenceCompletionTool[];
24746
25954
  /** Nucleus sampling, an alternative to sampling with temperature. */
24747
25955
  top_p?: float;
@@ -24759,6 +25967,25 @@ export interface InferenceSparseEmbeddingResult {
24759
25967
  export type InferenceSparseVector = Record<string, float>;
24760
25968
  export type InferenceTaskSettings = any;
24761
25969
  export type InferenceTaskType = 'sparse_embedding' | 'text_embedding' | 'rerank' | 'completion' | 'chat_completion';
25970
+ export type InferenceTaskTypeAlibabaCloudAI = 'text_embedding' | 'rerank' | 'completion' | 'sparse_embedding';
25971
+ export type InferenceTaskTypeAmazonBedrock = 'text_embedding' | 'completion';
25972
+ export type InferenceTaskTypeAmazonSageMaker = 'text_embedding' | 'completion' | 'chat_completion' | 'sparse_embedding' | 'rerank';
25973
+ export type InferenceTaskTypeAnthropic = 'completion';
25974
+ export type InferenceTaskTypeAzureAIStudio = 'text_embedding' | 'completion';
25975
+ export type InferenceTaskTypeAzureOpenAI = 'text_embedding' | 'completion';
25976
+ export type InferenceTaskTypeCohere = 'text_embedding' | 'rerank' | 'completion';
25977
+ export type InferenceTaskTypeCustom = 'text_embedding' | 'sparse_embedding' | 'rerank' | 'completion';
25978
+ export type InferenceTaskTypeDeepSeek = 'completion' | 'chat_completion';
25979
+ export type InferenceTaskTypeELSER = 'sparse_embedding';
25980
+ export type InferenceTaskTypeElasticsearch = 'sparse_embedding' | 'text_embedding' | 'rerank';
25981
+ export type InferenceTaskTypeGoogleAIStudio = 'text_embedding' | 'completion';
25982
+ export type InferenceTaskTypeGoogleVertexAI = 'text_embedding' | 'rerank';
25983
+ export type InferenceTaskTypeHuggingFace = 'chat_completion' | 'completion' | 'rerank' | 'text_embedding';
25984
+ export type InferenceTaskTypeJinaAi = 'text_embedding' | 'rerank';
25985
+ export type InferenceTaskTypeMistral = 'text_embedding' | 'chat_completion' | 'completion';
25986
+ export type InferenceTaskTypeOpenAI = 'text_embedding' | 'chat_completion' | 'completion';
25987
+ export type InferenceTaskTypeVoyageAI = 'text_embedding' | 'rerank';
25988
+ export type InferenceTaskTypeWatsonx = 'text_embedding' | 'chat_completion' | 'completion';
24762
25989
  export interface InferenceTextEmbeddingByteResult {
24763
25990
  embedding: InferenceDenseByteVector;
24764
25991
  }
@@ -24834,7 +26061,8 @@ export interface InferenceWatsonxServiceSettings {
24834
26061
  * For the active version data parameters, refer to the Wastonx documentation. */
24835
26062
  api_version: string;
24836
26063
  /** The name of the model to use for the inference task.
24837
- * Refer to the IBM Embedding Models section in the Watsonx documentation for the list of available text embedding models. */
26064
+ * Refer to the IBM Embedding Models section in the Watsonx documentation for the list of available text embedding models.
26065
+ * Refer to the IBM library - Foundation models in Watsonx.ai. */
24838
26066
  model_id: string;
24839
26067
  /** The identifier of the IBM Cloud project to use for the inference task. */
24840
26068
  project_id: string;
@@ -24845,7 +26073,7 @@ export interface InferenceWatsonxServiceSettings {
24845
26073
  url: string;
24846
26074
  }
24847
26075
  export type InferenceWatsonxServiceType = 'watsonxai';
24848
- export type InferenceWatsonxTaskType = 'text_embedding';
26076
+ export type InferenceWatsonxTaskType = 'text_embedding' | 'chat_completion' | 'completion';
24849
26077
  export interface InferenceChatCompletionUnifiedRequest extends RequestBase {
24850
26078
  /** The inference Id */
24851
26079
  inference_id: Id;
@@ -24968,6 +26196,17 @@ export interface InferenceInferenceRequest extends RequestBase {
24968
26196
  * > info
24969
26197
  * > Inference endpoints for the `completion` task type currently only support a single string as input. */
24970
26198
  input: string | string[];
26199
+ /** Specifies the input data type for the text embedding model. The `input_type` parameter only applies to Inference Endpoints with the `text_embedding` task type. Possible values include:
26200
+ * * `SEARCH`
26201
+ * * `INGEST`
26202
+ * * `CLASSIFICATION`
26203
+ * * `CLUSTERING`
26204
+ * Not all services support all values. Unsupported values will trigger a validation exception.
26205
+ * Accepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.
26206
+ *
26207
+ * > info
26208
+ * > The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`. */
26209
+ input_type?: string;
24971
26210
  /** Task settings for the individual inference request.
24972
26211
  * These settings are specific to the task type you specified and override the task settings specified when initializing the service. */
24973
26212
  task_settings?: InferenceTaskSettings;
@@ -24980,6 +26219,7 @@ export interface InferenceInferenceRequest extends RequestBase {
24980
26219
  timeout?: never;
24981
26220
  query?: never;
24982
26221
  input?: never;
26222
+ input_type?: never;
24983
26223
  task_settings?: never;
24984
26224
  });
24985
26225
  /** All values in `querystring` will be added to the request querystring. */
@@ -24991,15 +26231,18 @@ export interface InferenceInferenceRequest extends RequestBase {
24991
26231
  timeout?: never;
24992
26232
  query?: never;
24993
26233
  input?: never;
26234
+ input_type?: never;
24994
26235
  task_settings?: never;
24995
26236
  };
24996
26237
  }
24997
26238
  export type InferenceInferenceResponse = InferenceInferenceResult;
24998
26239
  export interface InferencePutRequest extends RequestBase {
24999
- /** The task type */
26240
+ /** The task type. Refer to the integration list in the API description for the available task types. */
25000
26241
  task_type?: InferenceTaskType;
25001
26242
  /** The inference Id */
25002
26243
  inference_id: Id;
26244
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26245
+ timeout?: Duration;
25003
26246
  inference_config?: InferenceInferenceEndpoint;
25004
26247
  /** All values in `body` will be added to the request body. */
25005
26248
  body?: string | ({
@@ -25007,6 +26250,7 @@ export interface InferencePutRequest extends RequestBase {
25007
26250
  } & {
25008
26251
  task_type?: never;
25009
26252
  inference_id?: never;
26253
+ timeout?: never;
25010
26254
  inference_config?: never;
25011
26255
  });
25012
26256
  /** All values in `querystring` will be added to the request querystring. */
@@ -25015,6 +26259,7 @@ export interface InferencePutRequest extends RequestBase {
25015
26259
  } & {
25016
26260
  task_type?: never;
25017
26261
  inference_id?: never;
26262
+ timeout?: never;
25018
26263
  inference_config?: never;
25019
26264
  };
25020
26265
  }
@@ -25024,6 +26269,8 @@ export interface InferencePutAlibabacloudRequest extends RequestBase {
25024
26269
  task_type: InferenceAlibabaCloudTaskType;
25025
26270
  /** The unique identifier of the inference endpoint. */
25026
26271
  alibabacloud_inference_id: Id;
26272
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26273
+ timeout?: Duration;
25027
26274
  /** The chunking configuration object. */
25028
26275
  chunking_settings?: InferenceInferenceChunkingSettings;
25029
26276
  /** The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`. */
@@ -25039,6 +26286,7 @@ export interface InferencePutAlibabacloudRequest extends RequestBase {
25039
26286
  } & {
25040
26287
  task_type?: never;
25041
26288
  alibabacloud_inference_id?: never;
26289
+ timeout?: never;
25042
26290
  chunking_settings?: never;
25043
26291
  service?: never;
25044
26292
  service_settings?: never;
@@ -25050,18 +26298,21 @@ export interface InferencePutAlibabacloudRequest extends RequestBase {
25050
26298
  } & {
25051
26299
  task_type?: never;
25052
26300
  alibabacloud_inference_id?: never;
26301
+ timeout?: never;
25053
26302
  chunking_settings?: never;
25054
26303
  service?: never;
25055
26304
  service_settings?: never;
25056
26305
  task_settings?: never;
25057
26306
  };
25058
26307
  }
25059
- export type InferencePutAlibabacloudResponse = InferenceInferenceEndpointInfo;
26308
+ export type InferencePutAlibabacloudResponse = InferenceInferenceEndpointInfoAlibabaCloudAI;
25060
26309
  export interface InferencePutAmazonbedrockRequest extends RequestBase {
25061
26310
  /** The type of the inference task that the model will perform. */
25062
26311
  task_type: InferenceAmazonBedrockTaskType;
25063
26312
  /** The unique identifier of the inference endpoint. */
25064
26313
  amazonbedrock_inference_id: Id;
26314
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26315
+ timeout?: Duration;
25065
26316
  /** The chunking configuration object. */
25066
26317
  chunking_settings?: InferenceInferenceChunkingSettings;
25067
26318
  /** The type of service supported for the specified task type. In this case, `amazonbedrock`. */
@@ -25077,6 +26328,7 @@ export interface InferencePutAmazonbedrockRequest extends RequestBase {
25077
26328
  } & {
25078
26329
  task_type?: never;
25079
26330
  amazonbedrock_inference_id?: never;
26331
+ timeout?: never;
25080
26332
  chunking_settings?: never;
25081
26333
  service?: never;
25082
26334
  service_settings?: never;
@@ -25088,19 +26340,65 @@ export interface InferencePutAmazonbedrockRequest extends RequestBase {
25088
26340
  } & {
25089
26341
  task_type?: never;
25090
26342
  amazonbedrock_inference_id?: never;
26343
+ timeout?: never;
26344
+ chunking_settings?: never;
26345
+ service?: never;
26346
+ service_settings?: never;
26347
+ task_settings?: never;
26348
+ };
26349
+ }
26350
+ export type InferencePutAmazonbedrockResponse = InferenceInferenceEndpointInfoAmazonBedrock;
26351
+ export interface InferencePutAmazonsagemakerRequest extends RequestBase {
26352
+ /** The type of the inference task that the model will perform. */
26353
+ task_type: InferenceTaskTypeAmazonSageMaker;
26354
+ /** The unique identifier of the inference endpoint. */
26355
+ amazonsagemaker_inference_id: Id;
26356
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26357
+ timeout?: Duration;
26358
+ /** The chunking configuration object. */
26359
+ chunking_settings?: InferenceInferenceChunkingSettings;
26360
+ /** The type of service supported for the specified task type. In this case, `amazon_sagemaker`. */
26361
+ service: InferenceAmazonSageMakerServiceType;
26362
+ /** Settings used to install the inference model.
26363
+ * These settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified. */
26364
+ service_settings: InferenceAmazonSageMakerServiceSettings;
26365
+ /** Settings to configure the inference task.
26366
+ * These settings are specific to the task type and `service_settings.api` you specified. */
26367
+ task_settings?: InferenceAmazonSageMakerTaskSettings;
26368
+ /** All values in `body` will be added to the request body. */
26369
+ body?: string | ({
26370
+ [key: string]: any;
26371
+ } & {
26372
+ task_type?: never;
26373
+ amazonsagemaker_inference_id?: never;
26374
+ timeout?: never;
26375
+ chunking_settings?: never;
26376
+ service?: never;
26377
+ service_settings?: never;
26378
+ task_settings?: never;
26379
+ });
26380
+ /** All values in `querystring` will be added to the request querystring. */
26381
+ querystring?: {
26382
+ [key: string]: any;
26383
+ } & {
26384
+ task_type?: never;
26385
+ amazonsagemaker_inference_id?: never;
26386
+ timeout?: never;
25091
26387
  chunking_settings?: never;
25092
26388
  service?: never;
25093
26389
  service_settings?: never;
25094
26390
  task_settings?: never;
25095
26391
  };
25096
26392
  }
25097
- export type InferencePutAmazonbedrockResponse = InferenceInferenceEndpointInfo;
26393
+ export type InferencePutAmazonsagemakerResponse = InferenceInferenceEndpointInfoAmazonSageMaker;
25098
26394
  export interface InferencePutAnthropicRequest extends RequestBase {
25099
26395
  /** The task type.
25100
26396
  * The only valid task type for the model to perform is `completion`. */
25101
26397
  task_type: InferenceAnthropicTaskType;
25102
26398
  /** The unique identifier of the inference endpoint. */
25103
26399
  anthropic_inference_id: Id;
26400
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26401
+ timeout?: Duration;
25104
26402
  /** The chunking configuration object. */
25105
26403
  chunking_settings?: InferenceInferenceChunkingSettings;
25106
26404
  /** The type of service supported for the specified task type. In this case, `anthropic`. */
@@ -25116,6 +26414,7 @@ export interface InferencePutAnthropicRequest extends RequestBase {
25116
26414
  } & {
25117
26415
  task_type?: never;
25118
26416
  anthropic_inference_id?: never;
26417
+ timeout?: never;
25119
26418
  chunking_settings?: never;
25120
26419
  service?: never;
25121
26420
  service_settings?: never;
@@ -25127,18 +26426,21 @@ export interface InferencePutAnthropicRequest extends RequestBase {
25127
26426
  } & {
25128
26427
  task_type?: never;
25129
26428
  anthropic_inference_id?: never;
26429
+ timeout?: never;
25130
26430
  chunking_settings?: never;
25131
26431
  service?: never;
25132
26432
  service_settings?: never;
25133
26433
  task_settings?: never;
25134
26434
  };
25135
26435
  }
25136
- export type InferencePutAnthropicResponse = InferenceInferenceEndpointInfo;
26436
+ export type InferencePutAnthropicResponse = InferenceInferenceEndpointInfoAnthropic;
25137
26437
  export interface InferencePutAzureaistudioRequest extends RequestBase {
25138
26438
  /** The type of the inference task that the model will perform. */
25139
26439
  task_type: InferenceAzureAiStudioTaskType;
25140
26440
  /** The unique identifier of the inference endpoint. */
25141
26441
  azureaistudio_inference_id: Id;
26442
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26443
+ timeout?: Duration;
25142
26444
  /** The chunking configuration object. */
25143
26445
  chunking_settings?: InferenceInferenceChunkingSettings;
25144
26446
  /** The type of service supported for the specified task type. In this case, `azureaistudio`. */
@@ -25154,6 +26456,7 @@ export interface InferencePutAzureaistudioRequest extends RequestBase {
25154
26456
  } & {
25155
26457
  task_type?: never;
25156
26458
  azureaistudio_inference_id?: never;
26459
+ timeout?: never;
25157
26460
  chunking_settings?: never;
25158
26461
  service?: never;
25159
26462
  service_settings?: never;
@@ -25165,19 +26468,22 @@ export interface InferencePutAzureaistudioRequest extends RequestBase {
25165
26468
  } & {
25166
26469
  task_type?: never;
25167
26470
  azureaistudio_inference_id?: never;
26471
+ timeout?: never;
25168
26472
  chunking_settings?: never;
25169
26473
  service?: never;
25170
26474
  service_settings?: never;
25171
26475
  task_settings?: never;
25172
26476
  };
25173
26477
  }
25174
- export type InferencePutAzureaistudioResponse = InferenceInferenceEndpointInfo;
26478
+ export type InferencePutAzureaistudioResponse = InferenceInferenceEndpointInfoAzureAIStudio;
25175
26479
  export interface InferencePutAzureopenaiRequest extends RequestBase {
25176
26480
  /** The type of the inference task that the model will perform.
25177
26481
  * NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. */
25178
26482
  task_type: InferenceAzureOpenAITaskType;
25179
26483
  /** The unique identifier of the inference endpoint. */
25180
26484
  azureopenai_inference_id: Id;
26485
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26486
+ timeout?: Duration;
25181
26487
  /** The chunking configuration object. */
25182
26488
  chunking_settings?: InferenceInferenceChunkingSettings;
25183
26489
  /** The type of service supported for the specified task type. In this case, `azureopenai`. */
@@ -25193,6 +26499,7 @@ export interface InferencePutAzureopenaiRequest extends RequestBase {
25193
26499
  } & {
25194
26500
  task_type?: never;
25195
26501
  azureopenai_inference_id?: never;
26502
+ timeout?: never;
25196
26503
  chunking_settings?: never;
25197
26504
  service?: never;
25198
26505
  service_settings?: never;
@@ -25204,18 +26511,21 @@ export interface InferencePutAzureopenaiRequest extends RequestBase {
25204
26511
  } & {
25205
26512
  task_type?: never;
25206
26513
  azureopenai_inference_id?: never;
26514
+ timeout?: never;
25207
26515
  chunking_settings?: never;
25208
26516
  service?: never;
25209
26517
  service_settings?: never;
25210
26518
  task_settings?: never;
25211
26519
  };
25212
26520
  }
25213
- export type InferencePutAzureopenaiResponse = InferenceInferenceEndpointInfo;
26521
+ export type InferencePutAzureopenaiResponse = InferenceInferenceEndpointInfoAzureOpenAI;
25214
26522
  export interface InferencePutCohereRequest extends RequestBase {
25215
26523
  /** The type of the inference task that the model will perform. */
25216
26524
  task_type: InferenceCohereTaskType;
25217
26525
  /** The unique identifier of the inference endpoint. */
25218
26526
  cohere_inference_id: Id;
26527
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26528
+ timeout?: Duration;
25219
26529
  /** The chunking configuration object. */
25220
26530
  chunking_settings?: InferenceInferenceChunkingSettings;
25221
26531
  /** The type of service supported for the specified task type. In this case, `cohere`. */
@@ -25232,6 +26542,7 @@ export interface InferencePutCohereRequest extends RequestBase {
25232
26542
  } & {
25233
26543
  task_type?: never;
25234
26544
  cohere_inference_id?: never;
26545
+ timeout?: never;
25235
26546
  chunking_settings?: never;
25236
26547
  service?: never;
25237
26548
  service_settings?: never;
@@ -25243,19 +26554,99 @@ export interface InferencePutCohereRequest extends RequestBase {
25243
26554
  } & {
25244
26555
  task_type?: never;
25245
26556
  cohere_inference_id?: never;
26557
+ timeout?: never;
26558
+ chunking_settings?: never;
26559
+ service?: never;
26560
+ service_settings?: never;
26561
+ task_settings?: never;
26562
+ };
26563
+ }
26564
+ export type InferencePutCohereResponse = InferenceInferenceEndpointInfoCohere;
26565
+ export interface InferencePutCustomRequest extends RequestBase {
26566
+ /** The type of the inference task that the model will perform. */
26567
+ task_type: InferenceCustomTaskType;
26568
+ /** The unique identifier of the inference endpoint. */
26569
+ custom_inference_id: Id;
26570
+ /** The chunking configuration object. */
26571
+ chunking_settings?: InferenceInferenceChunkingSettings;
26572
+ /** The type of service supported for the specified task type. In this case, `custom`. */
26573
+ service: InferenceCustomServiceType;
26574
+ /** Settings used to install the inference model.
26575
+ * These settings are specific to the `custom` service. */
26576
+ service_settings: InferenceCustomServiceSettings;
26577
+ /** Settings to configure the inference task.
26578
+ * These settings are specific to the task type you specified. */
26579
+ task_settings?: InferenceCustomTaskSettings;
26580
+ /** All values in `body` will be added to the request body. */
26581
+ body?: string | ({
26582
+ [key: string]: any;
26583
+ } & {
26584
+ task_type?: never;
26585
+ custom_inference_id?: never;
26586
+ chunking_settings?: never;
26587
+ service?: never;
26588
+ service_settings?: never;
26589
+ task_settings?: never;
26590
+ });
26591
+ /** All values in `querystring` will be added to the request querystring. */
26592
+ querystring?: {
26593
+ [key: string]: any;
26594
+ } & {
26595
+ task_type?: never;
26596
+ custom_inference_id?: never;
25246
26597
  chunking_settings?: never;
25247
26598
  service?: never;
25248
26599
  service_settings?: never;
25249
26600
  task_settings?: never;
25250
26601
  };
25251
26602
  }
25252
- export type InferencePutCohereResponse = InferenceInferenceEndpointInfo;
26603
+ export type InferencePutCustomResponse = InferenceInferenceEndpointInfoCustom;
26604
+ export interface InferencePutDeepseekRequest extends RequestBase {
26605
+ /** The type of the inference task that the model will perform. */
26606
+ task_type: InferenceTaskTypeDeepSeek;
26607
+ /** The unique identifier of the inference endpoint. */
26608
+ deepseek_inference_id: Id;
26609
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26610
+ timeout?: Duration;
26611
+ /** The chunking configuration object. */
26612
+ chunking_settings?: InferenceInferenceChunkingSettings;
26613
+ /** The type of service supported for the specified task type. In this case, `deepseek`. */
26614
+ service: InferenceDeepSeekServiceType;
26615
+ /** Settings used to install the inference model.
26616
+ * These settings are specific to the `deepseek` service. */
26617
+ service_settings: InferenceDeepSeekServiceSettings;
26618
+ /** All values in `body` will be added to the request body. */
26619
+ body?: string | ({
26620
+ [key: string]: any;
26621
+ } & {
26622
+ task_type?: never;
26623
+ deepseek_inference_id?: never;
26624
+ timeout?: never;
26625
+ chunking_settings?: never;
26626
+ service?: never;
26627
+ service_settings?: never;
26628
+ });
26629
+ /** All values in `querystring` will be added to the request querystring. */
26630
+ querystring?: {
26631
+ [key: string]: any;
26632
+ } & {
26633
+ task_type?: never;
26634
+ deepseek_inference_id?: never;
26635
+ timeout?: never;
26636
+ chunking_settings?: never;
26637
+ service?: never;
26638
+ service_settings?: never;
26639
+ };
26640
+ }
26641
+ export type InferencePutDeepseekResponse = InferenceInferenceEndpointInfoDeepSeek;
25253
26642
  export interface InferencePutElasticsearchRequest extends RequestBase {
25254
26643
  /** The type of the inference task that the model will perform. */
25255
26644
  task_type: InferenceElasticsearchTaskType;
25256
26645
  /** The unique identifier of the inference endpoint.
25257
26646
  * The must not match the `model_id`. */
25258
26647
  elasticsearch_inference_id: Id;
26648
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26649
+ timeout?: Duration;
25259
26650
  /** The chunking configuration object. */
25260
26651
  chunking_settings?: InferenceInferenceChunkingSettings;
25261
26652
  /** The type of service supported for the specified task type. In this case, `elasticsearch`. */
@@ -25271,6 +26662,7 @@ export interface InferencePutElasticsearchRequest extends RequestBase {
25271
26662
  } & {
25272
26663
  task_type?: never;
25273
26664
  elasticsearch_inference_id?: never;
26665
+ timeout?: never;
25274
26666
  chunking_settings?: never;
25275
26667
  service?: never;
25276
26668
  service_settings?: never;
@@ -25282,18 +26674,21 @@ export interface InferencePutElasticsearchRequest extends RequestBase {
25282
26674
  } & {
25283
26675
  task_type?: never;
25284
26676
  elasticsearch_inference_id?: never;
26677
+ timeout?: never;
25285
26678
  chunking_settings?: never;
25286
26679
  service?: never;
25287
26680
  service_settings?: never;
25288
26681
  task_settings?: never;
25289
26682
  };
25290
26683
  }
25291
- export type InferencePutElasticsearchResponse = InferenceInferenceEndpointInfo;
26684
+ export type InferencePutElasticsearchResponse = InferenceInferenceEndpointInfoElasticsearch;
25292
26685
  export interface InferencePutElserRequest extends RequestBase {
25293
26686
  /** The type of the inference task that the model will perform. */
25294
26687
  task_type: InferenceElserTaskType;
25295
26688
  /** The unique identifier of the inference endpoint. */
25296
26689
  elser_inference_id: Id;
26690
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26691
+ timeout?: Duration;
25297
26692
  /** The chunking configuration object. */
25298
26693
  chunking_settings?: InferenceInferenceChunkingSettings;
25299
26694
  /** The type of service supported for the specified task type. In this case, `elser`. */
@@ -25306,6 +26701,7 @@ export interface InferencePutElserRequest extends RequestBase {
25306
26701
  } & {
25307
26702
  task_type?: never;
25308
26703
  elser_inference_id?: never;
26704
+ timeout?: never;
25309
26705
  chunking_settings?: never;
25310
26706
  service?: never;
25311
26707
  service_settings?: never;
@@ -25316,17 +26712,20 @@ export interface InferencePutElserRequest extends RequestBase {
25316
26712
  } & {
25317
26713
  task_type?: never;
25318
26714
  elser_inference_id?: never;
26715
+ timeout?: never;
25319
26716
  chunking_settings?: never;
25320
26717
  service?: never;
25321
26718
  service_settings?: never;
25322
26719
  };
25323
26720
  }
25324
- export type InferencePutElserResponse = InferenceInferenceEndpointInfo;
26721
+ export type InferencePutElserResponse = InferenceInferenceEndpointInfoELSER;
25325
26722
  export interface InferencePutGoogleaistudioRequest extends RequestBase {
25326
26723
  /** The type of the inference task that the model will perform. */
25327
26724
  task_type: InferenceGoogleAiStudioTaskType;
25328
26725
  /** The unique identifier of the inference endpoint. */
25329
26726
  googleaistudio_inference_id: Id;
26727
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26728
+ timeout?: Duration;
25330
26729
  /** The chunking configuration object. */
25331
26730
  chunking_settings?: InferenceInferenceChunkingSettings;
25332
26731
  /** The type of service supported for the specified task type. In this case, `googleaistudio`. */
@@ -25339,6 +26738,7 @@ export interface InferencePutGoogleaistudioRequest extends RequestBase {
25339
26738
  } & {
25340
26739
  task_type?: never;
25341
26740
  googleaistudio_inference_id?: never;
26741
+ timeout?: never;
25342
26742
  chunking_settings?: never;
25343
26743
  service?: never;
25344
26744
  service_settings?: never;
@@ -25349,17 +26749,20 @@ export interface InferencePutGoogleaistudioRequest extends RequestBase {
25349
26749
  } & {
25350
26750
  task_type?: never;
25351
26751
  googleaistudio_inference_id?: never;
26752
+ timeout?: never;
25352
26753
  chunking_settings?: never;
25353
26754
  service?: never;
25354
26755
  service_settings?: never;
25355
26756
  };
25356
26757
  }
25357
- export type InferencePutGoogleaistudioResponse = InferenceInferenceEndpointInfo;
26758
+ export type InferencePutGoogleaistudioResponse = InferenceInferenceEndpointInfoGoogleAIStudio;
25358
26759
  export interface InferencePutGooglevertexaiRequest extends RequestBase {
25359
26760
  /** The type of the inference task that the model will perform. */
25360
26761
  task_type: InferenceGoogleVertexAITaskType;
25361
26762
  /** The unique identifier of the inference endpoint. */
25362
26763
  googlevertexai_inference_id: Id;
26764
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26765
+ timeout?: Duration;
25363
26766
  /** The chunking configuration object. */
25364
26767
  chunking_settings?: InferenceInferenceChunkingSettings;
25365
26768
  /** The type of service supported for the specified task type. In this case, `googlevertexai`. */
@@ -25375,6 +26778,7 @@ export interface InferencePutGooglevertexaiRequest extends RequestBase {
25375
26778
  } & {
25376
26779
  task_type?: never;
25377
26780
  googlevertexai_inference_id?: never;
26781
+ timeout?: never;
25378
26782
  chunking_settings?: never;
25379
26783
  service?: never;
25380
26784
  service_settings?: never;
@@ -25386,33 +26790,41 @@ export interface InferencePutGooglevertexaiRequest extends RequestBase {
25386
26790
  } & {
25387
26791
  task_type?: never;
25388
26792
  googlevertexai_inference_id?: never;
26793
+ timeout?: never;
25389
26794
  chunking_settings?: never;
25390
26795
  service?: never;
25391
26796
  service_settings?: never;
25392
26797
  task_settings?: never;
25393
26798
  };
25394
26799
  }
25395
- export type InferencePutGooglevertexaiResponse = InferenceInferenceEndpointInfo;
26800
+ export type InferencePutGooglevertexaiResponse = InferenceInferenceEndpointInfoGoogleVertexAI;
25396
26801
  export interface InferencePutHuggingFaceRequest extends RequestBase {
25397
26802
  /** The type of the inference task that the model will perform. */
25398
26803
  task_type: InferenceHuggingFaceTaskType;
25399
26804
  /** The unique identifier of the inference endpoint. */
25400
26805
  huggingface_inference_id: Id;
26806
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26807
+ timeout?: Duration;
25401
26808
  /** The chunking configuration object. */
25402
26809
  chunking_settings?: InferenceInferenceChunkingSettings;
25403
26810
  /** The type of service supported for the specified task type. In this case, `hugging_face`. */
25404
26811
  service: InferenceHuggingFaceServiceType;
25405
26812
  /** Settings used to install the inference model. These settings are specific to the `hugging_face` service. */
25406
26813
  service_settings: InferenceHuggingFaceServiceSettings;
26814
+ /** Settings to configure the inference task.
26815
+ * These settings are specific to the task type you specified. */
26816
+ task_settings?: InferenceHuggingFaceTaskSettings;
25407
26817
  /** All values in `body` will be added to the request body. */
25408
26818
  body?: string | ({
25409
26819
  [key: string]: any;
25410
26820
  } & {
25411
26821
  task_type?: never;
25412
26822
  huggingface_inference_id?: never;
26823
+ timeout?: never;
25413
26824
  chunking_settings?: never;
25414
26825
  service?: never;
25415
26826
  service_settings?: never;
26827
+ task_settings?: never;
25416
26828
  });
25417
26829
  /** All values in `querystring` will be added to the request querystring. */
25418
26830
  querystring?: {
@@ -25420,17 +26832,21 @@ export interface InferencePutHuggingFaceRequest extends RequestBase {
25420
26832
  } & {
25421
26833
  task_type?: never;
25422
26834
  huggingface_inference_id?: never;
26835
+ timeout?: never;
25423
26836
  chunking_settings?: never;
25424
26837
  service?: never;
25425
26838
  service_settings?: never;
26839
+ task_settings?: never;
25426
26840
  };
25427
26841
  }
25428
- export type InferencePutHuggingFaceResponse = InferenceInferenceEndpointInfo;
26842
+ export type InferencePutHuggingFaceResponse = InferenceInferenceEndpointInfoHuggingFace;
25429
26843
  export interface InferencePutJinaaiRequest extends RequestBase {
25430
26844
  /** The type of the inference task that the model will perform. */
25431
26845
  task_type: InferenceJinaAITaskType;
25432
26846
  /** The unique identifier of the inference endpoint. */
25433
26847
  jinaai_inference_id: Id;
26848
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26849
+ timeout?: Duration;
25434
26850
  /** The chunking configuration object. */
25435
26851
  chunking_settings?: InferenceInferenceChunkingSettings;
25436
26852
  /** The type of service supported for the specified task type. In this case, `jinaai`. */
@@ -25446,6 +26862,7 @@ export interface InferencePutJinaaiRequest extends RequestBase {
25446
26862
  } & {
25447
26863
  task_type?: never;
25448
26864
  jinaai_inference_id?: never;
26865
+ timeout?: never;
25449
26866
  chunking_settings?: never;
25450
26867
  service?: never;
25451
26868
  service_settings?: never;
@@ -25457,19 +26874,21 @@ export interface InferencePutJinaaiRequest extends RequestBase {
25457
26874
  } & {
25458
26875
  task_type?: never;
25459
26876
  jinaai_inference_id?: never;
26877
+ timeout?: never;
25460
26878
  chunking_settings?: never;
25461
26879
  service?: never;
25462
26880
  service_settings?: never;
25463
26881
  task_settings?: never;
25464
26882
  };
25465
26883
  }
25466
- export type InferencePutJinaaiResponse = InferenceInferenceEndpointInfo;
26884
+ export type InferencePutJinaaiResponse = InferenceInferenceEndpointInfoJinaAi;
25467
26885
  export interface InferencePutMistralRequest extends RequestBase {
25468
- /** The task type.
25469
- * The only valid task type for the model to perform is `text_embedding`. */
26886
+ /** The type of the inference task that the model will perform. */
25470
26887
  task_type: InferenceMistralTaskType;
25471
26888
  /** The unique identifier of the inference endpoint. */
25472
26889
  mistral_inference_id: Id;
26890
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26891
+ timeout?: Duration;
25473
26892
  /** The chunking configuration object. */
25474
26893
  chunking_settings?: InferenceInferenceChunkingSettings;
25475
26894
  /** The type of service supported for the specified task type. In this case, `mistral`. */
@@ -25482,6 +26901,7 @@ export interface InferencePutMistralRequest extends RequestBase {
25482
26901
  } & {
25483
26902
  task_type?: never;
25484
26903
  mistral_inference_id?: never;
26904
+ timeout?: never;
25485
26905
  chunking_settings?: never;
25486
26906
  service?: never;
25487
26907
  service_settings?: never;
@@ -25492,18 +26912,21 @@ export interface InferencePutMistralRequest extends RequestBase {
25492
26912
  } & {
25493
26913
  task_type?: never;
25494
26914
  mistral_inference_id?: never;
26915
+ timeout?: never;
25495
26916
  chunking_settings?: never;
25496
26917
  service?: never;
25497
26918
  service_settings?: never;
25498
26919
  };
25499
26920
  }
25500
- export type InferencePutMistralResponse = InferenceInferenceEndpointInfo;
26921
+ export type InferencePutMistralResponse = InferenceInferenceEndpointInfoMistral;
25501
26922
  export interface InferencePutOpenaiRequest extends RequestBase {
25502
26923
  /** The type of the inference task that the model will perform.
25503
26924
  * NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. */
25504
26925
  task_type: InferenceOpenAITaskType;
25505
26926
  /** The unique identifier of the inference endpoint. */
25506
26927
  openai_inference_id: Id;
26928
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26929
+ timeout?: Duration;
25507
26930
  /** The chunking configuration object. */
25508
26931
  chunking_settings?: InferenceInferenceChunkingSettings;
25509
26932
  /** The type of service supported for the specified task type. In this case, `openai`. */
@@ -25519,6 +26942,7 @@ export interface InferencePutOpenaiRequest extends RequestBase {
25519
26942
  } & {
25520
26943
  task_type?: never;
25521
26944
  openai_inference_id?: never;
26945
+ timeout?: never;
25522
26946
  chunking_settings?: never;
25523
26947
  service?: never;
25524
26948
  service_settings?: never;
@@ -25530,18 +26954,21 @@ export interface InferencePutOpenaiRequest extends RequestBase {
25530
26954
  } & {
25531
26955
  task_type?: never;
25532
26956
  openai_inference_id?: never;
26957
+ timeout?: never;
25533
26958
  chunking_settings?: never;
25534
26959
  service?: never;
25535
26960
  service_settings?: never;
25536
26961
  task_settings?: never;
25537
26962
  };
25538
26963
  }
25539
- export type InferencePutOpenaiResponse = InferenceInferenceEndpointInfo;
26964
+ export type InferencePutOpenaiResponse = InferenceInferenceEndpointInfoOpenAI;
25540
26965
  export interface InferencePutVoyageaiRequest extends RequestBase {
25541
26966
  /** The type of the inference task that the model will perform. */
25542
26967
  task_type: InferenceVoyageAITaskType;
25543
26968
  /** The unique identifier of the inference endpoint. */
25544
26969
  voyageai_inference_id: Id;
26970
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
26971
+ timeout?: Duration;
25545
26972
  /** The chunking configuration object. */
25546
26973
  chunking_settings?: InferenceInferenceChunkingSettings;
25547
26974
  /** The type of service supported for the specified task type. In this case, `voyageai`. */
@@ -25557,6 +26984,7 @@ export interface InferencePutVoyageaiRequest extends RequestBase {
25557
26984
  } & {
25558
26985
  task_type?: never;
25559
26986
  voyageai_inference_id?: never;
26987
+ timeout?: never;
25560
26988
  chunking_settings?: never;
25561
26989
  service?: never;
25562
26990
  service_settings?: never;
@@ -25568,19 +26996,21 @@ export interface InferencePutVoyageaiRequest extends RequestBase {
25568
26996
  } & {
25569
26997
  task_type?: never;
25570
26998
  voyageai_inference_id?: never;
26999
+ timeout?: never;
25571
27000
  chunking_settings?: never;
25572
27001
  service?: never;
25573
27002
  service_settings?: never;
25574
27003
  task_settings?: never;
25575
27004
  };
25576
27005
  }
25577
- export type InferencePutVoyageaiResponse = InferenceInferenceEndpointInfo;
27006
+ export type InferencePutVoyageaiResponse = InferenceInferenceEndpointInfoVoyageAI;
25578
27007
  export interface InferencePutWatsonxRequest extends RequestBase {
25579
- /** The task type.
25580
- * The only valid task type for the model to perform is `text_embedding`. */
27008
+ /** The type of the inference task that the model will perform. */
25581
27009
  task_type: InferenceWatsonxTaskType;
25582
27010
  /** The unique identifier of the inference endpoint. */
25583
27011
  watsonx_inference_id: Id;
27012
+ /** Specifies the amount of time to wait for the inference endpoint to be created. */
27013
+ timeout?: Duration;
25584
27014
  /** The type of service supported for the specified task type. In this case, `watsonxai`. */
25585
27015
  service: InferenceWatsonxServiceType;
25586
27016
  /** Settings used to install the inference model. These settings are specific to the `watsonxai` service. */
@@ -25591,6 +27021,7 @@ export interface InferencePutWatsonxRequest extends RequestBase {
25591
27021
  } & {
25592
27022
  task_type?: never;
25593
27023
  watsonx_inference_id?: never;
27024
+ timeout?: never;
25594
27025
  service?: never;
25595
27026
  service_settings?: never;
25596
27027
  });
@@ -25600,11 +27031,12 @@ export interface InferencePutWatsonxRequest extends RequestBase {
25600
27031
  } & {
25601
27032
  task_type?: never;
25602
27033
  watsonx_inference_id?: never;
27034
+ timeout?: never;
25603
27035
  service?: never;
25604
27036
  service_settings?: never;
25605
27037
  };
25606
27038
  }
25607
- export type InferencePutWatsonxResponse = InferenceInferenceEndpointInfo;
27039
+ export type InferencePutWatsonxResponse = InferenceInferenceEndpointInfoWatsonx;
25608
27040
  export interface InferenceRerankRequest extends RequestBase {
25609
27041
  /** The unique identifier for the inference endpoint. */
25610
27042
  inference_id: Id;
@@ -25676,6 +27108,8 @@ export type InferenceSparseEmbeddingResponse = InferenceSparseEmbeddingInference
25676
27108
  export interface InferenceStreamCompletionRequest extends RequestBase {
25677
27109
  /** The unique identifier for the inference endpoint. */
25678
27110
  inference_id: Id;
27111
+ /** The amount of time to wait for the inference request to complete. */
27112
+ timeout?: Duration;
25679
27113
  /** The text on which you want to perform the inference task.
25680
27114
  * It can be a single string or an array.
25681
27115
  *
@@ -25688,6 +27122,7 @@ export interface InferenceStreamCompletionRequest extends RequestBase {
25688
27122
  [key: string]: any;
25689
27123
  } & {
25690
27124
  inference_id?: never;
27125
+ timeout?: never;
25691
27126
  input?: never;
25692
27127
  task_settings?: never;
25693
27128
  });
@@ -25696,6 +27131,7 @@ export interface InferenceStreamCompletionRequest extends RequestBase {
25696
27131
  [key: string]: any;
25697
27132
  } & {
25698
27133
  inference_id?: never;
27134
+ timeout?: never;
25699
27135
  input?: never;
25700
27136
  task_settings?: never;
25701
27137
  };
@@ -26816,23 +28252,17 @@ export interface IngestGetIpLocationDatabaseRequest extends RequestBase {
26816
28252
  * Wildcard (`*`) expressions are supported.
26817
28253
  * To get all database configurations, omit this parameter or use `*`. */
26818
28254
  id?: Ids;
26819
- /** The period to wait for a connection to the master node.
26820
- * If no response is received before the timeout expires, the request fails and returns an error.
26821
- * A value of `-1` indicates that the request should never time out. */
26822
- master_timeout?: Duration;
26823
28255
  /** All values in `body` will be added to the request body. */
26824
28256
  body?: string | ({
26825
28257
  [key: string]: any;
26826
28258
  } & {
26827
28259
  id?: never;
26828
- master_timeout?: never;
26829
28260
  });
26830
28261
  /** All values in `querystring` will be added to the request querystring. */
26831
28262
  querystring?: {
26832
28263
  [key: string]: any;
26833
28264
  } & {
26834
28265
  id?: never;
26835
- master_timeout?: never;
26836
28266
  };
26837
28267
  }
26838
28268
  export interface IngestGetIpLocationDatabaseResponse {
@@ -27207,7 +28637,8 @@ export interface LicensePostStartBasicResponse {
27207
28637
  export interface LicensePostStartTrialRequest extends RequestBase {
27208
28638
  /** whether the user has acknowledged acknowledge messages (default: false) */
27209
28639
  acknowledge?: boolean;
27210
- type_query_string?: string;
28640
+ /** The type of trial license to generate (default: "trial") */
28641
+ type?: string;
27211
28642
  /** Period to wait for a connection to the master node. */
27212
28643
  master_timeout?: Duration;
27213
28644
  /** All values in `body` will be added to the request body. */
@@ -27215,7 +28646,7 @@ export interface LicensePostStartTrialRequest extends RequestBase {
27215
28646
  [key: string]: any;
27216
28647
  } & {
27217
28648
  acknowledge?: never;
27218
- type_query_string?: never;
28649
+ type?: never;
27219
28650
  master_timeout?: never;
27220
28651
  });
27221
28652
  /** All values in `querystring` will be added to the request querystring. */
@@ -27223,7 +28654,7 @@ export interface LicensePostStartTrialRequest extends RequestBase {
27223
28654
  [key: string]: any;
27224
28655
  } & {
27225
28656
  acknowledge?: never;
27226
- type_query_string?: never;
28657
+ type?: never;
27227
28658
  master_timeout?: never;
27228
28659
  };
27229
28660
  }
@@ -27411,7 +28842,8 @@ export interface MigrationPostFeatureUpgradeRequest extends RequestBase {
27411
28842
  }
27412
28843
  export interface MigrationPostFeatureUpgradeResponse {
27413
28844
  accepted: boolean;
27414
- features: MigrationPostFeatureUpgradeMigrationFeature[];
28845
+ features?: MigrationPostFeatureUpgradeMigrationFeature[];
28846
+ reason?: string;
27415
28847
  }
27416
28848
  export interface MlAdaptiveAllocationsSettings {
27417
28849
  /** If true, adaptive_allocations is enabled */
@@ -31589,13 +33021,7 @@ export interface MlPutJobRequest extends RequestBase {
31589
33021
  * `_all` string or when no indices are specified. */
31590
33022
  allow_no_indices?: boolean;
31591
33023
  /** Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
31592
- * whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:
31593
- *
31594
- * * `all`: Match any data stream or index, including hidden ones.
31595
- * * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
31596
- * * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
31597
- * * `none`: Wildcard patterns are not accepted.
31598
- * * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. */
33024
+ * whether wildcard expressions match hidden data streams. Supports comma-separated values. */
31599
33025
  expand_wildcards?: ExpandWildcards;
31600
33026
  /** If `true`, concrete, expanded or aliased indices are ignored when frozen. */
31601
33027
  ignore_throttled?: boolean;
@@ -32346,13 +33772,7 @@ export interface MlUpdateDatafeedRequest extends RequestBase {
32346
33772
  * `_all` string or when no indices are specified. */
32347
33773
  allow_no_indices?: boolean;
32348
33774
  /** Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
32349
- * whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:
32350
- *
32351
- * * `all`: Match any data stream or index, including hidden ones.
32352
- * * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
32353
- * * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
32354
- * * `none`: Wildcard patterns are not accepted.
32355
- * * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. */
33775
+ * whether wildcard expressions match hidden data streams. Supports comma-separated values. */
32356
33776
  expand_wildcards?: ExpandWildcards;
32357
33777
  /** If `true`, concrete, expanded or aliased indices are ignored when frozen. */
32358
33778
  ignore_throttled?: boolean;
@@ -33226,6 +34646,8 @@ export interface NodesJvmMemoryStats {
33226
34646
  heap_committed_in_bytes?: long;
33227
34647
  /** Maximum amount of memory, in bytes, available for use by the heap. */
33228
34648
  heap_max_in_bytes?: long;
34649
+ /** Maximum amount of memory, available for use by the heap. */
34650
+ heap_max?: ByteSize;
33229
34651
  /** Non-heap memory used, in bytes. */
33230
34652
  non_heap_used_in_bytes?: long;
33231
34653
  /** Amount of non-heap memory available, in bytes. */
@@ -33326,6 +34748,8 @@ export interface NodesPressureMemory {
33326
34748
  primary_rejections?: long;
33327
34749
  /** Number of indexing requests rejected in the replica stage. */
33328
34750
  replica_rejections?: long;
34751
+ primary_document_rejections?: long;
34752
+ large_operation_rejections?: long;
33329
34753
  }
33330
34754
  export interface NodesProcess {
33331
34755
  /** Contains CPU statistics for the node. */
@@ -33663,15 +35087,16 @@ export interface NodesInfoNodeInfo {
33663
35087
  /** Short hash of the last git commit in this release. */
33664
35088
  build_hash: string;
33665
35089
  build_type: string;
35090
+ component_versions: Record<Name, integer>;
33666
35091
  /** The node’s host name. */
33667
35092
  host: Host;
33668
35093
  http?: NodesInfoNodeInfoHttp;
35094
+ index_version: VersionNumber;
33669
35095
  /** The node’s IP address. */
33670
35096
  ip: Ip;
33671
35097
  jvm?: NodesInfoNodeJvmInfo;
33672
35098
  /** The node's name */
33673
35099
  name: Name;
33674
- network?: NodesInfoNodeInfoNetwork;
33675
35100
  os?: NodesInfoNodeOperatingSystemInfo;
33676
35101
  plugins?: PluginStats[];
33677
35102
  process?: NodesInfoNodeProcessInfo;
@@ -33685,11 +35110,13 @@ export interface NodesInfoNodeInfo {
33685
35110
  transport?: NodesInfoNodeInfoTransport;
33686
35111
  /** Host and port where transport HTTP connections are accepted. */
33687
35112
  transport_address: TransportAddress;
35113
+ transport_version: VersionNumber;
33688
35114
  /** Elasticsearch version running on this node. */
33689
35115
  version: VersionString;
33690
35116
  modules?: PluginStats[];
33691
35117
  ingest?: NodesInfoNodeInfoIngest;
33692
35118
  aggregations?: Record<string, NodesInfoNodeInfoAggregation>;
35119
+ remote_cluster_server?: NodesInfoRemoveClusterServer;
33693
35120
  }
33694
35121
  export interface NodesInfoNodeInfoAction {
33695
35122
  destructive_requires_name: string;
@@ -33704,7 +35131,7 @@ export interface NodesInfoNodeInfoClient {
33704
35131
  type: string;
33705
35132
  }
33706
35133
  export interface NodesInfoNodeInfoDiscoverKeys {
33707
- seed_hosts?: string[];
35134
+ seed_hosts?: string[] | string;
33708
35135
  type?: string;
33709
35136
  seed_providers?: string[];
33710
35137
  }
@@ -33745,15 +35172,6 @@ export interface NodesInfoNodeInfoMemory {
33745
35172
  total: string;
33746
35173
  total_in_bytes: long;
33747
35174
  }
33748
- export interface NodesInfoNodeInfoNetwork {
33749
- primary_interface: NodesInfoNodeInfoNetworkInterface;
33750
- refresh_interval: integer;
33751
- }
33752
- export interface NodesInfoNodeInfoNetworkInterface {
33753
- address: string;
33754
- mac_address: string;
33755
- name: Name;
33756
- }
33757
35175
  export interface NodesInfoNodeInfoOSCPU {
33758
35176
  cache_size: string;
33759
35177
  cache_size_in_bytes: integer;
@@ -33807,7 +35225,7 @@ export interface NodesInfoNodeInfoSettingsCluster {
33807
35225
  name: Name;
33808
35226
  routing?: IndicesIndexRouting;
33809
35227
  election: NodesInfoNodeInfoSettingsClusterElection;
33810
- initial_master_nodes?: string[];
35228
+ initial_master_nodes?: string[] | string;
33811
35229
  deprecation_indexing?: NodesInfoDeprecationIndexing;
33812
35230
  }
33813
35231
  export interface NodesInfoNodeInfoSettingsClusterElection {
@@ -33870,6 +35288,8 @@ export interface NodesInfoNodeInfoSettingsTransport {
33870
35288
  type: NodesInfoNodeInfoSettingsTransportType | string;
33871
35289
  'type.default'?: string;
33872
35290
  features?: NodesInfoNodeInfoSettingsTransportFeatures;
35291
+ /** Only used in unit tests */
35292
+ ignore_deserialization_errors?: SpecUtilsStringified<boolean>;
33873
35293
  }
33874
35294
  export interface NodesInfoNodeInfoSettingsTransportFeatures {
33875
35295
  'x-pack': string;
@@ -33933,8 +35353,6 @@ export interface NodesInfoNodeJvmInfo {
33933
35353
  vm_vendor: string;
33934
35354
  vm_version: VersionString;
33935
35355
  using_bundled_jdk: boolean;
33936
- /** @alias using_bundled_jdk */
33937
- bundled_jdk: boolean;
33938
35356
  using_compressed_ordinary_object_pointers?: boolean | string;
33939
35357
  input_arguments: string[];
33940
35358
  }
@@ -33972,6 +35390,10 @@ export interface NodesInfoNodeThreadPoolInfo {
33972
35390
  size?: integer;
33973
35391
  type: string;
33974
35392
  }
35393
+ export interface NodesInfoRemoveClusterServer {
35394
+ bound_address: TransportAddress[];
35395
+ publish_address: TransportAddress;
35396
+ }
33975
35397
  export interface NodesInfoRequest extends RequestBase {
33976
35398
  /** Comma-separated list of node IDs or names used to limit returned information. */
33977
35399
  node_id?: NodeIds;
@@ -35233,7 +36655,7 @@ export interface SecurityBulkError {
35233
36655
  export interface SecurityClusterNode {
35234
36656
  name: Name;
35235
36657
  }
35236
- export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_stats' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string;
36658
+ export type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_esql' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_esql' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_stats' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string;
35237
36659
  export interface SecurityCreatedStatus {
35238
36660
  created: boolean;
35239
36661
  }
@@ -36603,26 +38025,13 @@ export interface SecurityGetUserRequest extends RequestBase {
36603
38025
  }
36604
38026
  export type SecurityGetUserResponse = Record<string, SecurityUser>;
36605
38027
  export interface SecurityGetUserPrivilegesRequest extends RequestBase {
36606
- /** The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. */
36607
- application?: Name;
36608
- /** The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. */
36609
- priviledge?: Name;
36610
- username?: Name | null;
36611
38028
  /** All values in `body` will be added to the request body. */
36612
- body?: string | ({
38029
+ body?: string | {
36613
38030
  [key: string]: any;
36614
- } & {
36615
- application?: never;
36616
- priviledge?: never;
36617
- username?: never;
36618
- });
38031
+ };
36619
38032
  /** All values in `querystring` will be added to the request querystring. */
36620
38033
  querystring?: {
36621
38034
  [key: string]: any;
36622
- } & {
36623
- application?: never;
36624
- priviledge?: never;
36625
- username?: never;
36626
38035
  };
36627
38036
  }
36628
38037
  export interface SecurityGetUserPrivilegesResponse {
@@ -36683,6 +38092,11 @@ export interface SecurityGrantApiKeyGrantApiKey {
36683
38092
  metadata?: Metadata;
36684
38093
  }
36685
38094
  export interface SecurityGrantApiKeyRequest extends RequestBase {
38095
+ /** If 'true', Elasticsearch refreshes the affected shards to make this operation
38096
+ * visible to search.
38097
+ * If 'wait_for', it waits for a refresh to make this operation visible to search.
38098
+ * If 'false', nothing is done with refreshes. */
38099
+ refresh?: Refresh;
36686
38100
  /** The API key. */
36687
38101
  api_key: SecurityGrantApiKeyGrantApiKey;
36688
38102
  /** The type of grant. Supported grant types are: `access_token`, `password`. */
@@ -36705,6 +38119,7 @@ export interface SecurityGrantApiKeyRequest extends RequestBase {
36705
38119
  body?: string | ({
36706
38120
  [key: string]: any;
36707
38121
  } & {
38122
+ refresh?: never;
36708
38123
  api_key?: never;
36709
38124
  grant_type?: never;
36710
38125
  access_token?: never;
@@ -36716,6 +38131,7 @@ export interface SecurityGrantApiKeyRequest extends RequestBase {
36716
38131
  querystring?: {
36717
38132
  [key: string]: any;
36718
38133
  } & {
38134
+ refresh?: never;
36719
38135
  api_key?: never;
36720
38136
  grant_type?: never;
36721
38137
  access_token?: never;
@@ -38250,6 +39666,13 @@ export interface SlmSnapshotLifecycle {
38250
39666
  version: VersionNumber;
38251
39667
  stats: SlmStatistics;
38252
39668
  }
39669
+ export interface SlmSnapshotPolicyStats {
39670
+ policy: string;
39671
+ snapshots_taken: long;
39672
+ snapshots_failed: long;
39673
+ snapshots_deleted: long;
39674
+ snapshot_deletion_failures: long;
39675
+ }
38253
39676
  export interface SlmStatistics {
38254
39677
  retention_deletion_time?: Duration;
38255
39678
  retention_deletion_time_millis?: DurationValue<UnitMillis>;
@@ -38406,7 +39829,7 @@ export interface SlmGetStatsResponse {
38406
39829
  total_snapshot_deletion_failures: long;
38407
39830
  total_snapshots_failed: long;
38408
39831
  total_snapshots_taken: long;
38409
- policy_stats: string[];
39832
+ policy_stats: SlmSnapshotPolicyStats[];
38410
39833
  }
38411
39834
  export interface SlmGetStatusRequest extends RequestBase {
38412
39835
  /** The period to wait for a connection to the master node.
@@ -38829,7 +40252,7 @@ export interface SnapshotSnapshotShardFailure {
38829
40252
  index: IndexName;
38830
40253
  node_id?: Id;
38831
40254
  reason: string;
38832
- shard_id: Id;
40255
+ shard_id: integer;
38833
40256
  index_uuid: Id;
38834
40257
  status: string;
38835
40258
  }
@@ -38838,6 +40261,7 @@ export interface SnapshotSnapshotShardsStatus {
38838
40261
  stats: SnapshotShardsStatsSummary;
38839
40262
  }
38840
40263
  export type SnapshotSnapshotSort = 'start_time' | 'duration' | 'name' | 'index_count' | 'repository' | 'shard_count' | 'failed_shard_count';
40264
+ export type SnapshotSnapshotState = 'IN_PROGRESS' | 'SUCCESS' | 'FAILED' | 'PARTIAL' | 'INCOMPATIBLE';
38841
40265
  export interface SnapshotSnapshotStats {
38842
40266
  /** The number and size of files that still need to be copied as part of the incremental snapshot.
38843
40267
  * For completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot. */
@@ -39121,6 +40545,9 @@ export interface SnapshotDeleteRequest extends RequestBase {
39121
40545
  * If the master node is not available before the timeout expires, the request fails and returns an error.
39122
40546
  * To indicate that the request should never timeout, set it to `-1`. */
39123
40547
  master_timeout?: Duration;
40548
+ /** If `true`, the request returns a response when the matching snapshots are all deleted.
40549
+ * If `false`, the request returns a response as soon as the deletes are scheduled. */
40550
+ wait_for_completion?: boolean;
39124
40551
  /** All values in `body` will be added to the request body. */
39125
40552
  body?: string | ({
39126
40553
  [key: string]: any;
@@ -39128,6 +40555,7 @@ export interface SnapshotDeleteRequest extends RequestBase {
39128
40555
  repository?: never;
39129
40556
  snapshot?: never;
39130
40557
  master_timeout?: never;
40558
+ wait_for_completion?: never;
39131
40559
  });
39132
40560
  /** All values in `querystring` will be added to the request querystring. */
39133
40561
  querystring?: {
@@ -39136,6 +40564,7 @@ export interface SnapshotDeleteRequest extends RequestBase {
39136
40564
  repository?: never;
39137
40565
  snapshot?: never;
39138
40566
  master_timeout?: never;
40567
+ wait_for_completion?: never;
39139
40568
  };
39140
40569
  }
39141
40570
  export type SnapshotDeleteResponse = AcknowledgedResponseBase;
@@ -39216,6 +40645,9 @@ export interface SnapshotGetRequest extends RequestBase {
39216
40645
  /** The sort order for the result.
39217
40646
  * The default behavior is sorting by snapshot start time stamp. */
39218
40647
  sort?: SnapshotSnapshotSort;
40648
+ /** Only return snapshots with a state found in the given comma-separated list of snapshot states.
40649
+ * The default is all snapshot states. */
40650
+ state?: SnapshotSnapshotState | SnapshotSnapshotState[];
39219
40651
  /** If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.
39220
40652
  *
39221
40653
  * NOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined. */
@@ -39238,6 +40670,7 @@ export interface SnapshotGetRequest extends RequestBase {
39238
40670
  size?: never;
39239
40671
  slm_policy_filter?: never;
39240
40672
  sort?: never;
40673
+ state?: never;
39241
40674
  verbose?: never;
39242
40675
  });
39243
40676
  /** All values in `querystring` will be added to the request querystring. */
@@ -39258,6 +40691,7 @@ export interface SnapshotGetRequest extends RequestBase {
39258
40691
  size?: never;
39259
40692
  slm_policy_filter?: never;
39260
40693
  sort?: never;
40694
+ state?: never;
39261
40695
  verbose?: never;
39262
40696
  };
39263
40697
  }
@@ -40139,9 +41573,9 @@ export type SynonymsSynonymString = string;
40139
41573
  export interface SynonymsSynonymsUpdateResult {
40140
41574
  /** The update operation result. */
40141
41575
  result: Result;
40142
- /** Updating synonyms in a synonym set reloads the associated analyzers.
41576
+ /** Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.
40143
41577
  * This information is the analyzers reloading result. */
40144
- reload_analyzers_details: IndicesReloadSearchAnalyzersReloadResult;
41578
+ reload_analyzers_details?: IndicesReloadSearchAnalyzersReloadResult;
40145
41579
  }
40146
41580
  export interface SynonymsDeleteSynonymRequest extends RequestBase {
40147
41581
  /** The synonyms set identifier to delete. */
@@ -40165,12 +41599,17 @@ export interface SynonymsDeleteSynonymRuleRequest extends RequestBase {
40165
41599
  set_id: Id;
40166
41600
  /** The ID of the synonym rule to delete. */
40167
41601
  rule_id: Id;
41602
+ /** If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.
41603
+ * If `false`, analyzers will not be reloaded with the deleted synonym rule
41604
+ * @remarks This property is not supported on Elastic Cloud Serverless. */
41605
+ refresh?: boolean;
40168
41606
  /** All values in `body` will be added to the request body. */
40169
41607
  body?: string | ({
40170
41608
  [key: string]: any;
40171
41609
  } & {
40172
41610
  set_id?: never;
40173
41611
  rule_id?: never;
41612
+ refresh?: never;
40174
41613
  });
40175
41614
  /** All values in `querystring` will be added to the request querystring. */
40176
41615
  querystring?: {
@@ -40178,6 +41617,7 @@ export interface SynonymsDeleteSynonymRuleRequest extends RequestBase {
40178
41617
  } & {
40179
41618
  set_id?: never;
40180
41619
  rule_id?: never;
41620
+ refresh?: never;
40181
41621
  };
40182
41622
  }
40183
41623
  export type SynonymsDeleteSynonymRuleResponse = SynonymsSynonymsUpdateResult;
@@ -40267,6 +41707,10 @@ export interface SynonymsGetSynonymsSetsSynonymsSetItem {
40267
41707
  export interface SynonymsPutSynonymRequest extends RequestBase {
40268
41708
  /** The ID of the synonyms set to be created or updated. */
40269
41709
  id: Id;
41710
+ /** If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.
41711
+ * If `false`, analyzers will not be reloaded with the new synonym set
41712
+ * @remarks This property is not supported on Elastic Cloud Serverless. */
41713
+ refresh?: boolean;
40270
41714
  /** The synonym rules definitions for the synonyms set. */
40271
41715
  synonyms_set: SynonymsSynonymRule | SynonymsSynonymRule[];
40272
41716
  /** All values in `body` will be added to the request body. */
@@ -40274,6 +41718,7 @@ export interface SynonymsPutSynonymRequest extends RequestBase {
40274
41718
  [key: string]: any;
40275
41719
  } & {
40276
41720
  id?: never;
41721
+ refresh?: never;
40277
41722
  synonyms_set?: never;
40278
41723
  });
40279
41724
  /** All values in `querystring` will be added to the request querystring. */
@@ -40281,18 +41726,26 @@ export interface SynonymsPutSynonymRequest extends RequestBase {
40281
41726
  [key: string]: any;
40282
41727
  } & {
40283
41728
  id?: never;
41729
+ refresh?: never;
40284
41730
  synonyms_set?: never;
40285
41731
  };
40286
41732
  }
40287
41733
  export interface SynonymsPutSynonymResponse {
41734
+ /** The update operation result. */
40288
41735
  result: Result;
40289
- reload_analyzers_details: IndicesReloadSearchAnalyzersReloadResult;
41736
+ /** Updating a synonyms set can reload the associated analyzers in case refresh is set to true.
41737
+ * This information is the analyzers reloading result. */
41738
+ reload_analyzers_details?: IndicesReloadSearchAnalyzersReloadResult;
40290
41739
  }
40291
41740
  export interface SynonymsPutSynonymRuleRequest extends RequestBase {
40292
41741
  /** The ID of the synonym set. */
40293
41742
  set_id: Id;
40294
41743
  /** The ID of the synonym rule to be updated or created. */
40295
41744
  rule_id: Id;
41745
+ /** If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.
41746
+ * If `false`, analyzers will not be reloaded with the new synonym rule
41747
+ * @remarks This property is not supported on Elastic Cloud Serverless. */
41748
+ refresh?: boolean;
40296
41749
  /** The synonym rule information definition, which must be in Solr format. */
40297
41750
  synonyms: SynonymsSynonymString;
40298
41751
  /** All values in `body` will be added to the request body. */
@@ -40301,6 +41754,7 @@ export interface SynonymsPutSynonymRuleRequest extends RequestBase {
40301
41754
  } & {
40302
41755
  set_id?: never;
40303
41756
  rule_id?: never;
41757
+ refresh?: never;
40304
41758
  synonyms?: never;
40305
41759
  });
40306
41760
  /** All values in `querystring` will be added to the request querystring. */
@@ -40309,6 +41763,7 @@ export interface SynonymsPutSynonymRuleRequest extends RequestBase {
40309
41763
  } & {
40310
41764
  set_id?: never;
40311
41765
  rule_id?: never;
41766
+ refresh?: never;
40312
41767
  synonyms?: never;
40313
41768
  };
40314
41769
  }
@@ -43067,7 +44522,7 @@ export interface SpecUtilsCommonQueryParameters {
43067
44522
  filter_path?: string | string[];
43068
44523
  /** When set to `true` will return statistics in a format suitable for humans.
43069
44524
  * For example `"exists_time": "1h"` for humans and
43070
- * `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
44525
+ * `"exists_time_in_millis": 3600000` for computers. When disabled the human
43071
44526
  * readable values will be omitted. This makes sense for responses being consumed
43072
44527
  * only by machines. */
43073
44528
  human?: boolean;
@@ -43075,6 +44530,8 @@ export interface SpecUtilsCommonQueryParameters {
43075
44530
  * this option for debugging only. */
43076
44531
  pretty?: boolean;
43077
44532
  }
44533
+ export interface SpecUtilsOverloadOf<TDefinition = unknown> {
44534
+ }
43078
44535
  export interface SpecUtilsCommonCatQueryParameters {
43079
44536
  /** Specifies the format to return the columnar data in, can be set to
43080
44537
  * `text`, `json`, `cbor`, `yaml`, or `smile`. */
@@ -43085,5 +44542,3 @@ export interface SpecUtilsCommonCatQueryParameters {
43085
44542
  /** When set to `true` will enable verbose output. */
43086
44543
  v?: boolean;
43087
44544
  }
43088
- export interface SpecUtilsOverloadOf<TDefinition = unknown> {
43089
- }