diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 72331ec39b..d5a3478711 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -24077,15 +24077,22 @@ "schema": { "type": "object", "properties": { - "match_criteria": { - "type": "object", - "additionalProperties": { - "type": "object" - } + "rules": { + "oneOf": [ + { + "$ref": "#/components/schemas/query_rules._types:QueryRule" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules._types:QueryRule" + } + } + ] } }, "required": [ - "match_criteria" + "rules" ] } } @@ -24100,19 +24107,12 @@ "schema": { "type": "object", "properties": { - "total_matched_rules": { - "type": "number" - }, - "matched_rules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/query_rules.test:QueryRulesetMatchedRule" - } + "result": { + "$ref": "#/components/schemas/_types:Result" } }, "required": [ - "total_matched_rules", - "matched_rules" + "result" ] } } @@ -24214,6 +24214,77 @@ "x-state": "Added in 8.10.0" } }, + "/_query_rules/{ruleset_id}/_test": { + "post": { + "tags": [ + "query_rules" + ], + "summary": "Creates or updates a query ruleset", + "operationId": "query-rules-test", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "description": "The unique identifier of the query ruleset to be created or updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "match_criteria": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "match_criteria" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_matched_rules": { + "type": "number" + }, + "matched_rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules.test:QueryRulesetMatchedRule" + } + } + }, + "required": [ + "total_matched_rules", + "matched_rules" + ] + } + } + } + } + }, + "x-state": "Added in 8.10.0" + } + }, "/_rank_eval": { "get": { "tags": [ @@ -80706,6 +80777,12 @@ }, "rrf": { "$ref": "#/components/schemas/_types:RRFRetriever" + }, + "text_similarity_reranker": { + "$ref": "#/components/schemas/_types:TextSimilarityReranker" + }, + "rule": { + "$ref": "#/components/schemas/_types:RuleRetriever" } }, "minProperties": 1, @@ -80732,10 +80809,6 @@ "sort": { "$ref": "#/components/schemas/_types:Sort" }, - "min_score": { - "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", - "type": "number" - }, "collapse": { "$ref": "#/components/schemas/_global.search._types:FieldCollapse" } @@ -80759,6 +80832,10 @@ } } ] + }, + "min_score": { + "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", + "type": "number" } } }, @@ -80831,6 +80908,75 @@ } ] }, + "_types:TextSimilarityReranker": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:RetrieverBase" + }, + { + "type": "object", + "properties": { + "retriever": { + "$ref": "#/components/schemas/_types:RetrieverContainer" + }, + "rank_window_size": { + "description": "This value determines how many documents we will consider from the nested retriever.", + "type": "number" + }, + "inference_id": { + "description": "Unique identifier of the inference endpoint created using the inference API.", + "type": "string" + }, + "inference_text": { + "description": "The text snippet used as the basis for similarity comparison", + "type": "string" + }, + "field": { + "description": "The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text", + "type": "string" + } + }, + "required": [ + "retriever" + ] + } + ] + }, + "_types:RuleRetriever": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:RetrieverBase" + }, + { + "type": "object", + "properties": { + "ruleset_ids": { + "description": "The ruleset IDs containing the rules this retriever is evaluating against.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "match_criteria": { + "description": "The match criteria that will determine if a rule in the provided rulesets should be applied.", + "type": "object" + }, + "retriever": { + "$ref": "#/components/schemas/_types:RetrieverContainer" + }, + "rank_window_size": { + "description": "This value determines the size of the individual result set.", + "type": "number" + } + }, + "required": [ + "ruleset_ids", + "match_criteria", + "retriever" + ] + } + ] + }, "search_application._types:SearchApplication": { "type": "object", "properties": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 13a9a94f64..6aa4dd55dd 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -14916,15 +14916,22 @@ "schema": { "type": "object", "properties": { - "match_criteria": { - "type": "object", - "additionalProperties": { - "type": "object" - } + "rules": { + "oneOf": [ + { + "$ref": "#/components/schemas/query_rules._types:QueryRule" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules._types:QueryRule" + } + } + ] } }, "required": [ - "match_criteria" + "rules" ] } } @@ -14939,19 +14946,12 @@ "schema": { "type": "object", "properties": { - "total_matched_rules": { - "type": "number" - }, - "matched_rules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/query_rules.test:QueryRulesetMatchedRule" - } + "result": { + "$ref": "#/components/schemas/_types:Result" } }, "required": [ - "total_matched_rules", - "matched_rules" + "result" ] } } @@ -15053,6 +15053,77 @@ "x-state": "Added in 8.10.0" } }, + "/_query_rules/{ruleset_id}/_test": { + "post": { + "tags": [ + "query_rules" + ], + "summary": "Creates or updates a query ruleset", + "operationId": "query-rules-test", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "description": "The unique identifier of the query ruleset to be created or updated", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "match_criteria": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "required": [ + "match_criteria" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_matched_rules": { + "type": "number" + }, + "matched_rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/query_rules.test:QueryRulesetMatchedRule" + } + } + }, + "required": [ + "total_matched_rules", + "matched_rules" + ] + } + } + } + } + }, + "x-state": "Added in 8.10.0" + } + }, "/_rank_eval": { "get": { "tags": [ @@ -53274,6 +53345,12 @@ }, "rrf": { "$ref": "#/components/schemas/_types:RRFRetriever" + }, + "text_similarity_reranker": { + "$ref": "#/components/schemas/_types:TextSimilarityReranker" + }, + "rule": { + "$ref": "#/components/schemas/_types:RuleRetriever" } }, "minProperties": 1, @@ -53300,10 +53377,6 @@ "sort": { "$ref": "#/components/schemas/_types:Sort" }, - "min_score": { - "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", - "type": "number" - }, "collapse": { "$ref": "#/components/schemas/_global.search._types:FieldCollapse" } @@ -53327,6 +53400,10 @@ } } ] + }, + "min_score": { + "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", + "type": "number" } } }, @@ -53399,6 +53476,75 @@ } ] }, + "_types:TextSimilarityReranker": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:RetrieverBase" + }, + { + "type": "object", + "properties": { + "retriever": { + "$ref": "#/components/schemas/_types:RetrieverContainer" + }, + "rank_window_size": { + "description": "This value determines how many documents we will consider from the nested retriever.", + "type": "number" + }, + "inference_id": { + "description": "Unique identifier of the inference endpoint created using the inference API.", + "type": "string" + }, + "inference_text": { + "description": "The text snippet used as the basis for similarity comparison", + "type": "string" + }, + "field": { + "description": "The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text", + "type": "string" + } + }, + "required": [ + "retriever" + ] + } + ] + }, + "_types:RuleRetriever": { + "allOf": [ + { + "$ref": "#/components/schemas/_types:RetrieverBase" + }, + { + "type": "object", + "properties": { + "ruleset_ids": { + "description": "The ruleset IDs containing the rules this retriever is evaluating against.", + "type": "array", + "items": { + "$ref": "#/components/schemas/_types:Id" + } + }, + "match_criteria": { + "description": "The match criteria that will determine if a rule in the provided rulesets should be applied.", + "type": "object" + }, + "retriever": { + "$ref": "#/components/schemas/_types:RetrieverContainer" + }, + "rank_window_size": { + "description": "This value determines the size of the individual result set.", + "type": "number" + } + }, + "required": [ + "ruleset_ids", + "match_criteria", + "retriever" + ] + } + ] + }, "search_application._types:SearchApplication": { "type": "object", "properties": { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index cf3d812d38..ed85017d0f 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -18,7 +18,7 @@ "stability": "stable" } }, - "description": "Deletes an async search by identifier.\nIf the search is still running, the search request will be 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.", + "description": "Delete an async search.\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/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -55,7 +55,7 @@ "stability": "stable" } }, - "description": "Retrieves the results of a previously submitted async search request given its identifier.\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.", + "description": "Get async search results.\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/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -92,7 +92,7 @@ "stability": "stable" } }, - "description": "Get async search status\nRetrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get async search status.\nRetrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -129,7 +129,7 @@ "stability": "stable" } }, - "description": "Runs a search request asynchronously.\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, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t 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.", + "description": "Run an async search.\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/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -987,7 +987,7 @@ "stability": "experimental" } }, - "description": "Updates the last_seen field in the connector, and sets it to current timestamp", + "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/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html", "name": "connector.check_in", @@ -1023,7 +1023,7 @@ "stability": "beta" } }, - "description": "Deletes a connector.", + "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/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html", "name": "connector.delete", @@ -1059,7 +1059,7 @@ "stability": "beta" } }, - "description": "Retrieves a connector.", + "description": "Get a connector.\n\nGet the details about a connector.", "docId": "connector-get", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html", "name": "connector.get", @@ -1095,7 +1095,7 @@ "stability": "beta" } }, - "description": "Returns existing connectors.", + "description": "Get all connectors.\n\nGet information about all connectors.", "docId": "connector-list", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html", "name": "connector.list", @@ -1131,7 +1131,7 @@ "stability": "beta" } }, - "description": "Creates a connector.", + "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/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", "name": "connector.post", @@ -1170,7 +1170,7 @@ "stability": "beta" } }, - "description": "Creates or updates a connector.", + "description": "Create or update a connector.", "docId": "connector-put", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", "name": "connector.put", @@ -1215,7 +1215,7 @@ "stability": "beta" } }, - "description": "Cancels a connector sync job.", + "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/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html", "name": "connector.sync_job_cancel", @@ -1251,7 +1251,7 @@ "stability": "beta" } }, - "description": "Deletes a connector sync job.", + "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/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html", "name": "connector.sync_job_delete", @@ -1287,7 +1287,7 @@ "stability": "beta" } }, - "description": "Retrieves a connector sync job.", + "description": "Get a connector sync job.", "docId": "connector-sync-job-get", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html", "name": "connector.sync_job_get", @@ -1323,7 +1323,7 @@ "stability": "beta" } }, - "description": "Lists connector sync jobs.", + "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/guide/en/elasticsearch/reference/{branch}/list-connector-sync-jobs-api.html", "name": "connector.sync_job_list", @@ -1359,7 +1359,7 @@ "stability": "beta" } }, - "description": "Creates a connector sync job.", + "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/guide/en/elasticsearch/reference/{branch}/create-connector-sync-job-api.html", "name": "connector.sync_job_post", @@ -1398,7 +1398,7 @@ "stability": "experimental" } }, - "description": "Activates the valid draft filtering for a connector.", + "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "docId": "connector-update-filtering", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", "name": "connector.update_active_filtering", @@ -1437,7 +1437,7 @@ "stability": "beta" } }, - "description": "Updates the API key id in the connector document", + "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/guide/en/elasticsearch/reference/{branch}/update-connector-api-key-id-api.html", "name": "connector.update_api_key_id", @@ -1476,7 +1476,7 @@ "stability": "beta" } }, - "description": "Updates the configuration field in the connector document", + "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "docId": "connector-configuration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-configuration-api.html", "name": "connector.update_configuration", @@ -1515,7 +1515,7 @@ "stability": "experimental" } }, - "description": "Updates the filtering field in the connector document", + "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/guide/en/elasticsearch/reference/{branch}/update-connector-error-api.html", "name": "connector.update_error", @@ -1554,7 +1554,7 @@ "stability": "beta" } }, - "description": "Updates the filtering field in the connector document", + "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/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", "name": "connector.update_filtering", @@ -1593,7 +1593,7 @@ "stability": "experimental" } }, - "description": "Updates the draft filtering validation info for a connector.", + "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/{branch}/update-connector-filtering-validation-api.html", "name": "connector.update_filtering_validation", @@ -1632,7 +1632,7 @@ "stability": "beta" } }, - "description": "Updates the index_name in the connector document", + "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/guide/en/elasticsearch/reference/{branch}/update-connector-index-name-api.html", "name": "connector.update_index_name", @@ -1671,7 +1671,7 @@ "stability": "beta" } }, - "description": "Updates the name and description fields in the connector document", + "description": "Update the connector name and description.", "docId": "connector-update-name", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-name-description-api.html", "name": "connector.update_name", @@ -1710,7 +1710,7 @@ "stability": "beta" } }, - "description": "Updates the is_native flag in the connector document", + "description": "Update the connector is_native flag.", "docId": "connector-update-native", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-native-api.html", "name": "connector.update_native", @@ -1749,7 +1749,7 @@ "stability": "beta" } }, - "description": "Updates the pipeline field in the connector document", + "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/guide/en/elasticsearch/reference/{branch}/update-connector-pipeline-api.html", "name": "connector.update_pipeline", @@ -1788,7 +1788,7 @@ "stability": "beta" } }, - "description": "Updates the scheduling field in the connector document", + "description": "Update the connector scheduling.", "docId": "connector-update-scheduling", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-scheduling-api.html", "name": "connector.update_scheduling", @@ -1827,7 +1827,7 @@ "stability": "beta" } }, - "description": "Updates the service type of the connector", + "description": "Update the connector service type.", "docId": "connector-update-service-type", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-service-type-api.html", "name": "connector.update_service_type", @@ -1866,7 +1866,7 @@ "stability": "experimental" } }, - "description": "Updates the status of the connector", + "description": "Update the connector status.", "docId": "connector-update-status", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-status-api.html", "name": "connector.update_status", @@ -2854,7 +2854,7 @@ "stability": "stable" } }, - "description": "Performs analysis on a text string and returns the resulting tokens.", + "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "docId": "indices-analyze", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", "name": "indices.analyze", @@ -4877,7 +4877,8 @@ "stability": "stable" } }, - "description": "Allows to get multiple documents in one request.", + "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.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html", "name": "mget", "privileges": { @@ -7272,7 +7273,8 @@ "stability": "stable" } }, - "description": "Allows to execute several search operations in one request.", + "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`.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html", "name": "msearch", "privileges": { @@ -7374,7 +7376,8 @@ "stability": "stable" } }, - "description": "Returns multiple termvectors in one request.", + "description": "Get multiple term vectors.\n\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.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html", "name": "mtermvectors", "request": { @@ -7764,7 +7767,7 @@ "name": "query_rules.put_ruleset", "request": { "name": "Request", - "namespace": "query_rules.test" + "namespace": "query_rules.put_ruleset" }, "requestBodyRequired": true, "requestMediaType": [ @@ -7772,7 +7775,7 @@ ], "response": { "name": "Response", - "namespace": "query_rules.test" + "namespace": "query_rules.put_ruleset" }, "responseMediaType": [ "application/json" @@ -7786,6 +7789,44 @@ } ] }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, + "stack": { + "since": "8.10.0", + "stability": "stable" + } + }, + "description": "Creates or updates a query ruleset.", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/test-query-ruleset.html", + "name": "query_rules.test", + "request": { + "name": "Request", + "namespace": "query_rules.test" + }, + "requestBodyRequired": true, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "query_rules.test" + }, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "POST" + ], + "path": "/_query_rules/{ruleset_id}/_test" + } + ] + }, { "availability": { "serverless": { @@ -7973,8 +8014,11 @@ "stability": "stable" } }, - "description": "Allows to retrieve a large numbers of results from a single search request.", + "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.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll", + "extDocId": "scroll-search-results", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", "request": { "name": "Request", @@ -8456,7 +8500,7 @@ "stability": "stable" } }, - "description": "Authenticate a user.\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.", + "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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", "name": "security.authenticate", "request": { @@ -8491,7 +8535,7 @@ "stability": "stable" } }, - "description": "Create an API key.\nCreates an API key for access without requiring basic authentication.\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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html", "name": "security.create_api_key", "privileges": { @@ -8535,7 +8579,7 @@ "stability": "stable" } }, - "description": "Get API key information.\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.", + "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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", "name": "security.get_api_key", "privileges": { @@ -8576,8 +8620,10 @@ "stability": "stable" } }, - "description": "Check user privileges.\nDetermines whether the specified user has a specified list of privileges.", + "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.has_privileges", "request": { "name": "Request", @@ -8622,7 +8668,7 @@ "stability": "stable" } }, - "description": "Invalidate API keys.\nInvalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting 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- 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, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "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.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting 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- 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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "name": "security.invalidate_api_key", "privileges": { @@ -8666,7 +8712,7 @@ "stability": "stable" } }, - "description": "Query API keys.\nRetrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information. You can optionally filter the results with a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", "name": "security.query_api_keys", "privileges": { @@ -8711,7 +8757,7 @@ "stability": "stable" } }, - "description": "Update an API key.\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\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 bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\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.\nIf 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.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "description": "Update an API key.\n\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\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 bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\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.\nIf 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.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", "name": "security.update_api_key", "privileges": { @@ -9268,7 +9314,8 @@ "stability": "stable" } }, - "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", + "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: 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.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html", "name": "terms_enum", "request": { @@ -9877,7 +9924,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an async search by identifier.\nIf the search is still running, the search request will be 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.", + "description": "Delete an async search.\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.", "inherits": { "type": { "name": "RequestBase", @@ -9931,7 +9978,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the results of a previously submitted async search request given its identifier.\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.", + "description": "Get async search results.\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.", "inherits": { "type": { "name": "RequestBase", @@ -9995,7 +10042,7 @@ } } ], - "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L55" + "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L56" }, { "body": { @@ -10037,7 +10084,7 @@ "body": { "kind": "no_body" }, - "description": "Get async search status\nRetrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get async search status.\nRetrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "inherits": { "type": { "name": "RequestBase", @@ -10566,7 +10613,7 @@ } ] }, - "description": "Runs a search request asynchronously.\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, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t 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.", + "description": "Run an async search.\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.", "inherits": { "type": { "name": "RequestBase", @@ -11168,7 +11215,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L287" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L289" }, { "body": { @@ -13219,7 +13266,7 @@ "body": { "kind": "no_body" }, - "description": "Updates the last_seen field in the connector, and sets it to current timestamp", + "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", "inherits": { "type": { "name": "RequestBase", @@ -13246,7 +13293,7 @@ } ], "query": [], - "specLocation": "connector/check_in/ConnectorCheckInRequest.ts#L22-L36" + "specLocation": "connector/check_in/ConnectorCheckInRequest.ts#L22-L38" }, { "body": { @@ -13279,7 +13326,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a connector.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -13319,7 +13366,7 @@ } } ], - "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L42" + "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L47" }, { "body": { @@ -13346,7 +13393,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a connector.", + "description": "Get a connector.\n\nGet the details about a connector.", "inherits": { "type": { "name": "RequestBase", @@ -13373,7 +13420,7 @@ } ], "query": [], - "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L36" + "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L38" }, { "body": { @@ -13400,7 +13447,7 @@ "body": { "kind": "no_body" }, - "description": "Returns existing connectors.", + "description": "Get all connectors.\n\nGet information about all connectors.", "inherits": { "type": { "name": "RequestBase", @@ -13487,7 +13534,7 @@ } } ], - "specLocation": "connector/list/ConnectorListRequest.ts#L23-L57" + "specLocation": "connector/list/ConnectorListRequest.ts#L23-L59" }, { "body": { @@ -13602,7 +13649,7 @@ } ] }, - "description": "Creates a connector.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -13616,7 +13663,7 @@ }, "path": [], "query": [], - "specLocation": "connector/post/ConnectorPostRequest.ts#L22-L42" + "specLocation": "connector/post/ConnectorPostRequest.ts#L22-L46" }, { "body": { @@ -13728,7 +13775,7 @@ } ] }, - "description": "Creates or updates a connector.", + "description": "Create or update a connector.", "inherits": { "type": { "name": "RequestBase", @@ -13799,7 +13846,7 @@ "body": { "kind": "no_body" }, - "description": "Cancels a connector sync job.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -13826,7 +13873,7 @@ } ], "query": [], - "specLocation": "connector/sync_job_cancel/SyncJobCancelRequest.ts#L22-L36" + "specLocation": "connector/sync_job_cancel/SyncJobCancelRequest.ts#L22-L39" }, { "body": { @@ -13859,7 +13906,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a connector sync job.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -13886,7 +13933,7 @@ } ], "query": [], - "specLocation": "connector/sync_job_delete/SyncJobDeleteRequest.ts#L22-L36" + "specLocation": "connector/sync_job_delete/SyncJobDeleteRequest.ts#L22-L39" }, { "body": { @@ -13913,7 +13960,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a connector sync job.", + "description": "Get a connector sync job.", "inherits": { "type": { "name": "RequestBase", @@ -13967,7 +14014,7 @@ "body": { "kind": "no_body" }, - "description": "Lists connector sync jobs.", + "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "inherits": { "type": { "name": "RequestBase", @@ -14057,7 +14104,7 @@ } } ], - "specLocation": "connector/sync_job_list/SyncJobListRequest.ts#L25-L55" + "specLocation": "connector/sync_job_list/SyncJobListRequest.ts#L25-L57" }, { "body": { @@ -14140,7 +14187,7 @@ } ] }, - "description": "Creates a connector sync job.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -14154,7 +14201,7 @@ }, "path": [], "query": [], - "specLocation": "connector/sync_job_post/SyncJobPostRequest.ts#L23-L43" + "specLocation": "connector/sync_job_post/SyncJobPostRequest.ts#L23-L45" }, { "body": { @@ -14187,7 +14234,7 @@ "body": { "kind": "no_body" }, - "description": "Activates the valid draft filtering for a connector.", + "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "inherits": { "type": { "name": "RequestBase", @@ -14214,7 +14261,7 @@ } ], "query": [], - "specLocation": "connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts#L22-L36" + "specLocation": "connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts#L22-L38" }, { "body": { @@ -14271,7 +14318,7 @@ } ] }, - "description": "Updates the API key id in the connector document", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -14298,7 +14345,7 @@ } ], "query": [], - "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L42" + "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L47" }, { "body": { @@ -14362,7 +14409,7 @@ } ] }, - "description": "Updates the configuration field in the connector document", + "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "inherits": { "type": { "name": "RequestBase", @@ -14389,7 +14436,7 @@ } ], "query": [], - "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L47" + "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L49" }, { "body": { @@ -14444,7 +14491,7 @@ } ] }, - "description": "Updates the filtering field in the connector document", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -14471,7 +14518,7 @@ } ], "query": [], - "specLocation": "connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L44" + "specLocation": "connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L48" }, { "body": { @@ -14545,7 +14592,7 @@ } ] }, - "description": "Updates the filtering field in the connector document", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -14572,7 +14619,7 @@ } ], "query": [], - "specLocation": "connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L27-L50" + "specLocation": "connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L27-L54" }, { "body": { @@ -14618,7 +14665,7 @@ } ] }, - "description": "Updates the draft filtering validation info for a connector.", + "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.", "inherits": { "type": { "name": "RequestBase", @@ -14645,7 +14692,7 @@ } ], "query": [], - "specLocation": "connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts#L23-L40" + "specLocation": "connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts#L23-L42" }, { "body": { @@ -14700,7 +14747,7 @@ } ] }, - "description": "Updates the index_name in the connector document", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -14727,7 +14774,7 @@ } ], "query": [], - "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L43" + "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L45" }, { "body": { @@ -14784,7 +14831,7 @@ } ] }, - "description": "Updates the name and description fields in the connector document", + "description": "Update the connector name and description.", "inherits": { "type": { "name": "RequestBase", @@ -14857,7 +14904,7 @@ } ] }, - "description": "Updates the is_native flag in the connector document", + "description": "Update the connector is_native flag.", "inherits": { "type": { "name": "RequestBase", @@ -14930,7 +14977,7 @@ } ] }, - "description": "Updates the pipeline field in the connector document", + "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "inherits": { "type": { "name": "RequestBase", @@ -14957,7 +15004,7 @@ } ], "query": [], - "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L44" + "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L46" }, { "body": { @@ -15003,7 +15050,7 @@ } ] }, - "description": "Updates the scheduling field in the connector document", + "description": "Update the connector scheduling.", "inherits": { "type": { "name": "RequestBase", @@ -15076,7 +15123,7 @@ } ] }, - "description": "Updates the service type of the connector", + "description": "Update the connector service type.", "inherits": { "type": { "name": "RequestBase", @@ -15149,7 +15196,7 @@ } ] }, - "description": "Updates the status of the connector", + "description": "Update the connector status.", "inherits": { "type": { "name": "RequestBase", @@ -19942,7 +19989,7 @@ } ] }, - "description": "Performs analysis on a text string and returns the resulting tokens.", + "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "inherits": { "type": { "name": "RequestBase", @@ -19971,7 +20018,7 @@ } ], "query": [], - "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L92" + "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L93" }, { "body": { @@ -26034,7 +26081,7 @@ } ] }, - "description": "Allows to get multiple documents in one request.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -26167,7 +26214,7 @@ } } ], - "specLocation": "_global/mget/MultiGetRequest.ts#L25-L98" + "specLocation": "_global/mget/MultiGetRequest.ts#L25-L104" }, { "body": { @@ -33871,7 +33918,7 @@ } } }, - "description": "Allows to execute several search operations in one request.", + "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`.", "inherits": { "type": { "name": "RequestBase", @@ -34063,7 +34110,7 @@ } } ], - "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L106" + "specLocation": "_global/msearch/MultiSearchRequest.ts#L25-L124" }, { "body": { @@ -34281,7 +34328,7 @@ } ] }, - "description": "Returns multiple termvectors in one request.", + "description": "Get multiple term vectors.\n\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.", "inherits": { "type": { "name": "RequestBase", @@ -34464,7 +34511,7 @@ } } ], - "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L109" + "specLocation": "_global/mtermvectors/MultiTermVectorsRequest.ts#L31-L116" }, { "body": { @@ -35242,6 +35289,94 @@ }, "specLocation": "query_rules/put_rule/QueryRulePutResponse.ts#L22-L26" }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "name": "rules", + "required": true, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "QueryRule", + "namespace": "query_rules._types" + } + }, + { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "QueryRule", + "namespace": "query_rules._types" + } + } + } + ], + "kind": "union_of" + } + } + ] + }, + "description": "Creates or updates a query ruleset.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "query_rules.put_ruleset" + }, + "path": [ + { + "description": "The unique identifier of the query ruleset to be created or updated", + "name": "ruleset_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L43" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "result", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Result", + "namespace": "_types" + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "query_rules.put_ruleset" + }, + "specLocation": "query_rules/put_ruleset/QueryRulesetPutResponse.ts#L22-L26" + }, { "attachedBehaviors": [ "CommonQueryParameters" @@ -36177,7 +36312,7 @@ } ] }, - "description": "Allows to retrieve a large numbers of results from a single search request.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -36253,7 +36388,7 @@ } } ], - "specLocation": "_global/scroll/ScrollRequest.ts#L24-L59" + "specLocation": "_global/scroll/ScrollRequest.ts#L24-L75" }, { "body": { @@ -36555,9 +36690,12 @@ }, { "availability": { - "serverless": {}, + "serverless": { + "stability": "stable" + }, "stack": { - "since": "8.14.0" + "since": "8.14.0", + "stability": "stable" } }, "description": "A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn.", @@ -38900,7 +39038,7 @@ "body": { "kind": "no_body" }, - "description": "Authenticate a user.\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.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -38914,7 +39052,7 @@ }, "path": [], "query": [], - "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L32" + "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L33" }, { "body": { @@ -39159,7 +39297,7 @@ } ] }, - "description": "Create an API key.\nCreates an API key for access without requiring basic authentication.\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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "inherits": { "type": { "name": "RequestBase", @@ -39186,7 +39324,7 @@ } } ], - "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L59" + "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L60" }, { "body": { @@ -39274,7 +39412,7 @@ "body": { "kind": "no_body" }, - "description": "Get API key information.\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.", + "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.", "inherits": { "type": { "name": "RequestBase", @@ -39407,7 +39545,7 @@ } } ], - "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L87" + "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L88" }, { "body": { @@ -39488,7 +39626,7 @@ } ] }, - "description": "Check user privileges.\nDetermines whether the specified user has a specified list of privileges.", + "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.", "inherits": { "type": { "name": "RequestBase", @@ -39515,7 +39653,7 @@ } ], "query": [], - "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L44" + "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L46" }, { "body": { @@ -39691,7 +39829,7 @@ } ] }, - "description": "Invalidate API keys.\nInvalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting 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- 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, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "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.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting 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- 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.", "inherits": { "type": { "name": "RequestBase", @@ -39705,7 +39843,7 @@ }, "path": [], "query": [], - "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L67" + "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L69" }, { "body": { @@ -39872,7 +40010,7 @@ } ] }, - "description": "Query API keys.\nRetrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information. You can optionally filter the results with a query.", "inherits": { "type": { "name": "RequestBase", @@ -39943,7 +40081,7 @@ } } ], - "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L100" + "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L101" }, { "body": { @@ -40078,7 +40216,7 @@ } ] }, - "description": "Update an API key.\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\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 bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\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.\nIf 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.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "description": "Update an API key.\n\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\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 bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\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.\nIf 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.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "inherits": { "type": { "name": "RequestBase", @@ -40105,7 +40243,7 @@ } ], "query": [], - "specLocation": "security/update_api_key/Request.ts#L26-L66" + "specLocation": "security/update_api_key/Request.ts#L26-L67" }, { "body": { @@ -41845,7 +41983,7 @@ } ] }, - "description": "The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.", + "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis \"terms enum\" API is designed for low-latency look-ups used in auto-complete scenarios.\n\nIf the `complete` property in the response is false, the returned terms set may be incomplete and should be treated as approximate.\nThis can occur due to a few reasons, such as a request timeout or a node error.\n\nNOTE: 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.", "inherits": { "type": { "name": "RequestBase", @@ -41872,7 +42010,7 @@ } ], "query": [], - "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L65" + "specLocation": "_global/terms_enum/TermsEnumRequest.ts#L26-L75" }, { "body": { @@ -45528,6 +45666,8 @@ "aliases": [ "aggs" ], + "extDocId": "search-aggregations", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations.html", "name": "aggregations", "required": false, "type": { @@ -45987,7 +46127,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L70-L201" + "specLocation": "_global/msearch/types.ts#L70-L204" }, { "kind": "interface", @@ -46037,8 +46177,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-adjacency-matrix-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html", + "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html", "name": "adjacency_matrix", "required": false, "type": { @@ -46051,8 +46191,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-autodatehistogram-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html", "name": "auto_date_histogram", "required": false, "type": { @@ -46065,8 +46205,8 @@ }, { "description": "A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-avg-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-avg-aggregation.html", + "extDocId": "search-aggregations-metrics-avg-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-avg-aggregation.html", "name": "avg", "required": false, "type": { @@ -46079,8 +46219,8 @@ }, { "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.", - "docId": "search-aggregations-pipeline-avg-bucket-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html", "name": "avg_bucket", "required": false, "type": { @@ -46093,8 +46233,8 @@ }, { "description": "A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-boxplot-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-boxplot-aggregation.html", + "extDocId": "search-aggregations-metrics-boxplot-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-boxplot-aggregation.html", "name": "boxplot", "required": false, "type": { @@ -46107,8 +46247,8 @@ }, { "description": "A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.", - "docId": "search-aggregations-pipeline-bucket-script-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html", + "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html", "name": "bucket_script", "required": false, "type": { @@ -46121,8 +46261,8 @@ }, { "description": "A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.", - "docId": "search-aggregations-pipeline-bucket-selector-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html", + "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html", "name": "bucket_selector", "required": false, "type": { @@ -46135,8 +46275,8 @@ }, { "description": "A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.", - "docId": "search-aggregations-pipeline-bucket-sort-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html", + "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html", "name": "bucket_sort", "required": false, "type": { @@ -46157,8 +46297,8 @@ } }, "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.", - "docId": "search-aggregations-bucket-count-ks-test-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html", + "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html", "name": "bucket_count_ks_test", "required": false, "type": { @@ -46179,8 +46319,8 @@ } }, "description": "A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.", - "docId": "search-aggregations-bucket-correlation-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-correlation-aggregation.html", + "extDocId": "search-aggregations-bucket-correlation-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-correlation-aggregation.html", "name": "bucket_correlation", "required": false, "type": { @@ -46193,8 +46333,8 @@ }, { "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/{branch}/search-aggregations-metrics-cardinality-aggregation.html", + "extDocId": "search-aggregations-metrics-cardinality-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-cardinality-aggregation.html", "name": "cardinality", "required": false, "type": { @@ -46215,8 +46355,8 @@ } }, "description": "A multi-bucket aggregation that groups semi-structured text into buckets.", - "docId": "search-aggregations-bucket-categorize-text-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html", + "extDocId": "search-aggregations-bucket-categorize-text-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html", "name": "categorize_text", "required": false, "type": { @@ -46229,8 +46369,8 @@ }, { "description": "A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.", - "docId": "search-aggregations-bucket-children-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html", + "extDocId": "search-aggregations-bucket-children-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html", "name": "children", "required": false, "type": { @@ -46255,8 +46395,8 @@ }, { "description": "A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.", - "docId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", + "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", "name": "cumulative_cardinality", "required": false, "type": { @@ -46269,8 +46409,8 @@ }, { "description": "A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.", - "docId": "search-aggregations-pipeline-cumulative-sum-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html", + "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html", "name": "cumulative_sum", "required": false, "type": { @@ -46283,8 +46423,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-datehistogram-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html", + "extDocId": "search-aggregations-bucket-datehistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html", "name": "date_histogram", "required": false, "type": { @@ -46297,8 +46437,8 @@ }, { "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/{branch}/search-aggregations-bucket-daterange-aggregation.html", + "extDocId": "search-aggregations-bucket-daterange-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-daterange-aggregation.html", "name": "date_range", "required": false, "type": { @@ -46311,8 +46451,8 @@ }, { "description": "A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.", - "docId": "search-aggregations-pipeline-derivative-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html", + "extDocId": "search-aggregations-pipeline-derivative-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html", "name": "derivative", "required": false, "type": { @@ -46325,8 +46465,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-diversified-sampler-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html", + "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html", "name": "diversified_sampler", "required": false, "type": { @@ -46339,8 +46479,8 @@ }, { "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-extendedstats-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html", + "extDocId": "search-aggregations-metrics-extendedstats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html", "name": "extended_stats", "required": false, "type": { @@ -46353,8 +46493,8 @@ }, { "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", - "docId": "search-aggregations-pipeline-extended-stats-bucket-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-extended-stats-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-extended-stats-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-extended-stats-bucket-aggregation.html", "name": "extended_stats_bucket", "required": false, "type": { @@ -46367,8 +46507,8 @@ }, { "description": "A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.", - "docId": "search-aggregations-bucket-frequent-item-sets-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html", + "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html", "name": "frequent_item_sets", "required": false, "type": { @@ -46381,8 +46521,8 @@ }, { "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/{branch}/search-aggregations-bucket-filter-aggregation.html", + "extDocId": "search-aggregations-bucket-filter-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html", "name": "filter", "required": false, "type": { @@ -46395,8 +46535,8 @@ }, { "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/{branch}/search-aggregations-bucket-filters-aggregation.html", + "extDocId": "search-aggregations-bucket-filters-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filters-aggregation.html", "name": "filters", "required": false, "type": { @@ -46409,8 +46549,8 @@ }, { "description": "A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.", - "docId": "search-aggregations-metrics-geobounds-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geobounds-aggregation.html", + "extDocId": "search-aggregations-metrics-geobounds-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geobounds-aggregation.html", "name": "geo_bounds", "required": false, "type": { @@ -46423,8 +46563,8 @@ }, { "description": "A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.", - "docId": "search-aggregations-metrics-geocentroid-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geocentroid-aggregation.html", + "extDocId": "search-aggregations-metrics-geocentroid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geocentroid-aggregation.html", "name": "geo_centroid", "required": false, "type": { @@ -46437,8 +46577,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-geodistance-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geodistance-aggregation.html", + "extDocId": "search-aggregations-bucket-geodistance-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geodistance-aggregation.html", "name": "geo_distance", "required": false, "type": { @@ -46451,8 +46591,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-geohashgrid-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geohashgrid-aggregation.html", + "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geohashgrid-aggregation.html", "name": "geohash_grid", "required": false, "type": { @@ -46465,8 +46605,8 @@ }, { "description": "Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.", - "docId": "search-aggregations-metrics-geo-line", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geo-line.html", + "extDocId": "search-aggregations-metrics-geo-line", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geo-line.html", "name": "geo_line", "required": false, "type": { @@ -46479,8 +46619,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-geotilegrid-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geotilegrid-aggregation.html", + "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geotilegrid-aggregation.html", "name": "geotile_grid", "required": false, "type": { @@ -46493,8 +46633,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-geohexgrid-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geohexgrid-aggregation.html", + "extDocId": "search-aggregations-bucket-geohexgrid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geohexgrid-aggregation.html", "name": "geohex_grid", "required": false, "type": { @@ -46507,8 +46647,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-global-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-global-aggregation.html", + "extDocId": "search-aggregations-bucket-global-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-global-aggregation.html", "name": "global", "required": false, "type": { @@ -46521,8 +46661,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-histogram-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-histogram-aggregation.html", + "extDocId": "search-aggregations-bucket-histogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-histogram-aggregation.html", "name": "histogram", "required": false, "type": { @@ -46535,8 +46675,8 @@ }, { "description": "A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.", - "docId": "search-aggregations-bucket-iprange-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-iprange-aggregation.html", + "extDocId": "search-aggregations-bucket-iprange-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-iprange-aggregation.html", "name": "ip_range", "required": false, "type": { @@ -46549,8 +46689,8 @@ }, { "description": "A bucket aggregation that groups documents based on the network or sub-network of an IP address.", - "docId": "search-aggregations-bucket-ipprefix-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-ipprefix-aggregation.html", + "extDocId": "search-aggregations-bucket-ipprefix-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-ipprefix-aggregation.html", "name": "ip_prefix", "required": false, "type": { @@ -46563,8 +46703,8 @@ }, { "description": "A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.", - "docId": "search-aggregations-pipeline-inference-bucket-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-inference-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-inference-bucket-aggregation.html", "name": "inference", "required": false, "type": { @@ -46588,8 +46728,8 @@ }, { "description": "A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.", - "docId": "search-aggregations-matrix-stats-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-matrix-stats-aggregation.html", + "extDocId": "search-aggregations-matrix-stats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-matrix-stats-aggregation.html", "name": "matrix_stats", "required": false, "type": { @@ -46602,8 +46742,8 @@ }, { "description": "A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-max-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-max-aggregation.html", + "extDocId": "search-aggregations-metrics-max-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-max-aggregation.html", "name": "max", "required": false, "type": { @@ -46616,8 +46756,8 @@ }, { "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).", - "docId": "search-aggregations-pipeline-max-bucket-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-max-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-max-bucket-aggregation.html", "name": "max_bucket", "required": false, "type": { @@ -46630,8 +46770,8 @@ }, { "description": "A single-value aggregation that approximates the median absolute deviation of its search results.", - "docId": "search-aggregations-metrics-median-absolute-deviation-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-median-absolute-deviation-aggregation.html", + "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-median-absolute-deviation-aggregation.html", "name": "median_absolute_deviation", "required": false, "type": { @@ -46644,8 +46784,8 @@ }, { "description": "A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-min-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-min-aggregation.html", + "extDocId": "search-aggregations-metrics-min-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-min-aggregation.html", "name": "min", "required": false, "type": { @@ -46658,8 +46798,8 @@ }, { "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).", - "docId": "search-aggregations-pipeline-min-bucket-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-min-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-min-bucket-aggregation.html", "name": "min_bucket", "required": false, "type": { @@ -46672,8 +46812,8 @@ }, { "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).", - "docId": "search-aggregations-bucket-missing-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-missing-aggregation.html", + "extDocId": "search-aggregations-bucket-missing-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-missing-aggregation.html", "name": "missing", "required": false, "type": { @@ -46697,8 +46837,8 @@ }, { "description": "Given an ordered series of percentiles, \"slides\" a window across those percentiles and computes cumulative percentiles.", - "docId": "search-aggregations-pipeline-moving-percentiles-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-moving-percentiles-aggregation.html", + "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-moving-percentiles-aggregation.html", "name": "moving_percentiles", "required": false, "type": { @@ -46711,8 +46851,8 @@ }, { "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.", - "docId": "search-aggregations-pipeline-movfn-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-movfn-aggregation.html", + "extDocId": "search-aggregations-pipeline-movfn-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-movfn-aggregation.html", "name": "moving_fn", "required": false, "type": { @@ -46725,8 +46865,8 @@ }, { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.", - "docId": "search-aggregations-bucket-multi-terms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-multi-terms-aggregation.html", + "extDocId": "search-aggregations-bucket-multi-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-multi-terms-aggregation.html", "name": "multi_terms", "required": false, "type": { @@ -46739,8 +46879,8 @@ }, { "description": "A special single bucket aggregation that enables aggregating nested documents.", - "docId": "search-aggregations-bucket-nested-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-nested-aggregation.html", + "extDocId": "search-aggregations-bucket-nested-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-nested-aggregation.html", "name": "nested", "required": false, "type": { @@ -46753,8 +46893,8 @@ }, { "description": "A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.", - "docId": "search-aggregations-pipeline-normalize-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-normalize-aggregation.html", + "extDocId": "search-aggregations-pipeline-normalize-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-normalize-aggregation.html", "name": "normalize", "required": false, "type": { @@ -46767,8 +46907,8 @@ }, { "description": "A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.", - "docId": "search-aggregations-bucket-parent-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-parent-aggregation.html", + "extDocId": "search-aggregations-bucket-parent-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-parent-aggregation.html", "name": "parent", "required": false, "type": { @@ -46781,8 +46921,8 @@ }, { "description": "A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-percentile-rank-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-percentile-rank-aggregation.html", + "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-percentile-rank-aggregation.html", "name": "percentile_ranks", "required": false, "type": { @@ -46795,8 +46935,8 @@ }, { "description": "A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-percentile-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-percentile-aggregation.html", + "extDocId": "search-aggregations-metrics-percentile-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-percentile-aggregation.html", "name": "percentiles", "required": false, "type": { @@ -46809,8 +46949,8 @@ }, { "description": "A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.", - "docId": "search-aggregations-pipeline-percentiles-bucket-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-percentiles-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-percentiles-bucket-aggregation.html", "name": "percentiles_bucket", "required": false, "type": { @@ -46823,8 +46963,8 @@ }, { "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/{branch}/search-aggregations-bucket-range-aggregation.html", + "extDocId": "search-aggregations-bucket-range-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-range-aggregation.html", "name": "range", "required": false, "type": { @@ -46837,8 +46977,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-rare-terms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-rare-terms-aggregation.html", + "extDocId": "search-aggregations-bucket-rare-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-rare-terms-aggregation.html", "name": "rare_terms", "required": false, "type": { @@ -46851,8 +46991,8 @@ }, { "description": "Calculates a rate of documents or a field in each bucket.\nCan only be used inside a `date_histogram` or `composite` aggregation.", - "docId": "search-aggregations-metrics-rate-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-rate-aggregation.html", + "extDocId": "search-aggregations-metrics-rate-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-rate-aggregation.html", "name": "rate", "required": false, "type": { @@ -46865,8 +47005,8 @@ }, { "description": "A special single bucket aggregation that enables aggregating on parent documents from nested documents.\nShould only be defined inside a `nested` aggregation.", - "docId": "search-aggregations-bucket-reverse-nested-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-reverse-nested-aggregation.html", + "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-reverse-nested-aggregation.html", "name": "reverse_nested", "required": false, "type": { @@ -46879,8 +47019,8 @@ }, { "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.", - "docId": "search-aggregations-bucket-sampler-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-sampler-aggregation.html", + "extDocId": "search-aggregations-bucket-sampler-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-sampler-aggregation.html", "name": "sampler", "required": false, "type": { @@ -46893,8 +47033,8 @@ }, { "description": "A metric aggregation that uses scripts to provide a metric output.", - "docId": "search-aggregations-metrics-scripted-metric-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-scripted-metric-aggregation.html", + "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-scripted-metric-aggregation.html", "name": "scripted_metric", "required": false, "type": { @@ -46907,8 +47047,8 @@ }, { "description": "An aggregation that subtracts values in a time series from themselves at different time lags or periods.", - "docId": "search-aggregations-pipeline-serialdiff-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-serialdiff-aggregation.html", + "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-serialdiff-aggregation.html", "name": "serial_diff", "required": false, "type": { @@ -46921,8 +47061,8 @@ }, { "description": "Returns interesting or unusual occurrences of terms in a set.", - "docId": "search-aggregations-bucket-significantterms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html", + "extDocId": "search-aggregations-bucket-significantterms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significantterms-aggregation.html", "name": "significant_terms", "required": false, "type": { @@ -46935,8 +47075,8 @@ }, { "description": "Returns interesting or unusual occurrences of free-text terms in a set.", - "docId": "search-aggregations-bucket-significanttext-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", + "extDocId": "search-aggregations-bucket-significanttext-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", "name": "significant_text", "required": false, "type": { @@ -46949,8 +47089,8 @@ }, { "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-stats-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-stats-aggregation.html", + "extDocId": "search-aggregations-metrics-stats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-stats-aggregation.html", "name": "stats", "required": false, "type": { @@ -46963,8 +47103,8 @@ }, { "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", - "docId": "search-aggregations-pipeline-stats-bucket-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-stats-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-stats-bucket-aggregation.html", "name": "stats_bucket", "required": false, "type": { @@ -46977,8 +47117,8 @@ }, { "description": "A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-string-stats-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-string-stats-aggregation.html", + "extDocId": "search-aggregations-metrics-string-stats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-string-stats-aggregation.html", "name": "string_stats", "required": false, "type": { @@ -46991,8 +47131,8 @@ }, { "description": "A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-sum-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-sum-aggregation.html", + "extDocId": "search-aggregations-metrics-sum-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-sum-aggregation.html", "name": "sum", "required": false, "type": { @@ -47005,8 +47145,8 @@ }, { "description": "A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.", - "docId": "search-aggregations-pipeline-sum-bucket-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-sum-bucket-aggregation.html", + "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-sum-bucket-aggregation.html", "name": "sum_bucket", "required": false, "type": { @@ -47019,8 +47159,8 @@ }, { "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/{branch}/search-aggregations-bucket-terms-aggregation.html", + "extDocId": "search-aggregations-bucket-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-terms-aggregation.html", "name": "terms", "required": false, "type": { @@ -47041,8 +47181,8 @@ } }, "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.", - "docId": "search-aggregations-bucket-time-series-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-time-series-aggregation.html", + "extDocId": "search-aggregations-bucket-time-series-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-time-series-aggregation.html", "name": "time_series", "required": false, "type": { @@ -47055,8 +47195,8 @@ }, { "description": "A metric aggregation that returns the top matching documents per bucket.", - "docId": "search-aggregations-metrics-top-hits-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-hits-aggregation.html", + "extDocId": "search-aggregations-metrics-top-hits-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-hits-aggregation.html", "name": "top_hits", "required": false, "type": { @@ -47069,8 +47209,8 @@ }, { "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.", - "docId": "search-aggregations-metrics-ttest-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-ttest-aggregation.html", + "extDocId": "search-aggregations-metrics-ttest-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-ttest-aggregation.html", "name": "t_test", "required": false, "type": { @@ -47083,8 +47223,8 @@ }, { "description": "A metric aggregation that selects metrics from the document with the largest or smallest sort value.", - "docId": "search-aggregations-metrics-top-metrics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-metrics.html", + "extDocId": "search-aggregations-metrics-top-metrics", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-metrics.html", "name": "top_metrics", "required": false, "type": { @@ -47097,8 +47237,8 @@ }, { "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/{branch}/search-aggregations-metrics-valuecount-aggregation.html", + "extDocId": "search-aggregations-metrics-valuecount-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-valuecount-aggregation.html", "name": "value_count", "required": false, "type": { @@ -47111,8 +47251,8 @@ }, { "description": "A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.", - "docId": "search-aggregations-metrics-weight-avg-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-weight-avg-aggregation.html", + "extDocId": "search-aggregations-metrics-weight-avg-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-weight-avg-aggregation.html", "name": "weighted_avg", "required": false, "type": { @@ -47125,8 +47265,8 @@ }, { "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.", - "docId": "search-aggregations-bucket-variablewidthhistogram-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-variablewidthhistogram-aggregation.html", + "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-variablewidthhistogram-aggregation.html", "name": "variable_width_histogram", "required": false, "type": { @@ -47243,8 +47383,8 @@ "specLocation": "_types/aggregations/Aggregation.ts#L20-L20" }, { - "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html", + "extDocId": "query-dsl", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html", "kind": "interface", "name": { "name": "QueryContainer", @@ -47253,8 +47393,8 @@ "properties": [ { "description": "matches documents matching boolean combinations of other queries.", - "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", + "extDocId": "query-dsl-bool-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", "name": "bool", "required": false, "type": { @@ -47267,8 +47407,8 @@ }, { "description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.", - "docId": "query-dsl-boosting-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-boosting-query.html", + "extDocId": "query-dsl-boosting-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-boosting-query.html", "name": "boosting", "required": false, "type": { @@ -47313,8 +47453,8 @@ } }, "description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.", - "docId": "query-dsl-combined-fields-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-combined-fields-query.html", + "extDocId": "query-dsl-combined-fields-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-combined-fields-query.html", "name": "combined_fields", "required": false, "type": { @@ -47327,8 +47467,8 @@ }, { "description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.", - "docId": "query-dsl-constant-score-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-constant-score-query.html", + "extDocId": "query-dsl-constant-score-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-constant-score-query.html", "name": "constant_score", "required": false, "type": { @@ -47341,8 +47481,8 @@ }, { "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.", - "docId": "query-dsl-dis-max-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-dis-max-query.html", + "extDocId": "query-dsl-dis-max-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-dis-max-query.html", "name": "dis_max", "required": false, "type": { @@ -47355,8 +47495,8 @@ }, { "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.", - "docId": "query-dsl-distance-feature-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-distance-feature-query.html", + "extDocId": "query-dsl-distance-feature-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-distance-feature-query.html", "name": "distance_feature", "required": false, "type": { @@ -47369,8 +47509,8 @@ }, { "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/{branch}/query-dsl-exists-query.html", + "extDocId": "query-dsl-exists-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html", "name": "exists", "required": false, "type": { @@ -47383,8 +47523,8 @@ }, { "description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.", - "docId": "query-dsl-function-score-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-function-score-query.html", + "extDocId": "query-dsl-function-score-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-function-score-query.html", "name": "function_score", "required": false, "type": { @@ -47397,8 +47537,8 @@ }, { "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.", - "docId": "query-dsl-fuzzy-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html", + "extDocId": "query-dsl-fuzzy-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html", "name": "fuzzy", "required": false, "type": { @@ -47422,8 +47562,8 @@ }, { "description": "Matches geo_point and geo_shape values that intersect a bounding box.", - "docId": "query-dsl-geo-bounding-box-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html", + "extDocId": "query-dsl-geo-bounding-box-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html", "name": "geo_bounding_box", "required": false, "type": { @@ -47436,8 +47576,8 @@ }, { "description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.", - "docId": "query-dsl-geo-distance-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html", + "extDocId": "query-dsl-geo-distance-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html", "name": "geo_distance", "required": false, "type": { @@ -47465,8 +47605,8 @@ }, { "description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.", - "docId": "query-dsl-geo-shape-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html", + "extDocId": "query-dsl-geo-shape-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html", "name": "geo_shape", "required": false, "type": { @@ -47479,8 +47619,8 @@ }, { "description": "Returns parent documents whose joined child documents match a provided query.", - "docId": "query-dsl-has-child-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-child-query.html", + "extDocId": "query-dsl-has-child-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-child-query.html", "name": "has_child", "required": false, "type": { @@ -47493,8 +47633,8 @@ }, { "description": "Returns child documents whose joined parent document matches a provided query.", - "docId": "query-dsl-has-parent-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-parent-query.html", + "extDocId": "query-dsl-has-parent-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-parent-query.html", "name": "has_parent", "required": false, "type": { @@ -47507,8 +47647,8 @@ }, { "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/{branch}/query-dsl-ids-query.html", + "extDocId": "query-dsl-ids-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html", "name": "ids", "required": false, "type": { @@ -47521,8 +47661,8 @@ }, { "description": "Returns documents based on the order and proximity of matching terms.", - "docId": "query-dsl-intervals-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-intervals-query.html", + "extDocId": "query-dsl-intervals-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-intervals-query.html", "name": "intervals", "required": false, "type": { @@ -47546,8 +47686,8 @@ }, { "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.", - "docId": "query-dsl-knn-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-knn-query.html", + "extDocId": "query-dsl-knn-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-knn-query.html", "name": "knn", "required": false, "type": { @@ -47560,8 +47700,8 @@ }, { "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/{branch}/query-dsl-match-query.html", + "extDocId": "query-dsl-match-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html", "name": "match", "required": false, "type": { @@ -47585,8 +47725,8 @@ }, { "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/{branch}/query-dsl-match-all-query.html", + "extDocId": "query-dsl-match-all-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html", "name": "match_all", "required": false, "type": { @@ -47599,8 +47739,8 @@ }, { "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.", - "docId": "query-dsl-match-bool-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-bool-prefix-query.html", + "extDocId": "query-dsl-match-bool-prefix-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-bool-prefix-query.html", "name": "match_bool_prefix", "required": false, "type": { @@ -47624,8 +47764,8 @@ }, { "description": "Matches no documents.", - "docId": "query-dsl-match-none-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html#query-dsl-match-none-query", + "extDocId": "query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html#query-dsl-match-none-query", "name": "match_none", "required": false, "type": { @@ -47638,8 +47778,8 @@ }, { "description": "Analyzes the text and creates a phrase query out of the analyzed text.", - "docId": "query-dsl-match-query-phrase", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase.html", + "extDocId": "query-dsl-match-query-phrase", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase.html", "name": "match_phrase", "required": false, "type": { @@ -47663,8 +47803,8 @@ }, { "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.", - "docId": "query-dsl-match-query-phrase-prefix", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase-prefix.html", + "extDocId": "query-dsl-match-query-phrase-prefix", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase-prefix.html", "name": "match_phrase_prefix", "required": false, "type": { @@ -47688,8 +47828,8 @@ }, { "description": "Returns documents that are \"like\" a given set of documents.", - "docId": "query-dsl-mlt-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html", + "extDocId": "query-dsl-mlt-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html", "name": "more_like_this", "required": false, "type": { @@ -47702,8 +47842,8 @@ }, { "description": "Enables you to search for a provided text, number, date or boolean value across multiple fields.\nThe provided text is analyzed before matching.", - "docId": "query-dsl-multi-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-match-query.html", + "extDocId": "query-dsl-multi-match-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-match-query.html", "name": "multi_match", "required": false, "type": { @@ -47716,8 +47856,8 @@ }, { "description": "Wraps another query to search nested fields.\nIf an object matches the search, the nested query returns the root parent document.", - "docId": "query-dsl-nested-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-nested-query.html", + "extDocId": "query-dsl-nested-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-nested-query.html", "name": "nested", "required": false, "type": { @@ -47730,8 +47870,8 @@ }, { "description": "Returns child documents joined to a specific parent document.", - "docId": "query-dsl-parent-id-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-parent-id-query.html", + "extDocId": "query-dsl-parent-id-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-parent-id-query.html", "name": "parent_id", "required": false, "type": { @@ -47744,8 +47884,8 @@ }, { "description": "Matches queries stored in an index.", - "docId": "query-dsl-percolate-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-percolate-query.html", + "extDocId": "query-dsl-percolate-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-percolate-query.html", "name": "percolate", "required": false, "type": { @@ -47758,8 +47898,8 @@ }, { "description": "Promotes selected documents to rank higher than those matching a given query.", - "docId": "query-dsl-pinned-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-pinned-query.html", + "extDocId": "query-dsl-pinned-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-pinned-query.html", "name": "pinned", "required": false, "type": { @@ -47772,8 +47912,8 @@ }, { "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/{branch}/query-dsl-prefix-query.html", + "extDocId": "query-dsl-prefix-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-prefix-query.html", "name": "prefix", "required": false, "type": { @@ -47797,8 +47937,8 @@ }, { "description": "Returns documents based on a provided query string, using a parser with a strict syntax.", - "docId": "query-dsl-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-query-string-query.html", + "extDocId": "query-dsl-query-string-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-query-string-query.html", "name": "query_string", "required": false, "type": { @@ -47811,8 +47951,8 @@ }, { "description": "Returns documents that contain terms within a provided range.", - "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html", + "extDocId": "query-dsl-range-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html", "name": "range", "required": false, "type": { @@ -47836,8 +47976,8 @@ }, { "description": "Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.", - "docId": "query-dsl-rank-feature-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rank-feature-query.html", + "extDocId": "query-dsl-rank-feature-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rank-feature-query.html", "name": "rank_feature", "required": false, "type": { @@ -47850,8 +47990,8 @@ }, { "description": "Returns documents that contain terms matching a regular expression.", - "docId": "query-dsl-regexp-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-regexp-query.html", + "extDocId": "query-dsl-regexp-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-regexp-query.html", "name": "regexp", "required": false, "type": { @@ -47886,8 +48026,8 @@ }, { "description": "Filters documents based on a provided script.\nThe script query is typically used in a filter context.", - "docId": "query-dsl-script-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-query.html", + "extDocId": "query-dsl-script-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-query.html", "name": "script", "required": false, "type": { @@ -47900,8 +48040,8 @@ }, { "description": "Uses a script to provide a custom score for returned documents.", - "docId": "query-dsl-script-score-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-score-query.html", + "extDocId": "query-dsl-script-score-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-score-query.html", "name": "script_score", "required": false, "type": { @@ -47932,8 +48072,8 @@ }, { "description": "Queries documents that contain fields indexed using the `shape` type.", - "docId": "query-dsl-shape-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-shape-query.html", + "extDocId": "query-dsl-shape-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-shape-query.html", "name": "shape", "required": false, "type": { @@ -47946,8 +48086,8 @@ }, { "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/{branch}/query-dsl-simple-query-string-query.html", + "extDocId": "query-dsl-simple-query-string-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html", "name": "simple_query_string", "required": false, "type": { @@ -47960,8 +48100,8 @@ }, { "description": "Returns matches which enclose another span query.", - "docId": "query-dsl-span-containing-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-containing-query.html", + "extDocId": "query-dsl-span-containing-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-containing-query.html", "name": "span_containing", "required": false, "type": { @@ -47974,8 +48114,8 @@ }, { "description": "Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.", - "docId": "query-dsl-span-field-masking-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-field-masking-query.html", + "extDocId": "query-dsl-span-field-masking-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-field-masking-query.html", "name": "span_field_masking", "required": false, "type": { @@ -47988,8 +48128,8 @@ }, { "description": "Matches spans near the beginning of a field.", - "docId": "query-dsl-span-first-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-first-query.html", + "extDocId": "query-dsl-span-first-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-first-query.html", "name": "span_first", "required": false, "type": { @@ -48002,8 +48142,8 @@ }, { "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.", - "docId": "query-dsl-span-multi-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-multi-term-query.html", + "extDocId": "query-dsl-span-multi-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-multi-term-query.html", "name": "span_multi", "required": false, "type": { @@ -48016,8 +48156,8 @@ }, { "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.", - "docId": "query-dsl-span-near-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-near-query.html", + "extDocId": "query-dsl-span-near-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-near-query.html", "name": "span_near", "required": false, "type": { @@ -48030,8 +48170,8 @@ }, { "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.", - "docId": "query-dsl-span-not-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-not-query.html", + "extDocId": "query-dsl-span-not-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-not-query.html", "name": "span_not", "required": false, "type": { @@ -48044,8 +48184,8 @@ }, { "description": "Matches the union of its span clauses.", - "docId": "query-dsl-span-or-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-or-query.html", + "extDocId": "query-dsl-span-or-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-or-query.html", "name": "span_or", "required": false, "type": { @@ -48058,8 +48198,8 @@ }, { "description": "Matches spans containing a term.", - "docId": "query-dsl-span-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-term-query.html", + "extDocId": "query-dsl-span-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-term-query.html", "name": "span_term", "required": false, "type": { @@ -48083,8 +48223,8 @@ }, { "description": "Returns matches which are enclosed inside another span query.", - "docId": "query-dsl-span-within-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-within-query.html", + "extDocId": "query-dsl-span-within-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-within-query.html", "name": "span_within", "required": false, "type": { @@ -48103,7 +48243,8 @@ } }, "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.", - "docId": "query-dsl-sparse-vector-query", + "extDocId": "query-dsl-sparse-vector-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-sparse-vector-query.html", "name": "sparse_vector", "required": false, "type": { @@ -48116,8 +48257,8 @@ }, { "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/{branch}/query-dsl-term-query.html", + "extDocId": "query-dsl-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-term-query.html", "name": "term", "required": false, "type": { @@ -48141,8 +48282,8 @@ }, { "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/{branch}/query-dsl-terms-query.html", + "extDocId": "query-dsl-terms-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html", "name": "terms", "required": false, "type": { @@ -48155,8 +48296,8 @@ }, { "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.", - "docId": "query-dsl-terms-set-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-set-query.html", + "extDocId": "query-dsl-terms-set-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-set-query.html", "name": "terms_set", "required": false, "type": { @@ -48190,8 +48331,8 @@ "version": "8.15.0" }, "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.", - "docId": "query-dsl-text-expansion-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html", + "extDocId": "query-dsl-text-expansion-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html", "name": "text_expansion", "required": false, "type": { @@ -48225,7 +48366,8 @@ "version": "8.15.0" }, "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.", - "docId": "query-dsl-weighted-tokens-query", + "extDocId": "query-dsl-weighted-tokens-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-weighted-tokens-query.html", "name": "weighted_tokens", "required": false, "type": { @@ -48249,8 +48391,8 @@ }, { "description": "Returns documents that contain terms matching a wildcard pattern.", - "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html", + "extDocId": "query-dsl-wildcard-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html", "name": "wildcard", "required": false, "type": { @@ -48274,8 +48416,8 @@ }, { "description": "A query that accepts any other query as base64 encoded string.", - "docId": "query-dsl-wrapper-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html", + "extDocId": "query-dsl-wrapper-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html", "name": "wrapper", "required": false, "type": { @@ -48309,6 +48451,8 @@ } }, { + "extDocId": "query-dsl-bool-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-bool-query.html", "inherits": { "type": { "name": "QueryBase", @@ -48444,7 +48588,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L29-L53" + "specLocation": "_types/query_dsl/compound.ts#L29-L56" }, { "kind": "interface", @@ -48542,6 +48686,8 @@ } }, { + "extDocId": "query-dsl-boosting-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-boosting-query.html", "inherits": { "type": { "name": "QueryBase", @@ -48591,7 +48737,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L55-L68" + "specLocation": "_types/query_dsl/compound.ts#L58-L74" }, { "kind": "type_alias", @@ -48797,8 +48943,8 @@ }, { "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/{branch}/query-dsl-minimum-should-match.html", + "extDocId": "query-dsl-minimum-should-match", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html", "name": "minimum_should_match", "required": false, "type": { @@ -48839,7 +48985,7 @@ "name": "CombinedFieldsOperator", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/abstractions.ts#L509-L512" + "specLocation": "_types/query_dsl/abstractions.ts#L512-L515" }, { "kind": "enum", @@ -48857,9 +49003,11 @@ "name": "CombinedFieldsZeroTerms", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/abstractions.ts#L514-L523" + "specLocation": "_types/query_dsl/abstractions.ts#L517-L526" }, { + "extDocId": "query-dsl-constant-score-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-constant-score-query.html", "inherits": { "type": { "name": "QueryBase", @@ -48885,9 +49033,11 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L70-L77" + "specLocation": "_types/query_dsl/compound.ts#L76-L86" }, { + "extDocId": "query-dsl-dis-max-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-dis-max-query.html", "inherits": { "type": { "name": "QueryBase", @@ -48929,7 +49079,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L79-L91" + "specLocation": "_types/query_dsl/compound.ts#L88-L103" }, { "codegenNames": [ @@ -48937,12 +49087,14 @@ "geo", "date" ], + "extDocId": "query-dsl-distance-feature-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-distance-feature-query.html", "kind": "type_alias", "name": { "name": "DistanceFeatureQuery", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/specialized.ts#L76-L84", + "specLocation": "_types/query_dsl/specialized.ts#L76-L85", "type": { "items": [ { @@ -49125,6 +49277,8 @@ "specLocation": "_types/query_dsl/specialized.ts#L71-L74" }, { + "extDocId": "query-dsl-exists-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-exists-query.html", "inherits": { "type": { "name": "QueryBase", @@ -49150,9 +49304,11 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L38-L43" + "specLocation": "_types/query_dsl/term.ts#L38-L46" }, { + "extDocId": "query-dsl-function-score-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-function-score-query.html", "inherits": { "type": { "name": "QueryBase", @@ -49244,7 +49400,7 @@ } ], "shortcutProperty": "functions", - "specLocation": "_types/query_dsl/compound.ts#L93-L122" + "specLocation": "_types/query_dsl/compound.ts#L105-L135" }, { "kind": "enum", @@ -49278,7 +49434,7 @@ "name": "FunctionBoostMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L282-L308" + "specLocation": "_types/query_dsl/compound.ts#L295-L321" }, { "esQuirk": "this container is valid without a variant. Despite being documented as a function, 'weight'\nis actually a container property that can be combined with a function. Comment in the ES code\n(SearchModule#registerScoreFunctions) says: Weight doesn't have its own parser, so every function\nsupports it out of the box. Can be a single function too when not associated to any other function,\nwhich is why it needs to be registered manually here.", @@ -49385,7 +49541,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L213-L253", + "specLocation": "_types/query_dsl/compound.ts#L226-L266", "variants": { "kind": "container" } @@ -49402,7 +49558,7 @@ "name": "DecayFunction", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L202-L211", + "specLocation": "_types/query_dsl/compound.ts#L215-L224", "type": { "items": [ { @@ -49468,7 +49624,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L191-L194" + "specLocation": "_types/query_dsl/compound.ts#L204-L207" }, { "attachedBehaviors": [ @@ -49548,7 +49704,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L178-L189" + "specLocation": "_types/query_dsl/compound.ts#L191-L202" }, { "description": "In some places in the specification an object consists of a static set of properties and a single additional property\nwith an arbitrary name but a statically defined type. This is typically used for configurations associated\nto a single field. Meaning that object should theoretically extend SingleKeyDictionary but expose\na set of known keys. And possibly the object might already be part of an object graph and have a parent class.\nThis puts it into a bind that needs a client specific solution.\nWe therefore document the requirement to accept a single unknown property with this interface.", @@ -49638,7 +49794,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L157-L176" + "specLocation": "_types/query_dsl/compound.ts#L170-L189" }, { "kind": "enum", @@ -49664,7 +49820,7 @@ "name": "MultiValueMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L355-L372" + "specLocation": "_types/query_dsl/compound.ts#L368-L385" }, { "attachedBehaviors": [ @@ -49698,7 +49854,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L196-L196" + "specLocation": "_types/query_dsl/compound.ts#L209-L209" }, { "attachedBehaviors": [ @@ -49732,7 +49888,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L195-L195" + "specLocation": "_types/query_dsl/compound.ts#L208-L208" }, { "attachedBehaviors": [ @@ -49766,7 +49922,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/compound.ts#L197-L200" + "specLocation": "_types/query_dsl/compound.ts#L210-L213" }, { "kind": "interface", @@ -49825,7 +49981,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L136-L155" + "specLocation": "_types/query_dsl/compound.ts#L149-L168" }, { "kind": "enum", @@ -49875,7 +50031,7 @@ "name": "FieldValueFactorModifier", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L310-L353" + "specLocation": "_types/query_dsl/compound.ts#L323-L366" }, { "kind": "interface", @@ -49919,7 +50075,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L131-L134" + "specLocation": "_types/query_dsl/compound.ts#L144-L147" }, { "kind": "interface", @@ -49941,7 +50097,7 @@ } } ], - "specLocation": "_types/query_dsl/compound.ts#L124-L129" + "specLocation": "_types/query_dsl/compound.ts#L137-L142" }, { "kind": "interface", @@ -50091,9 +50247,11 @@ "name": "FunctionScoreMode", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/compound.ts#L255-L280" + "specLocation": "_types/query_dsl/compound.ts#L268-L293" }, { + "extDocId": "query-dsl-fuzzy-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html", "inherits": { "type": { "name": "QueryBase", @@ -50207,7 +50365,7 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L45-L80" + "specLocation": "_types/query_dsl/term.ts#L48-L86" }, { "docId": "query-dsl-multi-term-rewrite", @@ -50287,6 +50445,8 @@ } } ], + "extDocId": "query-dsl-geo-bounding-box-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html", "inherits": { "type": { "name": "QueryBase", @@ -50341,7 +50501,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L32-L53" + "specLocation": "_types/query_dsl/geo.ts#L32-L54" }, { "codegenNames": [ @@ -50665,7 +50825,7 @@ "name": "GeoExecution", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/geo.ts#L55-L58" + "specLocation": "_types/query_dsl/geo.ts#L56-L59" }, { "kind": "enum", @@ -50686,7 +50846,7 @@ "name": "GeoValidationMethod", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/geo.ts#L159-L169" + "specLocation": "_types/query_dsl/geo.ts#L163-L173" }, { "attachedBehaviors": [ @@ -50720,6 +50880,8 @@ } } ], + "extDocId": "query-dsl-geo-distance-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html", "inherits": { "type": { "name": "QueryBase", @@ -50786,7 +50948,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L60-L91" + "specLocation": "_types/query_dsl/geo.ts#L61-L93" }, { "kind": "type_alias", @@ -50857,6 +51019,8 @@ "description": "Use geo-shape instead.", "version": "7.12.0" }, + "extDocId": "query-dsl-geo-polygon-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-polygon-query.html", "inherits": { "type": { "name": "QueryBase", @@ -50893,7 +51057,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L97-L108" + "specLocation": "_types/query_dsl/geo.ts#L99-L111" }, { "kind": "interface", @@ -50917,7 +51081,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L93-L95" + "specLocation": "_types/query_dsl/geo.ts#L95-L97" }, { "attachedBehaviors": [ @@ -50951,6 +51115,8 @@ } } ], + "extDocId": "query-dsl-geo-shape-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html", "inherits": { "type": { "name": "QueryBase", @@ -50977,7 +51143,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L128-L143" + "specLocation": "_types/query_dsl/geo.ts#L131-L147" }, { "kind": "interface", @@ -51023,7 +51189,7 @@ } } ], - "specLocation": "_types/query_dsl/geo.ts#L115-L126" + "specLocation": "_types/query_dsl/geo.ts#L118-L129" }, { "description": "A GeoJson shape, that can also use Elasticsearch's `envelope` extension.", @@ -51122,6 +51288,8 @@ "specLocation": "_types/Geo.ts#L64-L82" }, { + "extDocId": "query-dsl-has-child-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-child-query.html", "inherits": { "type": { "name": "QueryBase", @@ -51223,7 +51391,7 @@ } } ], - "specLocation": "_types/query_dsl/joining.ts#L41-L76" + "specLocation": "_types/query_dsl/joining.ts#L41-L79" }, { "kind": "interface", @@ -51448,6 +51616,8 @@ } }, { + "extDocId": "collapse-search-results", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/collapse-search-results.html", "kind": "interface", "name": { "name": "FieldCollapse", @@ -51517,7 +51687,7 @@ } } ], - "specLocation": "_global/search/_types/FieldCollapse.ts#L24-L38" + "specLocation": "_global/search/_types/FieldCollapse.ts#L24-L41" }, { "description": "A reference to a field with formatting instructions on how to return the value", @@ -51564,7 +51734,7 @@ } ], "shortcutProperty": "field", - "specLocation": "_types/query_dsl/abstractions.ts#L525-L539" + "specLocation": "_types/query_dsl/abstractions.ts#L528-L542" }, { "inherits": { @@ -53035,6 +53205,8 @@ } }, { + "extDocId": "query-dsl-has-parent-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-parent-query.html", "inherits": { "type": { "name": "QueryBase", @@ -53112,9 +53284,11 @@ } } ], - "specLocation": "_types/query_dsl/joining.ts#L78-L104" + "specLocation": "_types/query_dsl/joining.ts#L81-L110" }, { + "extDocId": "query-dsl-ids-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-ids-query.html", "inherits": { "type": { "name": "QueryBase", @@ -53140,7 +53314,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L82-L87" + "specLocation": "_types/query_dsl/term.ts#L88-L96" }, { "kind": "type_alias", @@ -53173,6 +53347,8 @@ } }, { + "extDocId": "query-dsl-intervals-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-intervals-query.html", "inherits": { "type": { "name": "QueryBase", @@ -53260,7 +53436,7 @@ } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L235-L263", + "specLocation": "_types/query_dsl/fulltext.ts#L235-L266", "variants": { "kind": "container" } @@ -53836,9 +54012,11 @@ } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L265-L280" + "specLocation": "_types/query_dsl/fulltext.ts#L268-L283" }, { + "extDocId": "query-dsl-knn-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-knn-query.html", "inherits": { "type": { "name": "QueryBase", @@ -53951,7 +54129,7 @@ } } ], - "specLocation": "_types/Knn.ts#L54-L69" + "specLocation": "_types/Knn.ts#L54-L72" }, { "kind": "type_alias", @@ -53990,7 +54168,7 @@ } } ], - "specLocation": "_types/Knn.ts#L71-L74", + "specLocation": "_types/Knn.ts#L74-L77", "variants": { "kind": "container" } @@ -54025,9 +54203,11 @@ } } ], - "specLocation": "_types/Knn.ts#L76-L79" + "specLocation": "_types/Knn.ts#L79-L82" }, { + "extDocId": "query-dsl-match-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query.html", "inherits": { "type": { "name": "QueryBase", @@ -54235,7 +54415,7 @@ } ], "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L282-L347" + "specLocation": "_types/query_dsl/fulltext.ts#L285-L353" }, { "kind": "enum", @@ -54253,9 +54433,11 @@ "name": "ZeroTermsQuery", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/fulltext.ts#L569-L578" + "specLocation": "_types/query_dsl/fulltext.ts#L587-L596" }, { + "extDocId": "query-dsl-match-all-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html", "inherits": { "type": { "name": "QueryBase", @@ -54268,9 +54450,11 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/MatchAllQuery.ts#L22-L22" + "specLocation": "_types/query_dsl/MatchAllQuery.ts#L22-L25" }, { + "extDocId": "query-dsl-match-bool-prefix-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-bool-prefix-query.html", "inherits": { "type": { "name": "QueryBase", @@ -54405,9 +54589,11 @@ } ], "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L349-L403" + "specLocation": "_types/query_dsl/fulltext.ts#L355-L412" }, { + "extDocId": "query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-all-query.html#query-dsl-match-none-query", "inherits": { "type": { "name": "QueryBase", @@ -54420,9 +54606,11 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/MatchNoneQuery.ts#L22-L22" + "specLocation": "_types/query_dsl/MatchNoneQuery.ts#L22-L25" }, { + "extDocId": "query-dsl-match-query-phrase", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase.html", "inherits": { "type": { "name": "QueryBase", @@ -54489,9 +54677,11 @@ } ], "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L405-L426" + "specLocation": "_types/query_dsl/fulltext.ts#L414-L438" }, { + "extDocId": "query-dsl-match-query-phrase-prefix", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-match-query-phrase-prefix.html", "inherits": { "type": { "name": "QueryBase", @@ -54571,9 +54761,11 @@ } ], "shortcutProperty": "query", - "specLocation": "_types/query_dsl/fulltext.ts#L428-L454" + "specLocation": "_types/query_dsl/fulltext.ts#L440-L469" }, { + "extDocId": "query-dsl-mlt-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html", "inherits": { "type": { "name": "QueryBase", @@ -54588,8 +54780,8 @@ "properties": [ { "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", - "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", + "extDocId": "analysis", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "analyzer", "required": false, "type": { @@ -54846,7 +55038,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L86-L168" + "specLocation": "_types/query_dsl/specialized.ts#L87-L172" }, { "codegenNames": [ @@ -54861,7 +55053,7 @@ "name": "Like", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/specialized.ts#L194-L199", + "specLocation": "_types/query_dsl/specialized.ts#L198-L203", "type": { "items": [ { @@ -54993,7 +55185,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L170-L192" + "specLocation": "_types/query_dsl/specialized.ts#L174-L196" }, { "kind": "enum", @@ -55052,6 +55244,8 @@ } }, { + "extDocId": "query-dsl-multi-match-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-match-query.html", "inherits": { "type": { "name": "QueryBase", @@ -55290,7 +55484,7 @@ } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L456-L539" + "specLocation": "_types/query_dsl/fulltext.ts#L471-L557" }, { "kind": "enum", @@ -55324,9 +55518,11 @@ "name": "TextQueryType", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/fulltext.ts#L541-L567" + "specLocation": "_types/query_dsl/fulltext.ts#L559-L585" }, { + "extDocId": "query-dsl-nested-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-nested-query.html", "inherits": { "type": { "name": "QueryBase", @@ -55404,9 +55600,11 @@ } } ], - "specLocation": "_types/query_dsl/joining.ts#L106-L130" + "specLocation": "_types/query_dsl/joining.ts#L112-L139" }, { + "extDocId": "query-dsl-parent-id-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-parent-id-query.html", "inherits": { "type": { "name": "QueryBase", @@ -55457,9 +55655,11 @@ } } ], - "specLocation": "_types/query_dsl/joining.ts#L132-L146" + "specLocation": "_types/query_dsl/joining.ts#L141-L158" }, { + "extDocId": "query-dsl-percolate-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-percolate-query.html", "inherits": { "type": { "name": "QueryBase", @@ -55576,9 +55776,11 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L201-L238" + "specLocation": "_types/query_dsl/specialized.ts#L205-L245" }, { + "extDocId": "query-dsl-pinned-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-pinned-query.html", "inherits": { "type": { "name": "QueryBase", @@ -55635,7 +55837,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L240-L259", + "specLocation": "_types/query_dsl/specialized.ts#L247-L267", "variants": { "kind": "container" } @@ -55672,9 +55874,11 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L261-L270" + "specLocation": "_types/query_dsl/specialized.ts#L269-L278" }, { + "extDocId": "query-dsl-prefix-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-prefix-query.html", "inherits": { "type": { "name": "QueryBase", @@ -55734,9 +55938,11 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L89-L108" + "specLocation": "_types/query_dsl/term.ts#L98-L120" }, { + "extDocId": "query-dsl-query-string-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-query-string-query.html", "inherits": { "type": { "name": "QueryBase", @@ -56075,7 +56281,7 @@ } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L580-L700" + "specLocation": "_types/query_dsl/fulltext.ts#L598-L721" }, { "kind": "type_alias", @@ -56099,12 +56305,14 @@ "number", "term" ], + "extDocId": "query-dsl-range-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html", "kind": "type_alias", "name": { "name": "RangeQuery", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/term.ts#L164-L173", + "specLocation": "_types/query_dsl/term.ts#L176-L186", "type": { "items": [ { @@ -56189,7 +56397,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L138-L147" + "specLocation": "_types/query_dsl/term.ts#L150-L159" }, { "generics": [ @@ -56326,7 +56534,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L110-L136" + "specLocation": "_types/query_dsl/term.ts#L122-L148" }, { "kind": "enum", @@ -56348,7 +56556,7 @@ "name": "RangeRelation", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/term.ts#L175-L188" + "specLocation": "_types/query_dsl/term.ts#L188-L201" }, { "docId": "mapping-date-format", @@ -56414,7 +56622,7 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L149-L158" + "specLocation": "_types/query_dsl/term.ts#L161-L170" }, { "inherits": { @@ -56438,7 +56646,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/term.ts#L160-L160" + "specLocation": "_types/query_dsl/term.ts#L172-L172" }, { "inherits": { @@ -56462,9 +56670,11 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/term.ts#L162-L162" + "specLocation": "_types/query_dsl/term.ts#L174-L174" }, { + "extDocId": "query-dsl-rank-feature-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rank-feature-query.html", "inherits": { "type": { "name": "QueryBase", @@ -56538,7 +56748,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L301-L324" + "specLocation": "_types/query_dsl/specialized.ts#L309-L335" }, { "inherits": { @@ -56566,7 +56776,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L283-L288" + "specLocation": "_types/query_dsl/specialized.ts#L291-L296" }, { "kind": "interface", @@ -56575,7 +56785,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/specialized.ts#L272-L272" + "specLocation": "_types/query_dsl/specialized.ts#L280-L280" }, { "inherits": { @@ -56603,7 +56813,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L276-L281" + "specLocation": "_types/query_dsl/specialized.ts#L284-L289" }, { "inherits": { @@ -56618,7 +56828,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/specialized.ts#L274-L274" + "specLocation": "_types/query_dsl/specialized.ts#L282-L282" }, { "inherits": { @@ -56658,9 +56868,11 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L290-L299" + "specLocation": "_types/query_dsl/specialized.ts#L298-L307" }, { + "extDocId": "query-dsl-regexp-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-regexp-query.html", "inherits": { "type": { "name": "QueryBase", @@ -56749,9 +56961,11 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L190-L220" + "specLocation": "_types/query_dsl/term.ts#L203-L236" }, { + "extDocId": "query-dsl-rule-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rule-query.html", "inherits": { "type": { "name": "QueryBase", @@ -56797,9 +57011,11 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L380-L384" + "specLocation": "_types/query_dsl/specialized.ts#L398-L405" }, { + "extDocId": "query-dsl-script-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-query.html", "inherits": { "type": { "name": "QueryBase", @@ -56825,9 +57041,11 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L326-L332" + "specLocation": "_types/query_dsl/specialized.ts#L337-L346" }, { + "extDocId": "query-dsl-script-score-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-score-query.html", "inherits": { "type": { "name": "QueryBase", @@ -56877,9 +57095,11 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L334-L348" + "specLocation": "_types/query_dsl/specialized.ts#L348-L365" }, { + "extDocId": "query-dsl-semantic-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-semantic-query.html", "inherits": { "type": { "name": "QueryBase", @@ -56917,7 +57137,7 @@ } } ], - "specLocation": "_types/query_dsl/SemanticQuery.ts#L22-L27" + "specLocation": "_types/query_dsl/SemanticQuery.ts#L22-L30" }, { "attachedBehaviors": [ @@ -56951,6 +57171,8 @@ } } ], + "extDocId": "query-dsl-shape-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-shape-query.html", "inherits": { "type": { "name": "QueryBase", @@ -56976,7 +57198,7 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L350-L363" + "specLocation": "_types/query_dsl/specialized.ts#L367-L381" }, { "kind": "interface", @@ -57022,9 +57244,11 @@ } } ], - "specLocation": "_types/query_dsl/specialized.ts#L365-L378" + "specLocation": "_types/query_dsl/specialized.ts#L383-L396" }, { + "extDocId": "query-dsl-simple-query-string-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57208,7 +57432,7 @@ } } ], - "specLocation": "_types/query_dsl/fulltext.ts#L765-L830" + "specLocation": "_types/query_dsl/fulltext.ts#L786-L854" }, { "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`", @@ -57219,7 +57443,7 @@ "name": "SimpleQueryStringFlags", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/fulltext.ts#L702-L706", + "specLocation": "_types/query_dsl/fulltext.ts#L723-L727", "type": { "generics": [ { @@ -57272,6 +57496,8 @@ } }, { + "extDocId": "query-dsl-span-containing-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-containing-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57309,7 +57535,7 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L25-L36" + "specLocation": "_types/query_dsl/span.ts#L25-L39" }, { "kind": "interface", @@ -57449,13 +57675,15 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L131-L173", + "specLocation": "_types/query_dsl/span.ts#L158-L200", "variants": { "kind": "container", "nonExhaustive": true } }, { + "extDocId": "query-dsl-span-field-masking-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-field-masking-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57491,9 +57719,11 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L38-L41" + "specLocation": "_types/query_dsl/span.ts#L41-L47" }, { + "extDocId": "query-dsl-span-first-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-first-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57531,7 +57761,7 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L43-L52" + "specLocation": "_types/query_dsl/span.ts#L49-L61" }, { "description": "Can only be used as a clause in a span_near query.", @@ -57540,7 +57770,7 @@ "name": "SpanGapQuery", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/span.ts#L54-L56", + "specLocation": "_types/query_dsl/span.ts#L63-L65", "type": { "key": { "kind": "instance_of", @@ -57561,6 +57791,8 @@ } }, { + "extDocId": "query-dsl-span-multi-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-multi-term-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57586,9 +57818,11 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L58-L63" + "specLocation": "_types/query_dsl/span.ts#L67-L75" }, { + "extDocId": "query-dsl-span-near-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-near-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57641,9 +57875,11 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L65-L78" + "specLocation": "_types/query_dsl/span.ts#L77-L93" }, { + "extDocId": "query-dsl-span-not-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-not-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57719,9 +57955,11 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L80-L104" + "specLocation": "_types/query_dsl/span.ts#L95-L122" }, { + "extDocId": "query-dsl-span-or-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-or-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57750,9 +57988,11 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L106-L111" + "specLocation": "_types/query_dsl/span.ts#L124-L132" }, { + "extDocId": "query-dsl-span-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-term-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57778,9 +58018,11 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/span.ts#L113-L116" + "specLocation": "_types/query_dsl/span.ts#L134-L140" }, { + "extDocId": "query-dsl-span-within-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-within-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57818,9 +58060,11 @@ } } ], - "specLocation": "_types/query_dsl/span.ts#L118-L129" + "specLocation": "_types/query_dsl/span.ts#L142-L156" }, { + "extDocId": "query-dsl-sparse-vector-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-sparse-vector-query.html", "inherits": { "type": { "name": "QueryBase", @@ -57939,7 +58183,7 @@ } } ], - "specLocation": "_types/query_dsl/SparseVectorQuery.ts#L26-L79", + "specLocation": "_types/query_dsl/SparseVectorQuery.ts#L26-L80", "variants": { "kind": "container" } @@ -57994,6 +58238,8 @@ "specLocation": "_types/query_dsl/TokenPruningConfig.ts#L22-L35" }, { + "extDocId": "query-dsl-term-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-term-query.html", "inherits": { "type": { "name": "QueryBase", @@ -58039,7 +58285,7 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L222-L236" + "specLocation": "_types/query_dsl/term.ts#L238-L255" }, { "codegenNames": [ @@ -58125,7 +58371,7 @@ ], "meta": { "key": "field", - "value": "term" + "value": "terms" }, "type": { "name": "AdditionalProperty", @@ -58133,6 +58379,8 @@ } } ], + "extDocId": "query-dsl-terms-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html", "inherits": { "type": { "name": "QueryBase", @@ -58145,7 +58393,7 @@ "namespace": "_types.query_dsl" }, "properties": [], - "specLocation": "_types/query_dsl/term.ts#L238-L243" + "specLocation": "_types/query_dsl/term.ts#L257-L263" }, { "codegenNames": [ @@ -58157,7 +58405,7 @@ "name": "TermsQueryField", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/term.ts#L245-L248", + "specLocation": "_types/query_dsl/term.ts#L265-L268", "type": { "items": [ { @@ -58233,9 +58481,11 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L250-L255" + "specLocation": "_types/query_dsl/term.ts#L270-L275" }, { + "extDocId": "query-dsl-terms-set-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-set-query.html", "inherits": { "type": { "name": "QueryBase", @@ -58306,9 +58556,11 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L257-L276" + "specLocation": "_types/query_dsl/term.ts#L277-L299" }, { + "extDocId": "query-dsl-text-expansion-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html", "inherits": { "type": { "name": "QueryBase", @@ -58367,9 +58619,11 @@ } } ], - "specLocation": "_types/query_dsl/TextExpansionQuery.ts#L23-L33" + "specLocation": "_types/query_dsl/TextExpansionQuery.ts#L23-L36" }, { + "extDocId": "query-dsl-weighted-tokens-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-weighted-tokens-query.html", "inherits": { "type": { "name": "QueryBase", @@ -58418,9 +58672,11 @@ } } ], - "specLocation": "_types/query_dsl/WeightedTokensQuery.ts#L25-L30" + "specLocation": "_types/query_dsl/WeightedTokensQuery.ts#L25-L33" }, { + "extDocId": "query-dsl-wildcard-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html", "inherits": { "type": { "name": "QueryBase", @@ -58491,9 +58747,11 @@ } ], "shortcutProperty": "value", - "specLocation": "_types/query_dsl/term.ts#L282-L299" + "specLocation": "_types/query_dsl/term.ts#L305-L325" }, { + "extDocId": "query-dsl-wrapper-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html", "inherits": { "type": { "name": "QueryBase", @@ -58519,7 +58777,7 @@ } } ], - "specLocation": "_types/query_dsl/abstractions.ts#L501-L507" + "specLocation": "_types/query_dsl/abstractions.ts#L501-L510" }, { "inherits": { @@ -58546,9 +58804,11 @@ } } ], - "specLocation": "_types/query_dsl/term.ts#L278-L280" + "specLocation": "_types/query_dsl/term.ts#L301-L303" }, { + "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -58676,7 +58936,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L72-L107" + "specLocation": "_types/aggregations/bucket.ts#L72-L110" }, { "kind": "enum", @@ -58704,7 +58964,7 @@ "name": "MinimumInterval", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L109-L116" + "specLocation": "_types/aggregations/bucket.ts#L112-L119" }, { "description": "A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a\nnumber of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string\nrepresentation.", @@ -58852,6 +59112,8 @@ "specLocation": "_types/aggregations/metric.ts#L34-L45" }, { + "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-avg-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -58864,7 +59126,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L78-L78" + "specLocation": "_types/aggregations/pipeline.ts#L78-L81" }, { "inherits": { @@ -59044,6 +59306,8 @@ "specLocation": "_types/aggregations/metric.ts#L57-L62" }, { + "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -59069,9 +59333,11 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L80-L85" + "specLocation": "_types/aggregations/pipeline.ts#L83-L91" }, { + "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -59097,9 +59363,11 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L87-L92" + "specLocation": "_types/aggregations/pipeline.ts#L93-L101" }, { + "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html", "inherits": { "type": { "name": "Aggregation", @@ -59166,10 +59434,12 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L169-L190" + "specLocation": "_types/aggregations/pipeline.ts#L180-L204" }, { "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/{branch}/search-aggregations-bucket-count-ks-test-aggregation.html", "inherits": { "type": { "name": "BucketPathAggregation", @@ -59225,10 +59495,12 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L94-L127" + "specLocation": "_types/aggregations/pipeline.ts#L103-L137" }, { "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/{branch}/search-aggregations-bucket-correlation-aggregation.html", "inherits": { "type": { "name": "BucketPathAggregation", @@ -59254,7 +59526,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L129-L135" + "specLocation": "_types/aggregations/pipeline.ts#L139-L146" }, { "kind": "interface", @@ -59276,7 +59548,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L137-L142" + "specLocation": "_types/aggregations/pipeline.ts#L148-L153" }, { "kind": "interface", @@ -59298,7 +59570,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L144-L147" + "specLocation": "_types/aggregations/pipeline.ts#L155-L158" }, { "kind": "interface", @@ -59350,7 +59622,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L149-L167" + "specLocation": "_types/aggregations/pipeline.ts#L160-L178" }, { "inherits": { @@ -59436,6 +59708,8 @@ }, { "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/{branch}/search-aggregations-bucket-categorize-text-aggregation.html", "inherits": { "type": { "name": "Aggregation", @@ -59576,7 +59850,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1081-L1145" + "specLocation": "_types/aggregations/bucket.ts#L1117-L1182" }, { "codegenNames": [ @@ -59588,7 +59862,7 @@ "name": "CategorizeTextAnalyzer", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1147-L1150", + "specLocation": "_types/aggregations/bucket.ts#L1184-L1187", "type": { "items": [ { @@ -59656,7 +59930,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1152-L1156" + "specLocation": "_types/aggregations/bucket.ts#L1189-L1193" }, { "inherits": { @@ -59684,9 +59958,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L118-L123" + "specLocation": "_types/aggregations/bucket.ts#L121-L126" }, { + "extDocId": "search-aggregations-bucket-composite-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-composite-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -59751,7 +60027,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L127-L143" + "specLocation": "_types/aggregations/bucket.ts#L130-L149" }, { "kind": "type_alias", @@ -59759,7 +60035,7 @@ "name": "CompositeAggregateKey", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L125-L125", + "specLocation": "_types/aggregations/bucket.ts#L128-L128", "type": { "key": { "kind": "instance_of", @@ -59835,7 +60111,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L145-L162" + "specLocation": "_types/aggregations/bucket.ts#L151-L168" }, { "inherits": { @@ -59850,7 +60126,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L175-L175" + "specLocation": "_types/aggregations/bucket.ts#L181-L181" }, { "kind": "interface", @@ -59928,7 +60204,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L164-L173" + "specLocation": "_types/aggregations/bucket.ts#L170-L179" }, { "kind": "enum", @@ -59987,7 +60263,7 @@ "name": "ValueType", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/metric.ts#L424-L435" + "specLocation": "_types/aggregations/metric.ts#L436-L447" }, { "inherits": { @@ -60014,7 +60290,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L177-L179" + "specLocation": "_types/aggregations/bucket.ts#L183-L185" }, { "inherits": { @@ -60087,7 +60363,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L181-L189" + "specLocation": "_types/aggregations/bucket.ts#L187-L195" }, { "description": "A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and\n`y` (year)", @@ -60172,9 +60448,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L191-L194" + "specLocation": "_types/aggregations/bucket.ts#L197-L200" }, { + "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -60187,9 +60465,11 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L192-L192" + "specLocation": "_types/aggregations/pipeline.ts#L206-L209" }, { + "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -60202,7 +60482,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L194-L194" + "specLocation": "_types/aggregations/pipeline.ts#L211-L214" }, { "inherits": { @@ -60424,7 +60704,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L196-L254" + "specLocation": "_types/aggregations/bucket.ts#L202-L260" }, { "kind": "enum", @@ -60482,7 +60762,7 @@ "name": "CalendarInterval", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L256-L273" + "specLocation": "_types/aggregations/bucket.ts#L262-L279" }, { "generics": [ @@ -60522,7 +60802,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L496-L505" + "specLocation": "_types/aggregations/bucket.ts#L508-L517" }, { "kind": "type_alias", @@ -60530,7 +60810,7 @@ "name": "AggregateOrder", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1019-L1021", + "specLocation": "_types/aggregations/bucket.ts#L1052-L1054", "type": { "items": [ { @@ -60665,7 +60945,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L275-L301" + "specLocation": "_types/aggregations/bucket.ts#L281-L307" }, { "kind": "interface", @@ -60711,7 +60991,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L312-L325" + "specLocation": "_types/aggregations/bucket.ts#L318-L331" }, { "codegenNames": [ @@ -60724,7 +61004,7 @@ "name": "FieldDateMath", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L303-L310", + "specLocation": "_types/aggregations/bucket.ts#L309-L316", "type": { "items": [ { @@ -60773,9 +61053,11 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L196-L196" + "specLocation": "_types/aggregations/pipeline.ts#L216-L216" }, { + "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-diversified-sampler-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -60851,7 +61133,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L327-L348" + "specLocation": "_types/aggregations/bucket.ts#L333-L357" }, { "kind": "enum", @@ -60873,7 +61155,7 @@ "name": "SamplerAggregationExecutionHint", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L350-L363" + "specLocation": "_types/aggregations/bucket.ts#L359-L372" }, { "inherits": { @@ -60929,9 +61211,11 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L198-L203" + "specLocation": "_types/aggregations/pipeline.ts#L218-L223" }, { + "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-frequent-item-sets-aggregation.html", "kind": "interface", "name": { "name": "FrequentItemSetsAggregation", @@ -61005,7 +61289,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1203-L1227" + "specLocation": "_types/aggregations/bucket.ts#L1240-L1267" }, { "kind": "interface", @@ -61050,7 +61334,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1189-L1201" + "specLocation": "_types/aggregations/bucket.ts#L1226-L1238" }, { "codegenNames": [ @@ -61062,7 +61346,7 @@ "name": "TermsExclude", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1044-L1045", + "specLocation": "_types/aggregations/bucket.ts#L1077-L1078", "type": { "items": [ { @@ -61097,7 +61381,7 @@ "name": "TermsInclude", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1041-L1042", + "specLocation": "_types/aggregations/bucket.ts#L1074-L1075", "type": { "items": [ { @@ -61160,7 +61444,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1047-L1056" + "specLocation": "_types/aggregations/bucket.ts#L1080-L1089" }, { "inherits": { @@ -61235,7 +61519,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L365-L385" + "specLocation": "_types/aggregations/bucket.ts#L374-L394" }, { "codegenNames": [ @@ -61254,7 +61538,7 @@ "name": "Buckets", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/Aggregate.ts#L317-L326", + "specLocation": "_types/aggregations/Aggregate.ts#L346-L355", "type": { "items": [ { @@ -61290,6 +61574,8 @@ } }, { + "extDocId": "search-aggregations-metrics-geobounds-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geobounds-aggregation.html", "inherits": { "type": { "name": "MetricAggregationBase", @@ -61316,7 +61602,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L108-L114" + "specLocation": "_types/aggregations/metric.ts#L108-L117" }, { "inherits": { @@ -61354,7 +61640,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L116-L119" + "specLocation": "_types/aggregations/metric.ts#L119-L122" }, { "inherits": { @@ -61435,7 +61721,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L387-L410" + "specLocation": "_types/aggregations/bucket.ts#L396-L419" }, { "kind": "interface", @@ -61505,9 +61791,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L679-L692" + "specLocation": "_types/aggregations/bucket.ts#L691-L704" }, { + "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geohashgrid-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -61583,7 +61871,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L412-L437" + "specLocation": "_types/aggregations/bucket.ts#L421-L449" }, { "codegenNames": [ @@ -61687,7 +61975,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L121-L146" + "specLocation": "_types/aggregations/metric.ts#L124-L149" }, { "kind": "interface", @@ -61709,7 +61997,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L155-L160" + "specLocation": "_types/aggregations/metric.ts#L158-L163" }, { "kind": "interface", @@ -61731,7 +62019,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L148-L153" + "specLocation": "_types/aggregations/metric.ts#L151-L156" }, { "inherits": { @@ -61809,7 +62097,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L439-L465" + "specLocation": "_types/aggregations/bucket.ts#L451-L477" }, { "kind": "type_alias", @@ -61902,7 +62190,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L467-L492" + "specLocation": "_types/aggregations/bucket.ts#L479-L504" }, { "inherits": { @@ -61917,7 +62205,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L494-L494" + "specLocation": "_types/aggregations/bucket.ts#L506-L506" }, { "inherits": { @@ -62082,7 +62370,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L507-L553" + "specLocation": "_types/aggregations/bucket.ts#L519-L565" }, { "inherits": { @@ -62125,7 +62413,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L555-L564" + "specLocation": "_types/aggregations/bucket.ts#L567-L576" }, { "kind": "interface", @@ -62195,7 +62483,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L566-L579" + "specLocation": "_types/aggregations/bucket.ts#L578-L591" }, { "inherits": { @@ -62286,7 +62574,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1158-L1187" + "specLocation": "_types/aggregations/bucket.ts#L1195-L1224" }, { "inherits": { @@ -62326,7 +62614,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L205-L214" + "specLocation": "_types/aggregations/pipeline.ts#L225-L234" }, { "kind": "interface", @@ -62360,7 +62648,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L216-L222", + "specLocation": "_types/aggregations/pipeline.ts#L236-L242", "variants": { "kind": "container" } @@ -62568,9 +62856,11 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/metric.ts#L162-L162" + "specLocation": "_types/aggregations/metric.ts#L165-L165" }, { + "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-max-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -62583,9 +62873,11 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L224-L224" + "specLocation": "_types/aggregations/pipeline.ts#L244-L247" }, { + "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-median-absolute-deviation-aggregation.html", "inherits": { "type": { "name": "FormatMetricAggregationBase", @@ -62612,7 +62904,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L164-L170" + "specLocation": "_types/aggregations/metric.ts#L167-L176" }, { "inherits": { @@ -62627,9 +62919,11 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/metric.ts#L172-L172" + "specLocation": "_types/aggregations/metric.ts#L178-L178" }, { + "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-min-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -62642,7 +62936,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L226-L226" + "specLocation": "_types/aggregations/pipeline.ts#L249-L252" }, { "inherits": { @@ -62681,7 +62975,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L581-L587" + "specLocation": "_types/aggregations/bucket.ts#L593-L599" }, { "kind": "type_alias", @@ -62689,7 +62983,7 @@ "name": "MovingAverageAggregation", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/pipeline.ts#L228-L234", + "specLocation": "_types/aggregations/pipeline.ts#L254-L260", "type": { "items": [ { @@ -62768,7 +63062,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L242-L245" + "specLocation": "_types/aggregations/pipeline.ts#L268-L271" }, { "inherits": { @@ -62817,7 +63111,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L236-L240" + "specLocation": "_types/aggregations/pipeline.ts#L262-L266" }, { "description": "For empty Class assignments", @@ -62862,7 +63156,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L247-L250" + "specLocation": "_types/aggregations/pipeline.ts#L273-L276" }, { "inherits": { @@ -62897,7 +63191,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L252-L255" + "specLocation": "_types/aggregations/pipeline.ts#L278-L281" }, { "kind": "interface", @@ -62918,7 +63212,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L267-L269" + "specLocation": "_types/aggregations/pipeline.ts#L293-L295" }, { "inherits": { @@ -62953,7 +63247,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L257-L260" + "specLocation": "_types/aggregations/pipeline.ts#L283-L286" }, { "kind": "interface", @@ -62985,7 +63279,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L271-L274" + "specLocation": "_types/aggregations/pipeline.ts#L297-L300" }, { "inherits": { @@ -63020,7 +63314,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L262-L265" + "specLocation": "_types/aggregations/pipeline.ts#L288-L291" }, { "kind": "interface", @@ -63096,7 +63390,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L275-L282" + "specLocation": "_types/aggregations/pipeline.ts#L301-L308" }, { "kind": "enum", @@ -63114,9 +63408,11 @@ "name": "HoltWintersType", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/pipeline.ts#L283-L286" + "specLocation": "_types/aggregations/pipeline.ts#L309-L312" }, { + "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-moving-percentiles-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63166,9 +63462,11 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L305-L317" + "specLocation": "_types/aggregations/pipeline.ts#L334-L349" }, { + "extDocId": "search-aggregations-pipeline-movfn-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-movfn-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63219,7 +63517,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L288-L303" + "specLocation": "_types/aggregations/pipeline.ts#L314-L332" }, { "inherits": { @@ -63339,7 +63637,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L589-L629" + "specLocation": "_types/aggregations/bucket.ts#L601-L641" }, { "kind": "enum", @@ -63357,7 +63655,7 @@ "name": "TermsAggregationCollectMode", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1023-L1032" + "specLocation": "_types/aggregations/bucket.ts#L1056-L1065" }, { "kind": "interface", @@ -63391,7 +63689,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L631-L641" + "specLocation": "_types/aggregations/bucket.ts#L643-L653" }, { "inherits": { @@ -63419,9 +63717,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L643-L648" + "specLocation": "_types/aggregations/bucket.ts#L655-L660" }, { + "extDocId": "search-aggregations-pipeline-normalize-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-normalize-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63447,7 +63747,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L319-L324" + "specLocation": "_types/aggregations/pipeline.ts#L351-L359" }, { "kind": "enum", @@ -63482,7 +63782,7 @@ "name": "NormalizeMethod", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/pipeline.ts#L326-L352" + "specLocation": "_types/aggregations/pipeline.ts#L361-L387" }, { "inherits": { @@ -63510,9 +63810,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L650-L655" + "specLocation": "_types/aggregations/bucket.ts#L662-L667" }, { + "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-percentile-rank-aggregation.html", "inherits": { "type": { "name": "FormatMetricAggregationBase", @@ -63590,7 +63892,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L174-L193" + "specLocation": "_types/aggregations/metric.ts#L180-L202" }, { "kind": "interface", @@ -63612,7 +63914,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L216-L221" + "specLocation": "_types/aggregations/metric.ts#L225-L230" }, { "kind": "interface", @@ -63634,7 +63936,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L223-L228" + "specLocation": "_types/aggregations/metric.ts#L232-L237" }, { "inherits": { @@ -63702,9 +64004,11 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L195-L214" + "specLocation": "_types/aggregations/metric.ts#L204-L223" }, { + "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-percentiles-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63733,7 +64037,7 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L354-L359" + "specLocation": "_types/aggregations/pipeline.ts#L389-L397" }, { "inherits": { @@ -63822,9 +64126,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L657-L677" + "specLocation": "_types/aggregations/bucket.ts#L669-L689" }, { + "extDocId": "search-aggregations-bucket-rare-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-rare-terms-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -63923,7 +64229,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L694-L724" + "specLocation": "_types/aggregations/bucket.ts#L706-L739" }, { "inherits": { @@ -63964,7 +64270,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L230-L241" + "specLocation": "_types/aggregations/metric.ts#L239-L250" }, { "kind": "enum", @@ -63982,7 +64288,7 @@ "name": "RateMode", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/metric.ts#L243-L252" + "specLocation": "_types/aggregations/metric.ts#L252-L261" }, { "inherits": { @@ -64010,9 +64316,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L726-L732" + "specLocation": "_types/aggregations/bucket.ts#L741-L747" }, { + "extDocId": "search-aggregations-random-sampler-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-random-sampler-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -64050,9 +64358,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L734-L751" + "specLocation": "_types/aggregations/bucket.ts#L749-L769" }, { + "extDocId": "search-aggregations-bucket-sampler-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-sampler-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -64079,7 +64389,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L753-L759" + "specLocation": "_types/aggregations/bucket.ts#L771-L780" }, { "inherits": { @@ -64162,9 +64472,11 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L254-L280" + "specLocation": "_types/aggregations/metric.ts#L263-L289" }, { + "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-serialdiff-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -64190,9 +64502,11 @@ } } ], - "specLocation": "_types/aggregations/pipeline.ts#L361-L367" + "specLocation": "_types/aggregations/pipeline.ts#L399-L408" }, { + "extDocId": "search-aggregations-bucket-significanttext-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -64387,7 +64701,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L796-L860" + "specLocation": "_types/aggregations/bucket.ts#L817-L884" }, { "kind": "interface", @@ -64421,7 +64735,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L761-L770" + "specLocation": "_types/aggregations/bucket.ts#L782-L791" }, { "kind": "enum", @@ -64443,7 +64757,7 @@ "name": "TermsAggregationExecutionHint", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1034-L1039" + "specLocation": "_types/aggregations/bucket.ts#L1067-L1072" }, { "kind": "interface", @@ -64465,7 +64779,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L772-L777" + "specLocation": "_types/aggregations/bucket.ts#L793-L798" }, { "kind": "interface", @@ -64499,7 +64813,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L779-L788" + "specLocation": "_types/aggregations/bucket.ts#L800-L809" }, { "kind": "interface", @@ -64508,7 +64822,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/bucket.ts#L790-L790" + "specLocation": "_types/aggregations/bucket.ts#L811-L811" }, { "kind": "interface", @@ -64529,9 +64843,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L792-L794" + "specLocation": "_types/aggregations/bucket.ts#L813-L815" }, { + "extDocId": "search-aggregations-bucket-significanttext-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -64750,7 +65066,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L862-L934" + "specLocation": "_types/aggregations/bucket.ts#L886-L961" }, { "inherits": { @@ -64765,7 +65081,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/metric.ts#L282-L282" + "specLocation": "_types/aggregations/metric.ts#L291-L291" }, { "inherits": { @@ -64780,7 +65096,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L369-L369" + "specLocation": "_types/aggregations/pipeline.ts#L410-L410" }, { "inherits": { @@ -64809,7 +65125,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L284-L290" + "specLocation": "_types/aggregations/metric.ts#L293-L299" }, { "inherits": { @@ -64824,9 +65140,11 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/metric.ts#L292-L292" + "specLocation": "_types/aggregations/metric.ts#L301-L301" }, { + "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-sum-bucket-aggregation.html", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -64839,9 +65157,11 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/pipeline.ts#L371-L371" + "specLocation": "_types/aggregations/pipeline.ts#L412-L415" }, { + "extDocId": "search-aggregations-bucket-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-terms-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -65057,9 +65377,11 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L936-L1001" + "specLocation": "_types/aggregations/bucket.ts#L963-L1031" }, { + "extDocId": "search-aggregations-bucket-time-series-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-time-series-aggregation.html", "inherits": { "type": { "name": "BucketAggregationBase", @@ -65098,7 +65420,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1003-L1013" + "specLocation": "_types/aggregations/bucket.ts#L1033-L1046" }, { "inherits": { @@ -65292,7 +65614,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L337-L397" + "specLocation": "_types/aggregations/metric.ts#L346-L406" }, { "inherits": { @@ -65345,7 +65667,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L294-L308" + "specLocation": "_types/aggregations/metric.ts#L303-L317" }, { "kind": "interface", @@ -65390,7 +65712,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L310-L320" + "specLocation": "_types/aggregations/metric.ts#L319-L329" }, { "kind": "enum", @@ -65412,9 +65734,11 @@ "name": "TTestType", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/metric.ts#L322-L335" + "specLocation": "_types/aggregations/metric.ts#L331-L344" }, { + "extDocId": "search-aggregations-metrics-top-metrics", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-metrics.html", "inherits": { "type": { "name": "MetricAggregationBase", @@ -65480,7 +65804,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L399-L413" + "specLocation": "_types/aggregations/metric.ts#L408-L425" }, { "kind": "interface", @@ -65502,7 +65826,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L415-L420" + "specLocation": "_types/aggregations/metric.ts#L427-L432" }, { "inherits": { @@ -65517,7 +65841,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/metric.ts#L422-L422" + "specLocation": "_types/aggregations/metric.ts#L434-L434" }, { "inherits": { @@ -65607,7 +65931,7 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L437-L451" + "specLocation": "_types/aggregations/metric.ts#L449-L463" }, { "kind": "interface", @@ -65652,9 +65976,11 @@ } } ], - "specLocation": "_types/aggregations/metric.ts#L453-L463" + "specLocation": "_types/aggregations/metric.ts#L465-L475" }, { + "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-variablewidthhistogram-aggregation.html", "kind": "interface", "name": { "name": "VariableWidthHistogramAggregation", @@ -65722,7 +66048,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1058-L1079" + "specLocation": "_types/aggregations/bucket.ts#L1091-L1115" }, { "kind": "interface", @@ -67711,7 +68037,7 @@ "name": "ResponseItem", "namespace": "_global.msearch" }, - "specLocation": "_global/msearch/types.ts#L208-L211", + "specLocation": "_global/msearch/types.ts#L211-L214", "type": { "items": [ { @@ -67781,7 +68107,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L213-L216" + "specLocation": "_global/msearch/types.ts#L216-L219" }, { "generics": [ @@ -68791,12 +69117,14 @@ } }, { + "extDocId": "search-aggregations", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations.html", "kind": "type_alias", "name": { "name": "Aggregate", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/Aggregate.ts#L38-L124", + "specLocation": "_types/aggregations/Aggregate.ts#L38-L125", "type": { "items": [ { @@ -69322,7 +69650,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L139-L142", + "specLocation": "_types/aggregations/Aggregate.ts#L140-L143", "variantName": "cardinality" }, { @@ -69344,7 +69672,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L135-L137" + "specLocation": "_types/aggregations/Aggregate.ts#L136-L138" }, { "inherits": { @@ -69359,7 +69687,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L167-L168", + "specLocation": "_types/aggregations/Aggregate.ts#L168-L169", "variantName": "hdr_percentiles" }, { @@ -69387,7 +69715,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L147-L149" + "specLocation": "_types/aggregations/Aggregate.ts#L148-L150" }, { "codegenNames": [ @@ -69399,7 +69727,7 @@ "name": "Percentiles", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/Aggregate.ts#L151-L152", + "specLocation": "_types/aggregations/Aggregate.ts#L152-L153", "type": { "items": [ { @@ -69429,7 +69757,7 @@ "name": "KeyedPercentiles", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/Aggregate.ts#L159-L159", + "specLocation": "_types/aggregations/Aggregate.ts#L160-L160", "type": { "key": { "kind": "instance_of", @@ -69521,7 +69849,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L161-L165" + "specLocation": "_types/aggregations/Aggregate.ts#L162-L166" }, { "inherits": { @@ -69536,7 +69864,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L170-L171", + "specLocation": "_types/aggregations/Aggregate.ts#L171-L172", "variantName": "hdr_percentile_ranks" }, { @@ -69552,7 +69880,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L173-L174", + "specLocation": "_types/aggregations/Aggregate.ts#L174-L175", "variantName": "tdigest_percentiles" }, { @@ -69568,7 +69896,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L176-L177", + "specLocation": "_types/aggregations/Aggregate.ts#L177-L178", "variantName": "tdigest_percentile_ranks" }, { @@ -69584,7 +69912,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L179-L180", + "specLocation": "_types/aggregations/Aggregate.ts#L180-L181", "variantName": "percentiles_bucket" }, { @@ -69600,7 +69928,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L195-L196", + "specLocation": "_types/aggregations/Aggregate.ts#L196-L197", "variantName": "median_absolute_deviation" }, { @@ -69652,9 +69980,11 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L184-L193" + "specLocation": "_types/aggregations/Aggregate.ts#L185-L194" }, { + "extDocId": "search-aggregations-metrics-min-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-min-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -69667,10 +69997,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L198-L199", + "specLocation": "_types/aggregations/Aggregate.ts#L199-L203", "variantName": "min" }, { + "extDocId": "search-aggregations-metrics-max-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-max-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -69683,11 +70015,13 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L201-L202", + "specLocation": "_types/aggregations/Aggregate.ts#L205-L209", "variantName": "max" }, { "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/{branch}/search-aggregations-metrics-sum-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -69700,10 +70034,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L204-L208", + "specLocation": "_types/aggregations/Aggregate.ts#L211-L216", "variantName": "sum" }, { + "extDocId": "search-aggregations-metrics-avg-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-avg-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -69716,11 +70052,13 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L210-L211", + "specLocation": "_types/aggregations/Aggregate.ts#L218-L222", "variantName": "avg" }, { "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/{branch}/search-aggregations-metrics-weight-avg-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -69733,11 +70071,13 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L213-L217", + "specLocation": "_types/aggregations/Aggregate.ts#L224-L229", "variantName": "weighted_avg" }, { "description": "Value count aggregation result. `value` is always present.", + "extDocId": "search-aggregations-metrics-valuecount-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-valuecount-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -69750,7 +70090,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L219-L223", + "specLocation": "_types/aggregations/Aggregate.ts#L231-L236", "variantName": "value_count" }, { @@ -69766,10 +70106,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L225-L226", + "specLocation": "_types/aggregations/Aggregate.ts#L238-L239", "variantName": "simple_value" }, { + "extDocId": "search-aggregations-pipeline-derivative-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -69805,7 +70147,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L228-L232", + "specLocation": "_types/aggregations/Aggregate.ts#L241-L248", "variantName": "derivative" }, { @@ -69836,11 +70178,13 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L234-L237", + "specLocation": "_types/aggregations/Aggregate.ts#L250-L253", "variantName": "bucket_metric_value" }, { "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/{branch}/search-aggregations-metrics-stats-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -69989,10 +70333,12 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L241-L256", + "specLocation": "_types/aggregations/Aggregate.ts#L257-L273", "variantName": "stats" }, { + "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-stats-bucket-aggregation.html", "inherits": { "type": { "name": "StatsAggregate", @@ -70005,10 +70351,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L258-L259", + "specLocation": "_types/aggregations/Aggregate.ts#L275-L279", "variantName": "stats_bucket" }, { + "extDocId": "search-aggregations-metrics-extendedstats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-extendedstats-aggregation.html", "inherits": { "type": { "name": "StatsAggregate", @@ -70260,7 +70608,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L279-L297", + "specLocation": "_types/aggregations/Aggregate.ts#L299-L320", "variantName": "extended_stats" }, { @@ -70409,7 +70757,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L261-L268" + "specLocation": "_types/aggregations/Aggregate.ts#L281-L288" }, { "kind": "interface", @@ -70485,7 +70833,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L270-L277" + "specLocation": "_types/aggregations/Aggregate.ts#L290-L297" }, { "inherits": { @@ -70500,10 +70848,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L299-L300", + "specLocation": "_types/aggregations/Aggregate.ts#L322-L323", "variantName": "extended_stats_bucket" }, { + "extDocId": "search-aggregations-metrics-geobounds-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geobounds-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -70528,10 +70878,12 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L304-L307", + "specLocation": "_types/aggregations/Aggregate.ts#L327-L333", "variantName": "geo_bounds" }, { + "extDocId": "search-aggregations-metrics-geocentroid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geocentroid-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -70567,10 +70919,12 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L309-L313", + "specLocation": "_types/aggregations/Aggregate.ts#L335-L342", "variantName": "geo_centroid" }, { + "extDocId": "search-aggregations-bucket-histogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-histogram-aggregation.html", "inherits": { "generics": [ { @@ -70592,7 +70946,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L343-L344", + "specLocation": "_types/aggregations/Aggregate.ts#L372-L376", "variantName": "histogram" }, { @@ -70635,9 +70989,11 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L328-L330" + "specLocation": "_types/aggregations/Aggregate.ts#L357-L359" }, { + "extDocId": "search-aggregations-bucket-datehistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-datehistogram-aggregation.html", "inherits": { "generics": [ { @@ -70659,10 +71015,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L351-L352", + "specLocation": "_types/aggregations/Aggregate.ts#L383-L386", "variantName": "date_histogram" }, { + "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html", "inherits": { "generics": [ { @@ -70696,7 +71054,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L359-L363", + "specLocation": "_types/aggregations/Aggregate.ts#L393-L400", "variantName": "auto_date_histogram" }, { @@ -70721,7 +71079,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L365-L367", + "specLocation": "_types/aggregations/Aggregate.ts#L402-L404", "variantName": "variable_width_histogram" }, { @@ -70747,7 +71105,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L387-L392", + "specLocation": "_types/aggregations/Aggregate.ts#L424-L429", "variantName": "sterms" }, { @@ -70801,7 +71159,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L380-L385" + "specLocation": "_types/aggregations/Aggregate.ts#L417-L422" }, { "description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", @@ -70826,7 +71184,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L402-L407", + "specLocation": "_types/aggregations/Aggregate.ts#L439-L444", "variantName": "lterms" }, { @@ -70852,7 +71210,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L414-L419", + "specLocation": "_types/aggregations/Aggregate.ts#L451-L456", "variantName": "dterms" }, { @@ -70878,7 +71236,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L426-L432", + "specLocation": "_types/aggregations/Aggregate.ts#L463-L469", "variantName": "umterms" }, { @@ -70904,7 +71262,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L434-L439", + "specLocation": "_types/aggregations/Aggregate.ts#L471-L476", "variantName": "lrareterms" }, { @@ -70930,7 +71288,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L446-L450", + "specLocation": "_types/aggregations/Aggregate.ts#L483-L487", "variantName": "srareterms" }, { @@ -70956,10 +71314,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L456-L462", + "specLocation": "_types/aggregations/Aggregate.ts#L493-L499", "variantName": "umrareterms" }, { + "extDocId": "search-aggregations-bucket-multi-terms-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-multi-terms-aggregation.html", "inherits": { "generics": [ { @@ -70981,13 +71341,15 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L464-L466", + "specLocation": "_types/aggregations/Aggregate.ts#L501-L506", "variantName": "multi_terms" }, { "attachedBehaviors": [ "AdditionalProperties" ], + "extDocId": "search-aggregations-bucket-missing-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-missing-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -71000,7 +71362,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L488-L489", + "specLocation": "_types/aggregations/Aggregate.ts#L528-L532", "variantName": "missing" }, { @@ -71060,12 +71422,14 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L476-L486" + "specLocation": "_types/aggregations/Aggregate.ts#L516-L526" }, { "attachedBehaviors": [ "AdditionalProperties" ], + "extDocId": "search-aggregations-bucket-nested-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-nested-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -71078,13 +71442,15 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L491-L492", + "specLocation": "_types/aggregations/Aggregate.ts#L534-L538", "variantName": "nested" }, { "attachedBehaviors": [ "AdditionalProperties" ], + "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-reverse-nested-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -71097,13 +71463,15 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L494-L495", + "specLocation": "_types/aggregations/Aggregate.ts#L540-L544", "variantName": "reverse_nested" }, { "attachedBehaviors": [ "AdditionalProperties" ], + "extDocId": "search-aggregations-bucket-global-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-global-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -71116,13 +71484,15 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L497-L498", + "specLocation": "_types/aggregations/Aggregate.ts#L546-L550", "variantName": "global" }, { "attachedBehaviors": [ "AdditionalProperties" ], + "extDocId": "search-aggregations-bucket-filter-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filter-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -71135,13 +71505,15 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L500-L501", + "specLocation": "_types/aggregations/Aggregate.ts#L552-L556", "variantName": "filter" }, { "attachedBehaviors": [ "AdditionalProperties" ], + "extDocId": "search-aggregations-bucket-children-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-children-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -71154,13 +71526,15 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L791-L792", + "specLocation": "_types/aggregations/Aggregate.ts#L888-L892", "variantName": "children" }, { "attachedBehaviors": [ "AdditionalProperties" ], + "extDocId": "search-aggregations-bucket-parent-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-parent-aggregation.html", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -71173,7 +71547,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L794-L795", + "specLocation": "_types/aggregations/Aggregate.ts#L894-L898", "variantName": "parent" }, { @@ -71192,7 +71566,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L503-L504", + "specLocation": "_types/aggregations/Aggregate.ts#L558-L559", "variantName": "sampler" }, { @@ -71211,7 +71585,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L506-L507", + "specLocation": "_types/aggregations/Aggregate.ts#L561-L562", "variantName": "unmapped_sampler" }, { @@ -71236,10 +71610,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L511-L513", + "specLocation": "_types/aggregations/Aggregate.ts#L566-L568", "variantName": "geohash_grid" }, { + "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-geotilegrid-aggregation.html", "inherits": { "generics": [ { @@ -71261,7 +71637,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L519-L521", + "specLocation": "_types/aggregations/Aggregate.ts#L574-L579", "variantName": "geotile_grid" }, { @@ -71286,10 +71662,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L527-L528", + "specLocation": "_types/aggregations/Aggregate.ts#L585-L586", "variantName": "geohex_grid" }, { + "extDocId": "search-aggregations-bucket-range-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-range-aggregation.html", "inherits": { "generics": [ { @@ -71311,11 +71689,13 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L536-L537", + "specLocation": "_types/aggregations/Aggregate.ts#L594-L598", "variantName": "range" }, { "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/{branch}/search-aggregations-bucket-daterange-aggregation.html", "inherits": { "type": { "name": "RangeAggregate", @@ -71328,11 +71708,13 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L548-L553", + "specLocation": "_types/aggregations/Aggregate.ts#L609-L615", "variantName": "date_range" }, { "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/{branch}/search-aggregations-bucket-geodistance-aggregation.html", "inherits": { "type": { "name": "RangeAggregate", @@ -71345,10 +71727,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L555-L559", + "specLocation": "_types/aggregations/Aggregate.ts#L617-L622", "variantName": "geo_distance" }, { + "extDocId": "search-aggregations-bucket-iprange-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-iprange-aggregation.html", "inherits": { "generics": [ { @@ -71370,10 +71754,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L561-L563", + "specLocation": "_types/aggregations/Aggregate.ts#L624-L629", "variantName": "ip_range" }, { + "extDocId": "search-aggregations-bucket-ipprefix-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-ipprefix-aggregation.html", "inherits": { "generics": [ { @@ -71395,10 +71781,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L634-L635", + "specLocation": "_types/aggregations/Aggregate.ts#L709-L713", "variantName": "ip_prefix" }, { + "extDocId": "search-aggregations-bucket-filters-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-filters-aggregation.html", "inherits": { "generics": [ { @@ -71420,10 +71808,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L573-L574", + "specLocation": "_types/aggregations/Aggregate.ts#L639-L643", "variantName": "filters" }, { + "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html", "inherits": { "generics": [ { @@ -71445,7 +71835,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L578-L580", + "specLocation": "_types/aggregations/Aggregate.ts#L647-L652", "variantName": "adjacency_matrix" }, { @@ -71470,10 +71860,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L593-L595", + "specLocation": "_types/aggregations/Aggregate.ts#L668-L670", "variantName": "siglterms" }, { + "extDocId": "search-aggregations-bucket-significanttext-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-significanttext-aggregation.html", "generics": [ { "name": "T", @@ -71524,7 +71916,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L586-L591" + "specLocation": "_types/aggregations/Aggregate.ts#L658-L666" }, { "inherits": { @@ -71548,7 +71940,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L607-L609", + "specLocation": "_types/aggregations/Aggregate.ts#L682-L684", "variantName": "sigsterms" }, { @@ -71574,7 +71966,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L615-L621", + "specLocation": "_types/aggregations/Aggregate.ts#L690-L696", "variantName": "umsigterms" }, { @@ -71611,7 +72003,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L623-L628", + "specLocation": "_types/aggregations/Aggregate.ts#L698-L703", "variantName": "composite" }, { @@ -71636,7 +72028,7 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L644-L645", + "specLocation": "_types/aggregations/Aggregate.ts#L722-L723", "variantName": "frequent_item_sets" }, { @@ -71661,10 +72053,12 @@ "namespace": "_types.aggregations" }, "properties": [], - "specLocation": "_types/aggregations/Aggregate.ts#L652-L653", + "specLocation": "_types/aggregations/Aggregate.ts#L730-L731", "variantName": "time_series" }, { + "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-scripted-metric-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -71685,10 +72079,12 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L661-L664", + "specLocation": "_types/aggregations/Aggregate.ts#L739-L745", "variantName": "scripted_metric" }, { + "extDocId": "search-aggregations-metrics-top-hits-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-top-hits-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -71718,7 +72114,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L666-L669", + "specLocation": "_types/aggregations/Aggregate.ts#L747-L753", "variantName": "top_hits" }, { @@ -71749,6 +72145,8 @@ } } ], + "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-inference-bucket-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -71812,7 +72210,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L671-L685", + "specLocation": "_types/aggregations/Aggregate.ts#L755-L770", "variantName": "inference" }, { @@ -71859,7 +72257,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L693-L697" + "specLocation": "_types/aggregations/Aggregate.ts#L778-L782" }, { "kind": "interface", @@ -71891,7 +72289,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L699-L702" + "specLocation": "_types/aggregations/Aggregate.ts#L784-L787" }, { "kind": "interface", @@ -71934,7 +72332,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L687-L691" + "specLocation": "_types/aggregations/Aggregate.ts#L772-L776" }, { "inherits": { @@ -72120,10 +72518,12 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L708-L719", + "specLocation": "_types/aggregations/Aggregate.ts#L793-L804", "variantName": "string_stats" }, { + "extDocId": "search-aggregations-metrics-boxplot-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-boxplot-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -72291,7 +72691,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L721-L737", + "specLocation": "_types/aggregations/Aggregate.ts#L806-L825", "variantName": "boxplot" }, { @@ -72322,7 +72722,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L739-L742", + "specLocation": "_types/aggregations/Aggregate.ts#L827-L830", "variantName": "top_metrics" }, { @@ -72393,9 +72793,11 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L744-L748" + "specLocation": "_types/aggregations/Aggregate.ts#L832-L836" }, { + "extDocId": "search-aggregations-metrics-ttest-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-ttest-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -72443,10 +72845,12 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L750-L754", + "specLocation": "_types/aggregations/Aggregate.ts#L838-L845", "variantName": "t_test" }, { + "extDocId": "search-aggregations-metrics-rate-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-rate-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -72482,7 +72886,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L756-L760", + "specLocation": "_types/aggregations/Aggregate.ts#L847-L854", "variantName": "rate" }, { @@ -72522,10 +72926,12 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L762-L770", + "specLocation": "_types/aggregations/Aggregate.ts#L856-L864", "variantName": "simple_long_value" }, { + "extDocId": "search-aggregations-matrix-stats-aggregation", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-matrix-stats-aggregation.html", "inherits": { "type": { "name": "AggregateBase", @@ -72564,7 +72970,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L772-L776", + "specLocation": "_types/aggregations/Aggregate.ts#L866-L873", "variantName": "matrix_stats" }, { @@ -72685,9 +73091,11 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L778-L787" + "specLocation": "_types/aggregations/Aggregate.ts#L875-L884" }, { + "extDocId": "search-aggregations-metrics-geo-line", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-metrics-geo-line.html", "inherits": { "type": { "name": "AggregateBase", @@ -72730,7 +73138,7 @@ } } ], - "specLocation": "_types/aggregations/Aggregate.ts#L799-L806", + "specLocation": "_types/aggregations/Aggregate.ts#L902-L912", "variantName": "geo_line" }, { @@ -80719,12 +81127,14 @@ "name", "definition" ], + "extDocId": "analysis-charfilters", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html", "kind": "type_alias", "name": { "name": "CharFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/char_filters.ts#L28-L30", + "specLocation": "_types/analysis/char_filters.ts#L28-L33", "type": { "items": [ { @@ -80751,7 +81161,7 @@ "name": "CharFilterDefinition", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/char_filters.ts#L32-L41", + "specLocation": "_types/analysis/char_filters.ts#L35-L44", "type": { "items": [ { @@ -80834,7 +81244,7 @@ } } ], - "specLocation": "_types/analysis/char_filters.ts#L43-L46" + "specLocation": "_types/analysis/char_filters.ts#L46-L49" }, { "kind": "interface", @@ -80904,7 +81314,7 @@ } } ], - "specLocation": "_types/analysis/char_filters.ts#L48-L52" + "specLocation": "_types/analysis/char_filters.ts#L51-L55" }, { "inherits": { @@ -80961,7 +81371,7 @@ } } ], - "specLocation": "_types/analysis/char_filters.ts#L54-L59" + "specLocation": "_types/analysis/char_filters.ts#L57-L62" }, { "inherits": { @@ -81469,12 +81879,14 @@ "name", "definition" ], + "extDocId": "analysis-tokenfilters", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenfilters.html", "kind": "type_alias", "name": { "name": "TokenFilter", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/token_filters.ts#L345-L347", + "specLocation": "_types/analysis/token_filters.ts#L345-L350", "type": { "items": [ { @@ -81501,7 +81913,7 @@ "name": "TokenFilterDefinition", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/token_filters.ts#L349-L401", + "specLocation": "_types/analysis/token_filters.ts#L352-L404", "type": { "items": [ { @@ -84752,12 +85164,14 @@ "name", "definition" ], + "extDocId": "analysis-tokenizers", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-tokenizers.html", "kind": "type_alias", "name": { "name": "Tokenizer", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/tokenizers.ts#L140-L142", + "specLocation": "_types/analysis/tokenizers.ts#L140-L145", "type": { "items": [ { @@ -84784,7 +85198,7 @@ "name": "TokenizerDefinition", "namespace": "_types.analysis" }, - "specLocation": "_types/analysis/tokenizers.ts#L144-L167", + "specLocation": "_types/analysis/tokenizers.ts#L147-L170", "type": { "items": [ { @@ -90253,7 +90667,7 @@ "name": "SimpleQueryStringFlag", "namespace": "_types.query_dsl" }, - "specLocation": "_types/query_dsl/fulltext.ts#L708-L763" + "specLocation": "_types/query_dsl/fulltext.ts#L729-L784" }, { "kind": "enum", @@ -94195,17 +94609,20 @@ { "name": "long" }, + { + "name": "double" + }, { "name": "float" }, { - "name": "double" + "name": "boolean" }, { - "name": "string" + "name": "ip" }, { - "name": "boolean" + "name": "string" }, { "name": "auto" @@ -94215,7 +94632,37 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L531-L539" + "specLocation": "ingest/_types/Processors.ts#L621-L630" + }, + { + "kind": "enum", + "members": [ + { + "codegenName": "md5", + "name": "MD5" + }, + { + "codegenName": "sha1", + "name": "SHA-1" + }, + { + "codegenName": "sha256", + "name": "SHA-256" + }, + { + "codegenName": "sha512", + "name": "SHA-512" + }, + { + "codegenName": "murmurHash3", + "name": "MurmurHash3" + } + ], + "name": { + "name": "FingerprintDigest", + "namespace": "ingest._types" + }, + "specLocation": "ingest/_types/Processors.ts#L856-L862" }, { "kind": "enum", @@ -94231,7 +94678,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L406-L409" + "specLocation": "ingest/_types/Processors.ts#L433-L436" }, { "kind": "enum", @@ -94250,7 +94697,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L400-L404" + "specLocation": "ingest/_types/Processors.ts#L427-L431" }, { "kind": "enum", @@ -94268,7 +94715,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L970-L975" + "specLocation": "ingest/_types/Processors.ts#L1111-L1116" }, { "kind": "enum", @@ -94284,7 +94731,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1238-L1241" + "specLocation": "ingest/_types/Processors.ts#L1433-L1436" }, { "kind": "enum", @@ -94309,7 +94756,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L480-L486" + "specLocation": "ingest/_types/Processors.ts#L507-L513" }, { "kind": "enum", @@ -94508,6 +94955,8 @@ }, { "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/{branch}/analysis-tokenizers.html", "name": "tokenizer", "required": false, "type": { @@ -94519,7 +94968,7 @@ } } ], - "specLocation": "ml/_types/Analysis.ts#L184-L197" + "specLocation": "ml/_types/Analysis.ts#L184-L198" }, { "kind": "enum", @@ -94554,7 +95003,7 @@ "name": "ChunkingMode", "namespace": "ml._types" }, - "specLocation": "ml/_types/Datafeed.ts#L232-L236" + "specLocation": "ml/_types/Datafeed.ts#L235-L239" }, { "kind": "enum", @@ -94610,7 +95059,7 @@ "name": "DatafeedState", "namespace": "ml._types" }, - "specLocation": "ml/_types/Datafeed.ts#L132-L137" + "specLocation": "ml/_types/Datafeed.ts#L135-L140" }, { "kind": "enum", @@ -102719,8 +103168,8 @@ "properties": [ { "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.", - "docId": "templating-role-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query", + "extDocId": "templating-role-query", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query", "name": "template", "required": false, "type": { @@ -120893,6 +121342,20 @@ } } }, + { + "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/{branch}/community-id-processor.html", + "name": "community_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CommunityIDProcessor", + "namespace": "ingest._types" + } + } + }, { "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", @@ -121019,6 +121482,20 @@ } } }, + { + "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/{branch}/fingerprint-processor.html", + "name": "fingerprint", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FingerprintProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Runs an ingest processor on each element of an array or object.", "docId": "foreach-processor", @@ -121172,6 +121649,20 @@ } } }, + { + "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/{branch}/network-direction-processor.html", + "name": "network_direction", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NetworkDirectionProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Executes another pipeline.", "docId": "pipeline-processor", @@ -121200,6 +121691,20 @@ } } }, + { + "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/{branch}/registered-domain-processor.html", + "name": "registered_domain", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RegisteredDomainProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", "docId": "remove-processor", @@ -121396,7 +121901,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L270", + "specLocation": "ingest/_types/Processors.ts#L27-L297", "variants": { "kind": "container", "nonExhaustive": true @@ -121460,7 +121965,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L297-L312" + "specLocation": "ingest/_types/Processors.ts#L324-L339" }, { "kind": "interface", @@ -121533,7 +122038,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L272-L295" + "specLocation": "ingest/_types/Processors.ts#L299-L322" }, { "inherits": { @@ -121653,7 +122158,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L314-L355" + "specLocation": "ingest/_types/Processors.ts#L341-L382" }, { "inherits": { @@ -121707,7 +122212,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L488-L504" + "specLocation": "ingest/_types/Processors.ts#L515-L531" }, { "inherits": { @@ -121784,7 +122289,166 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L506-L529" + "specLocation": "ingest/_types/Processors.ts#L533-L556" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "CommunityIDProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "Field containing the source IP address.", + "name": "source_ip", + "required": false, + "serverDefault": "source.ip", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the source port.", + "name": "source_port", + "required": false, + "serverDefault": "source.port", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the destination IP address.", + "name": "destination_ip", + "required": false, + "serverDefault": "destination.ip", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the destination port.", + "name": "destination_port", + "required": false, + "serverDefault": "destination.port", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the IANA number.", + "name": "iana_number", + "required": false, + "serverDefault": "network.iana_number", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the ICMP type.", + "name": "icmp_type", + "required": false, + "serverDefault": "icmp.type", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the ICMP code.", + "name": "icmp_code", + "required": false, + "serverDefault": "icmp.code", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the transport protocol name or number. Used only when the\niana_number field is not present. The following protocol names are currently\nsupported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp", + "name": "transport", + "required": false, + "serverDefault": "network.transport", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Output field for the community ID.", + "name": "target_field", + "required": false, + "serverDefault": "network.community_id", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme.", + "name": "seed", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L558-L619" }, { "inherits": { @@ -121850,7 +122514,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L541-L561" + "specLocation": "ingest/_types/Processors.ts#L632-L652" }, { "inherits": { @@ -121948,7 +122612,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L563-L596" + "specLocation": "ingest/_types/Processors.ts#L654-L687" }, { "inherits": { @@ -122028,9 +122692,22 @@ "namespace": "_builtins" } } + }, + { + "description": "The format to use when writing the date to target_field. Must be a valid\njava time pattern.", + "name": "output_format", + "required": false, + "serverDefault": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "ingest/_types/Processors.ts#L638-L665" + "specLocation": "ingest/_types/Processors.ts#L729-L762" }, { "inherits": { @@ -122136,7 +122813,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L598-L636" + "specLocation": "ingest/_types/Processors.ts#L689-L727" }, { "inherits": { @@ -122202,7 +122879,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L667-L686" + "specLocation": "ingest/_types/Processors.ts#L764-L783" }, { "inherits": { @@ -122255,7 +122932,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L688-L706" + "specLocation": "ingest/_types/Processors.ts#L785-L803" }, { "inherits": { @@ -122270,7 +122947,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L708-L708" + "specLocation": "ingest/_types/Processors.ts#L805-L805" }, { "inherits": { @@ -122374,7 +123051,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L710-L749" + "specLocation": "ingest/_types/Processors.ts#L807-L846" }, { "inherits": { @@ -122402,7 +123079,86 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L751-L757" + "specLocation": "ingest/_types/Processors.ts#L848-L854" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "FingerprintProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "Array of fields to include in the fingerprint. For objects, the processor\nhashes both the field key and value. For other fields, the processor hashes\nonly the field value.", + "name": "fields", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Output field for the fingerprint.", + "name": "target_field", + "required": false, + "serverDefault": "fingerprint", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Salt value for the hash function.", + "name": "salt", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,\nSHA-256, SHA-512, or MurmurHash3.", + "name": "method", + "required": false, + "serverDefault": "SHA-1", + "type": { + "kind": "instance_of", + "type": { + "name": "FingerprintDigest", + "namespace": "ingest._types" + } + } + }, + { + "description": "If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L864-L892" }, { "inherits": { @@ -122455,7 +123211,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L759-L773" + "specLocation": "ingest/_types/Processors.ts#L894-L908" }, { "inherits": { @@ -122582,7 +123338,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L357-L398" + "specLocation": "ingest/_types/Processors.ts#L384-L425" }, { "inherits": { @@ -122689,7 +123445,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L411-L445" + "specLocation": "ingest/_types/Processors.ts#L438-L472" }, { "inherits": { @@ -122704,6 +123460,19 @@ "namespace": "ingest._types" }, "properties": [ + { + "description": "Must be disabled or v1. If v1, the processor uses patterns with Elastic\nCommon Schema (ECS) field names.", + "name": "ecs_compatibility", + "required": false, + "serverDefault": "disabled", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "description": "The field to use for grok expression parsing.", "name": "field", @@ -122781,7 +123550,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L775-L800" + "specLocation": "ingest/_types/Processors.ts#L910-L941" }, { "inherits": { @@ -122859,7 +123628,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L802-L826" + "specLocation": "ingest/_types/Processors.ts#L943-L967" }, { "inherits": { @@ -122913,7 +123682,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L828-L844" + "specLocation": "ingest/_types/Processors.ts#L969-L985" }, { "inherits": { @@ -122985,7 +123754,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L846-L865" + "specLocation": "ingest/_types/Processors.ts#L987-L1006" }, { "kind": "interface", @@ -123019,7 +123788,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L867-L879", + "specLocation": "ingest/_types/Processors.ts#L1008-L1020", "variants": { "kind": "container" } @@ -123058,7 +123827,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L881-L892" + "specLocation": "ingest/_types/Processors.ts#L1022-L1033" }, { "kind": "interface", @@ -123132,7 +123901,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L894-L920" + "specLocation": "ingest/_types/Processors.ts#L1035-L1061" }, { "inherits": { @@ -123185,7 +123954,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L922-L937" + "specLocation": "ingest/_types/Processors.ts#L1063-L1078" }, { "inherits": { @@ -123264,7 +124033,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L939-L968" + "specLocation": "ingest/_types/Processors.ts#L1080-L1109" }, { "inherits": { @@ -123421,7 +124190,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L977-L1029" + "specLocation": "ingest/_types/Processors.ts#L1118-L1170" }, { "inherits": { @@ -123475,7 +124244,102 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1031-L1047" + "specLocation": "ingest/_types/Processors.ts#L1172-L1188" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "NetworkDirectionProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "Field containing the source IP address.", + "name": "source_ip", + "required": false, + "serverDefault": "source.ip", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the destination IP address.", + "name": "destination_ip", + "required": false, + "serverDefault": "destination.ip", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Output field for the network direction.", + "name": "target_field", + "required": false, + "serverDefault": "network.direction", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field.", + "name": "internal_networks", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "A field on the given document to read the internal_networks configuration\nfrom.", + "name": "internal_networks_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L1190-L1224" }, { "inherits": { @@ -123516,7 +124380,143 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1049-L1060" + "specLocation": "ingest/_types/Processors.ts#L1226-L1237" + }, + { + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "kind": "interface", + "name": { + "name": "RedactProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "The field to be redacted", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "A list of grok expressions to match and redact named captures with", + "name": "patterns", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "GrokPattern", + "namespace": "_types" + } + } + } + }, + { + "name": "pattern_definitions", + "required": false, + "type": { + "key": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + }, + "kind": "dictionary_of", + "singleKey": false, + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "Start a redacted section with this token", + "name": "prefix", + "required": false, + "serverDefault": "<", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "End a redacted section with this token", + "name": "suffix", + "required": false, + "serverDefault": ">", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If `true` and the current license does not support running redact processors, then the processor quietly exits without modifying the document", + "name": "skip_if_unlicensed", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "availability": { + "serverless": {}, + "stack": { + "since": "8.16.0" + } + }, + "description": "If `true` then ingest metadata `_ingest._redact._is_redacted` is set to `true` if the document has been redacted", + "name": "trace_redact", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L1239-L1280" }, { "inherits": { @@ -123527,12 +124527,12 @@ }, "kind": "interface", "name": { - "name": "RedactProcessor", + "name": "RegisteredDomainProcessor", "namespace": "ingest._types" }, "properties": [ { - "description": "The field to be redacted", + "description": "Field containing the source FQDN.", "name": "field", "required": true, "type": { @@ -123544,105 +124544,22 @@ } }, { - "description": "A list of grok expressions to match and redact named captures with", - "name": "patterns", - "required": true, - "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "GrokPattern", - "namespace": "_types" - } - } - } - }, - { - "name": "pattern_definitions", - "required": false, - "type": { - "key": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - }, - "kind": "dictionary_of", - "singleKey": false, - "value": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - } - }, - { - "description": "Start a redacted section with this token", - "name": "prefix", - "required": false, - "serverDefault": "<", - "type": { - "kind": "instance_of", - "type": { - "name": "string", - "namespace": "_builtins" - } - } - }, - { - "description": "End a redacted section with this token", - "name": "suffix", + "description": "Object field containing extracted domain components. If an empty string,\nthe processor adds components to the document’s root.", + "name": "target_field", "required": false, - "serverDefault": ">", "type": { "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "Field", + "namespace": "_types" } } }, { - "description": "If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document.", + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", "name": "ignore_missing", "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "description": "If `true` and the current license does not support running redact processors, then the processor quietly exits without modifying the document", - "name": "skip_if_unlicensed", - "required": false, - "serverDefault": false, - "type": { - "kind": "instance_of", - "type": { - "name": "boolean", - "namespace": "_builtins" - } - } - }, - { - "availability": { - "serverless": {}, - "stack": { - "since": "8.16.0" - } - }, - "description": "If `true` then ingest metadata `_ingest._redact._is_redacted` is set to `true` if the document has been redacted", - "name": "trace_redact", - "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -123652,7 +124569,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1062-L1103" + "specLocation": "ingest/_types/Processors.ts#L1282-L1298" }, { "inherits": { @@ -123705,7 +124622,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1105-L1119" + "specLocation": "ingest/_types/Processors.ts#L1300-L1314" }, { "inherits": { @@ -123758,7 +124675,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1121-L1137" + "specLocation": "ingest/_types/Processors.ts#L1316-L1332" }, { "inherits": { @@ -123840,7 +124757,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1139-L1167" + "specLocation": "ingest/_types/Processors.ts#L1334-L1362" }, { "inherits": { @@ -123912,7 +124829,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1169-L1189" + "specLocation": "ingest/_types/Processors.ts#L1364-L1384" }, { "inherits": { @@ -123998,7 +124915,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1191-L1225" + "specLocation": "ingest/_types/Processors.ts#L1386-L1420" }, { "inherits": { @@ -124041,7 +124958,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1227-L1236" + "specLocation": "ingest/_types/Processors.ts#L1422-L1431" }, { "inherits": { @@ -124094,7 +125011,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1243-L1259" + "specLocation": "ingest/_types/Processors.ts#L1438-L1454" }, { "inherits": { @@ -124173,7 +125090,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1261-L1286" + "specLocation": "ingest/_types/Processors.ts#L1456-L1481" }, { "inherits": { @@ -124188,7 +125105,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1288-L1288" + "specLocation": "ingest/_types/Processors.ts#L1483-L1483" }, { "inherits": { @@ -124242,7 +125159,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1290-L1306" + "specLocation": "ingest/_types/Processors.ts#L1485-L1501" }, { "inherits": { @@ -124296,7 +125213,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1308-L1324" + "specLocation": "ingest/_types/Processors.ts#L1503-L1519" }, { "inherits": { @@ -124350,7 +125267,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1326-L1342" + "specLocation": "ingest/_types/Processors.ts#L1521-L1537" }, { "inherits": { @@ -124430,7 +125347,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1344-L1370" + "specLocation": "ingest/_types/Processors.ts#L1539-L1565" }, { "inherits": { @@ -124543,7 +125460,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L447-L478" + "specLocation": "ingest/_types/Processors.ts#L474-L505" }, { "kind": "interface", @@ -129198,7 +130115,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L139-L168" + "specLocation": "ml/_types/Datafeed.ts#L142-L171" }, { "kind": "interface", @@ -129307,7 +130224,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L170-L195" + "specLocation": "ml/_types/Datafeed.ts#L173-L198" }, { "kind": "interface", @@ -129353,7 +130270,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L197-L211" + "specLocation": "ml/_types/Datafeed.ts#L200-L214" }, { "kind": "interface", @@ -129429,7 +130346,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L213-L230" + "specLocation": "ml/_types/Datafeed.ts#L216-L233" }, { "kind": "interface", @@ -129559,6 +130476,8 @@ } }, { + "extDocId": "query-dsl", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html", "name": "query", "required": true, "type": { @@ -129647,7 +130566,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L36-L57" + "specLocation": "ml/_types/Datafeed.ts#L36-L60" }, { "kind": "interface", @@ -129731,7 +130650,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L238-L251" + "specLocation": "ml/_types/Datafeed.ts#L241-L254" }, { "kind": "interface", @@ -129765,7 +130684,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L118-L129" + "specLocation": "ml/_types/Datafeed.ts#L121-L132" }, { "description": "Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded\nto actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.", @@ -134686,7 +135605,7 @@ } } ], - "specLocation": "ml/_types/Datafeed.ts#L59-L116" + "specLocation": "ml/_types/Datafeed.ts#L62-L119" }, { "kind": "interface", @@ -136149,7 +137068,7 @@ } } ], - "specLocation": "_global/msearch/types.ts#L203-L206" + "specLocation": "_global/msearch/types.ts#L206-L209" }, { "kind": "interface", @@ -137009,7 +137928,7 @@ } } ], - "specLocation": "query_rules/test/types.ts#L21-L30" + "specLocation": "query_rules/test/QueryRulesetTestResponse.ts#L30-L39" }, { "kind": "interface", @@ -137975,9 +138894,33 @@ "namespace": "_types" } } + }, + { + "description": "A retriever that reranks the top documents based on a reranking model using the InferenceAPI", + "name": "text_similarity_reranker", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "TextSimilarityReranker", + "namespace": "_types" + } + } + }, + { + "description": "A retriever that replaces the functionality of a rule query.", + "name": "rule", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RuleRetriever", + "namespace": "_types" + } + } } ], - "specLocation": "_types/Retriever.ts#L26-L36", + "specLocation": "_types/Retriever.ts#L28-L42", "variants": { "kind": "container" } @@ -138043,18 +138986,6 @@ } } }, - { - "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", - "name": "min_score", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - }, { "description": "Collapses the top documents by a specified key into a single top document per key.", "name": "collapse", @@ -138068,7 +138999,7 @@ } } ], - "specLocation": "_types/Retriever.ts#L43-L56" + "specLocation": "_types/Retriever.ts#L51-L62" }, { "kind": "interface", @@ -138103,9 +139034,21 @@ ], "kind": "union_of" } + }, + { + "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", + "name": "min_score", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } } ], - "specLocation": "_types/Retriever.ts#L38-L41" + "specLocation": "_types/Retriever.ts#L44-L49" }, { "inherits": { @@ -138193,7 +139136,7 @@ } } ], - "specLocation": "_types/Retriever.ts#L58-L71" + "specLocation": "_types/Retriever.ts#L64-L77" }, { "inherits": { @@ -138248,7 +139191,146 @@ } } ], - "specLocation": "_types/Retriever.ts#L73-L80" + "specLocation": "_types/Retriever.ts#L79-L86" + }, + { + "inherits": { + "type": { + "name": "RetrieverBase", + "namespace": "_types" + } + }, + "kind": "interface", + "name": { + "name": "TextSimilarityReranker", + "namespace": "_types" + }, + "properties": [ + { + "description": "The nested retriever which will produce the first-level results, that will later be used for reranking.", + "name": "retriever", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RetrieverContainer", + "namespace": "_types" + } + } + }, + { + "description": "This value determines how many documents we will consider from the nested retriever.", + "name": "rank_window_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "Unique identifier of the inference endpoint created using the inference API.", + "name": "inference_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The text snippet used as the basis for similarity comparison", + "name": "inference_text", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text", + "name": "field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "_types/Retriever.ts#L88-L99" + }, + { + "inherits": { + "type": { + "name": "RetrieverBase", + "namespace": "_types" + } + }, + "kind": "interface", + "name": { + "name": "RuleRetriever", + "namespace": "_types" + }, + "properties": [ + { + "description": "The ruleset IDs containing the rules this retriever is evaluating against.", + "name": "ruleset_ids", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + }, + { + "description": "The match criteria that will determine if a rule in the provided rulesets should be applied.", + "name": "match_criteria", + "required": true, + "type": { + "kind": "user_defined_value" + } + }, + { + "description": "The retriever whose results rules should be applied to.", + "name": "retriever", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "RetrieverContainer", + "namespace": "_types" + } + } + }, + { + "description": "This value determines the size of the individual result set.", + "name": "rank_window_size", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + } + ], + "specLocation": "_types/Retriever.ts#L101-L110" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index a2ac512421..5615086605 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -32231,9 +32231,12 @@ }, { "availability": { - "serverless": {}, + "serverless": { + "stability": "stable" + }, "stack": { - "since": "8.14.0" + "since": "8.14.0", + "stability": "stable" } }, "description": "A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn.", @@ -47842,9 +47845,21 @@ } ] } + }, + { + "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", + "name": "min_score", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "float", + "namespace": "_types" + } + } } ], - "specLocation": "_types/Retriever.ts#L44-L47" + "specLocation": "_types/Retriever.ts#L44-L49" }, { "kind": "interface", @@ -49613,18 +49628,6 @@ } } }, - { - "description": "Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.", - "name": "min_score", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "float", - "namespace": "_types" - } - } - }, { "description": "Collapses the top documents by a specified key into a single top document per key.", "name": "collapse", @@ -49638,7 +49641,7 @@ } } ], - "specLocation": "_types/Retriever.ts#L49-L62" + "specLocation": "_types/Retriever.ts#L51-L62" }, { "kind": "interface", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 006e7f339c..280892406d 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -2697,6 +2697,7 @@ export interface Retries { export interface RetrieverBase { filter?: QueryDslQueryContainer | QueryDslQueryContainer[] + min_score?: float } export interface RetrieverContainer { @@ -2876,7 +2877,6 @@ export interface StandardRetriever extends RetrieverBase { search_after?: SortResults terminate_after?: integer sort?: Sort - min_score?: float collapse?: SearchFieldCollapse } diff --git a/specification/_global/search/SearchRequest.ts b/specification/_global/search/SearchRequest.ts index 9fec2b244d..b2719a6b29 100644 --- a/specification/_global/search/SearchRequest.ts +++ b/specification/_global/search/SearchRequest.ts @@ -428,8 +428,8 @@ export interface Request extends RequestBase { rescore?: Rescore | Rescore[] /** * A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn. - * @availability stack since=8.14.0 - * @availability serverless + * @availability stack since=8.14.0 stability=stable + * @availability serverless stability=stable */ retriever?: RetrieverContainer /** diff --git a/specification/_types/Retriever.ts b/specification/_types/Retriever.ts index f7ad83ceff..636f9413fb 100644 --- a/specification/_types/Retriever.ts +++ b/specification/_types/Retriever.ts @@ -44,6 +44,8 @@ export class RetrieverContainer { export class RetrieverBase { /** Query to filter the documents that can match. */ filter?: QueryContainer | QueryContainer[] + /** Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. */ + min_score?: float } export class StandardRetriever extends RetrieverBase { @@ -55,8 +57,6 @@ export class StandardRetriever extends RetrieverBase { terminate_after?: integer /** A sort object that that specifies the order of matching documents. */ sort?: Sort - /** Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. */ - min_score?: float /** Collapses the top documents by a specified key into a single top document per key. */ collapse?: FieldCollapse }