Fixes to shared types

2024-11-20 14:30:28 -06:00
parent 70a3ef44bb
commit 6c8d6e71cd
5 changed files with 147 additions and 1807 deletions
--- a/docs/reference-main-index.asciidoc
+++ b/docs/reference-main-index.asciidoc
@ -529,9 +529,9 @@ include::reference-watcher-stop.asciidoc[]
 include::reference-watcher-update_settings.asciidoc[]
 include::reference-xpack-info.asciidoc[]
 include::reference-xpack-usage.asciidoc[]
-include::reference-shared-types-_global.asciidoc[]
-include::reference-shared-types-_global.asciidoc[]
-include::reference-shared-types-_global.asciidoc[]
+include::reference-shared-types-knn_search.asciidoc[]
+include::reference-shared-types-search.asciidoc[]
+include::reference-shared-types-search_mvt.asciidoc[]
 include::reference-shared-types-async_search.asciidoc[]
 include::reference-shared-types-autoscaling.asciidoc[]
 include::reference-shared-types-cat.asciidoc[]
@ -587,7 +587,6 @@ include::reference-shared-types-health_report.asciidoc[]
 include::reference-shared-types-index.asciidoc[]
 include::reference-shared-types-info.asciidoc[]
 include::reference-shared-types-knn_search.asciidoc[]
-include::reference-shared-types-knn_search.asciidoc[]
 include::reference-shared-types-mget.asciidoc[]
 include::reference-shared-types-msearch.asciidoc[]
 include::reference-shared-types-msearch_template.asciidoc[]
@ -602,8 +601,6 @@ include::reference-shared-types-render_search_template.asciidoc[]
 include::reference-shared-types-scripts_painless_execute.asciidoc[]
 include::reference-shared-types-scroll.asciidoc[]
 include::reference-shared-types-search.asciidoc[]
-include::reference-shared-types-search.asciidoc[]
-include::reference-shared-types-search_mvt.asciidoc[]
 include::reference-shared-types-search_mvt.asciidoc[]
 include::reference-shared-types-search_shards.asciidoc[]
 include::reference-shared-types-search_template.asciidoc[]
--- a/docs/reference-shared-types-_global.asciidoc
+++ b/docs/reference-shared-types-_global.asciidoc
--- a/docs/reference-shared-types-knn_search.asciidoc
+++ b/docs/reference-shared-types-knn_search.asciidoc
@ -31,28 +31,37 @@


 [discrete]
-[[KnnSearchQuery]]
-=== KnnSearchQuery
+[[KnnSearchRequest]]
+=== KnnSearchRequest

 [pass]
 ++++
 <pre>
 ++++
