diff --git a/docs/reference/async_search.asciidoc b/docs/reference/async_search.asciidoc index 6baac8c6d..b113daa72 100644 --- a/docs/reference/async_search.asciidoc +++ b/docs/reference/async_search.asciidoc @@ -133,6 +133,7 @@ Get the async search status. Get the status of a previously submitted async sear ---- interface AsyncSearchStatusRequest extends <> { id: <> + keep_alive?: <> } ---- @@ -172,7 +173,6 @@ interface AsyncSearchSubmitRequest extends <> { index?: <> wait_for_completion_timeout?: <> keep_on_completion?: boolean - keep_alive?: <> allow_no_indices?: boolean allow_partial_search_results?: boolean analyzer?: string @@ -186,12 +186,9 @@ interface AsyncSearchSubmitRequest extends <> { ignore_unavailable?: boolean lenient?: boolean max_concurrent_shard_requests?: <> - min_compatible_shard_node?: <> preference?: string - pre_filter_shard_size?: <> request_cache?: boolean routing?: <> - scroll?: <> search_type?: <> suggest_field?: <> suggest_mode?: <> diff --git a/docs/reference/autoscaling.asciidoc b/docs/reference/autoscaling.asciidoc index c6a35c641..a00108f46 100644 --- a/docs/reference/autoscaling.asciidoc +++ b/docs/reference/autoscaling.asciidoc @@ -56,6 +56,8 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by ---- interface AutoscalingDeleteAutoscalingPolicyRequest extends <> { name: <> + master_timeout?: <> + timeout?: <> } ---- @@ -91,7 +93,9 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by [source,ts,subs=+macros] ---- -interface AutoscalingGetAutoscalingCapacityRequest extends <> {} +interface AutoscalingGetAutoscalingCapacityRequest extends <> { + master_timeout?: <> +} ---- @@ -130,6 +134,7 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El ---- interface AutoscalingGetAutoscalingPolicyRequest extends <> { name: <> + master_timeout?: <> } ---- @@ -167,6 +172,8 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir ---- interface AutoscalingPutAutoscalingPolicyRequest extends <> { name: <> + master_timeout?: <> + timeout?: <> policy?: <> } diff --git a/docs/reference/cat.asciidoc b/docs/reference/cat.asciidoc index b250278bb..37fbca03c 100644 --- a/docs/reference/cat.asciidoc +++ b/docs/reference/cat.asciidoc @@ -76,7 +76,7 @@ type CatAliasesResponse = CatAliasesAliasesRecord[] [[client.cat.allocation]] == `client.cat.allocation()` -Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. +Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. {ref}/cat-allocation.html[{es} documentation] [discrete] @@ -95,6 +95,7 @@ Provides a snapshot of the number of shards allocated to each data node and thei interface CatAllocationRequest extends <> { node_id?: <> bytes?: <> + local?: boolean } ---- @@ -132,6 +133,7 @@ Get component templates. Returns information about component templates in a clus ---- interface CatComponentTemplatesRequest extends <> { name?: string + local?: boolean } ---- @@ -188,7 +190,7 @@ type CatCountResponse = CatCountCountRecord[] [[client.cat.fielddata]] == `client.cat.fielddata()` -Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API. +Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API. {ref}/cat-fielddata.html[{es} documentation] [discrete] @@ -226,7 +228,7 @@ type CatFielddataResponse = CatFielddataFielddataRecord[] [[client.cat.health]] == `client.cat.health()` -Returns the health status of a cluster, similar to the cluster health API. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time. +Get the cluster health status. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time. {ref}/cat-health.html[{es} documentation] [discrete] @@ -342,7 +344,7 @@ type CatIndicesResponse = CatIndicesIndicesRecord[] [[client.cat.master]] == `client.cat.master()` -Returns information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. +Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. {ref}/cat-master.html[{es} documentation] [discrete] @@ -358,7 +360,9 @@ Returns information about the master node, including the ID, bound IP address, a [source,ts,subs=+macros] ---- -interface CatMasterRequest extends <> {} +interface CatMasterRequest extends <> { + local?: boolean +} ---- @@ -545,7 +549,7 @@ type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[] [[client.cat.nodeattrs]] == `client.cat.nodeattrs()` -Returns information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. +Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. {ref}/cat-nodeattrs.html[{es} documentation] [discrete] @@ -561,7 +565,9 @@ Returns information about custom node attributes. IMPORTANT: cat APIs are only i [source,ts,subs=+macros] ---- -interface CatNodeattrsRequest extends <> {} +interface CatNodeattrsRequest extends <> { + local?: boolean +} ---- @@ -580,7 +586,7 @@ type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[] [[client.cat.nodes]] == `client.cat.nodes()` -Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. +Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. {ref}/cat-nodes.html[{es} documentation] [discrete] @@ -619,7 +625,7 @@ type CatNodesResponse = CatNodesNodesRecord[] [[client.cat.pendingTasks]] == `client.cat.pendingTasks()` -Returns cluster-level changes that have not yet been executed. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. +Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. {ref}/cat-pending-tasks.html[{es} documentation] [discrete] @@ -635,7 +641,9 @@ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat AP [source,ts,subs=+macros] ---- -interface CatPendingTasksRequest extends <> {} +interface CatPendingTasksRequest extends <> { + local?: boolean +} ---- @@ -654,7 +662,7 @@ type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[] [[client.cat.plugins]] == `client.cat.plugins()` -Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. +Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. {ref}/cat-plugins.html[{es} documentation] [discrete] @@ -670,7 +678,9 @@ Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs [source,ts,subs=+macros] ---- -interface CatPluginsRequest extends <> {} +interface CatPluginsRequest extends <> { + local?: boolean +} ---- @@ -689,7 +699,7 @@ type CatPluginsResponse = CatPluginsPluginsRecord[] [[client.cat.recovery]] == `client.cat.recovery()` -Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. +Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. {ref}/cat-recovery.html[{es} documentation] [discrete] @@ -729,7 +739,7 @@ type CatRecoveryResponse = CatRecoveryRecoveryRecord[] [[client.cat.repositories]] == `client.cat.repositories()` -Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API. +Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API. {ref}/cat-repositories.html[{es} documentation] [discrete] @@ -764,7 +774,7 @@ type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[] [[client.cat.segments]] == `client.cat.segments()` -Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API. +Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API. {ref}/cat-segments.html[{es} documentation] [discrete] @@ -783,6 +793,7 @@ Returns low-level information about the Lucene segments in index shards. For dat interface CatSegmentsRequest extends <> { index?: <> bytes?: <> + local?: boolean } ---- @@ -802,7 +813,7 @@ type CatSegmentsResponse = CatSegmentsSegmentsRecord[] [[client.cat.shards]] == `client.cat.shards()` -Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. +Get shard information. Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. {ref}/cat-shards.html[{es} documentation] [discrete] @@ -840,7 +851,7 @@ type CatShardsResponse = CatShardsShardsRecord[] [[client.cat.snapshots]] == `client.cat.snapshots()` -Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API. +Get snapshot information Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API. {ref}/cat-snapshots.html[{es} documentation] [discrete] @@ -878,7 +889,7 @@ type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[] [[client.cat.tasks]] == `client.cat.tasks()` -Returns information about tasks currently executing in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API. +Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API. {ref}/tasks.html[{es} documentation] [discrete] @@ -918,7 +929,7 @@ type CatTasksResponse = CatTasksTasksRecord[] [[client.cat.templates]] == `client.cat.templates()` -Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API. +Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API. {ref}/cat-templates.html[{es} documentation] [discrete] @@ -936,6 +947,7 @@ Returns information about index templates in a cluster. You can use index templa ---- interface CatTemplatesRequest extends <> { name?: <> + local?: boolean } ---- @@ -955,7 +967,7 @@ type CatTemplatesResponse = CatTemplatesTemplatesRecord[] [[client.cat.threadPool]] == `client.cat.threadPool()` -Returns thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. +Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. {ref}/cat-thread-pool.html[{es} documentation] [discrete] @@ -974,6 +986,7 @@ Returns thread pool statistics for each node in a cluster. Returned information interface CatThreadPoolRequest extends <> { thread_pool_patterns?: <> time?: <> + local?: boolean } ---- @@ -993,7 +1006,7 @@ type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[] [[client.cat.transforms]] == `client.cat.transforms()` -Get transforms. Returns configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API. +Get transform information. Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API. {ref}/cat-transforms.html[{es} documentation] [discrete] diff --git a/docs/reference/ccr.asciidoc b/docs/reference/ccr.asciidoc index 09d0319a0..2f118b898 100644 --- a/docs/reference/ccr.asciidoc +++ b/docs/reference/ccr.asciidoc @@ -94,18 +94,20 @@ Creates a new follower index configured to follow the referenced leader index. interface CcrFollowRequest extends <> { index: <> wait_for_active_shards?: <> - leader_index?: <> + data_stream_name?: string + leader_index: <> max_outstanding_read_requests?: <> - max_outstanding_write_requests?: <> - max_read_request_operation_count?: <> - max_read_request_size?: string + max_outstanding_write_requests?: <> + max_read_request_operation_count?: <> + max_read_request_size?: <> max_retry_delay?: <> - max_write_buffer_count?: <> - max_write_buffer_size?: string - max_write_request_operation_count?: <> - max_write_request_size?: string + max_write_buffer_count?: <> + max_write_buffer_size?: <> + max_write_request_operation_count?: <> + max_write_request_size?: <> read_poll_timeout?: <> - remote_cluster?: string + remote_cluster: string + settings?: <> } ---- diff --git a/docs/reference/count.asciidoc b/docs/reference/count.asciidoc index b4832a36d..1c5c8c273 100644 --- a/docs/reference/count.asciidoc +++ b/docs/reference/count.asciidoc @@ -38,7 +38,7 @@ [[client.count]] == `client.count()` -Returns number of documents matching a query. +Count search results. Get the number of documents matching a query. {ref}/search-count.html[{es} documentation] [discrete] diff --git a/docs/reference/enrich.asciidoc b/docs/reference/enrich.asciidoc index 09ec1575a..cee45125e 100644 --- a/docs/reference/enrich.asciidoc +++ b/docs/reference/enrich.asciidoc @@ -75,7 +75,7 @@ type EnrichDeletePolicyResponse = <> [[client.enrich.executePolicy]] == `client.enrich.executePolicy()` -Creates the enrich index for an existing enrich policy. +Run an enrich policy. Create the enrich index for an existing enrich policy. {ref}/execute-enrich-policy-api.html[{es} documentation] [discrete] diff --git a/docs/reference/eql.asciidoc b/docs/reference/eql.asciidoc index be1ff41e0..0fd421af5 100644 --- a/docs/reference/eql.asciidoc +++ b/docs/reference/eql.asciidoc @@ -38,7 +38,7 @@ [[client.eql.delete]] == `client.eql.delete()` -Deletes an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. +Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. {ref}/eql-search-api.html[{es} documentation] [discrete] @@ -75,7 +75,7 @@ type EqlDeleteResponse = <> [[client.eql.get]] == `client.eql.get()` -Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search. {ref}/get-async-eql-search-api.html[{es} documentation] [discrete] @@ -114,7 +114,7 @@ type EqlGetResponse = <> [[client.eql.getStatus]] == `client.eql.getStatus()` -Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results. {ref}/get-async-eql-status-api.html[{es} documentation] [discrete] @@ -158,7 +158,7 @@ interface EqlGetStatusResponse { [[client.eql.search]] == `client.eql.search()` -Returns results matching a query expressed in Event Query Language (EQL) +Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event. {ref}/eql-search-api.html[{es} documentation] [discrete] @@ -193,6 +193,7 @@ interface EqlSearchRequest extends <> { fields?: <> | <> | (<> | <>)[] result_position?: EqlSearchResultPosition runtime_mappings?: <> + max_samples_per_key?: <> } ---- diff --git a/docs/reference/esql.asciidoc b/docs/reference/esql.asciidoc index a1f5aec11..e0f822dbe 100644 --- a/docs/reference/esql.asciidoc +++ b/docs/reference/esql.asciidoc @@ -68,7 +68,7 @@ Retrieves the results of a previously submitted async query request given its ID [[client.esql.query]] == `client.esql.query()` -Executes an ES|QL request +Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query. {ref}/esql-rest.html[{es} documentation] [discrete] diff --git a/docs/reference/fleet.asciidoc b/docs/reference/fleet.asciidoc index 7b41c4e04..f4027b44d 100644 --- a/docs/reference/fleet.asciidoc +++ b/docs/reference/fleet.asciidoc @@ -38,7 +38,7 @@ [[client.fleet.globalCheckpoints]] == `client.fleet.globalCheckpoints()` -Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. +Get global checkpoints. Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project. {ref}/get-global-checkpoints.html[{es} documentation] [discrete] @@ -82,7 +82,7 @@ interface FleetGlobalCheckpointsResponse { [[client.fleet.msearch]] == `client.fleet.msearch()` -Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request. The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it supports the wait_for_checkpoints parameter. +Run multiple Fleet searches. Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. [discrete] === Function signature @@ -133,7 +133,7 @@ interface FleetMsearchResponse { [[client.fleet.search]] == `client.fleet.search()` -The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch. +Run a Fleet search. The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. [discrete] === Function signature @@ -161,7 +161,6 @@ interface FleetSearchRequest extends <> { ignore_unavailable?: boolean lenient?: boolean max_concurrent_shard_requests?: <> - min_compatible_shard_node?: <> preference?: string pre_filter_shard_size?: <> request_cache?: boolean diff --git a/docs/reference/graph.asciidoc b/docs/reference/graph.asciidoc index 683af589d..fdb70353b 100644 --- a/docs/reference/graph.asciidoc +++ b/docs/reference/graph.asciidoc @@ -38,7 +38,7 @@ [[client.graph.explore]] == `client.graph.explore()` -Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned. {ref}/graph-explore-api.html[{es} documentation] [discrete] diff --git a/docs/reference/indices.asciidoc b/docs/reference/indices.asciidoc index beb7d760d..5414518d5 100644 --- a/docs/reference/indices.asciidoc +++ b/docs/reference/indices.asciidoc @@ -788,7 +788,7 @@ interface IndicesExistsAliasRequest extends <> { allow_no_indices?: boolean expand_wildcards?: <> ignore_unavailable?: boolean - local?: boolean + master_timeout?: <> } ---- @@ -808,7 +808,7 @@ type IndicesExistsAliasResponse = boolean [[client.indices.existsIndexTemplate]] == `client.indices.existsIndexTemplate()` -Returns information about whether a particular index template exists. +Check index templates. Check whether index templates exist. {ref}/index-templates.html[{es} documentation] [discrete] @@ -1124,7 +1124,7 @@ interface IndicesGetAliasRequest extends <> { allow_no_indices?: boolean expand_wildcards?: <> ignore_unavailable?: boolean - local?: boolean + master_timeout?: <> } ---- @@ -1668,8 +1668,7 @@ interface IndicesPutDataLifecycleRequest extends <> { expand_wildcards?: <> master_timeout?: <> timeout?: <> - data_retention?: <> - downsampling?: <> + lifecycle?: <> } ---- @@ -2044,7 +2043,7 @@ type IndicesResolveClusterResponse = Record<<>, IndicesResolveClus [[client.indices.resolveIndex]] == `client.indices.resolveIndex()` -Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. +Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. {ref}/indices-resolve-index-api.html[{es} documentation] [discrete] @@ -2163,7 +2162,6 @@ interface IndicesSegmentsRequest extends <> { allow_no_indices?: boolean expand_wildcards?: <> ignore_unavailable?: boolean - verbose?: boolean } ---- diff --git a/docs/reference/ingest.asciidoc b/docs/reference/ingest.asciidoc index 0ecb4ff13..b2d7699ab 100644 --- a/docs/reference/ingest.asciidoc +++ b/docs/reference/ingest.asciidoc @@ -38,7 +38,7 @@ [[client.ingest.deleteGeoipDatabase]] == `client.ingest.deleteGeoipDatabase()` -Deletes a geoip database configuration. +Delete GeoIP database configurations. Delete one or more IP geolocation database configurations. {ref}/delete-geoip-database-api.html[{es} documentation] [discrete] @@ -73,11 +73,26 @@ type IngestDeleteGeoipDatabaseResponse = <> ---- +[discrete] +[[client.ingest.deleteIpLocationDatabase]] +== `client.ingest.deleteIpLocationDatabase()` + +Deletes an ip location database configuration + +{ref}/delete-ip-location-database-api.html[{es} documentation] +[discrete] +=== Function signature + +[source,ts] +---- +(request: IngestDeleteIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise +---- + [discrete] [[client.ingest.deletePipeline]] == `client.ingest.deletePipeline()` -Deletes one or more existing ingest pipeline. +Delete pipelines. Delete one or more ingest pipelines. {ref}/delete-pipeline-api.html[{es} documentation] [discrete] @@ -116,7 +131,7 @@ type IngestDeletePipelineResponse = <> [[client.ingest.geoIpStats]] == `client.ingest.geoIpStats()` -Gets download statistics for GeoIP2 databases used with the geoip processor. +Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor. {ref}/geoip-processor.html[{es} documentation] [discrete] @@ -154,7 +169,7 @@ interface IngestGeoIpStatsResponse { [[client.ingest.getGeoipDatabase]] == `client.ingest.getGeoipDatabase()` -Returns information about one or more geoip database configurations. +Get GeoIP database configurations. Get information about one or more IP geolocation database configurations. {ref}/get-geoip-database-api.html[{es} documentation] [discrete] @@ -190,11 +205,26 @@ interface IngestGetGeoipDatabaseResponse { ---- +[discrete] +[[client.ingest.getIpLocationDatabase]] +== `client.ingest.getIpLocationDatabase()` + +Returns the specified ip location database configuration + +{ref}/get-ip-location-database-api.html[{es} documentation] +[discrete] +=== Function signature + +[source,ts] +---- +(request: IngestGetIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise +---- + [discrete] [[client.ingest.getPipeline]] == `client.ingest.getPipeline()` -Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline. +Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline. {ref}/get-pipeline-api.html[{es} documentation] [discrete] @@ -233,7 +263,7 @@ type IngestGetPipelineResponse = Record>> [[client.ingest.processorGrok]] == `client.ingest.processorGrok()` -Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. +Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. {ref}/grok-processor.html[{es} documentation] [discrete] @@ -270,7 +300,7 @@ interface IngestProcessorGrokResponse { [[client.ingest.putGeoipDatabase]] == `client.ingest.putGeoipDatabase()` -Returns information about one or more geoip database configurations. +Create or update GeoIP database configurations. Create or update IP geolocation database configurations. {ref}/put-geoip-database-api.html[{es} documentation] [discrete] @@ -307,11 +337,26 @@ type IngestPutGeoipDatabaseResponse = <> ---- +[discrete] +[[client.ingest.putIpLocationDatabase]] +== `client.ingest.putIpLocationDatabase()` + +Puts the configuration for a ip location database to be downloaded + +{ref}/put-ip-location-database-api.html[{es} documentation] +[discrete] +=== Function signature + +[source,ts] +---- +(request: IngestPutIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise +---- + [discrete] [[client.ingest.putPipeline]] == `client.ingest.putPipeline()` -Creates or updates an ingest pipeline. Changes made using this API take effect immediately. +Create or update a pipeline. Changes made using this API take effect immediately. {ref}/ingest.html[{es} documentation] [discrete] @@ -357,7 +402,7 @@ type IngestPutPipelineResponse = <> [[client.ingest.simulate]] == `client.ingest.simulate()` -Executes an ingest pipeline against a set of provided documents. +Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. {ref}/simulate-pipeline-api.html[{es} documentation] [discrete] diff --git a/docs/reference/migration.asciidoc b/docs/reference/migration.asciidoc index f780c301c..e9d4825b1 100644 --- a/docs/reference/migration.asciidoc +++ b/docs/reference/migration.asciidoc @@ -69,6 +69,7 @@ interface MigrationDeprecationsRequest extends <> { interface MigrationDeprecationsResponse { cluster_settings: MigrationDeprecationsDeprecation[] index_settings: Record + data_streams: Record node_settings: MigrationDeprecationsDeprecation[] ml_settings: MigrationDeprecationsDeprecation[] } diff --git a/docs/reference/ml.asciidoc b/docs/reference/ml.asciidoc index 87099ba68..3070edee5 100644 --- a/docs/reference/ml.asciidoc +++ b/docs/reference/ml.asciidoc @@ -2099,7 +2099,7 @@ interface MlPutDataFrameAnalyticsResponse { [[client.ml.putDatafeed]] == `client.ml.putDatafeed()` -Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. +Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay`) at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. {ref}/ml-put-datafeed.html[{es} documentation] [discrete] diff --git a/docs/reference/open_point_in_time.asciidoc b/docs/reference/open_point_in_time.asciidoc index 58017ec8c..ca9325fd8 100644 --- a/docs/reference/open_point_in_time.asciidoc +++ b/docs/reference/open_point_in_time.asciidoc @@ -61,6 +61,7 @@ interface OpenPointInTimeRequest extends <> { preference?: string routing?: <> expand_wildcards?: <> + allow_partial_search_results?: boolean index_filter?: <> } diff --git a/docs/reference/query_rules.asciidoc b/docs/reference/query_rules.asciidoc index f4b1e2f55..74810f338 100644 --- a/docs/reference/query_rules.asciidoc +++ b/docs/reference/query_rules.asciidoc @@ -38,7 +38,7 @@ [[client.queryRules.deleteRule]] == `client.queryRules.deleteRule()` -Deletes a query rule within a query ruleset. +Delete a query rule. Delete a query rule within a query ruleset. {ref}/delete-query-rule.html[{es} documentation] [discrete] @@ -76,7 +76,7 @@ type QueryRulesDeleteRuleResponse = <> [[client.queryRules.deleteRuleset]] == `client.queryRules.deleteRuleset()` -Deletes a query ruleset. +Delete a query ruleset. {ref}/delete-query-ruleset.html[{es} documentation] [discrete] @@ -113,7 +113,7 @@ type QueryRulesDeleteRulesetResponse = <> [[client.queryRules.getRule]] == `client.queryRules.getRule()` -Returns the details about a query rule within a query ruleset +Get a query rule. Get details about a query rule within a query ruleset. {ref}/get-query-rule.html[{es} documentation] [discrete] @@ -151,7 +151,7 @@ type QueryRulesGetRuleResponse = <> [[client.queryRules.getRuleset]] == `client.queryRules.getRuleset()` -Returns the details about a query ruleset +Get a query ruleset. Get details about a query ruleset. {ref}/get-query-ruleset.html[{es} documentation] [discrete] @@ -188,7 +188,7 @@ type QueryRulesGetRulesetResponse = <> [[client.queryRules.listRulesets]] == `client.queryRules.listRulesets()` -Returns summarized information about existing query rulesets. +Get all query rulesets. Get summarized information about the query rulesets. {ref}/list-query-rulesets.html[{es} documentation] [discrete] @@ -229,7 +229,7 @@ interface QueryRulesListRulesetsResponse { [[client.queryRules.putRule]] == `client.queryRules.putRule()` -Creates or updates a query rule within a query ruleset. +Create or update a query rule. Create or update a query rule within a query ruleset. {ref}/put-query-rule.html[{es} documentation] [discrete] @@ -273,7 +273,7 @@ interface QueryRulesPutRuleResponse { [[client.queryRules.putRuleset]] == `client.queryRules.putRuleset()` -Creates or updates a query ruleset. +Create or update a query ruleset. {ref}/put-query-ruleset.html[{es} documentation] [discrete] @@ -313,7 +313,7 @@ interface QueryRulesPutRulesetResponse { [[client.queryRules.test]] == `client.queryRules.test()` -Creates or updates a query ruleset. +Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. {ref}/test-query-ruleset.html[{es} documentation] [discrete] diff --git a/docs/reference/search.asciidoc b/docs/reference/search.asciidoc index 54103343d..53fd74a9c 100644 --- a/docs/reference/search.asciidoc +++ b/docs/reference/search.asciidoc @@ -70,7 +70,6 @@ interface SearchRequest extends <> { include_named_queries_score?: boolean lenient?: boolean max_concurrent_shard_requests?: <> - min_compatible_shard_node?: <> preference?: string pre_filter_shard_size?: <> request_cache?: boolean diff --git a/docs/reference/search_application.asciidoc b/docs/reference/search_application.asciidoc index 63f7faf06..a8ba3995e 100644 --- a/docs/reference/search_application.asciidoc +++ b/docs/reference/search_application.asciidoc @@ -218,7 +218,7 @@ interface SearchApplicationListRequest extends <> { ---- interface SearchApplicationListResponse { count: <> - results: SearchApplicationListSearchApplicationListItem[] + results: <>[] } ---- @@ -262,7 +262,7 @@ Create or update a search application. interface SearchApplicationPutRequest extends <> { name: <> create?: boolean - search_application?: <> + search_application?: <> } ---- diff --git a/docs/reference/security.asciidoc b/docs/reference/security.asciidoc index 3fcb5d643..ce49aaba6 100644 --- a/docs/reference/security.asciidoc +++ b/docs/reference/security.asciidoc @@ -105,7 +105,7 @@ interface SecurityAuthenticateRequest extends <> {} [source,ts,subs=+macros] ---- interface SecurityAuthenticateResponse { - api_key?: <> + api_key?: SecurityAuthenticateAuthenticateApiKey authentication_realm: <> email?: string | null full_name?: <> | null @@ -1115,8 +1115,9 @@ interface SecurityGetBuiltinPrivilegesRequest extends <> {} [source,ts,subs=+macros] ---- interface SecurityGetBuiltinPrivilegesResponse { - cluster: string[] - index: <> + cluster: <>[] + index: <>[] + remote_cluster: <>[] } ---- @@ -1164,7 +1165,7 @@ type SecurityGetPrivilegesResponse = Record> { global?: Record indices?: <>[] remote_indices?: <>[] + remote_cluster?: <>[] metadata?: <> run_as?: string[] description?: string diff --git a/docs/reference/shared-types/global-health-report.asciidoc b/docs/reference/shared-types/global-health-report.asciidoc index 1643d8686..fff8f47fd 100644 --- a/docs/reference/shared-types/global-health-report.asciidoc +++ b/docs/reference/shared-types/global-health-report.asciidoc @@ -136,6 +136,31 @@ interface HealthReportDiskIndicatorDetails { ---- +[discrete] +[[HealthReportFileSettingsIndicator]] +==== HealthReportFileSettingsIndicator + +[source,ts,subs=+macros] +---- +interface HealthReportFileSettingsIndicator extends <> { + details?: <> +} +---- + + +[discrete] +[[HealthReportFileSettingsIndicatorDetails]] +==== HealthReportFileSettingsIndicatorDetails + +[source,ts,subs=+macros] +---- +interface HealthReportFileSettingsIndicatorDetails { + failure_streak: <> + most_recent_failure: string +} +---- + + [discrete] [[HealthReportIlmIndicator]] ==== HealthReportIlmIndicator @@ -225,6 +250,7 @@ interface HealthReportIndicators { ilm?: <> slm?: <> shards_capacity?: <> + file_settings?: <> } ---- diff --git a/docs/reference/shared-types/global-open-point-in-time.asciidoc b/docs/reference/shared-types/global-open-point-in-time.asciidoc index e1353b112..0e2b003a1 100644 --- a/docs/reference/shared-types/global-open-point-in-time.asciidoc +++ b/docs/reference/shared-types/global-open-point-in-time.asciidoc @@ -48,6 +48,7 @@ interface OpenPointInTimeRequest extends <> { preference?: string routing?: <> expand_wildcards?: <> + allow_partial_search_results?: boolean index_filter?: <> } ---- diff --git a/docs/reference/shared-types/global-search.asciidoc b/docs/reference/shared-types/global-search.asciidoc index 558a531d0..2d4a8dd76 100644 --- a/docs/reference/shared-types/global-search.asciidoc +++ b/docs/reference/shared-types/global-search.asciidoc @@ -57,7 +57,6 @@ interface SearchRequest extends <> { include_named_queries_score?: boolean lenient?: boolean max_concurrent_shard_requests?: <> - min_compatible_shard_node?: <> preference?: string pre_filter_shard_size?: <> request_cache?: boolean diff --git a/docs/reference/shared-types/index.asciidoc b/docs/reference/shared-types/index.asciidoc index d2bf138b8..5a26157aa 100644 --- a/docs/reference/shared-types/index.asciidoc +++ b/docs/reference/shared-types/index.asciidoc @@ -1795,6 +1795,8 @@ interface RetrieverContainer { rrf?: <> pass:[/**] @property text_similarity_reranker A retriever that reranks the top documents based on a reranking model using the InferenceAPI */ text_similarity_reranker?: <> + pass:[/**] @property rule A retriever that replaces the functionality of a rule query. */ + rule?: <> } ---- @@ -1827,6 +1829,26 @@ interface RrfRank { +[discrete] +[[RuleRetriever]] +=== RuleRetriever + +[source,ts,subs=+macros] +---- +interface RuleRetriever extends <> { + pass:[/**] @property ruleset_ids The ruleset IDs containing the rules this retriever is evaluating against. */ + ruleset_ids: <>[] + pass:[/**] @property match_criteria The match criteria that will determine if a rule in the provided rulesets should be applied. */ + match_criteria: any + pass:[/**] @property retriever The retriever whose results rules should be applied to. */ + retriever: <> + pass:[/**] @property rank_window_size This value determines the size of the individual result set. */ + rank_window_size?: <> +} +---- + + + [discrete] [[ScalarValue]] === ScalarValue @@ -2919,8 +2941,6 @@ interface SpecUtilsCommonCatQueryParameters { h?: <> pass:[/**] @property help When set to `true` will output available columns. This option can't be combined with any other query string option. */ help?: boolean - pass:[/**] @property local If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. */ - local?: boolean pass:[/**] @property master_timeout Period to wait for a connection to the master node. */ master_timeout?: <> pass:[/**] @property s List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. */ @@ -9490,6 +9510,17 @@ interface MappingDateRangeProperty extends <> { +[discrete] +[[MappingDenseVectorElementType]] +=== MappingDenseVectorElementType + +[source,ts,subs=+macros] +---- +type MappingDenseVectorElementType = 'bit' | '<>' | '<>' +---- + + + [discrete] [[MappingDenseVectorIndexOptions]] === MappingDenseVectorIndexOptions @@ -9497,15 +9528,30 @@ interface MappingDateRangeProperty extends <> { [source,ts,subs=+macros] ---- interface MappingDenseVectorIndexOptions { - type: string - m?: <> - ef_construction?: <> + pass:[/**] @property confidence_interval The confidence interval to use when quantizing the vectors. Can be any value between and including `0.90` and `1.0` or exactly `0`. When the value is `0`, this indicates that dynamic quantiles should be calculated for optimized quantization. When between `0.90` and `1.0`, this value restricts the values used when calculating the quantization thresholds. For example, a value of `0.95` will only use the middle `95%` of the values when calculating the quantization thresholds (e.g. the highest and lowest `2.5%` of values will be ignored). Defaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4` for dynamic quantile calculation. Only applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat` index types. */ confidence_interval?: <> + pass:[/**] @property ef_construction The number of candidates to track while assembling the list of nearest neighbors for each new node. Only applicable to `hnsw`, `int8_hnsw`, and `int4_hnsw` index types. */ + ef_construction?: <> + pass:[/**] @property m The number of neighbors each node will be connected to in the HNSW graph. Only applicable to `hnsw`, `int8_hnsw`, and `int4_hnsw` index types. */ + m?: <> + pass:[/**] @property type The type of kNN algorithm to use. */ + type: <> } ---- +[discrete] +[[MappingDenseVectorIndexOptionsType]] +=== MappingDenseVectorIndexOptionsType + +[source,ts,subs=+macros] +---- +type MappingDenseVectorIndexOptionsType = 'flat' | 'hnsw' | 'int4_flat' | 'int4_hnsw' | 'int8_flat' | 'int8_hnsw' +---- + + + [discrete] [[MappingDenseVectorProperty]] === MappingDenseVectorProperty @@ -9514,16 +9560,32 @@ interface MappingDenseVectorIndexOptions { ---- interface MappingDenseVectorProperty extends <> { type: 'dense_vector' - element_type?: string + pass:[/**] @property dims Number of vector dimensions. Can't exceed `4096`. If `dims` is not specified, it will be set to the length of the first vector added to the field. */ dims?: <> - similarity?: string + pass:[/**] @property element_type The data type used to encode vectors. The supported data types are `<>` (default), `<>`, and `bit`. */ + element_type?: <> + pass:[/**] @property index If `true`, you can search this field using the kNN search API. */ index?: boolean + pass:[/**] @property index_options An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters that influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the expense of slower indexing speed. This parameter can only be specified when `index` is `true`. */ index_options?: <> + pass:[/**] @property similarity The vector similarity metric to use in kNN search. Documents are ranked by their vector field's similarity to the query vector. The `_score` of each document will be derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds to a higher ranking. Defaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`. `bit` vectors only support `l2_norm` as their similarity metric. This parameter can only be specified when `index` is `true`. */ + similarity?: <> } ---- +[discrete] +[[MappingDenseVectorSimilarity]] +=== MappingDenseVectorSimilarity + +[source,ts,subs=+macros] +---- +type MappingDenseVectorSimilarity = 'cosine' | 'dot_product' | 'l2_norm' | 'max_inner_product' +---- + + + [discrete] [[MappingDocValuesPropertyBase]] === MappingDocValuesPropertyBase @@ -12691,7 +12753,7 @@ interface QueryDslTermsSetQuery extends <> { pass:[/**] @property minimum_should_match_script Custom script containing the number of matching terms required to return a document. */ minimum_should_match_script?: <