diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index b5d966c000..db2105e6b3 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -21,7 +21,7 @@ "description": "Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit", "name": "async_search.delete", "request": { "name": "Request", @@ -58,7 +58,7 @@ "description": "Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit", "name": "async_search.get", "request": { "name": "Request", @@ -95,7 +95,7 @@ "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:\n\n* The user or API key that submitted the original async search request.\n* Users that have the `monitor` cluster privilege or greater privileges.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit", "name": "async_search.status", "privileges": { "cluster": [ @@ -137,7 +137,7 @@ "description": "Run an async search.\n\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit", "name": "async_search.submit", "request": { "name": "Request", @@ -182,7 +182,7 @@ "description": "Bulk index or delete documents.\nPerform multiple `index`, `create`, `delete`, and `update` actions in a single request.\nThis reduces overhead and can greatly increase indexing speed.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.\n* To use the `index` action, you must have the `create`, `index`, or `write` index privilege.\n* To use the `delete` action, you must have the `delete` or `write` index privilege.\n* To use the `update` action, you must have the `index` or `write` index privilege.\n* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n\n```\naction_and_meta_data\\n\noptional_source\\n\naction_and_meta_data\\n\noptional_source\\n\n....\naction_and_meta_data\\n\noptional_source\\n\n```\n\nThe `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.\nA `create` action fails if a document with the same ID already exists in the target\nAn `index` action adds or replaces a document as necessary.\n\nNOTE: Data streams support only the `create` action.\nTo update or delete a document in a data stream, you must target the backing index containing the document.\n\nAn `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n\nA `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n\nNOTE: The final line of data must end with a newline character (`\\n`).\nEach newline character may be preceded by a carriage return (`\\r`).\nWhen sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.\nBecause this format uses literal newline characters (`\\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n\nIf you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n\nA note on the format: the idea here is to make processing as fast as possible.\nAs some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n\nClient libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n\nThere is no \"correct\" number of actions to perform in a single bulk request.\nExperiment with different settings to find the optimal size for your particular workload.\nNote that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.\nIt is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.\nFor instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n\n**Client suppport for bulk requests**\n\nSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n\n* Go: Check out `esutil.BulkIndexer`\n* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`\n* Python: Check out `elasticsearch.helpers.*`\n* JavaScript: Check out `client.helpers.*`\n* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\n\n**Submitting bulk requests with cURL**\n\nIf you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.\nThe latter doesn't preserve newlines. For example:\n\n```\n$ cat requests\n{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n$ curl -s -H \"Content-Type: application/x-ndjson\" -XPOST localhost:9200/_bulk --data-binary \"@requests\"; echo\n{\"took\":7, \"errors\": false, \"items\":[{\"index\":{\"_index\":\"test\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"forced_refresh\":false}}]}\n```\n\n**Optimistic concurrency control**\n\nEach `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.\nThe `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n\n**Versioning**\n\nEach bulk item can include the version value using the `version` field.\nIt automatically follows the behavior of the index or delete operation based on the `_version` mapping.\nIt also support the `version_type`.\n\n**Routing**\n\nEach bulk item can include the routing value using the `routing` field.\nIt automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Wait for active shards**\n\nWhen making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.\n\n**Refresh**\n\nControl when the changes made by this request are visible to search.\n\nNOTE: Only the shards that receive the bulk request will be affected by refresh.\nImagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.\nThe request will only wait for those three shards to refresh.\nThe other two shards that make up the index do not participate in the `_bulk` request at all.", "docId": "docs-bulk", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-bulk", "name": "bulk", "request": { "name": "Request", @@ -228,7 +228,7 @@ }, "description": "Get aliases.\n\nGet the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", "docId": "cat-alias", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-aliases", "name": "cat.aliases", "privileges": { "index": [ @@ -276,7 +276,7 @@ }, "description": "Get component templates.\n\nGet information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", "docId": "cat-component-templates", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-component-templates", "name": "cat.component_templates", "privileges": { "cluster": [ @@ -323,7 +323,7 @@ }, "description": "Get a document count.\n\nGet quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", "docId": "cat-count", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count", "name": "cat.count", "privileges": { "index": [ @@ -370,7 +370,7 @@ }, "description": "Get CAT help.\n\nGet help for the CAT APIs.", "docId": "cat", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat", "name": "cat.help", "request": { "name": "Request", @@ -405,7 +405,7 @@ }, "description": "Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", "docId": "cat-indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-indices", "name": "cat.indices", "privileges": { "cluster": [ @@ -456,7 +456,7 @@ }, "description": "Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", "docId": "cat-dfanalytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-data-frame-analytics", "name": "cat.ml_data_frame_analytics", "privileges": { "cluster": [ @@ -504,7 +504,7 @@ }, "description": "Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "docId": "cat-datafeeds", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-datafeeds", "name": "cat.ml_datafeeds", "privileges": { "cluster": [ @@ -552,7 +552,7 @@ }, "description": "Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", "docId": "cat-anomaly-detectors", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-jobs", "name": "cat.ml_jobs", "privileges": { "cluster": [ @@ -600,7 +600,7 @@ }, "description": "Get trained models.\n\nGet configuration and usage information about inference trained models.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", "docId": "cat-trained-model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-trained-models", "name": "cat.ml_trained_models", "privileges": { "cluster": [ @@ -648,7 +648,7 @@ }, "description": "Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "docId": "cat-transforms", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-transforms", "name": "cat.transforms", "privileges": { "cluster": [ @@ -696,9 +696,9 @@ "description": "Clear a scrolling search.\nClear the search context and results for a scrolling search.", "docId": "clear-scroll-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-clear-scroll", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "clear_scroll", "request": { "name": "Request", @@ -749,7 +749,7 @@ "description": "Close a point in time.\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "docId": "point-in-time-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-open-point-in-time", "name": "close_point_in_time", "request": { "name": "Request", @@ -789,7 +789,7 @@ "description": "Delete component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template", "name": "cluster.delete_component_template", "privileges": { "cluster": [ @@ -831,7 +831,7 @@ "description": "Check component templates.\nReturns information about whether a particular component template exists.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template", "name": "cluster.exists_component_template", "request": { "name": "Request", @@ -868,7 +868,7 @@ "description": "Get component templates.\nGet information about component templates.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template", "name": "cluster.get_component_template", "privileges": { "cluster": [ @@ -915,7 +915,7 @@ }, "description": "Get cluster info.\nReturns basic information about the cluster.", "docId": "cluster-info", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-info", "name": "cluster.info", "request": { "name": "Request", @@ -952,7 +952,7 @@ "description": "Create or update a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template", "name": "cluster.put_component_template", "privileges": { "cluster": [ @@ -997,7 +997,7 @@ }, "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", "docId": "connector-checkin", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-check-in", "name": "connector.check_in", "request": { "name": "Request", @@ -1033,7 +1033,7 @@ }, "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "docId": "connector-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-delete", "name": "connector.delete", "request": { "name": "Request", @@ -1069,7 +1069,7 @@ }, "description": "Get a connector.\n\nGet the details about a connector.", "docId": "connector-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-get", "name": "connector.get", "request": { "name": "Request", @@ -1105,7 +1105,7 @@ }, "description": "Get all connectors.\n\nGet information about all connectors.", "docId": "connector-list", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-list", "name": "connector.list", "request": { "name": "Request", @@ -1141,7 +1141,7 @@ }, "description": "Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "docId": "connector-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put", "name": "connector.post", "request": { "name": "Request", @@ -1180,7 +1180,7 @@ }, "description": "Create or update a connector.", "docId": "connector-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put", "name": "connector.put", "request": { "name": "Request", @@ -1225,7 +1225,7 @@ }, "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "docId": "connector-sync-job-cancel", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-cancel", "name": "connector.sync_job_cancel", "request": { "name": "Request", @@ -1261,7 +1261,7 @@ }, "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "docId": "connector-sync-job-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-delete", "name": "connector.sync_job_delete", "request": { "name": "Request", @@ -1297,7 +1297,7 @@ }, "description": "Get a connector sync job.", "docId": "connector-sync-job-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-get", "name": "connector.sync_job_get", "request": { "name": "Request", @@ -1333,7 +1333,7 @@ }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "docId": "connector-sync-job-list", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-list", "name": "connector.sync_job_list", "request": { "name": "Request", @@ -1369,7 +1369,7 @@ }, "description": "Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "docId": "connector-sync-job-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-post", "name": "connector.sync_job_post", "request": { "name": "Request", @@ -1408,7 +1408,7 @@ }, "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "docId": "connector-update-filtering", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering", "name": "connector.update_active_filtering", "request": { "name": "Request", @@ -1447,7 +1447,7 @@ }, "description": "Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.", "docId": "connector-update-api-key-id", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-api-key-id", "name": "connector.update_api_key_id", "request": { "name": "Request", @@ -1486,7 +1486,7 @@ }, "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "docId": "connector-configuration", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-configuration", "name": "connector.update_configuration", "request": { "name": "Request", @@ -1525,7 +1525,7 @@ }, "description": "Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.", "docId": "connector-update-error", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-error", "name": "connector.update_error", "request": { "name": "Request", @@ -1564,7 +1564,7 @@ }, "description": "Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.", "docId": "connector-update-filtering", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering", "name": "connector.update_filtering", "request": { "name": "Request", @@ -1603,7 +1603,7 @@ }, "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.", "docId": "connector-update-filtering-validation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-validation-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering-validation", "name": "connector.update_filtering_validation", "request": { "name": "Request", @@ -1642,7 +1642,7 @@ }, "description": "Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.", "docId": "connector-update-index-name", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-index-name", "name": "connector.update_index_name", "request": { "name": "Request", @@ -1681,7 +1681,7 @@ }, "description": "Update the connector name and description.", "docId": "connector-update-name", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-name", "name": "connector.update_name", "request": { "name": "Request", @@ -1720,7 +1720,7 @@ }, "description": "Update the connector is_native flag.", "docId": "connector-update-native", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-native-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-native", "name": "connector.update_native", "request": { "name": "Request", @@ -1759,7 +1759,7 @@ }, "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "docId": "connector-update-pipeline", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-pipeline", "name": "connector.update_pipeline", "request": { "name": "Request", @@ -1798,7 +1798,7 @@ }, "description": "Update the connector scheduling.", "docId": "connector-update-scheduling", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-scheduling", "name": "connector.update_scheduling", "request": { "name": "Request", @@ -1837,7 +1837,7 @@ }, "description": "Update the connector service type.", "docId": "connector-update-service-type", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-service-type", "name": "connector.update_service_type", "request": { "name": "Request", @@ -1876,7 +1876,7 @@ }, "description": "Update the connector status.", "docId": "connector-update-status", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-status", "name": "connector.update_status", "request": { "name": "Request", @@ -1915,7 +1915,7 @@ "description": "Count search results.\nGet the number of documents matching a query.\n\nThe query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body.\nThe query is optional. When no query is provided, the API uses `match_all` to count all the documents.\n\nThe count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.\n\nThe operation is broadcast across all shards.\nFor each shard ID group, a replica is chosen and the search is run against it.\nThis means that replicas increase the scalability of the count.", "docId": "search-count", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-count", "name": "count", "privileges": { "index": [ @@ -1968,9 +1968,9 @@ "description": "Create a new document in the index.\n\nYou can index a new JSON document with the `//_doc/` or `//_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `//_doc/` API.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add a document using the `PUT //_create/<_id>` or `POST //_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.", "docId": "docs-index", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-create", "extDocId": "data-streams", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/data-streams", "name": "create", "privileges": { "index": [ @@ -2015,7 +2015,7 @@ "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", "docId": "docs-delete", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete", "name": "delete", "privileges": { "index": [ @@ -2057,7 +2057,7 @@ "description": "Delete documents.\n\nDeletes documents that match the specified query.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `delete` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\nWhen you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning.\nIf a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.\n\nNOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete.\nA bulk delete request is performed for each batch of matching documents.\nIf a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off.\nIf the maximum retry limit is reached, processing halts and all failed requests are returned in the response.\nAny delete requests that completed successfully still stick, they are not rolled back.\n\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.\n\n**Throttling delete requests**\n\nTo control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to disable throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is `1000`, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nDelete by query supports sliced scroll to parallelize the delete process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` lets Elasticsearch choose the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\nAdding slices to the delete by query operation creates sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with slices only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with `slices` will cancel each sub-request.\n* Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead.\n* Delete performance scales linearly across available resources with the number of slices.\n\nWhether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Cancel a delete by query operation**\n\nAny delete by query can be canceled using the task cancel API. For example:\n\n```\nPOST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel\n```\n\nThe task ID can be found by using the get tasks API.\n\nCancellation should happen quickly but might take a few seconds.\nThe get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.", "docId": "docs-delete-by-query", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-by-query", "name": "delete_by_query", "privileges": { "index": [ @@ -2102,7 +2102,7 @@ "description": "Delete a script or search template.\nDeletes a stored script or search template.", "docId": "script-delete", "docTag": "script", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-script", "name": "delete_script", "privileges": { "cluster": [ @@ -2143,7 +2143,7 @@ }, "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", "docId": "delete-enrich-policy-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-delete-policy", "name": "enrich.delete_policy", "request": { "name": "Request", @@ -2179,7 +2179,7 @@ }, "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", "docId": "execute-enrich-policy-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-execute-policy", "name": "enrich.execute_policy", "request": { "name": "Request", @@ -2215,7 +2215,7 @@ }, "description": "Get an enrich policy.\nReturns information about an enrich policy.", "docId": "get-enrich-policy-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-get-policy", "name": "enrich.get_policy", "request": { "name": "Request", @@ -2257,7 +2257,7 @@ }, "description": "Create an enrich policy.\nCreates an enrich policy.", "docId": "put-enrich-policy-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-put-policy", "name": "enrich.put_policy", "request": { "name": "Request", @@ -2296,7 +2296,7 @@ }, "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "docId": "eql-async-search-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-delete", "name": "eql.delete", "request": { "name": "Request", @@ -2332,7 +2332,7 @@ }, "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "docId": "eql-async-search-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-get", "name": "eql.get", "request": { "name": "Request", @@ -2368,7 +2368,7 @@ }, "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "docId": "eql-async-search-status-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-get-status", "name": "eql.get_status", "request": { "name": "Request", @@ -2404,9 +2404,9 @@ }, "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "docId": "eql-search-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-search", "extDocId": "eql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql", "name": "eql.search", "request": { "name": "Request", @@ -2442,9 +2442,9 @@ }, "description": "Run an ES|QL query.\nGet search results for an ES|QL (Elasticsearch query language) query.", "docId": "esql-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest", "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql", "name": "esql.query", "request": { "name": "Request", @@ -2483,7 +2483,7 @@ "description": "Check a document.\n\nVerify that a document exists.\nFor example, check to see if a document with the `_id` 0 exists:\n\n```\nHEAD my-index-000001/_doc/0\n```\n\nIf the document exists, the API returns a status code of `200 - OK`.\nIf the document doesn’t exist, the API returns `404 - Not Found`.\n\n**Versioning support**\n\nYou can use the `version` parameter to check the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", "docId": "docs-get", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "name": "exists", "request": { "name": "Request", @@ -2520,9 +2520,9 @@ "description": "Check for a document source.\n\nCheck whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping.", "docId": "docs-get", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "extDocId": "mapping-source-field", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field", "name": "exists_source", "privileges": { "index": [ @@ -2563,7 +2563,7 @@ "description": "Explain a document match result.\nGet information about why a specific document matches, or doesn't match, a query.\nIt computes a score explanation for a query and a specific document.", "docId": "search-explain", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-explain", "name": "explain", "privileges": { "index": [ @@ -2609,7 +2609,7 @@ "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "docId": "search-field-caps", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-field-caps", "name": "field_caps", "privileges": { "index": [ @@ -2662,7 +2662,7 @@ "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", "docId": "docs-get", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "name": "get", "privileges": { "index": [ @@ -2703,7 +2703,7 @@ "description": "Get a script or search template.\nRetrieves a stored script or search template.", "docId": "script-get", "docTag": "script", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script", "name": "get_script", "privileges": { "cluster": [ @@ -2744,9 +2744,9 @@ "description": "Get a document's source.\n\nGet the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```", "docId": "docs-get", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "extDocId": "mapping-source-field", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field", "name": "get_source", "privileges": { "index": [ @@ -2786,9 +2786,9 @@ }, "description": "Explore graph analytics.\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn 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.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "docId": "graph-explore-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-graph", "extDocId": "graph", - "extDocUrl": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/visualize/graph", "name": "graph.explore", "request": { "name": "Request", @@ -2828,9 +2828,9 @@ "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "docId": "docs-index", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-create", "extDocId": "data-streams", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/data-streams", "name": "index", "privileges": { "index": [ @@ -2881,7 +2881,7 @@ }, "description": "Add an index block.\n\nAdd an index block to an index.\nIndex blocks limit the operations allowed on an index by blocking specific operation types.", "docId": "index-block-add", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-add-block", "name": "indices.add_block", "request": { "name": "Request", @@ -2916,9 +2916,9 @@ }, "description": "Get tokens from text analysis.\nThe analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "docId": "indices-analyze", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-analyze", "extDocId": "analysis", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "indices.analyze", "privileges": { "index": [ @@ -2969,7 +2969,7 @@ }, "description": "Create an index.\nYou can use the create index API to add a new index to an Elasticsearch cluster.\nWhen creating an index, you can specify the following:\n\n* Settings for the index.\n* Mappings for fields in the index.\n* Index aliases\n\n**Wait for active shards**\n\nBy default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out.\nThe index creation response will indicate what happened.\nFor example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out.\nNote that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful.\nThese values simply indicate whether the operation completed before the timeout.\nIf `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon.\nIf `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`).\n\nYou can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`.\nNote that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations.", "docId": "indices-create-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create", "name": "indices.create", "privileges": { "index": [ @@ -3015,7 +3015,7 @@ "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", "docId": "indices-create-data-stream", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create-data-stream", "name": "indices.create_data_stream", "privileges": { "index": [ @@ -3055,7 +3055,7 @@ }, "description": "Delete indices.\nDeleting an index deletes its documents, shards, and metadata.\nIt does not delete related Kibana components, such as data views, visualizations, or dashboards.\n\nYou cannot delete the current write index of a data stream.\nTo delete the index, you must roll over the data stream so a new write index is created.\nYou can then use the delete index API to delete the previous write index.", "docId": "indices-delete-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete", "name": "indices.delete", "privileges": { "index": [ @@ -3095,7 +3095,7 @@ }, "description": "Delete an alias.\nRemoves a data stream or index from an alias.", "docId": "indices-delete-alias", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-alias", "name": "indices.delete_alias", "privileges": { "index": [ @@ -3143,7 +3143,7 @@ "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", "docId": "data-stream-delete", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-data-stream", "name": "indices.delete_data_stream", "privileges": { "index": [ @@ -3184,7 +3184,7 @@ }, "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", "docId": "indices-delete-template", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-index-template", "name": "indices.delete_index_template", "privileges": { "cluster": [ @@ -3224,7 +3224,7 @@ }, "description": "Check indices.\nCheck if one or more indices, index aliases, or data streams exist.", "docId": "indices-exists", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists", "name": "indices.exists", "request": { "name": "Request", @@ -3259,7 +3259,7 @@ }, "description": "Check aliases.\n\nCheck if one or more data stream or index aliases exist.", "docId": "indices-aliases-exist", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-alias", "name": "indices.exists_alias", "request": { "name": "Request", @@ -3300,7 +3300,7 @@ }, "description": "Check index templates.\n\nCheck whether index templates exist.", "docId": "index-templates-exist", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-index-template", "name": "indices.exists_index_template", "request": { "name": "Request", @@ -3337,7 +3337,7 @@ "description": "Get the status for a data stream lifecycle.\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", "docId": "data-stream-explain-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-explain-data-lifecycle", "name": "indices.explain_data_lifecycle", "request": { "name": "Request", @@ -3372,7 +3372,7 @@ }, "description": "Get index information.\nGet information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "docId": "indices-get-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get", "name": "indices.get", "privileges": { "index": [ @@ -3413,7 +3413,7 @@ }, "description": "Get aliases.\nRetrieves information for one or more data stream or index aliases.", "docId": "indices-get-alias", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-alias", "name": "indices.get_alias", "privileges": { "index": [ @@ -3473,7 +3473,7 @@ "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", "docId": "data-stream-get-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-data-lifecycle", "name": "indices.get_data_lifecycle", "request": { "name": "Request", @@ -3510,7 +3510,7 @@ "description": "Get data streams.\n\nGet information about one or more data streams.", "docId": "data-stream-get", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-data-stream", "name": "indices.get_data_stream", "privileges": { "index": [ @@ -3557,7 +3557,7 @@ }, "description": "Get index templates.\nGet information about one or more index templates.", "docId": "indices-get-template", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-index-template", "name": "indices.get_index_template", "privileges": { "cluster": [ @@ -3603,7 +3603,7 @@ }, "description": "Get mapping definitions.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "docId": "indices-get-mapping", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping", "name": "indices.get_mapping", "privileges": { "index": [ @@ -3649,7 +3649,7 @@ }, "description": "Get index settings.\nGet setting information for one or more indices.\nFor data streams, it returns setting information for the stream's backing indices.", "docId": "indices-get-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-settings", "name": "indices.get_settings", "privileges": { "index": [ @@ -3709,7 +3709,7 @@ "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "docId": "data-stream-migrate", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-to-data-stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-to-data-stream", "name": "indices.migrate_to_data_stream", "privileges": { "index": [ @@ -3751,7 +3751,7 @@ "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", "docId": "data-stream-update", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-modify-data-stream", "name": "indices.modify_data_stream", "request": { "name": "Request", @@ -3789,7 +3789,7 @@ }, "description": "Create or update an alias.\nAdds a data stream or index to an alias.", "docId": "alias-update", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-alias", "name": "indices.put_alias", "request": { "name": "Request", @@ -3837,7 +3837,7 @@ "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", "docId": "data-stream-put-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-data-lifecycle", "name": "indices.put_data_lifecycle", "request": { "name": "Request", @@ -3876,7 +3876,7 @@ }, "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition.", "docId": "index-templates-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-index-template", "name": "indices.put_index_template", "privileges": { "cluster": [ @@ -3920,9 +3920,9 @@ }, "description": "Update field mappings.\nAdd new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields and add new properties to existing object fields.\nFor data streams, these changes are applied to all backing indices by default.\n\n**Add multi-fields to an existing field**\n\nMulti-fields let you index the same field in different ways.\nYou can use this API to update the fields mapping parameter and enable multi-fields for an existing field.\nWARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.\nYou can populate the new multi-field with the update by query API.\n\n**Change supported mapping parameters for an existing field**\n\nThe documentation for each mapping parameter indicates whether you can update it for an existing field using this API.\nFor example, you can use the update mapping API to update the `ignore_above` parameter.\n\n**Change the mapping of an existing field**\n\nExcept for supported mapping parameters, you can't change the mapping or field type of an existing field.\nChanging an existing field could invalidate data that's already indexed.\n\nIf you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.\nIf you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.\n\n**Rename a field**\n\nRenaming a field would invalidate data already indexed under the old field name.\nInstead, add an alias field to create an alternate field name.", "docId": "indices-put-mapping", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-mapping", "extDocId": "mapping-params", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters", "name": "indices.put_mapping", "privileges": { "index": [ @@ -3966,9 +3966,9 @@ }, "description": "Update index settings.\nChanges dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.", "docId": "indices-update-settings", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-settings", "extDocId": "index-modules", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules", "name": "indices.put_settings", "privileges": { "index": [ @@ -4017,7 +4017,7 @@ }, "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.\n\nBy default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.\nYou can change this default interval with the `index.refresh_interval` setting.\n\nRefresh requests are synchronous and do not return a response until the refresh operation completes.\n\nRefreshes are resource-intensive.\nTo ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.\n\nIf your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option.\nThis option ensures the indexing operation waits for a periodic refresh before running the search.", "docId": "indices-refresh", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-refresh", "name": "indices.refresh", "privileges": { "index": [ @@ -4066,7 +4066,7 @@ }, "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "docId": "indices-resolve-index-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index", "name": "indices.resolve_index", "privileges": { "index": [ @@ -4107,7 +4107,7 @@ }, "description": "Roll over to a new index.\nTIP: It is recommended to use the index lifecycle rollover action to automate rollovers.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named ``.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`.", "docId": "indices-rollover-index", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-rollover", "name": "indices.rollover", "privileges": { "index": [ @@ -4157,7 +4157,7 @@ }, "description": "Simulate an index.\nGet the index configuration that would be applied to the specified index from an existing index template.", "docId": "indices-simulate", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-index-template", "name": "indices.simulate_index_template", "privileges": { "cluster": [ @@ -4200,7 +4200,7 @@ }, "description": "Simulate an index template.\nGet the index configuration that would be applied by a particular index template.", "docId": "indices-simulate-template", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-template", "name": "indices.simulate_template", "privileges": { "cluster": [ @@ -4250,7 +4250,7 @@ }, "description": "Create or update an alias.\nAdds a data stream or index to an alias.", "docId": "aliases-update", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-update-aliases", "name": "indices.update_aliases", "request": { "name": "Request", @@ -4289,7 +4289,7 @@ }, "description": "Validate a query.\nValidates a query without running it.", "docId": "search-validate", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-validate-query", "name": "indices.validate_query", "request": { "name": "Request", @@ -4337,7 +4337,7 @@ }, "description": "Perform chat completion inference", "docId": "inference-api-chat-completion", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-unified-inference", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-unified-inference", "name": "inference.chat_completion_unified", "request": { "name": "Request", @@ -4377,7 +4377,7 @@ }, "description": "Perform completion inference on the service", "docId": "inference-api-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference", "name": "inference.completion", "request": { "name": "Request", @@ -4417,7 +4417,7 @@ }, "description": "Delete an inference endpoint", "docId": "inference-api-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-delete", "name": "inference.delete", "request": { "name": "Request", @@ -4460,7 +4460,7 @@ }, "description": "Get an inference endpoint", "docId": "inference-api-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-get", "name": "inference.get", "request": { "name": "Request", @@ -4507,9 +4507,9 @@ "visibility": "public" } }, - "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", + "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\nFor details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "docId": "inference-api-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference", "name": "inference.inference", "privileges": { "cluster": [ @@ -4560,7 +4560,7 @@ }, "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "docId": "inference-api-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put", "name": "inference.put", "privileges": { "cluster": [ @@ -4611,7 +4611,7 @@ }, "description": "Create an AlibabaCloud AI Search inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-alibabacloud", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-alibabacloud", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-alibabacloud", "name": "inference.put_alibabacloud", "privileges": { "cluster": [ @@ -4656,7 +4656,7 @@ }, "description": "Create an Amazon Bedrock inference endpoint.\n\nCreates an inference endpoint to perform an inference task with the `amazonbedrock` service.\n\n>info\n> You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-amazonbedrock", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonbedrock", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-amazonbedrock", "name": "inference.put_amazonbedrock", "privileges": { "cluster": [ @@ -4701,7 +4701,7 @@ }, "description": "Create an Anthropic inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `anthropic` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-anthropic", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-anthropic", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-anthropic", "name": "inference.put_anthropic", "privileges": { "cluster": [ @@ -4746,7 +4746,7 @@ }, "description": "Create an Azure AI studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureaistudio` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-azureaistudio", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureaistudio", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureaistudio", "name": "inference.put_azureaistudio", "privileges": { "cluster": [ @@ -4791,7 +4791,7 @@ }, "description": "Create an Azure OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureopenai` service.\n\nThe list of chat completion models that you can choose from in your Azure OpenAI deployment include:\n\n* [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models)\n* [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35)\n\nThe list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings).\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-azureopenai", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureopenai", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureopenai", "name": "inference.put_azureopenai", "privileges": { "cluster": [ @@ -4836,7 +4836,7 @@ }, "description": "Create a Cohere inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `cohere` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-cohere", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-cohere", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-cohere", "name": "inference.put_cohere", "privileges": { "cluster": [ @@ -4881,7 +4881,7 @@ }, "description": "Create an Elasticsearch inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elasticsearch` service.\n\n> info\n> Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.\n\nIf you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-elasticsearch", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elasticsearch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-elasticsearch", "name": "inference.put_elasticsearch", "privileges": { "cluster": [ @@ -4930,7 +4930,7 @@ }, "description": "Create an ELSER inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elser` service.\nYou can also deploy ELSER by using the Elasticsearch inference integration.\n\n> info\n> Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings.\n\nThe API request will automatically download and deploy the ELSER model if it isn't already downloaded.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-elser", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elser", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-elser", "name": "inference.put_elser", "privileges": { "cluster": [ @@ -4975,7 +4975,7 @@ }, "description": "Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-googleaistudio", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googleaistudio", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googleaistudio", "name": "inference.put_googleaistudio", "privileges": { "cluster": [ @@ -5020,7 +5020,7 @@ }, "description": "Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-googlevertexai", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googlevertexai", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googlevertexai", "name": "inference.put_googlevertexai", "privileges": { "cluster": [ @@ -5065,7 +5065,7 @@ }, "description": "Create a Hugging Face inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `hugging_face` service.\n\nYou must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL.\nSelect the model you want to use on the new endpoint creation page (for example `intfloat/e5-small-v2`), then select the sentence embeddings task under the advanced configuration section.\nCreate the endpoint and copy the URL after the endpoint initialization has been finished.\n\nThe following models are recommended for the Hugging Face service:\n\n* `all-MiniLM-L6-v2`\n* `all-MiniLM-L12-v2`\n* `all-mpnet-base-v2`\n* `e5-base-v2`\n* `e5-small-v2`\n* `multilingual-e5-base`\n* `multilingual-e5-small`\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-huggingface", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-hugging-face", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-hugging-face", "name": "inference.put_hugging_face", "privileges": { "cluster": [ @@ -5110,7 +5110,7 @@ }, "description": "Create an JinaAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `jinaai` service.\n\nTo review the available `rerank` models, refer to .\nTo review the available `text_embedding` models, refer to the .\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-jinaai", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-jinaai", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-jinaai", "name": "inference.put_jinaai", "privileges": { "cluster": [ @@ -5155,7 +5155,7 @@ }, "description": "Create a Mistral inference endpoint.\n\nCreates an inference endpoint to perform an inference task with the `mistral` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-mistral", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-mistral", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-mistral", "name": "inference.put_mistral", "privileges": { "cluster": [ @@ -5200,7 +5200,7 @@ }, "description": "Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openai` service.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-openai", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-openai", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-openai", "name": "inference.put_openai", "privileges": { "cluster": [ @@ -5245,7 +5245,7 @@ }, "description": "Create a VoyageAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `voyageai` service.\n\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-voyageai", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-voyageai", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-voyageai", "name": "inference.put_voyageai", "privileges": { "cluster": [ @@ -5290,7 +5290,7 @@ }, "description": "Create a Watsonx inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `watsonxai` service.\nYou need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service.\nYou can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.\n\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.", "docId": "inference-api-put-watsonx", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-watsonx", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-watsonx", "name": "inference.put_watsonx", "privileges": { "cluster": [ @@ -5335,7 +5335,7 @@ }, "description": "Perform rereanking inference on the service", "docId": "inference-api-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference", "name": "inference.rerank", "privileges": { "cluster": [ @@ -5380,7 +5380,7 @@ }, "description": "Perform sparse embedding inference on the service", "docId": "inference-api-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference", "name": "inference.sparse_embedding", "request": { "name": "Request", @@ -5420,7 +5420,7 @@ }, "description": "Perform text embedding inference on the service", "docId": "inference-api-post", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference", "name": "inference.text_embedding", "request": { "name": "Request", @@ -5459,7 +5459,7 @@ "description": "Get cluster info.\nGet basic build, version, and cluster information.", "docId": "api-root", "docTag": "info", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-info", "name": "info", "privileges": { "cluster": [ @@ -5500,9 +5500,9 @@ }, "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "docId": "delete-pipeline-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-pipeline", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-pipeline", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", "name": "ingest.delete_pipeline", "request": { "name": "Request", @@ -5538,9 +5538,9 @@ }, "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "docId": "get-pipeline-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-pipeline", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-pipeline", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", "name": "ingest.get_pipeline", "request": { "name": "Request", @@ -5582,9 +5582,9 @@ }, "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor", "extDocId": "grok-processor", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "extDocUrl": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor", "name": "ingest.processor_grok", "request": { "name": "Request", @@ -5620,9 +5620,9 @@ }, "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", "docId": "ingest", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "docUrl": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", "name": "ingest.put_pipeline", "request": { "name": "Request", @@ -5661,7 +5661,7 @@ }, "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "docId": "simulate-pipeline-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-simulate", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-simulate", "name": "ingest.simulate", "privileges": { "cluster": [ @@ -5712,7 +5712,7 @@ }, "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "docId": "get-license", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get", "name": "license.get", "request": { "name": "Request", @@ -5748,9 +5748,9 @@ }, "description": "Delete a Logstash pipeline.\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", "docId": "logstash-api-delete-pipeline", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-delete-pipeline", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-delete-pipeline", "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management", "name": "logstash.delete_pipeline", "privileges": { "cluster": [ @@ -5791,9 +5791,9 @@ }, "description": "Get Logstash pipelines.\nGet pipelines that are used for Logstash Central Management.", "docId": "logstash-api-get-pipeline", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-get-pipeline", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-get-pipeline", "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management", "name": "logstash.get_pipeline", "privileges": { "cluster": [ @@ -5840,9 +5840,9 @@ }, "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "docId": "logstash-api-put-pipeline", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-put-pipeline", "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management", "name": "logstash.put_pipeline", "privileges": { "cluster": [ @@ -5887,7 +5887,7 @@ "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.", "docId": "docs-multi-get", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-mget", "name": "mget", "privileges": { "index": [ @@ -5940,7 +5940,7 @@ "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "docId": "ml-close-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-close-job", "name": "ml.close_job", "privileges": { "cluster": [ @@ -5985,7 +5985,7 @@ "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", "docId": "ml-delete-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-calendar", "name": "ml.delete_calendar", "privileges": { "cluster": [ @@ -6027,7 +6027,7 @@ "description": "Delete events from a calendar.", "docId": "ml-delete-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-calendar-event", "name": "ml.delete_calendar_event", "request": { "name": "Request", @@ -6064,7 +6064,7 @@ "description": "Delete anomaly jobs from a calendar.", "docId": "ml-delete-calendar-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-calendar-job", "name": "ml.delete_calendar_job", "privileges": { "cluster": [ @@ -6106,7 +6106,7 @@ "description": "Delete a data frame analytics job.", "docId": "ml-delete-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-data-frame-analytics", "name": "ml.delete_data_frame_analytics", "privileges": { "cluster": [ @@ -6148,7 +6148,7 @@ "description": "Delete a datafeed.", "docId": "ml-delete-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-datafeed", "name": "ml.delete_datafeed", "privileges": { "cluster": [ @@ -6190,7 +6190,7 @@ "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "docId": "ml-delete-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-filter", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-filter", "name": "ml.delete_filter", "privileges": { "cluster": [ @@ -6232,7 +6232,7 @@ "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "docId": "ml-delete-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-job", "name": "ml.delete_job", "privileges": { "cluster": [ @@ -6274,7 +6274,7 @@ "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "docId": "delete-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model", "name": "ml.delete_trained_model", "privileges": { "cluster": [ @@ -6316,7 +6316,7 @@ "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "docId": "delete-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model-alias", "name": "ml.delete_trained_model_alias", "privileges": { "cluster": [ @@ -6361,7 +6361,7 @@ "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "docId": "ml-estimate-memory", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-estimate-model-memory", "name": "ml.estimate_model_memory", "privileges": { "cluster": [ @@ -6406,7 +6406,7 @@ "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "docId": "evaluate-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-evaluate-data-frame", "name": "ml.evaluate_data_frame", "privileges": { "cluster": [ @@ -6451,7 +6451,7 @@ "description": "Force buffered data to be processed.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", "docId": "ml-flush-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-flush-job", "name": "ml.flush_job", "privileges": { "cluster": [ @@ -6496,7 +6496,7 @@ "description": "Get info about events in calendars.", "docId": "ml-get-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-calendar-events", "name": "ml.get_calendar_events", "privileges": { "cluster": [ @@ -6538,7 +6538,7 @@ "description": "Get calendar configuration info.", "docId": "ml-get-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-calendars", "name": "ml.get_calendars", "privileges": { "cluster": [ @@ -6591,7 +6591,7 @@ "description": "Get data frame analytics job configuration info.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", "docId": "get-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics", "name": "ml.get_data_frame_analytics", "privileges": { "cluster": [ @@ -6639,7 +6639,7 @@ "description": "Get data frame analytics jobs usage info.", "docId": "get-dfanalytics-stats", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics-stats", "name": "ml.get_data_frame_analytics_stats", "privileges": { "cluster": [ @@ -6687,7 +6687,7 @@ "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "docId": "ml-get-datafeed-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeed-stats", "name": "ml.get_datafeed_stats", "privileges": { "cluster": [ @@ -6735,7 +6735,7 @@ "description": "Get datafeeds configuration info.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "docId": "ml-get-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeeds", "name": "ml.get_datafeeds", "privileges": { "cluster": [ @@ -6783,7 +6783,7 @@ "description": "Get filters.\nYou can get a single filter or all filters.", "docId": "ml-get-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-filters", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-filters", "name": "ml.get_filters", "privileges": { "cluster": [ @@ -6831,7 +6831,7 @@ "description": "Get anomaly detection jobs usage info.", "docId": "ml-get-job-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-job-stats", "name": "ml.get_job_stats", "privileges": { "cluster": [ @@ -6879,7 +6879,7 @@ "description": "Get anomaly detection jobs configuration info.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", "docId": "ml-get-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-jobs", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-jobs", "name": "ml.get_jobs", "privileges": { "cluster": [ @@ -6927,7 +6927,7 @@ "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", "docId": "ml-get-overall-buckets", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-overall-buckets", "name": "ml.get_overall_buckets", "privileges": { "cluster": [ @@ -6973,7 +6973,7 @@ "description": "Get trained model configuration info.", "docId": "get-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-trained-models", "name": "ml.get_trained_models", "privileges": { "cluster": [ @@ -7021,7 +7021,7 @@ "description": "Get trained models usage info.\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", "docId": "get-trained-models-stats", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models-stats", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-trained-models-stats", "name": "ml.get_trained_models_stats", "privileges": { "cluster": [ @@ -7069,7 +7069,7 @@ "description": "Evaluate a trained model.", "docId": "infer-trained-model", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-infer-trained-model", "name": "ml.infer_trained_model", "request": { "name": "Request", @@ -7109,7 +7109,7 @@ "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "docId": "ml-open-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-open-job", "name": "ml.open_job", "privileges": { "cluster": [ @@ -7154,7 +7154,7 @@ "description": "Add scheduled events to the calendar.", "docId": "ml-post-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-post-calendar-events", "name": "ml.post_calendar_events", "privileges": { "cluster": [ @@ -7199,7 +7199,7 @@ "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", "docId": "preview-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-preview-data-frame-analytics", "name": "ml.preview_data_frame_analytics", "privileges": { "cluster": [ @@ -7252,7 +7252,7 @@ "description": "Preview a datafeed.\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", "docId": "ml-preview-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-datafeed", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-preview-datafeed", "name": "ml.preview_datafeed", "privileges": { "cluster": [ @@ -7308,7 +7308,7 @@ "description": "Create a calendar.", "docId": "ml-put-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-calendar", "name": "ml.put_calendar", "privileges": { "cluster": [ @@ -7353,7 +7353,7 @@ "description": "Add anomaly detection job to calendar.", "docId": "ml-put-calendar-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-calendar-job", "name": "ml.put_calendar_job", "privileges": { "cluster": [ @@ -7395,7 +7395,7 @@ "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", "docId": "put-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-data-frame-analytics", "name": "ml.put_data_frame_analytics", "privileges": { "cluster": [ @@ -7447,7 +7447,7 @@ "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", "docId": "ml-put-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-datafeed", "name": "ml.put_datafeed", "privileges": { "cluster": [ @@ -7495,7 +7495,7 @@ "description": "Create a filter.\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", "docId": "ml-put-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-filter", "name": "ml.put_filter", "privileges": { "cluster": [ @@ -7540,7 +7540,7 @@ "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", "docId": "ml-put-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-job", "name": "ml.put_job", "privileges": { "cluster": [ @@ -7588,7 +7588,7 @@ "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", "docId": "put-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model", "name": "ml.put_trained_model", "privileges": { "cluster": [ @@ -7633,7 +7633,7 @@ "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "docId": "put-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-alias", "name": "ml.put_trained_model_alias", "privileges": { "cluster": [ @@ -7678,7 +7678,7 @@ "description": "Create part of a trained model definition.", "docId": "put-trained-model-definition-part", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-definition-part", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-definition-part", "name": "ml.put_trained_model_definition_part", "privileges": { "cluster": [ @@ -7723,7 +7723,7 @@ "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "docId": "put-trained-model-vocabulary", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-vocabulary", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-vocabulary", "name": "ml.put_trained_model_vocabulary", "privileges": { "cluster": [ @@ -7768,7 +7768,7 @@ "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "docId": "ml-reset-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-reset-job", "name": "ml.reset_job", "privileges": { "cluster": [ @@ -7810,7 +7810,7 @@ "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "docId": "start-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-data-frame-analytics", "name": "ml.start_data_frame_analytics", "privileges": { "cluster": [ @@ -7862,7 +7862,7 @@ "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "docId": "ml-start-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-datafeed", "name": "ml.start_datafeed", "privileges": { "cluster": [ @@ -7907,7 +7907,7 @@ "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", "docId": "start-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-trained-model-deployment", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-trained-model-deployment", "name": "ml.start_trained_model_deployment", "privileges": { "cluster": [ @@ -7952,7 +7952,7 @@ "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "docId": "stop-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-data-frame-analytics", "name": "ml.stop_data_frame_analytics", "privileges": { "cluster": [ @@ -7997,7 +7997,7 @@ "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "docId": "ml-stop-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-datafeed", "name": "ml.stop_datafeed", "privileges": { "cluster": [ @@ -8042,7 +8042,7 @@ "description": "Stop a trained model deployment.", "docId": "stop-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-trained-model-deployment", "name": "ml.stop_trained_model_deployment", "privileges": { "cluster": [ @@ -8087,7 +8087,7 @@ "description": "Update a data frame analytics job.", "docId": "update-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-data-frame-analytics", "name": "ml.update_data_frame_analytics", "privileges": { "cluster": [ @@ -8139,7 +8139,7 @@ "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "docId": "ml-update-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-datafeed", "name": "ml.update_datafeed", "privileges": { "cluster": [ @@ -8184,7 +8184,7 @@ "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", "docId": "ml-update-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-filter", "name": "ml.update_filter", "privileges": { "cluster": [ @@ -8229,7 +8229,7 @@ "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", "docId": "ml-update-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-job", "name": "ml.update_job", "privileges": { "cluster": [ @@ -8274,7 +8274,7 @@ "description": "Update a trained model deployment.", "docId": "update-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-trained-model-deployment", "name": "ml.update_trained_model_deployment", "privileges": { "cluster": [ @@ -8319,7 +8319,7 @@ "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "docId": "search-multi-search", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-msearch", "name": "msearch", "privileges": { "index": [ @@ -8372,9 +8372,9 @@ "description": "Run multiple templated searches.\n\nRun multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "docId": "search-multi-search-template", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-msearch-template", "extDocId": "search-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/search-templates", "name": "msearch_template", "privileges": { "index": [ @@ -8426,7 +8426,7 @@ "description": "Get multiple term vectors.\n\nGet multiple term vectors with a single request.\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.\n\n**Artificial documents**\n\nYou can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request.\nThe mapping used is determined by the specified `_index`.", "docId": "docs-multi-termvectors", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-mtermvectors", "name": "mtermvectors", "privileges": { "index": [ @@ -8479,7 +8479,7 @@ "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\n\nA subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.\n\nJust like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.\nIf you want to retrieve more hits, use PIT with `search_after`.\n\nIMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.\n\nWhen a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.\nTo get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.\n\n**Keeping point in time alive**\n\nThe `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.\nThe value does not need to be long enough to process all data — it just needs to be long enough for the next request.\n\nNormally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.\nOnce the smaller segments are no longer needed they are deleted.\nHowever, open point-in-times prevent the old segments from being deleted since they are still in use.\n\nTIP: Keeping older segments alive means that more disk space and file handles are needed.\nEnsure that you have configured your nodes to have ample free file handles.\n\nAdditionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.\nEnsure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.\nNote that a point-in-time doesn't prevent its associated indices from being deleted.\nYou can check how many point-in-times (that is, search contexts) are open with the nodes stats API.", "docId": "point-in-time-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-open-point-in-time", "name": "open_point_in_time", "privileges": { "index": [ @@ -8523,7 +8523,7 @@ "description": "Ping the cluster.\nGet information about whether the cluster is running.", "docId": "cluster-ping", "docTag": "cluster", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cluster", "name": "ping", "request": { "name": "Request", @@ -8559,9 +8559,9 @@ "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", "docId": "script-put", "docTag": "script", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-put-script", "extDocId": "search-template", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/search-templates", "name": "put_script", "privileges": { "cluster": [ @@ -8613,7 +8613,7 @@ }, "description": "Delete a query rule.\nDelete a query rule within a query ruleset.\nThis is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.", "docId": "query-rule-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-rule", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-delete-rule", "name": "query_rules.delete_rule", "privileges": { "cluster": [ @@ -8654,7 +8654,7 @@ }, "description": "Delete a query ruleset.\nRemove a query ruleset and its associated data.\nThis is a destructive action that is not recoverable.", "docId": "query-ruleset-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-ruleset", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-delete-ruleset", "name": "query_rules.delete_ruleset", "privileges": { "cluster": [ @@ -8695,9 +8695,9 @@ }, "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", "docId": "query-rule-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-get-rule", "extDocId": "query-rule", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules", "name": "query_rules.get_rule", "privileges": { "cluster": [ @@ -8738,7 +8738,7 @@ }, "description": "Get a query ruleset.\nGet details about a query ruleset.", "docId": "query-ruleset-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-get-ruleset", "name": "query_rules.get_ruleset", "privileges": { "cluster": [ @@ -8779,7 +8779,7 @@ }, "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", "docId": "query-ruleset-list", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-list-rulesets", "name": "query_rules.list_rulesets", "privileges": { "cluster": [ @@ -8820,7 +8820,7 @@ }, "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.\n\nIMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", "docId": "query-rule-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-rule", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-put-rule", "name": "query_rules.put_rule", "privileges": { "cluster": [ @@ -8864,9 +8864,9 @@ }, "description": "Create or update a query ruleset.\nThere is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", "docId": "query-ruleset-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-put-ruleset", "extDocId": "query-rule", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules", "name": "query_rules.put_ruleset", "privileges": { "cluster": [ @@ -8910,7 +8910,7 @@ }, "description": "Test a query ruleset.\nEvaluate match criteria against a query ruleset to identify the rules that would match that criteria.", "docId": "query-ruleset-test", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-test", "name": "query_rules.test", "privileges": { "cluster": [ @@ -8955,7 +8955,7 @@ "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", "docId": "search-rank-eval", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rank-eval", "name": "rank_eval", "privileges": { "index": [ @@ -9008,7 +9008,7 @@ "description": "Reindex documents.\n\nCopy documents from a source to a destination.\nYou can copy all documents to the destination index or reindex a subset of the documents.\nThe source can be any existing index, alias, or data stream.\nThe destination must differ from the source.\nFor example, you cannot reindex a data stream into itself.\n\nIMPORTANT: Reindex requires `_source` to be enabled for all documents in the source.\nThe destination should be configured as wanted before calling the reindex API.\nReindex does not copy the settings from the source or its associated template.\nMappings, shard counts, and replicas, for example, must be configured ahead of time.\n\nIf the Elasticsearch security features are enabled, you must have the following security privileges:\n\n* The `read` index privilege for the source data stream, index, or alias.\n* The `write` index privilege for the destination data stream, index, or index alias.\n* To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias.\n* If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.\n\nIf reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting.\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe `dest` element can be configured like the index API to control optimistic concurrency control.\nOmitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.\n\nSetting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.\n\nSetting `op_type` to `create` causes the reindex API to create only missing documents in the destination.\nAll existing documents will cause a version conflict.\n\nIMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`.\nA reindex can only add new documents to a destination data stream.\nIt cannot update existing documents in a destination data stream.\n\nBy default, version conflicts abort the reindex process.\nTo continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`.\nIn this case, the response includes a count of the version conflicts that were encountered.\nNote that the handling of other error types is unaffected by the `conflicts` property.\nAdditionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.\n\nNOTE: The reindex API makes no effort to handle ID collisions.\nThe last document written will \"win\" but the order isn't usually predictable so it is not a good idea to rely on this behavior.\nInstead, make sure that IDs are unique by using a script.\n\n**Running reindex asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `_tasks/`.\n\n**Reindex from multiple sources**\n\nIf you have many sources to reindex it is generally better to reindex them one at a time rather than using a glob pattern to pick up multiple sources.\nThat way you can resume the process if there are any errors by removing the partially completed source and starting over.\nIt also makes parallelizing the process fairly simple: split the list of sources to reindex and run each list in parallel.\n\nFor example, you can use a bash script like this:\n\n```\nfor index in i1 i2 i3 i4 i5; do\n curl -HContent-Type:application/json -XPOST localhost:9200/_reindex?pretty -d'{\n \"source\": {\n \"index\": \"'$index'\"\n },\n \"dest\": {\n \"index\": \"'$index'-reindexed\"\n }\n }'\ndone\n```\n\n**Throttling**\n\nSet `requests_per_second` to any positive decimal number (`1.4`, `6`, `1000`, for example) to throttle the rate at which reindex issues batches of index operations.\nRequests are throttled by padding each batch with a wait time.\nTo turn off throttling, set `requests_per_second` to `-1`.\n\nThe throttling is done by waiting between batches so that the scroll that reindex uses internally can be given a timeout that takes into account the padding.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is `1000`, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single bulk request, large batch sizes cause Elasticsearch to create many requests and then wait for a while before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nYou can slice a reindex request manually by providing a slice ID and total number of slices to each request.\nYou can also let reindex automatically parallelize by using sliced scroll to slice on `_id`.\nThe `slices` parameter specifies the number of slices to use.\n\nAdding `slices` to the reindex request just automates the manual process, creating sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks API. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with `slices` will cancel each sub-request.\n* Due to the nature of `slices`, each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the previous point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being reindexed.\n* Each sub-request gets a slightly different snapshot of the source, though these are all taken at approximately the same time.\n\nIf slicing automatically, setting `slices` to `auto` will choose a reasonable number for most indices.\nIf slicing manually or otherwise tuning automatic slicing, use the following guidelines.\n\nQuery performance is most efficient when the number of slices is equal to the number of shards in the index.\nIf that number is large (for example, `500`), choose a lower number as too many slices will hurt performance.\nSetting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n\nIndexing performance scales linearly across available resources with the number of slices.\n\nWhether query or indexing performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Modify documents during reindexing**\n\nLike `_update_by_query`, reindex operations support a script that modifies the document.\nUnlike `_update_by_query`, the script is allowed to modify the document's metadata.\n\nJust as in `_update_by_query`, you can set `ctx.op` to change the operation that is run on the destination.\nFor example, set `ctx.op` to `noop` if your script decides that the document doesn’t have to be indexed in the destination. This \"no operation\" will be reported in the `noop` counter in the response body.\nSet `ctx.op` to `delete` if your script decides that the document must be deleted from the destination.\nThe deletion will be reported in the `deleted` counter in the response body.\nSetting `ctx.op` to anything else will return an error, as will setting any other field in `ctx`.\n\nThink of the possibilities! Just be careful; you are able to change:\n\n* `_id`\n* `_index`\n* `_version`\n* `_routing`\n\nSetting `_version` to `null` or clearing it from the `ctx` map is just like not sending the version in an indexing request.\nIt will cause the document to be overwritten in the destination regardless of the version on the target or the version type you use in the reindex API.\n\n**Reindex from remote**\n\nReindex supports reindexing from a remote Elasticsearch cluster.\nThe `host` parameter must contain a scheme, host, port, and optional path.\nThe `username` and `password` parameters are optional and when they are present the reindex operation will connect to the remote Elasticsearch node using basic authentication.\nBe sure to use HTTPS when using basic authentication or the password will be sent in plain text.\nThere are a range of settings available to configure the behavior of the HTTPS connection.\n\nWhen using Elastic Cloud, it is also possible to authenticate against the remote cluster through the use of a valid API key.\nRemote hosts must be explicitly allowed with the `reindex.remote.whitelist` setting.\nIt can be set to a comma delimited list of allowed remote host and port combinations.\nScheme is ignored; only the host and port are used.\nFor example:\n\n```\nreindex.remote.whitelist: [otherhost:9200, another:9200, 127.0.10.*:9200, localhost:*\"]\n```\n\nThe list of allowed hosts must be configured on any nodes that will coordinate the reindex.\nThis feature should work with remote clusters of any version of Elasticsearch.\nThis should enable you to upgrade from any version of Elasticsearch to the current version by reindexing from a cluster of the old version.\n\nWARNING: Elasticsearch does not support forward compatibility across major versions.\nFor example, you cannot reindex from a 7.x cluster into a 6.x cluster.\n\nTo enable queries sent to older versions of Elasticsearch, the `query` parameter is sent directly to the remote host without validation or modification.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nReindexing from a remote server uses an on-heap buffer that defaults to a maximum size of 100mb.\nIf the remote index includes very large documents you'll need to use a smaller batch size.\nIt is also possible to set the socket read timeout on the remote connection with the `socket_timeout` field and the connection timeout with the `connect_timeout` field.\nBoth default to 30 seconds.\n\n**Configuring SSL parameters**\n\nReindex from remote supports configurable SSL settings.\nThese must be specified in the `elasticsearch.yml` file, with the exception of the secure settings, which you add in the Elasticsearch keystore.\nIt is not possible to configure SSL in the body of the reindex request.", "docId": "docs-reindex", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-reindex", "name": "reindex", "privileges": { "index": [ @@ -9053,7 +9053,7 @@ "description": "Render a search template.\n\nRender a search template as a search request body.", "docId": "render-search-template-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-render-search-template", "name": "render_search_template", "privileges": { "index": [ @@ -9106,7 +9106,7 @@ "description": "Run a script.\n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script.", "docId": "painless-execute-api", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html", + "docUrl": "https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples", "name": "scripts_painless_execute", "request": { "name": "Request", @@ -9146,9 +9146,9 @@ "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "docId": "scroll-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-scroll", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "privileges": { "index": [ @@ -9203,9 +9203,9 @@ }, "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "docId": "search-search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search", "extDocId": "ccs-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs", "name": "search", "privileges": { "index": [ @@ -9257,7 +9257,7 @@ }, "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "docId": "search-application-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete", "name": "search_application.delete", "privileges": { "cluster": [ @@ -9306,7 +9306,7 @@ "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", "docId": "delete-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete-behavioral-analytics", "name": "search_application.delete_behavioral_analytics", "request": { "name": "Request", @@ -9342,7 +9342,7 @@ }, "description": "Get search application details.", "docId": "search-application-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get", "name": "search_application.get", "privileges": { "cluster": [ @@ -9388,7 +9388,7 @@ "description": "Get behavioral analytics collections.", "docId": "list-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get-behavioral-analytics", "name": "search_application.get_behavioral_analytics", "request": { "name": "Request", @@ -9430,7 +9430,7 @@ }, "description": "Get search applications.\nGet information about search applications.", "docId": "list-analytics-collection", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get-behavioral-analytics", "name": "search_application.list", "privileges": { "cluster": [ @@ -9471,7 +9471,7 @@ }, "description": "Create or update a search application.", "docId": "search-application-put", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put", "name": "search_application.put", "privileges": { "cluster": [ @@ -9523,7 +9523,7 @@ "description": "Create a behavioral analytics collection.", "docId": "put-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put-behavioral-analytics", "name": "search_application.put_behavioral_analytics", "request": { "name": "Request", @@ -9559,7 +9559,7 @@ }, "description": "Run a search application search.\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "docId": "search-application-search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-search", "name": "search_application.search", "request": { "name": "Request", @@ -9600,7 +9600,7 @@ "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nFor example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search\n\n```\nGET my-index/_search\n{\n \"size\": 10000,\n \"query\": {\n \"geo_bounding_box\": {\n \"my-geo-field\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"aggregations\": {\n \"grid\": {\n \"geotile_grid\": {\n \"field\": \"my-geo-field\",\n \"precision\": 11,\n \"size\": 65536,\n \"bounds\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"bounds\": {\n \"geo_bounds\": {\n \"field\": \"my-geo-field\",\n \"wrap_longitude\": false\n }\n }\n }\n}\n```\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.", "docId": "search-vector-tile-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-mvt", "extDocId": "mapbox-vector-tile", "extDocUrl": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md", "name": "search_mvt", @@ -9648,9 +9648,9 @@ "description": "Run a search with a search template.", "docId": "search-template-api", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-template", "extDocId": "search-template", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/search-templates", "name": "search_template", "privileges": { "index": [ @@ -9702,7 +9702,7 @@ }, "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", "docId": "security-api-authenticate", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-authenticate", "name": "security.authenticate", "request": { "name": "Request", @@ -9738,9 +9738,9 @@ }, "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", "docId": "security-api-create-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-create-api-key", "extDocId": "security-settings-api-keys", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#api-key-service-settings", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings", "name": "security.create_api_key", "privileges": { "cluster": [ @@ -9784,7 +9784,7 @@ }, "description": "Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.", "docId": "security-api-delete-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-role", "name": "security.delete_role", "privileges": { "cluster": [ @@ -9825,7 +9825,7 @@ }, "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "docId": "security-api-get-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-api-key", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-api-key", "name": "security.get_api_key", "privileges": { "cluster": [ @@ -9867,9 +9867,9 @@ }, "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docId": "security-api-get-builtin-privileges", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-builtin-privileges", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges", "name": "security.get_builtin_privileges", "privileges": { "cluster": [ @@ -9909,7 +9909,7 @@ }, "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", "docId": "security-api-get-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-role", "name": "security.get_role", "privileges": { "cluster": [ @@ -9956,9 +9956,9 @@ }, "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "docId": "security-api-has-privileges", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-has-privileges", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges", "name": "security.has_privileges", "request": { "name": "Request", @@ -10005,7 +10005,7 @@ }, "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\n\nTo use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges.\nThe `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys.\nThe `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys.\nThe `manage_own_api_key` only allows deleting REST API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user's identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.", "docId": "security-api-invalidate-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-api-key", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-invalidate-api-key", "name": "security.invalidate_api_key", "privileges": { "cluster": [ @@ -10049,9 +10049,9 @@ }, "description": "Create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "docId": "security-api-put-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-role", "extDocId": "defining-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles", "name": "security.put_role", "privileges": { "cluster": [ @@ -10096,7 +10096,7 @@ }, "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information.\nYou can optionally filter the results with a query.\n\nTo use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.\nIf you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "docId": "security-api-query-api-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-api-keys", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-api-keys", "name": "security.query_api_keys", "privileges": { "cluster": [ @@ -10142,7 +10142,7 @@ }, "description": "Find roles with a query.\n\nGet roles in a paginated manner.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe query roles API does not retrieve roles that are defined in roles files, nor built-in ones.\nYou can optionally filter the results with a query.\nAlso, the results can be paginated and sorted.", "docId": "security-api-query-role", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-role", "name": "security.query_role", "privileges": { "cluster": [ @@ -10187,7 +10187,7 @@ }, "description": "Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified.", "docId": "security-api-update-key", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-api-key", "name": "security.update_api_key", "privileges": { "cluster": [ @@ -10231,7 +10231,7 @@ }, "description": "Clear an SQL search cursor.", "docId": "sql-clear-cursor-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-clear-cursor", "name": "sql.clear_cursor", "request": { "name": "Request", @@ -10270,7 +10270,7 @@ }, "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.", "docId": "sql-delete-async-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-delete-async", "name": "sql.delete_async", "privileges": { "cluster": [ @@ -10311,7 +10311,7 @@ }, "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.", "docId": "sql-async-search-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async", "name": "sql.get_async", "request": { "name": "Request", @@ -10347,7 +10347,7 @@ }, "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", "docId": "sql-async-status-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async-status", "name": "sql.get_async_status", "privileges": { "cluster": [ @@ -10388,7 +10388,7 @@ }, "description": "Get SQL search results.\nRun an SQL request.", "docId": "sql-search-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-query", "name": "sql.query", "privileges": { "index": [ @@ -10433,7 +10433,7 @@ }, "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.", "docId": "sql-translate-api", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-translate", "name": "sql.translate", "privileges": { "index": [ @@ -10478,7 +10478,7 @@ }, "description": "Delete a synonym set.\n\nYou can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it.", "docId": "synonym-set-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym", "name": "synonyms.delete_synonym", "privileges": { "cluster": [ @@ -10519,7 +10519,7 @@ }, "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", "docId": "synonym-rule-delete", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym-rule", "name": "synonyms.delete_synonym_rule", "privileges": { "cluster": [ @@ -10563,7 +10563,7 @@ }, "description": "Get a synonym set.", "docId": "synonym-set-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym", "name": "synonyms.get_synonym", "privileges": { "cluster": [ @@ -10604,7 +10604,7 @@ }, "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", "docId": "synonym-rule-get", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym-rule", "name": "synonyms.get_synonym_rule", "privileges": { "cluster": [ @@ -10648,7 +10648,7 @@ }, "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", "docId": "synonym-set-list", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym", "name": "synonyms.get_synonyms_sets", "privileges": { "cluster": [ @@ -10689,7 +10689,7 @@ }, "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.", "docId": "synonym-set-create", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym", "name": "synonyms.put_synonym", "privileges": { "cluster": [ @@ -10733,7 +10733,7 @@ }, "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.", "docId": "synonym-rule-create", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym-rule", "name": "synonyms.put_synonym_rule", "privileges": { "cluster": [ @@ -10777,7 +10777,7 @@ }, "description": "Get task information.\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.", "docId": "tasks", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks", "name": "tasks.get", "privileges": { "cluster": [ @@ -10819,7 +10819,7 @@ "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "docId": "search-terms-enum", "docTag": "search", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-terms-enum", "name": "terms_enum", "request": { "name": "Request", @@ -10859,7 +10859,7 @@ "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.", "docId": "docs-termvectors", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-termvectors", "name": "termvectors", "privileges": { "index": [ @@ -10911,7 +10911,7 @@ }, "description": "Delete a transform.", "docId": "delete-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-delete-transform", "name": "transform.delete_transform", "privileges": { "cluster": [ @@ -10952,7 +10952,7 @@ }, "description": "Get transforms.\nGet configuration information for transforms.", "docId": "get-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform", "name": "transform.get_transform", "privileges": { "cluster": [ @@ -10999,7 +10999,7 @@ }, "description": "Get transform stats.\n\nGet usage information for transforms.", "docId": "get-transform-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform-stats", "name": "transform.get_transform_stats", "privileges": { "cluster": [ @@ -11044,7 +11044,7 @@ }, "description": "Preview a transform.\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "docId": "preview-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-preview-transform", "name": "transform.preview_transform", "privileges": { "cluster": [ @@ -11100,7 +11100,7 @@ }, "description": "Create a transform.\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", "docId": "put-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-put-transform", "name": "transform.put_transform", "privileges": { "cluster": [ @@ -11150,7 +11150,7 @@ }, "description": "Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "docId": "reset-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-reset-transform", "name": "transform.reset_transform", "privileges": { "cluster": [ @@ -11191,7 +11191,7 @@ }, "description": "Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.", "docId": "schedule-now-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-schedule-now-transform", "name": "transform.schedule_now_transform", "privileges": { "cluster": [ @@ -11235,7 +11235,7 @@ }, "description": "Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "docId": "start-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-start-transform", "name": "transform.start_transform", "privileges": { "cluster": [ @@ -11280,7 +11280,7 @@ }, "description": "Stop transforms.\nStops one or more transforms.", "docId": "stop-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-stop-transform", "name": "transform.stop_transform", "privileges": { "cluster": [ @@ -11321,7 +11321,7 @@ }, "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "docId": "update-transform", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-update-transform", "name": "transform.update_transform", "privileges": { "cluster": [ @@ -11370,7 +11370,7 @@ "description": "Update a document.\n\nUpdate a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).", "docId": "docs-update", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update", "name": "update", "privileges": { "index": [ @@ -11415,7 +11415,7 @@ "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `index` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to turn off throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is 1000, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with slices will cancel each sub-request.\n* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Update the document source**\n\nUpdate by query supports scripts to update the document source.\nAs with the update API, you can set `ctx.op` to change the operation that is performed.\n\nSet `ctx.op = \"noop\"` if your script decides that it doesn't have to make any changes.\nThe update by query operation skips updating the document and increments the `noop` counter.\n\nSet `ctx.op = \"delete\"` if your script decides that the document should be deleted.\nThe update by query operation deletes the document and increments the `deleted` counter.\n\nUpdate by query supports only `index`, `noop`, and `delete`.\nSetting `ctx.op` to anything else is an error.\nSetting any other field in `ctx` is an error.\nThis API enables you to only modify the source of matching documents; you cannot move them.", "docId": "docs-update-by-query", "docTag": "document", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query", "name": "update_by_query", "privileges": { "index": [ @@ -12020,7 +12020,7 @@ }, { "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -17663,7 +17663,7 @@ { "description": "Only perform the operation if the document has this primary term.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_primary_term", "required": false, "type": { @@ -17677,7 +17677,7 @@ { "description": "Only perform the operation if the document has this sequence number.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_seq_no", "required": false, "type": { @@ -17897,7 +17897,7 @@ { "description": "Only perform the operation if the document has this primary term.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_primary_term", "required": false, "type": { @@ -17911,7 +17911,7 @@ { "description": "Only perform the operation if the document has this sequence number.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_seq_no", "required": false, "type": { @@ -18366,7 +18366,7 @@ { "description": "The period to retain the search context for scrolling.", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "required": false, "type": { @@ -19498,7 +19498,7 @@ { "description": "EQL query you wish to run.", "docId": "eql-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax", "name": "query", "required": true, "type": { @@ -19536,7 +19536,7 @@ { "description": "Field used to sort hits with the same timestamp in ascending order", "docId": "sort-tiebreaker", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html#eql-search-specify-a-sort-tiebreaker", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql#eql-search-specify-a-sort-tiebreaker", "name": "tiebreaker_field", "required": false, "type": { @@ -19661,7 +19661,7 @@ { "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "docId": "eql-basic-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-basic-syntax", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-basic-syntax", "name": "size", "required": false, "type": { @@ -19972,7 +19972,7 @@ { "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", "docId": "esql-query-params", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html#esql-rest-params", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest#esql-rest-params", "name": "params", "required": false, "type": { @@ -20199,7 +20199,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -20227,7 +20227,7 @@ { "description": "A custom value used to route operations to a specific shard.", "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get#get-routing", "name": "routing", "required": false, "type": { @@ -20385,7 +20385,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "extDocId": "realtime", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -20413,7 +20413,7 @@ { "description": "A custom value used to route operations to a specific shard.", "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get#get-routing", "name": "routing", "required": false, "type": { @@ -20849,7 +20849,7 @@ }, "description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", "docId": "runtime-search-request", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request", "name": "runtime_mappings", "required": false, "type": { @@ -21151,7 +21151,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -21179,7 +21179,7 @@ { "description": "A custom value used to route operations to a specific shard.", "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get#get-routing", "name": "routing", "required": false, "type": { @@ -21538,7 +21538,7 @@ { "description": "A custom value used to route operations to a specific shard.", "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get#get-routing", "name": "routing", "required": false, "type": { @@ -21921,7 +21921,7 @@ { "description": "Only perform the operation if the document has this primary term.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_primary_term", "required": false, "type": { @@ -21935,7 +21935,7 @@ { "description": "Only perform the operation if the document has this sequence number.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_seq_no", "required": false, "type": { @@ -22284,7 +22284,7 @@ { "description": "The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.", "docId": "analysis-analyzers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/analyzer-reference", "name": "analyzer", "required": false, "type": { @@ -22313,7 +22313,7 @@ { "description": "Array of character filters used to preprocess characters before the tokenizer.", "docId": "analysis-charfilters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/character-filter-reference", "name": "char_filter", "required": false, "type": { @@ -22355,7 +22355,7 @@ { "description": "Array of token filters used to apply after the tokenizer.", "docId": "analysis-tokenfilters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/token-filter-reference", "name": "filter", "required": false, "type": { @@ -22372,7 +22372,7 @@ { "description": "Normalizer to use to convert text into a single token.", "docId": "analysis-normalizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/normalizers", "name": "normalizer", "required": false, "type": { @@ -22398,7 +22398,7 @@ { "description": "Tokenizer to use to convert text into tokens.", "docId": "analysis-tokenizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference", "name": "tokenizer", "required": false, "type": { @@ -22464,7 +22464,7 @@ { "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", "docId": "analysis-standard-analyzer", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-standard-analyzer.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-standard-analyzer", "name": "index", "required": false, "type": { @@ -22480,7 +22480,7 @@ { "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", "docId": "analysis-standard-analyzer", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-standard-analyzer.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-standard-analyzer", "name": "index", "required": false, "type": { @@ -22571,7 +22571,7 @@ { "description": "Mapping for fields in the index. If specified, this mapping can include:\n- Field names\n- Field data types\n- Mapping parameters", "docId": "mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/mapping", "name": "mappings", "required": false, "type": { @@ -24873,7 +24873,7 @@ { "description": "Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.", "docId": "api-date-math-index-names", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-date-math-index-names", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-date-math-index-names", "name": "name", "required": true, "type": { @@ -25170,7 +25170,7 @@ { "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -26499,7 +26499,7 @@ { "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "docId": "avoid-index-pattern-collisions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html#avoid-index-pattern-collisions", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/templates#avoid-index-pattern-collisions", "name": "index_patterns", "required": false, "type": { @@ -26576,7 +26576,7 @@ { "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -27536,7 +27536,7 @@ } ] }, - "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", + "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\nFor details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "inherits": { "type": { "name": "RequestBase", @@ -27589,7 +27589,7 @@ } } ], - "specLocation": "inference/inference/InferenceRequest.ts#L26-L89" + "specLocation": "inference/inference/InferenceRequest.ts#L26-L91" }, { "body": { @@ -27695,7 +27695,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -27836,7 +27836,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -27967,7 +27967,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -28092,7 +28092,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -28223,7 +28223,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -28354,7 +28354,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -28485,7 +28485,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -28642,7 +28642,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -28771,7 +28771,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -28885,7 +28885,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -29016,7 +29016,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -29130,7 +29130,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -29261,7 +29261,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -29374,7 +29374,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -29505,7 +29505,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -31117,7 +31117,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -31169,7 +31169,7 @@ { "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.", "docId": "mapping-source-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field", "name": "_source_excludes", "required": false, "type": { @@ -31183,7 +31183,7 @@ { "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "docId": "mapping-source-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field", "name": "_source_includes", "required": false, "type": { @@ -32279,7 +32279,7 @@ { "description": "A query clause that retrieves a subset of data from the source index.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": false, "type": { @@ -34469,7 +34469,7 @@ { "description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.", "docId": "put-dfanalytics", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-data-frame-analytics", "name": "config", "required": false, "type": { @@ -34886,7 +34886,7 @@ { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "allow_lazy_start", "required": false, "serverDefault": false, @@ -37746,7 +37746,7 @@ { "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "model_memory_limit", "required": false, "serverDefault": "1gb", @@ -37774,7 +37774,7 @@ { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "allow_lazy_start", "required": false, "serverDefault": false, @@ -38584,7 +38584,7 @@ { "description": "Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "allow_lazy_open", "required": false, "serverDefault": false, @@ -38690,7 +38690,7 @@ { "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.", "docId": "ml-model-snapshots", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs#ml-ad-model-snapshots", "name": "daily_model_snapshot_retention_after_days", "required": false, "serverDefault": 1, @@ -38705,7 +38705,7 @@ { "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.", "docId": "ml-model-snapshots", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs#ml-ad-model-snapshots", "name": "model_snapshot_retention_days", "required": false, "serverDefault": 10, @@ -39251,7 +39251,7 @@ { "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "docId": "ccs-network-delays", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "docUrl": "https://www.elastic.co/docs/solutions/search/cross-cluster-search#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, @@ -39765,7 +39765,7 @@ { "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -41280,7 +41280,7 @@ { "description": "The number of slices this task should be divided into.\nIt defaults to one slice, which means the task isn't sliced into subtasks.\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nIf set to `auto`, Elasticsearch chooses the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards.", "extDocId": "slice-scroll", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#slice-scroll", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#slice-scroll", "name": "slices", "required": false, "serverDefault": "1", @@ -41845,7 +41845,7 @@ { "description": "The period to retain the search context for scrolling.", "docId": "scroll-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "required": false, "serverDefault": "1d", @@ -41911,7 +41911,7 @@ { "description": "The period to retain the search context for scrolling.", "docId": "scroll-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "required": false, "serverDefault": "1d", @@ -42107,7 +42107,7 @@ { "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "extDocId": "relevance-scores", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores", "name": "indices_boost", "required": false, "type": { @@ -42135,7 +42135,7 @@ { "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "extDocId": "docvalue-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields", "name": "docvalue_fields", "required": false, "type": { @@ -42158,7 +42158,7 @@ }, "description": "The approximate kNN search to run.", "extDocId": "knn-approximate", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn", "name": "knn", "required": false, "type": { @@ -42224,7 +42224,7 @@ { "description": "The search definition using the Query DSL.", "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": false, "type": { @@ -42346,7 +42346,7 @@ { "description": "A comma-separated list of : pairs.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -42360,7 +42360,7 @@ { "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", "extDocId": "source-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#source-filtering", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering", "name": "_source", "required": false, "type": { @@ -42452,7 +42452,7 @@ { "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "seq_no_primary_term", "required": false, "type": { @@ -42466,7 +42466,7 @@ { "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "extDocId": "stored-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields", "name": "stored_fields", "required": false, "type": { @@ -42492,7 +42492,7 @@ { "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", "extDocId": "runtime-search-request", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request", "name": "runtime_mappings", "required": false, "type": { @@ -42631,7 +42631,7 @@ { "description": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.", "extDocId": "ccs-network-delays", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/cross-cluster-search#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, @@ -42671,7 +42671,7 @@ { "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit.", "extDocId": "docvalue-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields", "name": "docvalue_fields", "required": false, "type": { @@ -42804,7 +42804,7 @@ { "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.", "extDocId": "shard-request-cache", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shard-request-cache.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/shard-request-cache", "name": "request_cache", "required": false, "type": { @@ -42830,7 +42830,7 @@ { "description": "The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "required": false, "type": { @@ -42844,7 +42844,7 @@ { "description": "Indicates how distributed term frequencies are calculated for relevance scoring.", "extDocId": "relevance-scores", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores", "name": "search_type", "required": false, "type": { @@ -42873,7 +42873,7 @@ { "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "extDocId": "stored-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields", "name": "stored_fields", "required": false, "type": { @@ -43063,7 +43063,7 @@ { "description": "If `true`, the request returns the sequence number and primary term of the last modification of each hit.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "seq_no_primary_term", "required": false, "type": { @@ -43115,7 +43115,7 @@ { "description": "A comma-separated list of `:` pairs.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -44941,7 +44941,7 @@ { "description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.", "extDocId": "security-api-put-role", - "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-role", "name": "role_descriptors", "required": false, "type": { @@ -45966,7 +45966,7 @@ { "description": "A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", "extDocId": "run-as-privilege", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users", "name": "run_as", "required": false, "type": { @@ -46164,7 +46164,7 @@ { "description": "The sort definition.\nOther than `id`, all public fields of an API key are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -46191,7 +46191,7 @@ { "description": "The search after definition.", "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after", "name": "search_after", "required": false, "type": { @@ -46421,7 +46421,7 @@ { "description": "The sort definition.\nYou can sort on `username`, `roles`, or `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -46448,7 +46448,7 @@ { "description": "The search after definition.", "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after", "name": "search_after", "required": false, "type": { @@ -47155,7 +47155,7 @@ { "description": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.", "extDocId": "sql-rest-columnar", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-columnar.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-columnar", "name": "columnar", "required": false, "serverDefault": false, @@ -47208,7 +47208,7 @@ { "description": "The Elasticsearch query DSL for additional filtering.", "extDocId": "sql-rest-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-filtering.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering", "name": "filter", "required": false, "serverDefault": "none", @@ -47294,7 +47294,7 @@ { "description": "The SQL query to run.", "extDocId": "sql-spec", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-spec.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/sql/sql-spec", "name": "query", "required": false, "type": { @@ -47382,7 +47382,7 @@ { "description": "The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.", "extDocId": "sql-rest-format", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-format.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-format", "name": "format", "required": false, "type": { @@ -47510,7 +47510,7 @@ { "description": "The Elasticsearch query DSL for additional filtering.", "extDocId": "sql-rest-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-filtering.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering", "name": "filter", "required": false, "serverDefault": "none", @@ -48185,7 +48185,7 @@ { "description": "The synonym rule information definition, which must be in Solr format.", "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms", "name": "synonyms", "required": true, "type": { @@ -48462,7 +48462,7 @@ { "description": "Filter an index shard if the provided query rewrites to `match_none`.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "index_filter", "required": false, "type": { @@ -48612,7 +48612,7 @@ { "description": "Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.", "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query", "name": "filter", "required": false, "type": { @@ -48912,7 +48912,7 @@ { "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -50825,7 +50825,7 @@ { "description": "Only perform the operation if the document has this primary term.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_primary_term", "required": false, "type": { @@ -50839,7 +50839,7 @@ { "description": "Only perform the operation if the document has this sequence number.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_seq_no", "required": false, "type": { @@ -52718,7 +52718,7 @@ { "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "extDocId": "relevance-scores", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores", "name": "indices_boost", "required": false, "type": { @@ -52746,7 +52746,7 @@ { "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "extDocId": "docvalue-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields", "name": "docvalue_fields", "required": false, "type": { @@ -52769,7 +52769,7 @@ }, "description": "The approximate kNN search to run.", "extDocId": "knn-approximate", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn", "name": "knn", "required": false, "type": { @@ -52835,7 +52835,7 @@ { "description": "The search definition using the Query DSL.", "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": false, "type": { @@ -52957,7 +52957,7 @@ { "description": "A comma-separated list of : pairs.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -52971,7 +52971,7 @@ { "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", "extDocId": "source-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#source-filtering", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering", "name": "_source", "required": false, "type": { @@ -53063,7 +53063,7 @@ { "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "seq_no_primary_term", "required": false, "type": { @@ -53077,7 +53077,7 @@ { "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "extDocId": "stored-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields", "name": "stored_fields", "required": false, "type": { @@ -53103,7 +53103,7 @@ { "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", "extDocId": "runtime-search-request", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request", "name": "runtime_mappings", "required": false, "type": { @@ -53181,7 +53181,7 @@ { "description": "A bucket aggregation returning a form of adjacency matrix.\nThe request provides a collection of named filter expressions, similar to the `filters` aggregation.\nEach bucket in the response represents a non-empty cell in the matrix of intersecting filters.", "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation", "name": "adjacency_matrix", "required": false, "type": { @@ -53195,7 +53195,7 @@ { "description": "A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation", "name": "auto_date_histogram", "required": false, "type": { @@ -53209,7 +53209,7 @@ { "description": "A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation", "name": "avg", "required": false, "type": { @@ -53223,7 +53223,7 @@ { "description": "A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.\nThe specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation", "name": "avg_bucket", "required": false, "type": { @@ -53237,7 +53237,7 @@ { "description": "A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-boxplot-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation", "name": "boxplot", "required": false, "type": { @@ -53251,7 +53251,7 @@ { "description": "A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation", "name": "bucket_script", "required": false, "type": { @@ -53265,7 +53265,7 @@ { "description": "A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation", "name": "bucket_selector", "required": false, "type": { @@ -53279,7 +53279,7 @@ { "description": "A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation", "name": "bucket_sort", "required": false, "type": { @@ -53301,7 +53301,7 @@ }, "description": "A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test (\"K-S test\") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.", "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation", "name": "bucket_count_ks_test", "required": false, "type": { @@ -53323,7 +53323,7 @@ }, "description": "A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.", "extDocId": "search-aggregations-bucket-correlation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation", "name": "bucket_correlation", "required": false, "type": { @@ -53337,7 +53337,7 @@ { "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", "extDocId": "search-aggregations-metrics-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation", "name": "cardinality", "required": false, "type": { @@ -53359,7 +53359,7 @@ }, "description": "A multi-bucket aggregation that groups semi-structured text into buckets.", "extDocId": "search-aggregations-bucket-categorize-text-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation", "name": "categorize_text", "required": false, "type": { @@ -53373,7 +53373,7 @@ { "description": "A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.", "extDocId": "search-aggregations-bucket-children-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation", "name": "children", "required": false, "type": { @@ -53399,7 +53399,7 @@ { "description": "A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation", "name": "cumulative_cardinality", "required": false, "type": { @@ -53413,7 +53413,7 @@ { "description": "A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation", "name": "cumulative_sum", "required": false, "type": { @@ -53427,7 +53427,7 @@ { "description": "A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", "extDocId": "search-aggregations-bucket-datehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation", "name": "date_histogram", "required": false, "type": { @@ -53441,7 +53441,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-daterange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation", "name": "date_range", "required": false, "type": { @@ -53455,7 +53455,7 @@ { "description": "A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-derivative-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation", "name": "derivative", "required": false, "type": { @@ -53469,7 +53469,7 @@ { "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.\nSimilar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.", "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation", "name": "diversified_sampler", "required": false, "type": { @@ -53483,7 +53483,7 @@ { "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-extendedstats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation", "name": "extended_stats", "required": false, "type": { @@ -53497,7 +53497,7 @@ { "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-extended-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-extended-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation", "name": "extended_stats_bucket", "required": false, "type": { @@ -53511,7 +53511,7 @@ { "description": "A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.", "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation", "name": "frequent_item_sets", "required": false, "type": { @@ -53525,7 +53525,7 @@ { "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", "extDocId": "search-aggregations-bucket-filter-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation", "name": "filter", "required": false, "type": { @@ -53539,7 +53539,7 @@ { "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", "extDocId": "search-aggregations-bucket-filters-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation", "name": "filters", "required": false, "type": { @@ -53553,7 +53553,7 @@ { "description": "A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.", "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation", "name": "geo_bounds", "required": false, "type": { @@ -53567,7 +53567,7 @@ { "description": "A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.", "extDocId": "search-aggregations-metrics-geocentroid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation", "name": "geo_centroid", "required": false, "type": { @@ -53581,7 +53581,7 @@ { "description": "A multi-bucket aggregation that works on `geo_point` fields.\nEvaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.", "extDocId": "search-aggregations-bucket-geodistance-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation", "name": "geo_distance", "required": false, "type": { @@ -53595,7 +53595,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell is labeled using a geohash which is of user-definable precision.", "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation", "name": "geohash_grid", "required": false, "type": { @@ -53609,7 +53609,7 @@ { "description": "Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.", "extDocId": "search-aggregations-metrics-geo-line", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line", "name": "geo_line", "required": false, "type": { @@ -53623,7 +53623,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a map tile as used by many online map sites.", "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation", "name": "geotile_grid", "required": false, "type": { @@ -53637,7 +53637,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a H3 cell index and is labeled using the H3Index representation.", "extDocId": "search-aggregations-bucket-geohexgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohexgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation", "name": "geohex_grid", "required": false, "type": { @@ -53651,7 +53651,7 @@ { "description": "Defines a single bucket of all the documents within the search execution context.\nThis context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.", "extDocId": "search-aggregations-bucket-global-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation", "name": "global", "required": false, "type": { @@ -53665,7 +53665,7 @@ { "description": "A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", "extDocId": "search-aggregations-bucket-histogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation", "name": "histogram", "required": false, "type": { @@ -53679,7 +53679,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-iprange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation", "name": "ip_range", "required": false, "type": { @@ -53693,7 +53693,7 @@ { "description": "A bucket aggregation that groups documents based on the network or sub-network of an IP address.", "extDocId": "search-aggregations-bucket-ipprefix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation", "name": "ip_prefix", "required": false, "type": { @@ -53707,7 +53707,7 @@ { "description": "A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.", "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation", "name": "inference", "required": false, "type": { @@ -53732,7 +53732,7 @@ { "description": "A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.", "extDocId": "search-aggregations-matrix-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation", "name": "matrix_stats", "required": false, "type": { @@ -53746,7 +53746,7 @@ { "description": "A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-max-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation", "name": "max", "required": false, "type": { @@ -53760,7 +53760,7 @@ { "description": "A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation", "name": "max_bucket", "required": false, "type": { @@ -53774,7 +53774,7 @@ { "description": "A single-value aggregation that approximates the median absolute deviation of its search results.", "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation", "name": "median_absolute_deviation", "required": false, "type": { @@ -53788,7 +53788,7 @@ { "description": "A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-min-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation", "name": "min", "required": false, "type": { @@ -53802,7 +53802,7 @@ { "description": "A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation", "name": "min_bucket", "required": false, "type": { @@ -53816,7 +53816,7 @@ { "description": "A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).", "extDocId": "search-aggregations-bucket-missing-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation", "name": "missing", "required": false, "type": { @@ -53841,7 +53841,7 @@ { "description": "Given an ordered series of percentiles, \"slides\" a window across those percentiles and computes cumulative percentiles.", "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation", "name": "moving_percentiles", "required": false, "type": { @@ -53855,7 +53855,7 @@ { "description": "Given an ordered series of data, \"slides\" a window across the data and runs a custom script on each window of data.\nFor convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.", "extDocId": "search-aggregations-pipeline-movfn-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation", "name": "moving_fn", "required": false, "type": { @@ -53869,7 +53869,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.", "extDocId": "search-aggregations-bucket-multi-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation", "name": "multi_terms", "required": false, "type": { @@ -53883,7 +53883,7 @@ { "description": "A special single bucket aggregation that enables aggregating nested documents.", "extDocId": "search-aggregations-bucket-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation", "name": "nested", "required": false, "type": { @@ -53897,7 +53897,7 @@ { "description": "A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.", "extDocId": "search-aggregations-pipeline-normalize-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation", "name": "normalize", "required": false, "type": { @@ -53911,7 +53911,7 @@ { "description": "A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.", "extDocId": "search-aggregations-bucket-parent-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation", "name": "parent", "required": false, "type": { @@ -53925,7 +53925,7 @@ { "description": "A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation", "name": "percentile_ranks", "required": false, "type": { @@ -53939,7 +53939,7 @@ { "description": "A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-percentile-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation", "name": "percentiles", "required": false, "type": { @@ -53953,7 +53953,7 @@ { "description": "A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation", "name": "percentiles_bucket", "required": false, "type": { @@ -53967,7 +53967,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-range-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation", "name": "range", "required": false, "type": { @@ -53981,7 +53981,7 @@ { "description": "A multi-bucket value source based aggregation which finds \"rare\" terms — terms that are at the long-tail of the distribution and are not frequent.", "extDocId": "search-aggregations-bucket-rare-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation", "name": "rare_terms", "required": false, "type": { @@ -53995,7 +53995,7 @@ { "description": "Calculates a rate of documents or a field in each bucket.\nCan only be used inside a `date_histogram` or `composite` aggregation.", "extDocId": "search-aggregations-metrics-rate-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation", "name": "rate", "required": false, "type": { @@ -54009,7 +54009,7 @@ { "description": "A special single bucket aggregation that enables aggregating on parent documents from nested documents.\nShould only be defined inside a `nested` aggregation.", "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation", "name": "reverse_nested", "required": false, "type": { @@ -54023,7 +54023,7 @@ { "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.", "extDocId": "search-aggregations-bucket-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation", "name": "sampler", "required": false, "type": { @@ -54037,7 +54037,7 @@ { "description": "A metric aggregation that uses scripts to provide a metric output.", "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation", "name": "scripted_metric", "required": false, "type": { @@ -54051,7 +54051,7 @@ { "description": "An aggregation that subtracts values in a time series from themselves at different time lags or periods.", "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation", "name": "serial_diff", "required": false, "type": { @@ -54065,7 +54065,7 @@ { "description": "Returns interesting or unusual occurrences of terms in a set.", "extDocId": "search-aggregations-bucket-significantterms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation", "name": "significant_terms", "required": false, "type": { @@ -54079,7 +54079,7 @@ { "description": "Returns interesting or unusual occurrences of free-text terms in a set.", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation", "name": "significant_text", "required": false, "type": { @@ -54093,7 +54093,7 @@ { "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation", "name": "stats", "required": false, "type": { @@ -54107,7 +54107,7 @@ { "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation", "name": "stats_bucket", "required": false, "type": { @@ -54121,7 +54121,7 @@ { "description": "A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-string-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-string-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation", "name": "string_stats", "required": false, "type": { @@ -54135,7 +54135,7 @@ { "description": "A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation", "name": "sum", "required": false, "type": { @@ -54149,7 +54149,7 @@ { "description": "A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation", "name": "sum_bucket", "required": false, "type": { @@ -54163,7 +54163,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", "extDocId": "search-aggregations-bucket-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation", "name": "terms", "required": false, "type": { @@ -54185,7 +54185,7 @@ }, "description": "The time series aggregation queries data created using a time series index.\nThis is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.", "extDocId": "search-aggregations-bucket-time-series-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation", "name": "time_series", "required": false, "type": { @@ -54199,7 +54199,7 @@ { "description": "A metric aggregation that returns the top matching documents per bucket.", "extDocId": "search-aggregations-metrics-top-hits-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation", "name": "top_hits", "required": false, "type": { @@ -54213,7 +54213,7 @@ { "description": "A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-ttest-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation", "name": "t_test", "required": false, "type": { @@ -54227,7 +54227,7 @@ { "description": "A metric aggregation that selects metrics from the document with the largest or smallest sort value.", "extDocId": "search-aggregations-metrics-top-metrics", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics", "name": "top_metrics", "required": false, "type": { @@ -54241,7 +54241,7 @@ { "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-valuecount-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation", "name": "value_count", "required": false, "type": { @@ -54255,7 +54255,7 @@ { "description": "A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-weight-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation", "name": "weighted_avg", "required": false, "type": { @@ -54269,7 +54269,7 @@ { "description": "A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation", "name": "variable_width_histogram", "required": false, "type": { @@ -54388,7 +54388,7 @@ { "description": "An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.", "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "kind": "interface", "name": { "name": "QueryContainer", @@ -54398,7 +54398,7 @@ { "description": "matches documents matching boolean combinations of other queries.", "extDocId": "query-dsl-bool-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "name": "bool", "required": false, "type": { @@ -54412,7 +54412,7 @@ { "description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.", "extDocId": "query-dsl-boosting-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-boosting-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query", "name": "boosting", "required": false, "type": { @@ -54458,7 +54458,7 @@ }, "description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.", "extDocId": "query-dsl-combined-fields-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-combined-fields-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query", "name": "combined_fields", "required": false, "type": { @@ -54472,7 +54472,7 @@ { "description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.", "extDocId": "query-dsl-constant-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query", "name": "constant_score", "required": false, "type": { @@ -54486,7 +54486,7 @@ { "description": "Returns documents matching one or more wrapped queries, called query clauses or clauses.\nIf a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.", "extDocId": "query-dsl-dis-max-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query", "name": "dis_max", "required": false, "type": { @@ -54500,7 +54500,7 @@ { "description": "Boosts the relevance score of documents closer to a provided origin date or point.\nFor example, you can use this query to give more weight to documents closer to a certain date or location.", "extDocId": "query-dsl-distance-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query", "name": "distance_feature", "required": false, "type": { @@ -54514,7 +54514,7 @@ { "description": "Returns documents that contain an indexed value for a field.", "extDocId": "query-dsl-exists-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "name": "exists", "required": false, "type": { @@ -54528,7 +54528,7 @@ { "description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.", "extDocId": "query-dsl-function-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query", "name": "function_score", "required": false, "type": { @@ -54542,7 +54542,7 @@ { "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.", "extDocId": "query-dsl-fuzzy-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query", "name": "fuzzy", "required": false, "type": { @@ -54567,7 +54567,7 @@ { "description": "Matches geo_point and geo_shape values that intersect a bounding box.", "extDocId": "query-dsl-geo-bounding-box-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query", "name": "geo_bounding_box", "required": false, "type": { @@ -54581,7 +54581,7 @@ { "description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.", "extDocId": "query-dsl-geo-distance-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query", "name": "geo_distance", "required": false, "type": { @@ -54633,7 +54633,7 @@ { "description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.", "extDocId": "query-dsl-geo-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query", "name": "geo_shape", "required": false, "type": { @@ -54647,7 +54647,7 @@ { "description": "Returns parent documents whose joined child documents match a provided query.", "extDocId": "query-dsl-has-child-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-child-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query", "name": "has_child", "required": false, "type": { @@ -54661,7 +54661,7 @@ { "description": "Returns child documents whose joined parent document matches a provided query.", "extDocId": "query-dsl-has-parent-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query", "name": "has_parent", "required": false, "type": { @@ -54675,7 +54675,7 @@ { "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", "extDocId": "query-dsl-ids-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "name": "ids", "required": false, "type": { @@ -54689,7 +54689,7 @@ { "description": "Returns documents based on the order and proximity of matching terms.", "extDocId": "query-dsl-intervals-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query", "name": "intervals", "required": false, "type": { @@ -54714,7 +54714,7 @@ { "description": "Finds the k nearest vectors to a query vector, as measured by a similarity\nmetric. knn query finds nearest vectors through approximate search on indexed\ndense_vectors.", "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query", "name": "knn", "required": false, "type": { @@ -54728,7 +54728,7 @@ { "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "extDocId": "query-dsl-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "name": "match", "required": false, "type": { @@ -54753,7 +54753,7 @@ { "description": "Matches all documents, giving them all a `_score` of 1.0.", "extDocId": "query-dsl-match-all-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "name": "match_all", "required": false, "type": { @@ -54767,7 +54767,7 @@ { "description": "Analyzes its input and constructs a `bool` query from the terms.\nEach term except the last is used in a `term` query.\nThe last term is used in a prefix query.", "extDocId": "query-dsl-match-bool-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query", "name": "match_bool_prefix", "required": false, "type": { @@ -54792,7 +54792,7 @@ { "description": "Matches no documents.", "extDocId": "query-dsl-match-none-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query", "name": "match_none", "required": false, "type": { @@ -54806,7 +54806,7 @@ { "description": "Analyzes the text and creates a phrase query out of the analyzed text.", "extDocId": "query-dsl-match-query-phrase", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase", "name": "match_phrase", "required": false, "type": { @@ -54831,7 +54831,7 @@ { "description": "Returns documents that contain the words of a provided text, in the same order as provided.\nThe last term of the provided text is treated as a prefix, matching any words that begin with that term.", "extDocId": "query-dsl-match-query-phrase-prefix", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix", "name": "match_phrase_prefix", "required": false, "type": { @@ -54856,7 +54856,7 @@ { "description": "Returns documents that are \"like\" a given set of documents.", "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query", "name": "more_like_this", "required": false, "type": { @@ -54870,7 +54870,7 @@ { "description": "Enables you to search for a provided text, number, date or boolean value across multiple fields.\nThe provided text is analyzed before matching.", "extDocId": "query-dsl-multi-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query", "name": "multi_match", "required": false, "type": { @@ -54884,7 +54884,7 @@ { "description": "Wraps another query to search nested fields.\nIf an object matches the search, the nested query returns the root parent document.", "extDocId": "query-dsl-nested-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query", "name": "nested", "required": false, "type": { @@ -54898,7 +54898,7 @@ { "description": "Returns child documents joined to a specific parent document.", "extDocId": "query-dsl-parent-id-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query", "name": "parent_id", "required": false, "type": { @@ -54912,7 +54912,7 @@ { "description": "Matches queries stored in an index.", "extDocId": "query-dsl-percolate-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query", "name": "percolate", "required": false, "type": { @@ -54926,7 +54926,7 @@ { "description": "Promotes selected documents to rank higher than those matching a given query.", "extDocId": "query-dsl-pinned-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query", "name": "pinned", "required": false, "type": { @@ -54940,7 +54940,7 @@ { "description": "Returns documents that contain a specific prefix in a provided field.", "extDocId": "query-dsl-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "name": "prefix", "required": false, "type": { @@ -54965,7 +54965,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a strict syntax.", "extDocId": "query-dsl-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query", "name": "query_string", "required": false, "type": { @@ -54979,7 +54979,7 @@ { "description": "Returns documents that contain terms within a provided range.", "extDocId": "query-dsl-range-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "name": "range", "required": false, "type": { @@ -55004,7 +55004,7 @@ { "description": "Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.", "extDocId": "query-dsl-rank-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query", "name": "rank_feature", "required": false, "type": { @@ -55018,7 +55018,7 @@ { "description": "Returns documents that contain terms matching a regular expression.", "extDocId": "query-dsl-regexp-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query", "name": "regexp", "required": false, "type": { @@ -55054,7 +55054,7 @@ { "description": "Filters documents based on a provided script.\nThe script query is typically used in a filter context.", "extDocId": "query-dsl-script-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query", "name": "script", "required": false, "type": { @@ -55068,7 +55068,7 @@ { "description": "Uses a script to provide a custom score for returned documents.", "extDocId": "query-dsl-script-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query", "name": "script_score", "required": false, "type": { @@ -55100,7 +55100,7 @@ { "description": "Queries documents that contain fields indexed using the `shape` type.", "extDocId": "query-dsl-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query", "name": "shape", "required": false, "type": { @@ -55114,7 +55114,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "extDocId": "query-dsl-simple-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "name": "simple_query_string", "required": false, "type": { @@ -55128,7 +55128,7 @@ { "description": "Returns matches which enclose another span query.", "extDocId": "query-dsl-span-containing-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query", "name": "span_containing", "required": false, "type": { @@ -55142,7 +55142,7 @@ { "description": "Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.", "extDocId": "query-dsl-span-field-masking-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query", "name": "span_field_masking", "required": false, "type": { @@ -55156,7 +55156,7 @@ { "description": "Matches spans near the beginning of a field.", "extDocId": "query-dsl-span-first-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query", "name": "span_first", "required": false, "type": { @@ -55170,7 +55170,7 @@ { "description": "Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested.", "extDocId": "query-dsl-span-multi-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query", "name": "span_multi", "required": false, "type": { @@ -55184,7 +55184,7 @@ { "description": "Matches spans which are near one another.\nYou can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.", "extDocId": "query-dsl-span-near-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query", "name": "span_near", "required": false, "type": { @@ -55198,7 +55198,7 @@ { "description": "Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query.", "extDocId": "query-dsl-span-not-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query", "name": "span_not", "required": false, "type": { @@ -55212,7 +55212,7 @@ { "description": "Matches the union of its span clauses.", "extDocId": "query-dsl-span-or-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query", "name": "span_or", "required": false, "type": { @@ -55226,7 +55226,7 @@ { "description": "Matches spans containing a term.", "extDocId": "query-dsl-span-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query", "name": "span_term", "required": false, "type": { @@ -55251,7 +55251,7 @@ { "description": "Returns matches which are enclosed inside another span query.", "extDocId": "query-dsl-span-within-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query", "name": "span_within", "required": false, "type": { @@ -55271,7 +55271,7 @@ }, "description": "Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.", "extDocId": "query-dsl-sparse-vector-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query", "name": "sparse_vector", "required": false, "type": { @@ -55285,7 +55285,7 @@ { "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "extDocId": "query-dsl-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "name": "term", "required": false, "type": { @@ -55310,7 +55310,7 @@ { "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "extDocId": "query-dsl-terms-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "name": "terms", "required": false, "type": { @@ -55324,7 +55324,7 @@ { "description": "Returns documents that contain a minimum number of exact terms in a provided field.\nTo return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.", "extDocId": "query-dsl-terms-set-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query", "name": "terms_set", "required": false, "type": { @@ -55359,7 +55359,7 @@ }, "description": "Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.", "extDocId": "query-dsl-text-expansion-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query", "name": "text_expansion", "required": false, "type": { @@ -55394,7 +55394,7 @@ }, "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.", "extDocId": "query-dsl-weighted-tokens-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query", "name": "weighted_tokens", "required": false, "type": { @@ -55419,7 +55419,7 @@ { "description": "Returns documents that contain terms matching a wildcard pattern.", "extDocId": "query-dsl-wildcard-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "name": "wildcard", "required": false, "type": { @@ -55444,7 +55444,7 @@ { "description": "A query that accepts any other query as base64 encoded string.", "extDocId": "query-dsl-wrapper-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query", "name": "wrapper", "required": false, "type": { @@ -55479,7 +55479,7 @@ }, { "extDocId": "query-dsl-bool-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "inherits": { "type": { "name": "QueryBase", @@ -55522,7 +55522,7 @@ { "description": "Specifies the number or percentage of `should` clauses returned documents must match.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -55670,7 +55670,7 @@ { "description": "The minimum number of terms that should match as integer, percentage or range", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "kind": "type_alias", "name": { "name": "MinimumShouldMatch", @@ -55714,7 +55714,7 @@ }, { "extDocId": "query-dsl-boosting-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-boosting-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query", "inherits": { "type": { "name": "QueryBase", @@ -55971,7 +55971,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "extDocId": "query-dsl-minimum-should-match", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -56034,7 +56034,7 @@ }, { "extDocId": "query-dsl-constant-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query", "inherits": { "type": { "name": "QueryBase", @@ -56064,7 +56064,7 @@ }, { "extDocId": "query-dsl-dis-max-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query", "inherits": { "type": { "name": "QueryBase", @@ -56115,7 +56115,7 @@ "date" ], "extDocId": "query-dsl-distance-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query", "kind": "type_alias", "name": { "name": "DistanceFeatureQuery", @@ -56305,7 +56305,7 @@ }, { "extDocId": "query-dsl-exists-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "inherits": { "type": { "name": "QueryBase", @@ -56335,7 +56335,7 @@ }, { "extDocId": "query-dsl-function-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query", "inherits": { "type": { "name": "QueryBase", @@ -57309,7 +57309,7 @@ }, { "extDocId": "query-dsl-fuzzy-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query", "inherits": { "type": { "name": "QueryBase", @@ -57351,7 +57351,7 @@ { "description": "Number of beginning characters left unchanged when creating expansions.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "serverDefault": "constant_score", @@ -57379,7 +57379,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -57427,7 +57427,7 @@ }, { "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "kind": "type_alias", "name": { "name": "MultiTermQueryRewrite", @@ -57444,7 +57444,7 @@ }, { "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "kind": "type_alias", "name": { "name": "Fuzziness", @@ -57504,7 +57504,7 @@ } ], "extDocId": "query-dsl-geo-bounding-box-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query", "inherits": { "type": { "name": "QueryBase", @@ -57939,7 +57939,7 @@ } ], "extDocId": "query-dsl-geo-distance-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query", "inherits": { "type": { "name": "QueryBase", @@ -57955,7 +57955,7 @@ { "description": "The radius of the circle centred on the specified location.\nPoints which fall into this circle are considered to be matches.", "docId": "distance-units", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#distance-units", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#distance-units", "name": "distance", "required": true, "type": { @@ -58162,7 +58162,7 @@ "version": "7.12.0" }, "extDocId": "query-dsl-geo-polygon-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-polygon-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-polygon-query", "inherits": { "type": { "name": "QueryBase", @@ -58258,7 +58258,7 @@ } ], "extDocId": "query-dsl-geo-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query", "inherits": { "type": { "name": "QueryBase", @@ -58431,7 +58431,7 @@ }, { "extDocId": "query-dsl-has-child-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-child-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query", "inherits": { "type": { "name": "QueryBase", @@ -58460,7 +58460,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -58759,7 +58759,7 @@ }, { "extDocId": "collapse-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results", "kind": "interface", "name": { "name": "FieldCollapse", @@ -59509,7 +59509,7 @@ } ], "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "kind": "interface", "name": { "name": "SortOptions", @@ -60354,7 +60354,7 @@ }, { "extDocId": "query-dsl-has-parent-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query", "inherits": { "type": { "name": "QueryBase", @@ -60383,7 +60383,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -60436,7 +60436,7 @@ }, { "extDocId": "query-dsl-ids-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "inherits": { "type": { "name": "QueryBase", @@ -60496,7 +60496,7 @@ }, { "extDocId": "query-dsl-intervals-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query", "inherits": { "type": { "name": "QueryBase", @@ -60536,7 +60536,7 @@ { "description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzzy", "required": false, "type": { @@ -60905,7 +60905,7 @@ { "description": "Analyzer used to normalize the term.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -60992,7 +60992,7 @@ { "description": "Analyzer used to analyze terms in the query.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -61078,7 +61078,7 @@ { "description": "Analyzer used to analyze the `prefix`.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -61164,7 +61164,7 @@ }, { "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query", "inherits": { "type": { "name": "QueryBase", @@ -61398,7 +61398,7 @@ }, { "extDocId": "query-dsl-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "inherits": { "type": { "name": "QueryBase", @@ -61414,7 +61414,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -61456,7 +61456,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -61470,7 +61470,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "fuzzy_rewrite", "required": false, "type": { @@ -61523,7 +61523,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -61628,7 +61628,7 @@ }, { "extDocId": "query-dsl-match-all-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "inherits": { "type": { "name": "QueryBase", @@ -61645,7 +61645,7 @@ }, { "extDocId": "query-dsl-match-bool-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query", "inherits": { "type": { "name": "QueryBase", @@ -61661,7 +61661,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -61675,7 +61675,7 @@ { "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -61689,7 +61689,7 @@ { "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "fuzzy_rewrite", "required": false, "type": { @@ -61729,7 +61729,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -61784,7 +61784,7 @@ }, { "extDocId": "query-dsl-match-none-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query", "inherits": { "type": { "name": "QueryBase", @@ -61801,7 +61801,7 @@ }, { "extDocId": "query-dsl-match-query-phrase", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase", "inherits": { "type": { "name": "QueryBase", @@ -61817,7 +61817,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -61872,7 +61872,7 @@ }, { "extDocId": "query-dsl-match-query-phrase-prefix", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix", "inherits": { "type": { "name": "QueryBase", @@ -61888,7 +61888,7 @@ { "description": "Analyzer used to convert text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -61956,7 +61956,7 @@ }, { "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query", "inherits": { "type": { "name": "QueryBase", @@ -61972,7 +61972,7 @@ { "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", "extDocId": "analysis", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -62118,7 +62118,7 @@ { "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -62238,7 +62238,7 @@ ], "description": "Text that we want similar documents for or a lookup to a document's field for the text.", "docId": "document-input-parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query#_document_input_parameters", "kind": "type_alias", "name": { "name": "Like", @@ -62437,7 +62437,7 @@ }, { "extDocId": "query-dsl-multi-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query", "inherits": { "type": { "name": "QueryBase", @@ -62453,7 +62453,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -62507,7 +62507,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -62521,7 +62521,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "fuzzy_rewrite", "required": false, "type": { @@ -62574,7 +62574,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -62714,7 +62714,7 @@ }, { "extDocId": "query-dsl-nested-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query", "inherits": { "type": { "name": "QueryBase", @@ -62743,7 +62743,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -62796,7 +62796,7 @@ }, { "extDocId": "query-dsl-parent-id-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query", "inherits": { "type": { "name": "QueryBase", @@ -62851,7 +62851,7 @@ }, { "extDocId": "query-dsl-percolate-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query", "inherits": { "type": { "name": "QueryBase", @@ -62972,7 +62972,7 @@ }, { "extDocId": "query-dsl-pinned-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query", "inherits": { "type": { "name": "QueryBase", @@ -63070,7 +63070,7 @@ }, { "extDocId": "query-dsl-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "inherits": { "type": { "name": "QueryBase", @@ -63086,7 +63086,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "type": { @@ -63134,7 +63134,7 @@ }, { "extDocId": "query-dsl-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query", "inherits": { "type": { "name": "QueryBase", @@ -63163,7 +63163,7 @@ { "description": "Analyzer used to convert text in the query string into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -63268,7 +63268,7 @@ { "description": "Maximum edit distance allowed for fuzzy matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -63308,7 +63308,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "fuzzy_rewrite", "required": false, "type": { @@ -63361,7 +63361,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -63424,7 +63424,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "type": { @@ -63498,7 +63498,7 @@ "term" ], "extDocId": "query-dsl-range-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "kind": "type_alias", "name": { "name": "RangeQuery", @@ -63752,7 +63752,7 @@ }, { "docId": "mapping-date-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-date-format", "kind": "type_alias", "name": { "name": "DateFormat", @@ -63866,7 +63866,7 @@ }, { "extDocId": "query-dsl-rank-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query", "inherits": { "type": { "name": "QueryBase", @@ -64064,7 +64064,7 @@ }, { "extDocId": "query-dsl-regexp-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query", "inherits": { "type": { "name": "QueryBase", @@ -64099,7 +64099,7 @@ { "description": "Enables optional operators for the regular expression.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax", "name": "flags", "required": false, "type": { @@ -64126,7 +64126,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "type": { @@ -64140,7 +64140,7 @@ { "description": "Regular expression for terms you wish to find in the provided field.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax", "name": "value", "required": true, "type": { @@ -64157,7 +64157,7 @@ }, { "extDocId": "query-dsl-rule-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rule-query", "inherits": { "type": { "name": "QueryBase", @@ -64207,7 +64207,7 @@ }, { "extDocId": "query-dsl-script-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query", "inherits": { "type": { "name": "QueryBase", @@ -64237,7 +64237,7 @@ }, { "extDocId": "query-dsl-script-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query", "inherits": { "type": { "name": "QueryBase", @@ -64291,7 +64291,7 @@ }, { "extDocId": "query-dsl-semantic-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-semantic-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-semantic-query", "inherits": { "type": { "name": "QueryBase", @@ -64364,7 +64364,7 @@ } ], "extDocId": "query-dsl-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query", "inherits": { "type": { "name": "QueryBase", @@ -64440,7 +64440,7 @@ }, { "extDocId": "query-dsl-simple-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "inherits": { "type": { "name": "QueryBase", @@ -64456,7 +64456,7 @@ { "description": "Analyzer used to convert text in the query string into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -64588,7 +64588,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -64629,7 +64629,7 @@ { "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`", "docId": "supported-flags", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html#supported-flags", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query#supported-flags", "kind": "type_alias", "name": { "name": "SimpleQueryStringFlags", @@ -64689,7 +64689,7 @@ }, { "extDocId": "query-dsl-span-containing-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query", "inherits": { "type": { "name": "QueryBase", @@ -64875,7 +64875,7 @@ }, { "extDocId": "query-dsl-span-field-masking-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query", "inherits": { "type": { "name": "QueryBase", @@ -64915,7 +64915,7 @@ }, { "extDocId": "query-dsl-span-first-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query", "inherits": { "type": { "name": "QueryBase", @@ -64984,7 +64984,7 @@ }, { "extDocId": "query-dsl-span-multi-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query", "inherits": { "type": { "name": "QueryBase", @@ -65014,7 +65014,7 @@ }, { "extDocId": "query-dsl-span-near-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query", "inherits": { "type": { "name": "QueryBase", @@ -65071,7 +65071,7 @@ }, { "extDocId": "query-dsl-span-not-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query", "inherits": { "type": { "name": "QueryBase", @@ -65151,7 +65151,7 @@ }, { "extDocId": "query-dsl-span-or-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query", "inherits": { "type": { "name": "QueryBase", @@ -65184,7 +65184,7 @@ }, { "extDocId": "query-dsl-span-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query", "inherits": { "type": { "name": "QueryBase", @@ -65273,7 +65273,7 @@ }, { "extDocId": "query-dsl-span-within-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query", "inherits": { "type": { "name": "QueryBase", @@ -65315,7 +65315,7 @@ }, { "extDocId": "query-dsl-sparse-vector-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query", "inherits": { "type": { "name": "QueryBase", @@ -65490,7 +65490,7 @@ }, { "extDocId": "query-dsl-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "inherits": { "type": { "name": "QueryBase", @@ -65571,7 +65571,7 @@ } ], "extDocId": "query-dsl-terms-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "inherits": { "type": { "name": "QueryBase", @@ -65676,7 +65676,7 @@ }, { "extDocId": "query-dsl-terms-set-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query", "inherits": { "type": { "name": "QueryBase", @@ -65751,7 +65751,7 @@ }, { "extDocId": "query-dsl-text-expansion-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query", "inherits": { "type": { "name": "QueryBase", @@ -65814,7 +65814,7 @@ }, { "extDocId": "query-dsl-weighted-tokens-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query", "inherits": { "type": { "name": "QueryBase", @@ -65867,7 +65867,7 @@ }, { "extDocId": "query-dsl-wildcard-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "inherits": { "type": { "name": "QueryBase", @@ -65901,7 +65901,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "type": { @@ -65942,7 +65942,7 @@ }, { "extDocId": "query-dsl-wrapper-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query", "inherits": { "type": { "name": "QueryBase", @@ -65999,7 +65999,7 @@ }, { "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -66304,7 +66304,7 @@ }, { "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -66347,7 +66347,7 @@ { "description": "Policy to apply when gaps are found in the data.", "docId": "gap-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/pipeline#gap-policy", "name": "gap_policy", "required": false, "serverDefault": "skip", @@ -66378,7 +66378,7 @@ { "description": "Path to the buckets that contain one set of values to correlate.", "docId": "search-aggregations-pipeline-bucket-path", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#buckets-path-syntax", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/pipeline#buckets-path-syntax", "name": "buckets_path", "required": false, "type": { @@ -66498,7 +66498,7 @@ }, { "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -66528,7 +66528,7 @@ }, { "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -66558,7 +66558,7 @@ }, { "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation", "inherits": { "type": { "name": "Aggregation", @@ -66586,7 +66586,7 @@ { "description": "The policy to apply when gaps are found in the data.", "docId": "gap-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/pipeline#gap-policy", "name": "gap_policy", "required": false, "serverDefault": "skip", @@ -66613,7 +66613,7 @@ { "description": "The list of fields to sort on.", "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -66630,7 +66630,7 @@ { "description": "A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred\nto as a \"K-S test\" from now on) against a provided distribution, and the distribution implied\nby the documents counts in the configured sibling aggregation. Specifically, for some metric,\nassuming that the percentile intervals of the metric are known beforehand or have been computed\nby an aggregation, then one would use range aggregation for the sibling to compute the p-value\nof the distribution difference between the metric and the restriction of that metric to a subset\nof the documents. A natural use case is if the sibling aggregation range aggregation nested in a\nterms aggregation, in which case one compares the overall distribution of metric to its restriction\nto each term.", "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation", "inherits": { "type": { "name": "BucketPathAggregation", @@ -66691,7 +66691,7 @@ { "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.", "extDocId": "search-aggregations-bucket-correlation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation", "inherits": { "type": { "name": "BucketPathAggregation", @@ -66900,7 +66900,7 @@ { "description": "A multi-bucket aggregation that groups semi-structured text into buckets. Each text\nfield is re-analyzed using a custom analyzer. The resulting tokens are then categorized\ncreating buckets of similarly formatted text values. This aggregation works best with machine\ngenerated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.", "extDocId": "search-aggregations-bucket-categorize-text-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation", "inherits": { "type": { "name": "Aggregation", @@ -66980,7 +66980,9 @@ } }, { - "description": "The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.\nThe syntax is very similar to that used to define the analyzer in the [Analyze endpoint](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html). This property\ncannot be used at the same time as categorization_filters.", + "description": "The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.\nThe syntax is very similar to that used to define the analyzer in the analyze API. This property\ncannot be used at the same time as `categorization_filters`.", + "extDocId": "indices-analyze", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-analyze", "name": "categorization_analyzer", "required": false, "type": { @@ -67041,7 +67043,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1117-L1182" + "specLocation": "_types/aggregations/bucket.ts#L1117-L1183" }, { "codegenNames": [ @@ -67053,7 +67055,7 @@ "name": "CategorizeTextAnalyzer", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1184-L1187", + "specLocation": "_types/aggregations/bucket.ts#L1185-L1188", "type": { "items": [ { @@ -67121,7 +67123,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1189-L1193" + "specLocation": "_types/aggregations/bucket.ts#L1190-L1194" }, { "inherits": { @@ -67153,7 +67155,7 @@ }, { "extDocId": "search-aggregations-bucket-composite-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-composite-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-composite-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -67643,7 +67645,7 @@ }, { "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -67660,7 +67662,7 @@ }, { "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -68248,7 +68250,7 @@ }, { "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -68406,7 +68408,7 @@ }, { "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation", "kind": "interface", "name": { "name": "FrequentItemSetsAggregation", @@ -68480,7 +68482,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1240-L1267" + "specLocation": "_types/aggregations/bucket.ts#L1241-L1268" }, { "kind": "interface", @@ -68525,7 +68527,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1226-L1238" + "specLocation": "_types/aggregations/bucket.ts#L1227-L1239" }, { "codegenNames": [ @@ -68766,7 +68768,7 @@ }, { "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation", "inherits": { "type": { "name": "MetricAggregationBase", @@ -68986,7 +68988,7 @@ }, { "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -69765,7 +69767,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1195-L1224" + "specLocation": "_types/aggregations/bucket.ts#L1196-L1225" }, { "inherits": { @@ -69866,7 +69868,7 @@ { "description": "Specifies the maximum number of feature importance values per document.", "docId": "ml-feature-importance", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-feature-importance", "name": "num_top_feature_importance_values", "required": false, "serverDefault": 0, @@ -69903,7 +69905,7 @@ { "description": "Specifies the maximum number of feature importance values per document.", "docId": "ml-feature-importance", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-feature-importance", "name": "num_top_feature_importance_values", "required": false, "serverDefault": 0, @@ -70051,7 +70053,7 @@ }, { "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -70068,7 +70070,7 @@ }, { "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation", "inherits": { "type": { "name": "FormatMetricAggregationBase", @@ -70114,7 +70116,7 @@ }, { "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -70603,7 +70605,7 @@ }, { "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -70657,7 +70659,7 @@ }, { "extDocId": "search-aggregations-pipeline-movfn-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -70912,7 +70914,7 @@ }, { "extDocId": "search-aggregations-pipeline-normalize-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -71005,7 +71007,7 @@ }, { "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation", "inherits": { "type": { "name": "FormatMetricAggregationBase", @@ -71199,7 +71201,7 @@ }, { "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -71321,7 +71323,7 @@ }, { "extDocId": "search-aggregations-bucket-rare-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -71511,7 +71513,7 @@ }, { "extDocId": "search-aggregations-random-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-random-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -71553,7 +71555,7 @@ }, { "extDocId": "search-aggregations-bucket-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -71667,7 +71669,7 @@ }, { "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -71697,7 +71699,7 @@ }, { "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -72038,7 +72040,7 @@ }, { "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -72335,7 +72337,7 @@ }, { "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -72352,7 +72354,7 @@ }, { "extDocId": "search-aggregations-bucket-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -72572,7 +72574,7 @@ }, { "extDocId": "search-aggregations-bucket-time-series-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -72929,7 +72931,7 @@ }, { "extDocId": "search-aggregations-metrics-top-metrics", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics", "inherits": { "type": { "name": "MetricAggregationBase", @@ -73171,7 +73173,7 @@ }, { "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation", "kind": "interface", "name": { "name": "VariableWidthHistogramAggregation", @@ -73394,7 +73396,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "knn-inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#nested-knn-search-inner-hits", + "docUrl": "https://www.elastic.co/docs/solutions/search/vector/knn#nested-knn-search-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -74608,7 +74610,7 @@ ], "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.", "docId": "document-input-parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query#_document_input_parameters", "kind": "type_alias", "name": { "name": "Context", @@ -74645,7 +74647,7 @@ { "description": "The fuzziness factor.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "serverDefault": "AUTO", @@ -74722,7 +74724,7 @@ { "description": "Optional operators for the regular expression.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax", "name": "flags", "required": false, "type": { @@ -75686,7 +75688,7 @@ { "description": "A custom format for `date` type runtime fields.", "docId": "mapping-date-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-date-format", "name": "format", "required": false, "type": { @@ -76110,7 +76112,7 @@ { "description": "The identifier for the search and its search context.\nYou can use this scroll ID with the scroll API to retrieve the next batch of search results for the request.\nThis property is returned only if the `scroll` query parameter is specified in the request.", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "_scroll_id", "required": false, "type": { @@ -76955,7 +76957,7 @@ }, { "extDocId": "search-aggregations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations", "kind": "type_alias", "name": { "name": "Aggregate", @@ -77821,7 +77823,7 @@ }, { "extDocId": "search-aggregations-metrics-min-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -77839,7 +77841,7 @@ }, { "extDocId": "search-aggregations-metrics-max-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -77858,7 +77860,7 @@ { "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", "extDocId": "search-aggregations-metrics-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -77876,7 +77878,7 @@ }, { "extDocId": "search-aggregations-metrics-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -77895,7 +77897,7 @@ { "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.", "extDocId": "search-aggregations-metrics-weight-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -77914,7 +77916,7 @@ { "description": "Value count aggregation result. `value` is always present.", "extDocId": "search-aggregations-metrics-valuecount-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -77948,7 +77950,7 @@ }, { "extDocId": "search-aggregations-pipeline-derivative-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -78021,7 +78023,7 @@ { "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).", "extDocId": "search-aggregations-metrics-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -78175,7 +78177,7 @@ }, { "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation", "inherits": { "type": { "name": "StatsAggregate", @@ -78193,7 +78195,7 @@ }, { "extDocId": "search-aggregations-metrics-extendedstats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation", "inherits": { "type": { "name": "StatsAggregate", @@ -78690,7 +78692,7 @@ }, { "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -78720,7 +78722,7 @@ }, { "extDocId": "search-aggregations-metrics-geocentroid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -78761,7 +78763,7 @@ }, { "extDocId": "search-aggregations-bucket-histogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation", "inherits": { "generics": [ { @@ -78830,7 +78832,7 @@ }, { "extDocId": "search-aggregations-bucket-datehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation", "inherits": { "generics": [ { @@ -78857,7 +78859,7 @@ }, { "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation", "inherits": { "generics": [ { @@ -79156,7 +79158,7 @@ }, { "extDocId": "search-aggregations-bucket-multi-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation", "inherits": { "generics": [ { @@ -79186,7 +79188,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-missing-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -79266,7 +79268,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -79287,7 +79289,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -79308,7 +79310,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-global-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -79329,7 +79331,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-filter-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -79350,7 +79352,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-children-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -79371,7 +79373,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-parent-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -79452,7 +79454,7 @@ }, { "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation", "inherits": { "generics": [ { @@ -79504,7 +79506,7 @@ }, { "extDocId": "search-aggregations-bucket-range-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation", "inherits": { "generics": [ { @@ -79532,7 +79534,7 @@ { "description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.", "extDocId": "search-aggregations-bucket-daterange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation", "inherits": { "type": { "name": "RangeAggregate", @@ -79551,7 +79553,7 @@ { "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.", "extDocId": "search-aggregations-bucket-geodistance-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation", "inherits": { "type": { "name": "RangeAggregate", @@ -79569,7 +79571,7 @@ }, { "extDocId": "search-aggregations-bucket-iprange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation", "inherits": { "generics": [ { @@ -79596,7 +79598,7 @@ }, { "extDocId": "search-aggregations-bucket-ipprefix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation", "inherits": { "generics": [ { @@ -79623,7 +79625,7 @@ }, { "extDocId": "search-aggregations-bucket-filters-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation", "inherits": { "generics": [ { @@ -79650,7 +79652,7 @@ }, { "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation", "inherits": { "generics": [ { @@ -79702,7 +79704,7 @@ }, { "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation", "generics": [ { "name": "T", @@ -79895,7 +79897,7 @@ }, { "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -79921,7 +79923,7 @@ }, { "extDocId": "search-aggregations-metrics-top-hits-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -79983,7 +79985,7 @@ } ], "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -80360,7 +80362,7 @@ }, { "extDocId": "search-aggregations-metrics-boxplot-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -80634,7 +80636,7 @@ }, { "extDocId": "search-aggregations-metrics-ttest-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -80687,7 +80689,7 @@ }, { "extDocId": "search-aggregations-metrics-rate-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -80768,7 +80770,7 @@ }, { "extDocId": "search-aggregations-matrix-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -80932,7 +80934,7 @@ }, { "extDocId": "search-aggregations-metrics-geo-line", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line", "inherits": { "type": { "name": "AggregateBase", @@ -84374,7 +84376,7 @@ }, { "docId": "byte-units", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#byte-units", "kind": "type_alias", "name": { "name": "ByteSize", @@ -84994,7 +84996,7 @@ }, { "docId": "modules-node", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/node-settings", "kind": "type_alias", "name": { "name": "NodeName", @@ -88855,7 +88857,7 @@ "definition" ], "extDocId": "analysis-charfilters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/character-filter-reference", "kind": "type_alias", "name": { "name": "CharFilter", @@ -89334,7 +89336,7 @@ }, { "docId": "analysis-normalizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/normalizers", "kind": "type_alias", "name": { "name": "Normalizer", @@ -89607,7 +89609,7 @@ "definition" ], "extDocId": "analysis-tokenfilters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/token-filter-reference", "kind": "type_alias", "name": { "name": "TokenFilter", @@ -92892,7 +92894,7 @@ "definition" ], "extDocId": "analysis-tokenizers", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference", "kind": "type_alias", "name": { "name": "Tokenizer", @@ -94652,7 +94654,7 @@ { "description": "Metadata about the field.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "meta", "required": false, "type": { @@ -95568,7 +95570,7 @@ { "description": "Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one\nfield for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.", "docId": "multi-fields", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-fields.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/multi-fields", "name": "fields", "required": false, "type": { @@ -95593,7 +95595,7 @@ { "description": "Metadata about the field.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "meta", "required": false, "type": { @@ -97622,7 +97624,7 @@ { "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.", "docId": "geo-shape", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/geo-shape", "inherits": { "type": { "name": "DocValuesPropertyBase", @@ -97772,7 +97774,7 @@ { "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.", "docId": "shape", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shape.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/shape", "inherits": { "type": { "name": "DocValuesPropertyBase", @@ -104634,7 +104636,7 @@ { "description": "The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`.", "extDocId": "analysis-tokenizers", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference", "name": "tokenizer", "required": false, "type": { @@ -105701,7 +105703,7 @@ { "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.", "extDocId": "templating-role-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query", "name": "template", "required": false, "type": { @@ -106249,7 +106251,7 @@ { "description": "The Azure repository type.", "extDocId": "repository-azure", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-azure.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/azure-repository", "name": "type", "required": true, "type": { @@ -106474,7 +106476,7 @@ { "description": "The Google Cloud Storage repository type.", "extDocId": "repository-gcs", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-gcs.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository", "name": "type", "required": true, "type": { @@ -106595,7 +106597,7 @@ { "description": "The S3 repository type.", "extDocId": "repository-s3", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository", "name": "type", "required": true, "type": { @@ -106782,7 +106784,7 @@ { "description": "The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`.", "extDocId": "repository-s3-storage-classes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html#repository-s3-storage-classes", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository#repository-s3-storage-classes", "name": "storage_class", "required": false, "serverDefault": "standard", @@ -106851,7 +106853,7 @@ { "description": "The shared file system repository type.", "extDocId": "repository-shared-fs", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-filesystem-repository.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/shared-file-system-repository", "name": "type", "required": true, "type": { @@ -106944,7 +106946,7 @@ { "description": "The read-only URL repository type.", "extDocId": "repository-read-only", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-read-only-repository.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/read-only-url-repository", "name": "type", "required": true, "type": { @@ -107050,7 +107052,7 @@ { "description": "The source-only repository type.", "extDocId": "repository-source-only", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-source-only-repository.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/source-only-repository", "name": "type", "required": true, "type": { @@ -107941,7 +107943,7 @@ }, { "docId": "cron-expressions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-cron-expressions", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-cron-expressions", "kind": "type_alias", "name": { "name": "CronExpression", @@ -114427,7 +114429,7 @@ }, { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -114461,7 +114463,7 @@ "properties": [ { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -114590,7 +114592,7 @@ } ], "docId": "index-modules-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules", "kind": "interface", "name": { "name": "IndexSettings", @@ -116599,7 +116601,7 @@ { "description": "Mapping Limit Settings", "docId": "mapping-settings-limit", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-settings-limit.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/mapping-limit", "kind": "interface", "name": { "name": "MappingLimitSettings", @@ -116978,7 +116980,7 @@ { "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.", "docId": "index-modules-slowlog-slowlog", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-slowlog.html#index-slow-log", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/slow-log#index-slow-log", "name": "index", "required": false, "type": { @@ -117171,7 +117173,7 @@ }, { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -120860,7 +120862,7 @@ { "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.", "docId": "eql-sequences", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-sequences", "name": "sequences", "required": false, "type": { @@ -120938,7 +120940,7 @@ { "description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.", "docId": "eql-missing-events", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-missing-events", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-missing-events", "name": "missing", "required": false, "type": { @@ -121013,7 +121015,7 @@ { "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.", "docId": "eql-sequences", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-sequences", "name": "join_keys", "required": false, "type": { @@ -121609,7 +121611,7 @@ { "description": "Whether this field is registered as a metadata field.", "docId": "mapping-metadata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/document-metadata-fields", "name": "metadata_field", "required": false, "type": { @@ -121989,7 +121991,7 @@ { "description": "Filters associated terms so only those that are significantly associated with your query are included.", "docId": "search-aggregations-bucket-significantterms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation", "name": "use_significance", "required": true, "type": { @@ -122791,7 +122793,7 @@ { "description": "Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -123258,7 +123260,7 @@ { "description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -126083,7 +126085,7 @@ { "description": "The name of the model to use for the inference task.\nIt can be the ID of a built-in model (for example, `.multilingual-e5-small` for E5) or a text embedding model that was uploaded by using the Eland client.", "extDocId": "eland-import", - "extDocUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-import-model.html#ml-nlp-import-script", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-import-model#ml-nlp-import-script", "name": "model_id", "required": true, "type": { @@ -127255,7 +127257,7 @@ { "description": "Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values.", "docId": "append-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/append-processor", "name": "append", "required": false, "type": { @@ -127269,7 +127271,7 @@ { "description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika.", "docId": "attachment", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/attachment.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/attachment", "name": "attachment", "required": false, "type": { @@ -127283,7 +127285,7 @@ { "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.", "docId": "bytes-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/bytes-processor", "name": "bytes", "required": false, "type": { @@ -127297,7 +127299,7 @@ { "description": "Converts circle definitions of shapes to regular polygons which approximate them.", "docId": "ingest-circle-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/ingest-circle-processor", "name": "circle", "required": false, "type": { @@ -127311,7 +127313,7 @@ { "description": "Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow.", "docId": "community-id-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/community-id-processor", "name": "community_id", "required": false, "type": { @@ -127325,7 +127327,7 @@ { "description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.", "docId": "convert-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/convert-processor", "name": "convert", "required": false, "type": { @@ -127339,7 +127341,7 @@ { "description": "Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped.", "docId": "csv-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/csv-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/csv-processor", "name": "csv", "required": false, "type": { @@ -127353,7 +127355,7 @@ { "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.", "docId": "data-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/date-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/date-processor", "name": "date", "required": false, "type": { @@ -127367,7 +127369,7 @@ { "description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.", "docId": "date-index-name-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/date-index-name-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/date-index-name-processor", "name": "date_index_name", "required": false, "type": { @@ -127381,7 +127383,7 @@ { "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", "docId": "dissect-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/dissect-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/dissect-processor", "name": "dissect", "required": false, "type": { @@ -127395,7 +127397,7 @@ { "description": "Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor.", "docId": "dot-expand-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/dot-expand-processor", "name": "dot_expander", "required": false, "type": { @@ -127409,7 +127411,7 @@ { "description": "Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition.", "docId": "drop-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/drop-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/drop-processor", "name": "drop", "required": false, "type": { @@ -127423,7 +127425,7 @@ { "description": "The `enrich` processor can enrich documents with data from another index.", "docId": "enrich-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/enrich-processor", "name": "enrich", "required": false, "type": { @@ -127437,7 +127439,7 @@ { "description": "Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.", "docId": "fail-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/fail-processor", "name": "fail", "required": false, "type": { @@ -127451,7 +127453,7 @@ { "description": "Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting.", "docId": "fingerprint-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/fingerprint-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/fingerprint-processor", "name": "fingerprint", "required": false, "type": { @@ -127465,7 +127467,7 @@ { "description": "Runs an ingest processor on each element of an array or object.", "docId": "foreach-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/foreach-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/foreach-processor", "name": "foreach", "required": false, "type": { @@ -127491,7 +127493,7 @@ { "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.", "docId": "geo-grid-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-geo-grid-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/ingest-geo-grid-processor", "name": "geo_grid", "required": false, "type": { @@ -127505,7 +127507,7 @@ { "description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address.", "docId": "geoip-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/geoip-processor", "name": "geoip", "required": false, "type": { @@ -127519,7 +127521,7 @@ { "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor", "name": "grok", "required": false, "type": { @@ -127533,7 +127535,7 @@ { "description": "Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception.", "docId": "gsub-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/gsub-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/gsub-processor", "name": "gsub", "required": false, "type": { @@ -127560,7 +127562,7 @@ { "description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline.", "docId": "inference-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/inference-processor", "name": "inference", "required": false, "type": { @@ -127574,7 +127576,7 @@ { "description": "Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array.", "docId": "join-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/join-processor", "name": "join", "required": false, "type": { @@ -127588,7 +127590,7 @@ { "description": "Converts a JSON string into a structured JSON object.", "docId": "json-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/json-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/json-processor", "name": "json", "required": false, "type": { @@ -127602,7 +127604,7 @@ { "description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.", "docId": "kv-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/kv-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/kv-processor", "name": "kv", "required": false, "type": { @@ -127616,7 +127618,7 @@ { "description": "Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", "docId": "lowercase-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/lowercase-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/lowercase-processor", "name": "lowercase", "required": false, "type": { @@ -127630,7 +127632,7 @@ { "description": "Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks.", "docId": "network-direction-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/network-direction-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/network-direction-processor", "name": "network_direction", "required": false, "type": { @@ -127644,7 +127646,7 @@ { "description": "Executes another pipeline.", "docId": "pipeline-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/pipeline-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/pipeline-processor", "name": "pipeline", "required": false, "type": { @@ -127658,7 +127660,7 @@ { "description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred.", "docId": "redact-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/redact-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/redact-processor", "name": "redact", "required": false, "type": { @@ -127672,7 +127674,7 @@ { "description": "Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List.", "docId": "registered-domain-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/registered-domain-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/registered-domain-processor", "name": "registered_domain", "required": false, "type": { @@ -127686,7 +127688,7 @@ { "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", "docId": "remove-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remove-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/remove-processor", "name": "remove", "required": false, "type": { @@ -127700,7 +127702,7 @@ { "description": "Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown.", "docId": "rename-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/rename-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/rename-processor", "name": "rename", "required": false, "type": { @@ -127714,7 +127716,7 @@ { "description": "Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.", "docId": "reroute-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reroute-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/reroute-processor", "name": "reroute", "required": false, "type": { @@ -127728,7 +127730,7 @@ { "description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.", "docId": "script-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/script-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/script-processor", "name": "script", "required": false, "type": { @@ -127742,7 +127744,7 @@ { "description": "Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one.", "docId": "set-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/set-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/set-processor", "name": "set", "required": false, "type": { @@ -127756,7 +127758,7 @@ { "description": "Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest.", "docId": "ingest-node-set-security-user-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{banch}/ingest-node-set-security-user-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/ingest-geo-grid-processor", "name": "set_security_user", "required": false, "type": { @@ -127770,7 +127772,7 @@ { "description": "Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array.", "docId": "sort-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/sort-processor", "name": "sort", "required": false, "type": { @@ -127784,7 +127786,7 @@ { "description": "Splits a field into an array using a separator character.\nOnly works on string fields.", "docId": "split-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/split-processor", "name": "split", "required": false, "type": { @@ -127798,7 +127800,7 @@ { "description": "Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option.", "docId": "terminate-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/terminate-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/terminate-processor", "name": "terminate", "required": false, "type": { @@ -127812,7 +127814,7 @@ { "description": "Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.", "docId": "trim-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/trim-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/trim-processor", "name": "trim", "required": false, "type": { @@ -127826,7 +127828,7 @@ { "description": "Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", "docId": "uppercase-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/uppercase-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/uppercase-processor", "name": "uppercase", "required": false, "type": { @@ -127840,7 +127842,7 @@ { "description": "URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded.", "docId": "urldecode-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/urldecode-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/urldecode-processor", "name": "urldecode", "required": false, "type": { @@ -127867,7 +127869,7 @@ { "description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field.", "docId": "user-agent-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-agent-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/user-agent-processor", "name": "user_agent", "required": false, "type": { @@ -132231,7 +132233,7 @@ { "description": "The configuration for the pipeline.", "extDocId": "logstash-configuration-file-structure", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/configuration-file-structure", "name": "pipeline", "required": true, "type": { @@ -132257,7 +132259,7 @@ { "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.", "extDocId": "logstash-logstash-settings-file", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file", "name": "pipeline_settings", "required": true, "type": { @@ -132325,7 +132327,7 @@ { "description": "The number of workers that will, in parallel, execute the filter and output stages of the pipeline.", "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", + "docUrl": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file", "name": "pipeline.workers", "required": true, "type": { @@ -132363,7 +132365,7 @@ { "description": "The internal queuing model to use for event buffering.", "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", + "docUrl": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file", "name": "queue.type", "required": true, "type": { @@ -134471,7 +134473,7 @@ { "description": "The configuration information necessary to perform classification.", "docId": "ml-classification", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-classification.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-classification", "name": "classification", "required": false, "type": { @@ -134485,7 +134487,7 @@ { "description": "The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", "docId": "ml-classification", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-classification.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-classification", "name": "outlier_detection", "required": false, "type": { @@ -134499,7 +134501,7 @@ { "description": "The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", "docId": "ml-regression", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-regression.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-regression", "name": "regression", "required": false, "type": { @@ -135435,7 +135437,7 @@ { "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": false, "type": { @@ -136763,7 +136765,7 @@ }, { "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": true, "type": { @@ -139970,7 +139972,7 @@ { "description": "A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", "docId": "ml-regression-loss", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-regression-lossfunction.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/dfa-regression-lossfunction", "name": "absolute_importance", "required": false, "type": { @@ -140460,7 +140462,7 @@ { "description": "A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API.", "docId": "cluster-nodes-stats", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-stats", "name": "ingest", "required": false, "type": { @@ -141141,7 +141143,7 @@ { "description": "The number of times the model was loaded for inference and was not retrieved from the cache.\nIf this number is close to the `inference_count`, the cache is not being appropriately used.\nThis can be solved by increasing the cache size or its time-to-live (TTL).\nRefer to general machine learning settings for the appropriate settings.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "cache_miss_count", "required": true, "type": { @@ -142394,7 +142396,7 @@ { "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", "docId": "ml-put-job", - "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-job", "name": "allow_lazy_open", "required": false, "serverDefault": false, @@ -142901,7 +142903,7 @@ { "description": "The analysis function that is used.\nFor example, `count`, `rare`, `mean`, `min`, `max`, and `sum`.", "docId": "ml-functions", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-functions.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-functions", "name": "function", "required": true, "type": { @@ -145129,7 +145131,7 @@ { "description": "Precision at K (P@k)", "docId": "k-precision", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#k-precision", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rank-eval#k-precision", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -145213,7 +145215,7 @@ { "description": "Recall at K (R@k)", "docId": "k-recall", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#k-recall", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html#k-recall", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -145231,7 +145233,7 @@ { "description": "Mean Reciprocal Rank", "docId": "mean-reciprocal", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_mean_reciprocal_rank", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html#_mean_reciprocal_rank", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -145249,7 +145251,7 @@ { "description": "Discounted cumulative gain (DCG)", "docId": "dcg", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_discounted_cumulative_gain_dcg", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html", "inherits": { "type": { "name": "RankEvalMetricBase", @@ -145282,7 +145284,7 @@ { "description": "Expected Reciprocal Rank (ERR)", "docId": "expected-reciprocal", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_expected_reciprocal_rank_err", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rank-eval#_expected_reciprocal_rank_err", "inherits": { "type": { "name": "RankEvalMetricBase", @@ -146195,7 +146197,7 @@ { "description": "A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", "extDocId": "run-as-privilege", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users", "name": "run_as", "required": false, "type": { @@ -146264,7 +146266,7 @@ { "description": "The document fields that the owners of the role have read access to.", "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level", "name": "field_security", "required": false, "type": { @@ -146837,7 +146839,7 @@ { "description": "The document fields that the owners of the role have read access to.", "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level", "name": "field_security", "required": false, "type": { @@ -147266,7 +147268,7 @@ { "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", "docId": "search-aggregations-metrics-cardinality-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation", "name": "cardinality", "required": false, "type": { @@ -147292,7 +147294,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", "docId": "search-aggregations-bucket-daterange-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation", "name": "date_range", "required": false, "type": { @@ -147306,7 +147308,7 @@ { "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", "docId": "search-aggregations-bucket-filter-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation", "name": "filter", "required": false, "type": { @@ -147320,7 +147322,7 @@ { "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", "docId": "search-aggregations-bucket-filters-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation", "name": "filters", "required": false, "type": { @@ -147345,7 +147347,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", "docId": "search-aggregations-bucket-range-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation", "name": "range", "required": false, "type": { @@ -147359,7 +147361,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", "docId": "search-aggregations-bucket-terms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation", "name": "terms", "required": false, "type": { @@ -147373,7 +147375,7 @@ { "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", "docId": "search-aggregations-metrics-valuecount-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation", "name": "value_count", "required": false, "type": { @@ -147401,7 +147403,7 @@ { "description": "Matches documents matching boolean combinations of other queries.", "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "name": "bool", "required": false, "type": { @@ -147415,7 +147417,7 @@ { "description": "Returns documents that contain an indexed value for a field.", "docId": "query-dsl-exists-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "name": "exists", "required": false, "type": { @@ -147429,7 +147431,7 @@ { "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", "docId": "query-dsl-ids-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "name": "ids", "required": false, "type": { @@ -147443,7 +147445,7 @@ { "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "docId": "query-dsl-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "name": "match", "required": false, "type": { @@ -147468,7 +147470,7 @@ { "description": "Matches all documents, giving them all a `_score` of 1.0.", "docId": "query-dsl-match-all-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "name": "match_all", "required": false, "type": { @@ -147482,7 +147484,7 @@ { "description": "Returns documents that contain a specific prefix in a provided field.", "docId": "query-dsl-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "name": "prefix", "required": false, "type": { @@ -147507,7 +147509,7 @@ { "description": "Returns documents that contain terms within a provided range.", "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "name": "range", "required": false, "type": { @@ -147532,7 +147534,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "docId": "query-dsl-simple-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "name": "simple_query_string", "required": false, "type": { @@ -147546,7 +147548,7 @@ { "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "docId": "query-dsl-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "name": "term", "required": false, "type": { @@ -147571,7 +147573,7 @@ { "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "docId": "query-dsl-terms-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "name": "terms", "required": false, "type": { @@ -147585,7 +147587,7 @@ { "description": "Returns documents that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "name": "wildcard", "required": false, "type": { @@ -147699,7 +147701,7 @@ { "description": "matches roles matching boolean combinations of other queries.", "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "name": "bool", "required": false, "type": { @@ -147713,7 +147715,7 @@ { "description": "Returns roles that contain an indexed value for a field.", "docId": "query-dsl-exists-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "name": "exists", "required": false, "type": { @@ -147727,7 +147729,7 @@ { "description": "Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field.", "docId": "query-dsl-ids-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "name": "ids", "required": false, "type": { @@ -147741,7 +147743,7 @@ { "description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "docId": "query-dsl-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "name": "match", "required": false, "type": { @@ -147766,7 +147768,7 @@ { "description": "Matches all roles, giving them all a `_score` of 1.0.", "docId": "query-dsl-match-all-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "name": "match_all", "required": false, "type": { @@ -147780,7 +147782,7 @@ { "description": "Returns roles that contain a specific prefix in a provided field.", "docId": "query-dsl-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "name": "prefix", "required": false, "type": { @@ -147805,7 +147807,7 @@ { "description": "Returns roles that contain terms within a provided range.", "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "name": "range", "required": false, "type": { @@ -147830,7 +147832,7 @@ { "description": "Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "docId": "query-dsl-simple-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "name": "simple_query_string", "required": false, "type": { @@ -147844,7 +147846,7 @@ { "description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "docId": "query-dsl-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "name": "term", "required": false, "type": { @@ -147869,7 +147871,7 @@ { "description": "Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "docId": "query-dsl-terms-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "name": "terms", "required": false, "type": { @@ -147883,7 +147885,7 @@ { "description": "Returns roles that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "name": "wildcard", "required": false, "type": { @@ -148141,9 +148143,9 @@ } }, { - "description": "Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2", - "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", + "description": "Synonyms, in Solr format, that conform the synonym rule.", + "extDocId": "synonym-solr", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#_solr_format_2", "name": "synonyms", "required": true, "type": { @@ -148155,7 +148157,7 @@ } } ], - "specLocation": "synonyms/_types/SynonymRule.ts#L40-L49" + "specLocation": "synonyms/_types/SynonymRule.ts#L40-L50" }, { "kind": "interface", @@ -148179,7 +148181,7 @@ { "description": "The synonyms that conform the synonym rule in Solr format.", "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms", "name": "synonyms", "required": true, "type": {