Fix duplicate includes
This commit is contained in:
Josh Mock
@ -529,86 +529,86 @@ 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-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[]
|
||||
include::reference-shared-types-ccr.asciidoc[]
|
||||
include::reference-shared-types-cluster.asciidoc[]
|
||||
include::reference-shared-types-connector.asciidoc[]
|
||||
include::reference-shared-types-enrich.asciidoc[]
|
||||
include::reference-shared-types-eql.asciidoc[]
|
||||
include::reference-shared-types-esql.asciidoc[]
|
||||
include::reference-shared-types-features.asciidoc[]
|
||||
include::reference-shared-types-fleet.asciidoc[]
|
||||
include::reference-shared-types-graph.asciidoc[]
|
||||
include::reference-shared-types-ilm.asciidoc[]
|
||||
include::reference-shared-types-indices.asciidoc[]
|
||||
include::reference-shared-types-indices.asciidoc[]
|
||||
include::reference-shared-types-inference.asciidoc[]
|
||||
include::reference-shared-types-ingest.asciidoc[]
|
||||
include::reference-shared-types-license.asciidoc[]
|
||||
include::reference-shared-types-logstash.asciidoc[]
|
||||
include::reference-shared-types-ml.asciidoc[]
|
||||
include::reference-shared-types-nodes.asciidoc[]
|
||||
include::reference-shared-types-query_rules.asciidoc[]
|
||||
include::reference-shared-types-rollup.asciidoc[]
|
||||
include::reference-shared-types-search_application.asciidoc[]
|
||||
include::reference-shared-types-searchable_snapshots.asciidoc[]
|
||||
include::reference-shared-types-security.asciidoc[]
|
||||
include::reference-shared-types-shutdown.asciidoc[]
|
||||
include::reference-shared-types-slm.asciidoc[]
|
||||
include::reference-shared-types-snapshot.asciidoc[]
|
||||
include::reference-shared-types-synonyms.asciidoc[]
|
||||
include::reference-shared-types-tasks.asciidoc[]
|
||||
include::reference-shared-types-transform.asciidoc[]
|
||||
include::reference-shared-types-watcher.asciidoc[]
|
||||
include::reference-shared-types-bulk.asciidoc[]
|
||||
include::reference-shared-types-clear_scroll.asciidoc[]
|
||||
include::reference-shared-types-close_point_in_time.asciidoc[]
|
||||
include::reference-shared-types-count.asciidoc[]
|
||||
include::reference-shared-types-create.asciidoc[]
|
||||
include::reference-shared-types-delete.asciidoc[]
|
||||
include::reference-shared-types-delete_by_query.asciidoc[]
|
||||
include::reference-shared-types-delete_by_query_rethrottle.asciidoc[]
|
||||
include::reference-shared-types-delete_script.asciidoc[]
|
||||
include::reference-shared-types-exists.asciidoc[]
|
||||
include::reference-shared-types-exists_source.asciidoc[]
|
||||
include::reference-shared-types-explain.asciidoc[]
|
||||
include::reference-shared-types-field_caps.asciidoc[]
|
||||
include::reference-shared-types-get.asciidoc[]
|
||||
include::reference-shared-types-get_script.asciidoc[]
|
||||
include::reference-shared-types-get_script_context.asciidoc[]
|
||||
include::reference-shared-types-get_script_languages.asciidoc[]
|
||||
include::reference-shared-types-get_source.asciidoc[]
|
||||
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-mget.asciidoc[]
|
||||
include::reference-shared-types-msearch.asciidoc[]
|
||||
include::reference-shared-types-msearch_template.asciidoc[]
|
||||
include::reference-shared-types-mtermvectors.asciidoc[]
|
||||
include::reference-shared-types-open_point_in_time.asciidoc[]
|
||||
include::reference-shared-types-ping.asciidoc[]
|
||||
include::reference-shared-types-put_script.asciidoc[]
|
||||
include::reference-shared-types-rank_eval.asciidoc[]
|
||||
include::reference-shared-types-reindex.asciidoc[]
|
||||
include::reference-shared-types-reindex_rethrottle.asciidoc[]
|
||||
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_mvt.asciidoc[]
|
||||
include::reference-shared-types-search_shards.asciidoc[]
|
||||
include::reference-shared-types-search_template.asciidoc[]
|
||||
include::reference-shared-types-terms_enum.asciidoc[]
|
||||
include::reference-shared-types-termvectors.asciidoc[]
|
||||
include::reference-shared-types-update.asciidoc[]
|
||||
include::reference-shared-types-update_by_query.asciidoc[]
|
||||
include::reference-shared-types-update_by_query_rethrottle.asciidoc[]
|
||||
include::reference-shared-types--global-knn-search-types.asciidoc[]
|
||||
include::reference-shared-types--global-search-types.asciidoc[]
|
||||
include::reference-shared-types--global-search-mvt-types.asciidoc[]
|
||||
include::reference-shared-types-async-search-types.asciidoc[]
|
||||
include::reference-shared-types-autoscaling-types.asciidoc[]
|
||||
include::reference-shared-types-cat-types.asciidoc[]
|
||||
include::reference-shared-types-ccr-types.asciidoc[]
|
||||
include::reference-shared-types-cluster-types.asciidoc[]
|
||||
include::reference-shared-types-connector-types.asciidoc[]
|
||||
include::reference-shared-types-enrich-types.asciidoc[]
|
||||
include::reference-shared-types-eql-types.asciidoc[]
|
||||
include::reference-shared-types-esql-types.asciidoc[]
|
||||
include::reference-shared-types-features-types.asciidoc[]
|
||||
include::reference-shared-types-fleet-types.asciidoc[]
|
||||
include::reference-shared-types-graph-types.asciidoc[]
|
||||
include::reference-shared-types-ilm-types.asciidoc[]
|
||||
include::reference-shared-types-indices-types.asciidoc[]
|
||||
include::reference-shared-types-indices-forcemerge-types.asciidoc[]
|
||||
include::reference-shared-types-inference-types.asciidoc[]
|
||||
include::reference-shared-types-ingest-types.asciidoc[]
|
||||
include::reference-shared-types-license-types.asciidoc[]
|
||||
include::reference-shared-types-logstash-types.asciidoc[]
|
||||
include::reference-shared-types-ml-types.asciidoc[]
|
||||
include::reference-shared-types-nodes-types.asciidoc[]
|
||||
include::reference-shared-types-query-rules-types.asciidoc[]
|
||||
include::reference-shared-types-rollup-types.asciidoc[]
|
||||
include::reference-shared-types-search-application-types.asciidoc[]
|
||||
include::reference-shared-types-searchable-snapshots-types.asciidoc[]
|
||||
include::reference-shared-types-security-types.asciidoc[]
|
||||
include::reference-shared-types-shutdown-types.asciidoc[]
|
||||
include::reference-shared-types-slm-types.asciidoc[]
|
||||
include::reference-shared-types-snapshot-types.asciidoc[]
|
||||
include::reference-shared-types-synonyms-types.asciidoc[]
|
||||
include::reference-shared-types-tasks-types.asciidoc[]
|
||||
include::reference-shared-types-transform-types.asciidoc[]
|
||||
include::reference-shared-types-watcher-types.asciidoc[]
|
||||
include::reference-shared-types--global-bulk.asciidoc[]
|
||||
include::reference-shared-types--global-clear-scroll.asciidoc[]
|
||||
include::reference-shared-types--global-close-point-in-time.asciidoc[]
|
||||
include::reference-shared-types--global-count.asciidoc[]
|
||||
include::reference-shared-types--global-create.asciidoc[]
|
||||
include::reference-shared-types--global-delete.asciidoc[]
|
||||
include::reference-shared-types--global-delete-by-query.asciidoc[]
|
||||
include::reference-shared-types--global-delete-by-query-rethrottle.asciidoc[]
|
||||
include::reference-shared-types--global-delete-script.asciidoc[]
|
||||
include::reference-shared-types--global-exists.asciidoc[]
|
||||
include::reference-shared-types--global-exists-source.asciidoc[]
|
||||
include::reference-shared-types--global-explain.asciidoc[]
|
||||
include::reference-shared-types--global-field-caps.asciidoc[]
|
||||
include::reference-shared-types--global-get.asciidoc[]
|
||||
include::reference-shared-types--global-get-script.asciidoc[]
|
||||
include::reference-shared-types--global-get-script-context.asciidoc[]
|
||||
include::reference-shared-types--global-get-script-languages.asciidoc[]
|
||||
include::reference-shared-types--global-get-source.asciidoc[]
|
||||
include::reference-shared-types--global-health-report.asciidoc[]
|
||||
include::reference-shared-types--global-index.asciidoc[]
|
||||
include::reference-shared-types--global-info.asciidoc[]
|
||||
include::reference-shared-types--global-knn-search.asciidoc[]
|
||||
include::reference-shared-types--global-mget.asciidoc[]
|
||||
include::reference-shared-types--global-msearch.asciidoc[]
|
||||
include::reference-shared-types--global-msearch-template.asciidoc[]
|
||||
include::reference-shared-types--global-mtermvectors.asciidoc[]
|
||||
include::reference-shared-types--global-open-point-in-time.asciidoc[]
|
||||
include::reference-shared-types--global-ping.asciidoc[]
|
||||
include::reference-shared-types--global-put-script.asciidoc[]
|
||||
include::reference-shared-types--global-rank-eval.asciidoc[]
|
||||
include::reference-shared-types--global-reindex.asciidoc[]
|
||||
include::reference-shared-types--global-reindex-rethrottle.asciidoc[]
|
||||
include::reference-shared-types--global-render-search-template.asciidoc[]
|
||||
include::reference-shared-types--global-scripts-painless-execute.asciidoc[]
|
||||
include::reference-shared-types--global-scroll.asciidoc[]
|
||||
include::reference-shared-types--global-search.asciidoc[]
|
||||
include::reference-shared-types--global-search-mvt.asciidoc[]
|
||||
include::reference-shared-types--global-search-shards.asciidoc[]
|
||||
include::reference-shared-types--global-search-template.asciidoc[]
|
||||
include::reference-shared-types--global-terms-enum.asciidoc[]
|
||||
include::reference-shared-types--global-termvectors.asciidoc[]
|
||||
include::reference-shared-types--global-update.asciidoc[]
|
||||
include::reference-shared-types--global-update-by-query.asciidoc[]
|
||||
include::reference-shared-types--global-update-by-query-rethrottle.asciidoc[]
|
||||
|
||||
|
||||
* <<client.asyncSearch.delete>>
|
||||
|
||||
@ -0,0 +1,54 @@
|
||||
[[reference-shared-types-knn_search]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||||
|| You should update the script that does the generation, which can be found in: ||
|
||||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||||
|| ||
|
||||
|| You can run the script with the following command: ||
|
||||
|| npm run elasticsearch -- --version <version> ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
===========================================================================================================================
|
||||
////////
|
||||
|
||||
|
||||
|
||||
== Shared KnnSearch types
|
||||
|
||||
|
||||
[discrete]
|
||||
[[KnnSearchQuery]]
|
||||
=== KnnSearchQuery
|
||||
|
||||
[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>>
|
||||
}
|
||||
[pass]
|
||||
++++
|
||||
</pre>
|
||||
++++
|
||||
@ -0,0 +1,87 @@
|
||||
[[reference-shared-types-search_mvt]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||||
|| You should update the script that does the generation, which can be found in: ||
|
||||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||||
|| ||
|
||||
|| You can run the script with the following command: ||
|
||||
|| npm run elasticsearch -- --version <version> ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
===========================================================================================================================
|
||||
////////
|
||||
|
||||
|
||||
|
||||
== Shared SearchMvt types
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SearchMvtCoordinate]]
|
||||
=== SearchMvtCoordinate
|
||||
|
||||
[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>
|
||||
++++
|
||||
@ -31,82 +31,26 @@
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SearchRequest]]
|
||||
=== SearchRequest
|
||||
[[SearchAggregationBreakdown]]
|
||||
=== SearchAggregationBreakdown
|
||||
|
||||
[pass]
|
||||
++++
|
||||
<pre>
|
||||
++++
|
||||
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[]
|
||||
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>>
|
||||
}
|
||||
[pass]
|
||||
++++
|
||||
@ -114,48 +58,136 @@ interface SearchRequest extends <<RequestBase>> {
|
||||
++++
|
||||
|
||||
[discrete]
|
||||
[[SearchResponse]]
|
||||
=== SearchResponse
|
||||
[[SearchAggregationProfile]]
|
||||
=== SearchAggregationProfile
|
||||
|
||||
[pass]
|
||||
++++
|
||||
<pre>
|
||||
++++
|
||||
type SearchResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<SearchResponseBody>><TDocument, TAggregations>
|
||||
interface SearchAggregationProfile {
|
||||
breakdown: <<SearchAggregationBreakdown>>
|
||||
description: string
|
||||
time_in_nanos: <<DurationValue>><<<UnitNanos>>>
|
||||
type: string
|
||||
debug?: <<SearchAggregationProfileDebug>>
|
||||
children?: <<SearchAggregationProfile>>[]
|
||||
}
|
||||
[pass]
|
||||
++++
|
||||
</pre>
|
||||
++++
|
||||
|
||||
[discrete]
|
||||
[[SearchResponseBody]]
|
||||
=== SearchResponseBody
|
||||
[[SearchAggregationProfileDebug]]
|
||||
=== SearchAggregationProfileDebug
|
||||
|
||||
[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
|
||||
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>
|
||||
++++
|
||||
<<double>>
|
||||
|
||||
[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>>
|
||||
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. */
|
||||
157
docs/reference-shared-types--global-search.asciidoc
Normal file
157
docs/reference-shared-types--global-search.asciidoc
Normal file
@ -0,0 +1,157 @@
|
||||
[[reference-shared-types-search]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||||
|| You should update the script that does the generation, which can be found in: ||
|
||||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||||
|| ||
|
||||
|| You can run the script with the following command: ||
|
||||
|| npm run elasticsearch -- --version <version> ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
===========================================================================================================================
|
||||
////////
|
||||
|
||||
|
||||
|
||||
== Shared Search types
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SearchRequest]]
|
||||
=== SearchRequest
|
||||
|
||||
[pass]
|
||||
++++
|
||||
<pre>
|
||||
++++
|
||||
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]
|
||||
++++
|
||||
</pre>
|
||||
++++
|
||||
|
||||
[discrete]
|
||||
[[SearchResponse]]
|
||||
=== SearchResponse
|
||||
|
||||
[pass]
|
||||
++++
|
||||
<pre>
|
||||
++++
|
||||
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>
|
||||
++++
|
||||
@ -0,0 +1,48 @@
|
||||
[[reference-shared-types-indices]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||||
|| You should update the script that does the generation, which can be found in: ||
|
||||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||||
|| ||
|
||||
|| You can run the script with the following command: ||
|
||||
|| npm run elasticsearch -- --version <version> ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
===========================================================================================================================
|
||||
////////
|
||||
|
||||
|
||||
|
||||
== Shared Indices types
|
||||
|
||||
|
||||
[discrete]
|
||||
[[IndicesForceMergeResponseBody]]
|
||||
=== IndicesForceMergeResponseBody
|
||||
|
||||
[pass]
|
||||
++++
|
||||
<pre>
|
||||
++++
|
||||
interface IndicesForcemergeForceMergeResponseBody extends <<ShardsOperationResponseBase>> {
|
||||
pass:[/**] @property task task contains a task id returned when wait_for_completion=false, you can use the task_id to get the status of the task at _tasks/<task_id> */
|
||||
task?: string
|
||||
}
|
||||
[pass]
|
||||
++++
|
||||
</pre>
|
||||
++++
|
||||
@ -31,22 +31,18 @@
|
||||
|
||||
|
||||
[discrete]
|
||||
[[IndicesForceMergeResponseBody]]
|
||||
=== IndicesForceMergeResponseBody
|
||||
[[IndicesAlias]]
|
||||
=== IndicesAlias
|
||||
|
||||
[pass]
|
||||
++++
|
||||
<pre>
|
||||
++++
|
||||
interface IndicesForcemergeForceMergeResponseBody extends <<ShardsOperationResponseBase>> {
|
||||
pass:[/**] @property task task contains a task id returned when wait_for_completion=false, you can use the task_id to get the status of the task at _tasks/<task_id> */
|
||||
task?: string
|
||||
}
|
||||
[pass]
|
||||
++++
|
||||
</pre>
|
||||
++++
|
||||
uting?: <<Routing>>
|
||||
interface IndicesAlias {
|
||||
pass:[/**] @property filter <<Query>> used to limit documents the alias can access. */
|
||||
filter?: <<QueryDslQueryContainer>>
|
||||
pass:[/**] @property index_routing Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. */
|
||||
index_routing?: <<Routing>>
|
||||
pass:[/**] @property is_hidden If `true`, the alias is hidden. All indices for the alias must have the same `is_hidden` value. */
|
||||
is_hidden?: boolean
|
||||
pass:[/**] @property is_write_index If `true`, the index is the write index for the alias. */
|
||||
Reference in New Issue
Block a user