-interface KnnSearchQuery {
-  pass:[/**] @property field The name of the vector field to search against */
-  field: <<Field>>
-  pass:[/**] @property query_vector The query vector */
-  query_vector: <<QueryVector>>
-  pass:[/**] @property k The final number of nearest neighbors to return as top hits */
-  k: <<integer>>
-  pass:[/**] @property num_candidates The number of nearest neighbor candidates to consider per shard */
-  num_candidates: <<integer>>
+interface KnnSearchRequest extends <<RequestBase>> {
+  index: <<Indices>>
+  routing?: <<Routing>>
+  _source?: <<SearchSourceConfig>>
+  docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
+  stored_fields?: <<Fields>>
+  fields?: <<Fields>>
+  filter?: <<QueryDslQueryContainer>> | <<QueryDslQueryContainer>>[]
+  knn: <<KnnSearchQuery>>
 }
 [pass]
 ++++
 </pre>
 ++++
-<TDocument = unknown> {
+
+[discrete]
+[[KnnSearchResponse]]
+=== KnnSearchResponse
+
+[pass]
++++
+<pre>
++++
+interface KnnSearchResponse<TDocument = unknown> {
  took: <<long>>
  timed_out: boolean
  _shards: <<ShardStatistics>>
--- a/docs/reference-shared-types-search.asciidoc
+++ b/docs/reference-shared-types-search.asciidoc
@ -31,26 +31,82 @@


 [discrete]
-[[SearchAggregationBreakdown]]
-=== SearchAggregationBreakdown
+[[SearchRequest]]
+=== SearchRequest

 [pass]
 ++++
 <pre>
 ++++
-interface SearchAggregationBreakdown {
-  build_aggregation: <<long>>
-  build_aggregation_count: <<long>>
-  build_leaf_collector: <<long>>
-  build_leaf_collector_count: <<long>>
-  collect: <<long>>
-  collect_count: <<long>>
-  initialize: <<long>>
-  initialize_count: <<long>>
-  post_collection?: <<long>>
-  post_collection_count?: <<long>>
-  reduce: <<long>>
-  reduce_count: <<long>>
+interface SearchRequest extends <<RequestBase>> {
+  index?: <<Indices>>
+  allow_no_indices?: boolean
+  allow_partial_search_results?: boolean
+  analyzer?: string
+  analyze_wildcard?: boolean
+  batched_reduce_size?: <<long>>
+  ccs_minimize_roundtrips?: boolean
+  default_operator?: <<QueryDslOperator>>
+  df?: string
+  expand_wildcards?: <<ExpandWildcards>>
+  ignore_throttled?: boolean
+  ignore_unavailable?: boolean
+  include_named_queries_score?: boolean
+  lenient?: boolean
+  max_concurrent_shard_requests?: <<long>>
+  min_compatible_shard_node?: <<VersionString>>
+  preference?: string
+  pre_filter_shard_size?: <<long>>
+  request_cache?: boolean
+  routing?: <<Routing>>
+  scroll?: <<Duration>>
+  search_type?: <<SearchType>>
+  suggest_field?: <<Field>>
+  suggest_mode?: <<SuggestMode>>
+  suggest_size?: <<long>>
+  suggest_text?: string
+  typed_keys?: boolean
+  rest_total_hits_as_int?: boolean
+  _source_excludes?: <<Fields>>
+  _source_includes?: <<Fields>>
+  q?: string
+  force_synthetic_source?: boolean
+  aggregations?: Record<string, <<AggregationsAggregationContainer>>>
+  pass:[/**] @alias aggregations */
+  aggs?: Record<string, <<AggregationsAggregationContainer>>>
+  collapse?: <<SearchFieldCollapse>>
+  explain?: boolean
+  ext?: Record<string, any>
+  from?: <<integer>>
+  highlight?: <<SearchHighlight>>
+  track_total_hits?: <<SearchTrackHits>>
+  indices_boost?: Record<<<IndexName>>, <<double>>>[]
+  docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
+  knn?: <<KnnSearch>> | <<KnnSearch>>[]
+  rank?: <<RankContainer>>
+  min_score?: <<double>>
+  post_filter?: <<QueryDslQueryContainer>>
+  profile?: boolean
+  query?: <<QueryDslQueryContainer>>
+  rescore?: <<SearchRescore>> | <<SearchRescore>>[]
+  retriever?: <<RetrieverContainer>>
+  script_fields?: Record<string, <<ScriptField>>>
+  search_after?: <<SortResults>>
+  size?: <<integer>>
+  slice?: <<SlicedScroll>>
+  sort?: <<Sort>>
+  _source?: <<SearchSourceConfig>>
+  fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
+  suggest?: <<SearchSuggester>>
+  terminate_after?: <<long>>
+  timeout?: string
+  track_scores?: boolean
+  version?: boolean
+  seq_no_primary_term?: boolean
+  stored_fields?: <<Fields>>
+  pit?: <<SearchPointInTimeReference>>
+  runtime_mappings?: <<MappingRuntimeFields>>
+  stats?: string[]
 }
 [pass]
 ++++
@ -58,136 +114,48 @@ interface SearchAggregationBreakdown {
 ++++

 [discrete]
-[[SearchAggregationProfile]]
-=== SearchAggregationProfile
+[[SearchResponse]]
+=== SearchResponse

 [pass]
 ++++
 <pre>
 ++++
-interface SearchAggregationProfile {
-  breakdown: <<SearchAggregationBreakdown>>
-  description: string
-  time_in_nanos: <<DurationValue>><<<UnitNanos>>>
-  type: string
-  debug?: <<SearchAggregationProfileDebug>>
-  children?: <<SearchAggregationProfile>>[]
+type SearchResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<SearchResponseBody>><TDocument, TAggregations>
+[pass]
++++
+</pre>
++++
+
+[discrete]
+[[SearchResponseBody]]
+=== SearchResponseBody
+
+[pass]
++++
+<pre>
++++
+interface SearchResponseBody<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> {
+  took: <<long>>
+  timed_out: boolean
+  _shards: <<ShardStatistics>>
+  hits: <<SearchHitsMetadata>><TDocument>
+  aggregations?: TAggregations
+  _clusters?: <<ClusterStatistics>>
+  fields?: Record<string, any>
+  max_score?: <<double>>
+  num_reduce_phases?: <<long>>
+  profile?: <<SearchProfile>>
+  pit_id?: <<Id>>
+  _scroll_id?: <<ScrollId>>
+  suggest?: Record<<<SuggestionName>>, <<SearchSuggest>><TDocument>[]>
+  terminated_early?: boolean
 }
 [pass]
 ++++
 </pre>
 ++++
-
-[discrete]
-[[SearchAggregationProfileDebug]]
-=== SearchAggregationProfileDebug
-
-[pass]
-++++
-<pre>
-++++
-interface SearchAggregationProfileDebug {
-  segments_with_multi_valued_ords?: <<integer>>
-  collection_strategy?: string
-  segments_with_single_valued_ords?: <<integer>>
-  total_buckets?: <<integer>>
-  built_buckets?: <<integer>>
-  result_strategy?: string
-  has_filter?: boolean
-  delegate?: string
-  delegate_debug?: <<SearchAggregationProfileDebug>>
-  chars_fetched?: <<integer>>
-  extract_count?: <<integer>>
-  extract_ns?: <<integer>>
-  values_fetched?: <<integer>>
-  collect_analyzed_ns?: <<integer>>
-  collect_analyzed_count?: <<integer>>
-  surviving_buckets?: <<integer>>
-  ordinals_collectors_used?: <<integer>>
-  ordinals_collectors_overhead_too_high?: <<integer>>
-  string_hashing_collectors_used?: <<integer>>
-  numeric_collectors_used?: <<integer>>
-  empty_collectors_used?: <<integer>>
-  deferred_aggregators?: string[]
-  segments_with_doc_count_field?: <<integer>>
-  segments_with_deleted_docs?: <<integer>>
-  filters?: <<SearchAggregationProfileDelegateDebugFilter>>[]
-  segments_counted?: <<integer>>
-  segments_collected?: <<integer>>
-  map_reducer?: string
-  brute_force_used?: <<integer>>
-  dynamic_pruning_attempted?: <<integer>>
-  dynamic_pruning_used?: <<integer>>
-  skipped_due_to_no_data?: <<integer>>
-}
-[pass]
-++++
-</pre>
-++++
-
-[discrete]
-[[SearchAggregationProfileDelegateDebugFilter]]
-=== SearchAggregationProfileDelegateDebugFilter
-
-[pass]
-++++
-<pre>
-++++
-interface SearchAggregationProfileDelegateDebugFilter {
-  results_from_metadata?: <<integer>>
-  query?: string
-  specialized_for?: string
-  segments_counted_in_constant_time?: <<integer>>
-}
-[pass]
-++++
-</pre>
-++++
-
-[discrete]
-[[SearchBoundaryScanner]]
-=== SearchBoundaryScanner
-
-[pass]
-++++
-<pre>
-++++
-type SearchBoundaryScanner = 'chars' | 'sentence' | 'word'
-[pass]
-++++
-</pre>
-++++
-
-[discrete]
-[[SearchCollector]]
-=== SearchCollector
-
-[pass]
-++++
-<pre>
-++++
-interface SearchCollector {
-  name: string
-  reason: string
-  time_in_nanos: <<DurationValue>><<<UnitNanos>>>
-  children?: <<SearchCollector>>[]
-}
-[pass]
-++++
-</pre>
-++++
-
-[discrete]
-[[SearchCompletionContext]]
-=== SearchCompletionContext
-
-[pass]
-++++
-<pre>
-++++
-interface SearchCompletionContext {
-  pass:[/**] @property boost The factor by which the score of the suggestion should be boosted. The score is computed by multiplying the boost with the suggestion weight. */
-  boost?: <<double>>
+ <<double>>
  pass:[/**] @property context The value of the category to filter/boost on. */
  context: <<SearchContext>>
  pass:[/**] @property neighbours An array of precision values at which neighboring geohashes should be taken into account. Precision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash precision (`1`..`12`). Defaults to generating neighbors for index time precision level. */
--- a/docs/reference-shared-types-search_mvt.asciidoc
+++ b/docs/reference-shared-types-search_mvt.asciidoc
@ -31,61 +31,31 @@


 [discrete]
-[[SearchMvtCoordinate]]
-=== SearchMvtCoordinate
+[[SearchMvtRequest]]
+=== SearchMvtRequest

 [pass]
 ++++
 <pre>
 ++++
-type SearchMvtCoordinate = <<integer>>
-[pass]
-++++
-</pre>
-++++
-
-[discrete]
-[[SearchMvtGridAggregationType]]
-=== SearchMvtGridAggregationType
-
-[pass]
-++++
-<pre>
-++++
-type SearchMvtGridAggregationType = 'geotile' | 'geohex'
-[pass]
-++++
-</pre>
-++++
-
-[discrete]
-[[SearchMvtGridType]]
-=== SearchMvtGridType
-
-[pass]
-++++
-<pre>
-++++
-type SearchMvtGridType = 'grid' | 'point' | 'centroid'
-[pass]
-++++
-</pre>
-++++
-
-[discrete]
-[[SearchMvtZoomLevel]]
-=== SearchMvtZoomLevel
-
-[pass]
-++++
-<pre>
-++++
-type SearchMvtZoomLevel = <<integer>>
-[pass]
-++++
-</pre>
-++++
- sort?: <<Sort>>
+interface SearchMvtRequest extends <<RequestBase>> {
+  index: <<Indices>>
+  field: <<Field>>
+  zoom: <<SearchMvtZoomLevel>>
+  x: <<SearchMvtCoordinate>>
+  y: <<SearchMvtCoordinate>>
+  aggs?: Record<string, <<AggregationsAggregationContainer>>>
+  buffer?: <<integer>>
+  exact_bounds?: boolean
+  extent?: <<integer>>
+  fields?: <<Fields>>
+  grid_agg?: <<SearchMvtGridAggregationType>>
+  grid_precision?: <<integer>>
+  grid_type?: <<SearchMvtGridType>>
+  query?: <<QueryDslQueryContainer>>
+  runtime_mappings?: <<MappingRuntimeFields>>
+  size?: <<integer>>
+  sort?: <<Sort>>
  track_total_hits?: <<SearchTrackHits>>
  with_labels?: boolean
 }