openapi: 3.2.0 info: title: Elasticsearch Request & Response Specification Text Structure API license: name: Apache 2.0 url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE version: '' tags: - name: text_structure paths: /_text_structure/find_field_structure: get: tags: - text_structure summary: Find the structure of a text field description: 'Find the structure of a text field in an Elasticsearch index. This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. ## Required authorization * Cluster privileges: `monitor_text_structure` ' operationId: text-structure-find-field-structure parameters: - in: query name: column_names description: 'If `format` is set to `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header row, columns are named "column1", "column2", "column3", for example.' deprecated: false schema: oneOf: - type: string - type: array items: type: string style: form - in: query name: delimiter description: 'If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.' deprecated: false schema: type: string style: form - in: query name: documents_to_sample description: 'The number of documents to include in the structural analysis. The minimum value is 2.' deprecated: false schema: default: 1000.0 allOf: - $ref: '#/components/schemas/_types.uint' style: form - in: query name: ecs_compatibility description: 'The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output. The intention in that situation is that a user who knows the meanings will rename the fields before using them.' deprecated: false schema: default: disabled allOf: - $ref: '#/components/schemas/text_structure._types.EcsCompatibilityType' style: form - in: query name: explain description: If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. deprecated: false schema: default: false type: boolean style: form - in: query name: field description: The field that should be analyzed. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Field' style: form - in: query name: format description: 'The high level structure of the text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.' deprecated: false schema: $ref: '#/components/schemas/text_structure._types.FormatType' style: form - in: query name: grok_pattern description: 'If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern.' deprecated: false schema: $ref: '#/components/schemas/_types.GrokPattern' style: form - in: query name: index description: The name of the index that contains the analyzed field. required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: form - in: query name: quote description: 'If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote (`"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.' deprecated: false schema: type: string style: form - in: query name: should_trim_fields description: 'If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. Otherwise, the default value is `false`.' deprecated: false schema: type: boolean style: form - in: query name: should_parse_recursively description: 'If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively. The nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting. Anything beyond that depth is parsed as an `object` type field. For formats other than `ndjson`, this parameter is ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: timeout description: 'The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires, it will be stopped.' deprecated: false schema: default: 25s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timestamp_field description: 'The name of the field that contains the primary timestamp of each record in the text. In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text.' deprecated: false schema: $ref: '#/components/schemas/_types.Field' style: form - in: query name: timestamp_format description: 'The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz` Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS ''in'' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.' deprecated: false schema: type: string style: form responses: '200': description: '' content: application/json: schema: type: object properties: charset: type: string ecs_compatibility: allOf: - $ref: '#/components/schemas/text_structure._types.EcsCompatibilityType' field_stats: type: object additionalProperties: $ref: '#/components/schemas/text_structure._types.FieldStat' format: allOf: - $ref: '#/components/schemas/text_structure._types.FormatType' grok_pattern: allOf: - $ref: '#/components/schemas/_types.GrokPattern' java_timestamp_formats: type: array items: type: string joda_timestamp_formats: type: array items: type: string ingest_pipeline: allOf: - $ref: '#/components/schemas/ingest._types.PipelineConfig' mappings: allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' multiline_start_pattern: type: string need_client_timezone: type: boolean num_lines_analyzed: type: number num_messages_analyzed: type: number sample_start: type: string timestamp_field: allOf: - $ref: '#/components/schemas/_types.Field' required: - charset - field_stats - format - ingest_pipeline - mappings - need_client_timezone - num_lines_analyzed - num_messages_analyzed - sample_start examples: FindFieldStructureResponseExample1: description: A successful response from `GET _text_structure/find_field_structure?index=test-logs&field=message`. value: "{\n \"num_lines_analyzed\" : 22,\n \"num_messages_analyzed\" : 22,\n \"sample_start\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\\n[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\\n\",\n \"charset\" : \"UTF-8\",\n \"format\" : \"semi_structured_text\",\n \"multiline_start_pattern\" : \"^\\\\[\\\\b\\\\d{4}-\\\\d{2}-\\\\d{2}[T ]\\\\d{2}:\\\\d{2}\",\n \"grok_pattern\" : \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"timestamp\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"loglevel\" : {\n \"type\" : \"keyword\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"grok\" : {\n \"field\" : \"message\",\n \"patterns\" : [\n \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\"\n ],\n \"ecs_compatibility\" : \"disabled\"\n }\n },\n {\n \"date\" : {\n \"field\" : \"timestamp\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n },\n {\n \"remove\" : {\n \"field\" : \"timestamp\"\n }\n }\n ]\n },\n \"field_stats\" : {\n \"loglevel\" : {\n \"count\" : 22,\n \"cardinality\" : 1,\n \"top_hits\" : [\n {\n \"value\" : \"INFO\",\n \"count\" : 22\n }\n ]\n },\n \"message\" : {\n \"count\" : 22,\n \"cardinality\" : 22,\n \"top_hits\" : [\n {\n \"value\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"count\" : 1\n }\n ]\n },\n \"timestamp\" : {\n \"count\" : 22,\n \"cardinality\" : 14,\n \"earliest\" : \"2024-03-05T10:52:36,256\",\n \"latest\" : \"2024-03-05T10:52:49,199\",\n \"top_hits\" : [\n {\n \"value\" : \"2024-03-05T10:52:41,044\",\n \"count\" : 6\n },\n {\n \"value\" : \"2024-03-05T10:52:41,043\",\n \"count\" : 3\n },\n {\n \"value\" : \"2024-03-05T10:52:41,059\",\n \"count\" : 2\n },\n {\n \"value\" : \"2024-03-05T10:52:36,256\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,038\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,042\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:43,291\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:46,098\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,227\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,259\",\n \"count\" : 1\n }\n ]\n }\n }\n}" x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_text_structure/find_message_structure: get: tags: - text_structure summary: Find the structure of text messages description: 'Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. ## Required authorization * Cluster privileges: `monitor_text_structure` ' operationId: text-structure-find-message-structure parameters: - $ref: '#/components/parameters/text_structure.find_message_structure-column_names' - $ref: '#/components/parameters/text_structure.find_message_structure-delimiter' - $ref: '#/components/parameters/text_structure.find_message_structure-ecs_compatibility' - $ref: '#/components/parameters/text_structure.find_message_structure-explain' - $ref: '#/components/parameters/text_structure.find_message_structure-format' - $ref: '#/components/parameters/text_structure.find_message_structure-grok_pattern' - $ref: '#/components/parameters/text_structure.find_message_structure-quote' - $ref: '#/components/parameters/text_structure.find_message_structure-should_trim_fields' - $ref: '#/components/parameters/text_structure.find_message_structure-should_parse_recursively' - $ref: '#/components/parameters/text_structure.find_message_structure-timeout' - $ref: '#/components/parameters/text_structure.find_message_structure-timestamp_field' - $ref: '#/components/parameters/text_structure.find_message_structure-timestamp_format' requestBody: $ref: '#/components/requestBodies/text_structure.find_message_structure' responses: '200': $ref: '#/components/responses/text_structure.find_message_structure-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - text_structure summary: Find the structure of text messages description: 'Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. ## Required authorization * Cluster privileges: `monitor_text_structure` ' operationId: text-structure-find-message-structure-1 parameters: - $ref: '#/components/parameters/text_structure.find_message_structure-column_names' - $ref: '#/components/parameters/text_structure.find_message_structure-delimiter' - $ref: '#/components/parameters/text_structure.find_message_structure-ecs_compatibility' - $ref: '#/components/parameters/text_structure.find_message_structure-explain' - $ref: '#/components/parameters/text_structure.find_message_structure-format' - $ref: '#/components/parameters/text_structure.find_message_structure-grok_pattern' - $ref: '#/components/parameters/text_structure.find_message_structure-quote' - $ref: '#/components/parameters/text_structure.find_message_structure-should_trim_fields' - $ref: '#/components/parameters/text_structure.find_message_structure-should_parse_recursively' - $ref: '#/components/parameters/text_structure.find_message_structure-timeout' - $ref: '#/components/parameters/text_structure.find_message_structure-timestamp_field' - $ref: '#/components/parameters/text_structure.find_message_structure-timestamp_format' requestBody: $ref: '#/components/requestBodies/text_structure.find_message_structure' responses: '200': $ref: '#/components/responses/text_structure.find_message_structure-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_text_structure/find_structure: post: tags: - text_structure summary: Find the structure of a text file description: 'The text file must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. It must, however, be text; binary text formats are not currently supported. The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb. The response from the API contains: * A couple of messages from the beginning of the text. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. ## Required authorization * Cluster privileges: `monitor_text_structure` ' externalDocs: description: About finding text structure API url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/find-text-structure-examples x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/find-structure.html operationId: text-structure-find-structure parameters: - in: query name: charset description: 'The text''s character set. It must be a character set that is supported by the JVM that Elasticsearch uses. For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`. If this parameter is not specified, the structure finder chooses an appropriate character set.' deprecated: false schema: type: string style: form - in: query name: column_names description: 'If you have set format to `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", for example.' deprecated: false schema: oneOf: - type: string - type: array items: type: string style: form - in: query name: delimiter description: 'If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.' deprecated: false schema: type: string style: form - in: query name: ecs_compatibility description: 'The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. Valid values are `disabled` and `v1`. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.' deprecated: false schema: default: disabled type: string style: form - in: query name: explain description: 'If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.' deprecated: false schema: default: false type: boolean style: form - in: query name: format description: 'The high level structure of the text. Valid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.' deprecated: false schema: $ref: '#/components/schemas/text_structure.find_structure.FindStructureFormat' style: form - in: query name: grok_pattern description: 'If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern.' deprecated: false schema: $ref: '#/components/schemas/_types.GrokPattern' style: form - in: query name: has_header_row description: 'If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text. If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.' deprecated: false schema: type: boolean style: form - in: query name: line_merge_size_limit description: 'The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.' deprecated: false schema: default: 10000.0 allOf: - $ref: '#/components/schemas/_types.uint' style: form - in: query name: lines_to_sample description: 'The number of lines to include in the structural analysis, starting from the beginning of the text. The minimum is 2. If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines. NOTE: The number of lines and the variation of the lines affects the speed of the analysis. For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample. If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety.' deprecated: false schema: default: 1000.0 allOf: - $ref: '#/components/schemas/_types.uint' style: form - in: query name: quote description: 'If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote (`"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.' deprecated: false schema: type: string style: form - in: query name: should_trim_fields description: 'If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`. Otherwise, the default value is `false`.' deprecated: false schema: type: boolean style: form - in: query name: should_parse_recursively description: 'If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively. The nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting. Anything beyond that depth is parsed as an `object` type field. For formats other than `ndjson`, this parameter is ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: timeout description: 'The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires then it will be stopped.' deprecated: false schema: default: 25s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timestamp_field description: 'The name of the field that contains the primary timestamp of each record in the text. In particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text.' deprecated: false schema: $ref: '#/components/schemas/_types.Field' style: form - in: query name: timestamp_format description: 'The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz` Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`. Spacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS ''in'' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text this will result in the structure finder treating the text as single-line messages.' deprecated: false schema: type: string style: form requestBody: content: application/json: schema: type: array items: type: object examples: FindStructureRequestExample1: description: Run `POST _text_structure/find_structure` to analyze newline-delimited JSON text. value: '{"name": "Leviathan Wakes", "author": "James S.A. Corey", "release_date": "2011-06-02", "page_count": 561} {"name": "Hyperion", "author": "Dan Simmons", "release_date": "1989-05-26", "page_count": 482} {"name": "Dune", "author": "Frank Herbert", "release_date": "1965-06-01", "page_count": 604} {"name": "Dune Messiah", "author": "Frank Herbert", "release_date": "1969-10-15", "page_count": 331} {"name": "Children of Dune", "author": "Frank Herbert", "release_date": "1976-04-21", "page_count": 408} {"name": "God Emperor of Dune", "author": "Frank Herbert", "release_date": "1981-05-28", "page_count": 454} {"name": "Consider Phlebas", "author": "Iain M. Banks", "release_date": "1987-04-23", "page_count": 471} {"name": "Pandora''s Star", "author": "Peter F. Hamilton", "release_date": "2004-03-02", "page_count": 768} {"name": "Revelation Space", "author": "Alastair Reynolds", "release_date": "2000-03-15", "page_count": 585} {"name": "A Fire Upon the Deep", "author": "Vernor Vinge", "release_date": "1992-06-01", "page_count": 613} {"name": "Ender''s Game", "author": "Orson Scott Card", "release_date": "1985-06-01", "page_count": 324} {"name": "1984", "author": "George Orwell", "release_date": "1985-06-01", "page_count": 328} {"name": "Fahrenheit 451", "author": "Ray Bradbury", "release_date": "1953-10-15", "page_count": 227} {"name": "Brave New World", "author": "Aldous Huxley", "release_date": "1932-06-01", "page_count": 268} {"name": "Foundation", "author": "Isaac Asimov", "release_date": "1951-06-01", "page_count": 224} {"name": "The Giver", "author": "Lois Lowry", "release_date": "1993-04-26", "page_count": 208} {"name": "Slaughterhouse-Five", "author": "Kurt Vonnegut", "release_date": "1969-06-01", "page_count": 275} {"name": "The Hitchhiker''s Guide to the Galaxy", "author": "Douglas Adams", "release_date": "1979-10-12", "page_count": 180} {"name": "Snow Crash", "author": "Neal Stephenson", "release_date": "1992-06-01", "page_count": 470} {"name": "Neuromancer", "author": "William Gibson", "release_date": "1984-07-01", "page_count": 271} {"name": "The Handmaid''s Tale", "author": "Margaret Atwood", "release_date": "1985-06-01", "page_count": 311} {"name": "Starship Troopers", "author": "Robert A. Heinlein", "release_date": "1959-12-01", "page_count": 335} {"name": "The Left Hand of Darkness", "author": "Ursula K. Le Guin", "release_date": "1969-06-01", "page_count": 304} {"name": "The Moon is a Harsh Mistress", "author": "Robert A. Heinlein", "release_date": "1966-04-01", "page_count": 288}' required: true responses: '200': description: '' content: application/json: schema: type: object properties: charset: description: The character encoding used to parse the text. type: string has_header_row: type: boolean has_byte_order_marker: description: For UTF character encodings, it indicates whether the text begins with a byte order marker. type: boolean format: description: Valid values include `ndjson`, `xml`, `delimited`, and `semi_structured_text`. type: string field_stats: description: 'The most common values of each field, plus basic numeric statistics for the numeric `page_count` field. This information may provide clues that the data needs to be cleaned or transformed prior to use by other Elastic Stack functionality.' type: object additionalProperties: $ref: '#/components/schemas/text_structure._types.FieldStat' sample_start: description: 'The first two messages in the text verbatim. This may help diagnose parse errors or accidental uploads of the wrong text.' type: string num_messages_analyzed: description: 'The number of distinct messages the lines contained. For NDJSON, this value is the same as `num_lines_analyzed`. For other text formats, messages can span several lines.' type: number mappings: description: Some suitable mappings for an index into which the data could be ingested. allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' quote: type: string delimiter: type: string need_client_timezone: description: 'If a timestamp format is detected that does not include a timezone, `need_client_timezone` is `true`. The server that parses the text must therefore be told the correct timezone by the client.' type: boolean num_lines_analyzed: description: The number of lines of the text that were analyzed. type: number column_names: description: If `format` is `delimited`, the `column_names` field lists the column names in the order they appear in the sample. type: array items: type: string explanation: type: array items: type: string grok_pattern: allOf: - $ref: '#/components/schemas/_types.GrokPattern' multiline_start_pattern: type: string exclude_lines_pattern: type: string java_timestamp_formats: description: 'The Java time formats recognized in the time fields. Elasticsearch mappings and ingest pipelines use this format.' type: array items: type: string joda_timestamp_formats: description: Information that is used to tell Logstash how to parse timestamps. type: array items: type: string timestamp_field: description: The field considered most likely to be the primary timestamp of each document. allOf: - $ref: '#/components/schemas/_types.Field' should_trim_fields: type: boolean ingest_pipeline: allOf: - $ref: '#/components/schemas/ingest._types.PipelineConfig' required: - charset - has_byte_order_marker - format - field_stats - sample_start - num_messages_analyzed - mappings - need_client_timezone - num_lines_analyzed - ingest_pipeline examples: FindStructureResponseExample1: description: A successful response from `POST _text_structure/find_structure`. value: "{\n \"num_lines_analyzed\" : 24,\n \"num_messages_analyzed\" : 24,\n \"sample_start\" : \"{\\\"name\\\": \\\"Leviathan Wakes\\\", \\\"author\\\": \\\"James S.A. Corey\\\", \\\"release_date\\\": \\\"2011-06-02\\\", \\\"page_count\\\": 561}\\n{\\\"name\\\": \\\"Hyperion\\\", \\\"author\\\": \\\"Dan Simmons\\\", \\\"release_date\\\": \\\"1989-05-26\\\", \\\"page_count\\\": 482}\\n\",\n \"charset\" : \"UTF-8\",\n \"has_byte_order_marker\" : false,\n \"format\" : \"ndjson\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"release_date\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"author\" : {\n \"type\" : \"keyword\"\n },\n \"name\" : {\n \"type\" : \"keyword\"\n },\n \"page_count\" : {\n \"type\" : \"long\"\n },\n \"release_date\" : {\n \"type\" : \"date\",\n \"format\" : \"iso8601\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"date\" : {\n \"field\" : \"release_date\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n }\n ]\n },\n \"field_stats\" : {\n \"author\" : {\n \"count\" : 24,\n \"cardinality\" : 20,\n \"top_hits\" : [\n {\n \"value\" : \"Frank Herbert\",\n \"count\" : 4\n },\n {\n \"value\" : \"Robert A. Heinlein\",\n \"count\" : 2\n },\n {\n \"value\" : \"Alastair Reynolds\",\n \"count\" : 1\n },\n {\n \"value\" : \"Aldous Huxley\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dan Simmons\",\n \"count\" : 1\n },\n {\n \"value\" : \"Douglas Adams\",\n \"count\" : 1\n },\n {\n \"value\" : \"George Orwell\",\n \"count\" : 1\n },\n {\n \"value\" : \"Iain M. Banks\",\n \"count\" : 1\n },\n {\n \"value\" : \"Isaac Asimov\",\n \"count\" : 1\n },\n {\n \"value\" : \"James S.A. Corey\",\n \"count\" : 1\n }\n ]\n },\n \"name\" : {\n \"count\" : 24,\n \"cardinality\" : 24,\n \"top_hits\" : [\n {\n \"value\" : \"1984\",\n \"count\" : 1\n },\n {\n \"value\" : \"A Fire Upon the Deep\",\n \"count\" : 1\n },\n {\n \"value\" : \"Brave New World\",\n \"count\" : 1\n },\n {\n \"value\" : \"Children of Dune\",\n \"count\" : 1\n },\n {\n \"value\" : \"Consider Phlebas\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dune\",\n \"count\" : 1\n },\n {\n \"value\" : \"Dune Messiah\",\n \"count\" : 1\n },\n {\n \"value\" : \"Ender's Game\",\n \"count\" : 1\n },\n {\n \"value\" : \"Fahrenheit 451\",\n \"count\" : 1\n },\n {\n \"value\" : \"Foundation\",\n \"count\" : 1\n }\n ]\n },\n \"page_count\" : {\n \"count\" : 24,\n \"cardinality\" : 24,\n \"min_value\" : 180,\n \"max_value\" : 768,\n \"mean_value\" : 387.0833333333333,\n \"median_value\" : 329.5,\n \"top_hits\" : [\n {\n \"value\" : 180,\n \"count\" : 1\n },\n {\n \"value\" : 208,\n \"count\" : 1\n },\n {\n \"value\" : 224,\n \"count\" : 1\n },\n {\n \"value\" : 227,\n \"count\" : 1\n },\n {\n \"value\" : 268,\n \"count\" : 1\n },\n {\n \"value\" : 271,\n \"count\" : 1\n },\n {\n \"value\" : 275,\n \"count\" : 1\n },\n {\n \"value\" : 288,\n \"count\" : 1\n },\n {\n \"value\" : 304,\n \"count\" : 1\n },\n {\n \"value\" : 311,\n \"count\" : 1\n }\n ]\n },\n \"release_date\" : {\n \"count\" : 24,\n \"cardinality\" : 20,\n \"earliest\" : \"1932-06-01\",\n \"latest\" : \"2011-06-02\",\n \"top_hits\" : [\n {\n \"value\" : \"1985-06-01\",\n \"count\" : 3\n },\n {\n \"value\" : \"1969-06-01\",\n \"count\" : 2\n },\n {\n \"value\" : \"1992-06-01\",\n \"count\" : 2\n },\n {\n \"value\" : \"1932-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1951-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1953-10-15\",\n \"count\" : 1\n },\n {\n \"value\" : \"1959-12-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1965-06-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1966-04-01\",\n \"count\" : 1\n },\n {\n \"value\" : \"1969-10-15\",\n \"count\" : 1\n }\n ]\n }\n }\n}" x-state: Generally available; Added in 7.13.0 x-metaTags: - content: Elasticsearch name: product_name /_text_structure/test_grok_pattern: get: tags: - text_structure summary: Test a Grok pattern description: 'Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.' externalDocs: description: Learn more about Grok patterns url: https://www.elastic.co/docs/explore-analyze/scripting/grok x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/test-grok-pattern.html operationId: text-structure-test-grok-pattern parameters: - $ref: '#/components/parameters/text_structure.test_grok_pattern-ecs_compatibility' requestBody: $ref: '#/components/requestBodies/text_structure.test_grok_pattern' responses: '200': $ref: '#/components/responses/text_structure.test_grok_pattern-200' x-state: Generally available; Added in 8.13.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - text_structure summary: Test a Grok pattern description: 'Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.' externalDocs: description: Learn more about Grok patterns url: https://www.elastic.co/docs/explore-analyze/scripting/grok x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/test-grok-pattern.html operationId: text-structure-test-grok-pattern-1 parameters: - $ref: '#/components/parameters/text_structure.test_grok_pattern-ecs_compatibility' requestBody: $ref: '#/components/requestBodies/text_structure.test_grok_pattern' responses: '200': $ref: '#/components/responses/text_structure.test_grok_pattern-200' x-state: Generally available; Added in 8.13.0 x-metaTags: - content: Elasticsearch name: product_name components: schemas: _types.query_dsl.SpanContainingQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: big: description: 'Can be any span query. Matching spans from `big` that contain matches from `little` are returned.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' little: description: 'Can be any span query. Matching spans from `big` that contain matches from `little` are returned.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - big - little _types.query_dsl.TypeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: value: type: string required: - value _types.aggregations.TopHitsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: docvalue_fields: description: Fields for which to return doc values. type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' explain: description: If `true`, returns detailed information about score computation as part of a hit. default: false type: boolean fields: description: 'Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.' type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' from: description: Starting document offset. default: 0.0 type: number highlight: description: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. allOf: - $ref: '#/components/schemas/_global.search._types.Highlight' script_fields: description: Returns the result of one or more script evaluations for each hit. type: object additionalProperties: $ref: '#/components/schemas/_types.ScriptField' size: description: The maximum number of top matching hits to return per bucket. default: 3.0 type: number sort: description: 'Sort order of the top matching hits. By default, the hits are sorted by the score of the main query.' allOf: - $ref: '#/components/schemas/_types.Sort' _source: description: Selects the fields of the source that are returned. allOf: - $ref: '#/components/schemas/_global.search._types.SourceConfig' stored_fields: description: Returns values for the specified stored fields (fields that use the `store` mapping option). allOf: - $ref: '#/components/schemas/_types.Fields' track_scores: description: If `true`, calculates and returns document scores, even if the scores are not used for sorting. default: false type: boolean version: description: If `true`, returns document version as part of a hit. default: false type: boolean seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. type: boolean _types.query_dsl.CombinedFieldsZeroTerms: type: string enum: - none - all _types.aggregations.BucketSelectorAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: script: description: The script to run for this aggregation. allOf: - $ref: '#/components/schemas/_types.Script' _types.mapping.VersionProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - version required: - type _types.mapping.MatchType: type: string enum: - simple - regex _types.aggregations.TermsPartition: type: object properties: num_partitions: description: The number of partitions. type: number partition: description: The partition number for this request. type: number required: - num_partitions - partition ingest._types.RedactProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to be redacted allOf: - $ref: '#/components/schemas/_types.Field' patterns: description: A list of grok expressions to match and redact named captures with type: array items: $ref: '#/components/schemas/_types.GrokPattern' pattern_definitions: type: object additionalProperties: type: string prefix: description: Start a redacted section with this token default: < type: string suffix: description: End a redacted section with this token default: '>' type: string ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean skip_if_unlicensed: description: If `true` and the current license does not support running redact processors, then the processor quietly exits without modifying the document default: false type: boolean trace_redact: description: If `true` then ingest metadata `_ingest._redact._is_redacted` is set to `true` if the document has been redacted default: false x-state: Generally available; Added in 8.16.0 type: boolean required: - field - patterns _types.query_dsl.GeoBoundingBoxQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: type: deprecated: true allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoExecution' validation_method: description: 'Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. Set to `COERCE` to also try to infer correct latitude or longitude.' default: '''strict''' allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod' ignore_unmapped: description: 'Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped.' default: false type: boolean _types.SortResults: type: array items: $ref: '#/components/schemas/_types.FieldValue' _types.mapping.CorePropertyBase: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: copy_to: allOf: - $ref: '#/components/schemas/_types.Fields' store: type: boolean _types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator: type: object properties: doc_count: description: 'The total number of documents that initially created the expectations. It’s required to be greater than or equal to the sum of all values in the buckets_path as this is the originating superset of data to which the term values are correlated.' type: number expectations: description: 'An array of numbers with which to correlate the configured `bucket_path` values. The length of this value must always equal the number of buckets returned by the `bucket_path`.' type: array items: type: number fractions: description: 'An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, must equal expectations.' type: array items: type: number required: - doc_count - expectations _types.aggregations.ChildrenAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: type: description: The child type that should be selected. allOf: - $ref: '#/components/schemas/_types.RelationName' _types.EpochTimeUnitMillis: allOf: - $ref: '#/components/schemas/_types.UnitMillis' _types.aggregations.MatrixAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: fields: description: An array of fields for computing the statistics. allOf: - $ref: '#/components/schemas/_types.Fields' missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' type: object additionalProperties: type: number _types.query_dsl.DisMaxQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: queries: description: 'One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, Elasticsearch uses the highest relevance score.' type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' tie_breaker: description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. default: 0.0 type: number required: - queries _types.mapping.IntegerNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - integer null_value: type: number required: - type _types.aggregations.SamplerAggregationExecutionHint: type: string enum: - map - global_ordinals - bytes_hash ingest._types.HtmlStripProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The string-valued field to remove HTML tags from. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document, default: false type: boolean target_field: description: 'The field to assign the converted value to By default, the `field` is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.aggregations.MovingPercentilesAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: window: description: The size of window to "slide" across the histogram. type: number shift: description: 'By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right.' default: 0.0 type: number keyed: type: boolean _types.aggregations.HoltWintersModelSettings: type: object properties: alpha: type: number beta: type: number gamma: type: number pad: type: boolean period: type: number type: allOf: - $ref: '#/components/schemas/_types.aggregations.HoltWintersType' _types.aggregations.HistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: extended_bounds: description: Enables extending the bounds of the histogram beyond the data itself. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsdouble' hard_bounds: description: 'Limits the range of buckets in the histogram. It is particularly useful in the case of open data ranges that can result in a very large number of buckets.' allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsdouble' field: description: The name of the field to aggregate on. allOf: - $ref: '#/components/schemas/_types.Field' interval: description: 'The interval for the buckets. Must be a positive decimal.' type: number min_doc_count: description: 'Only returns buckets that have `min_doc_count` number of documents. By default, the response will fill gaps in the histogram with empty buckets.' type: number missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' type: number offset: description: 'By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. The bucket boundaries can be shifted by using the `offset` option.' type: number order: description: 'The sort order of the returned buckets. By default, the returned buckets are sorted by their key ascending.' allOf: - $ref: '#/components/schemas/_types.aggregations.AggregateOrder' script: allOf: - $ref: '#/components/schemas/_types.Script' format: type: string keyed: description: If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys. default: false type: boolean _types.GeoTilePrecision: type: number _types.mapping.DataStreamTimestamp: type: object properties: enabled: type: boolean required: - enabled _types.aggregations.DateRangeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The date field whose values are use to build ranges. allOf: - $ref: '#/components/schemas/_types.Field' format: description: The date format used to format `from` and `to` in the response. type: string missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' ranges: description: Array of date ranges. type: array items: $ref: '#/components/schemas/_types.aggregations.DateRangeExpression' time_zone: description: Time zone used to convert dates from another time zone to UTC. allOf: - $ref: '#/components/schemas/_types.TimeZone' keyed: description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. type: boolean _types.aggregations.StringStatsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: show_distribution: description: Shows the probability distribution for all characters. default: false type: boolean _types.byte: type: number _types.aggregations.TTestType: type: string enum: - paired - homoscedastic - heteroscedastic ingest._types.DotExpanderProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: 'The field to expand into an object field. If set to `*`, all top-level fields will be expanded.' allOf: - $ref: '#/components/schemas/_types.Field' override: description: 'Controls the behavior when there is already an existing nested object that conflicts with the expanded field. When `false`, the processor will merge conflicts by combining the old and the new values into an array. When `true`, the value from the expanded field will overwrite the existing value.' default: false type: boolean path: description: 'The field that contains the field to expand. Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields.' type: string required: - field _types.TextSimilarityReranker: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retriever: description: The nested retriever which will produce the first-level results, that will later be used for reranking. allOf: - $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 chunk_rescorer: description: Whether to rescore on only the best matching chunks. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.ChunkRescorer' required: - retriever - inference_text - field _types.aggregations.ParentAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: type: description: The child type that should be selected. allOf: - $ref: '#/components/schemas/_types.RelationName' _types.aggregations.MaxBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object ingest._types.GrokProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: ecs_compatibility: description: 'Must be disabled or v1. If v1, the processor uses patterns with Elastic Common Schema (ECS) field names.' default: disabled type: string field: description: The field to use for grok expression parsing. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean pattern_definitions: description: 'A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition.' type: object additionalProperties: type: string patterns: description: 'An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.' type: array items: $ref: '#/components/schemas/_types.GrokPattern' trace_match: description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. default: false type: boolean validate_only: description: When `true`, the processor does matching but does not extract structured fields default: false x-state: Generally available; Added in 9.4.0 type: boolean required: - field - patterns _global.search._types.FieldCollapse: type: object properties: field: description: The field to collapse the result set on allOf: - $ref: '#/components/schemas/_types.Field' inner_hits: description: The number of inner hits and their sort order oneOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' - type: array items: $ref: '#/components/schemas/_global.search._types.InnerHits' max_concurrent_group_searches: description: The number of concurrent requests allowed to retrieve the inner_hits per group type: number collapse: allOf: - $ref: '#/components/schemas/_global.search._types.FieldCollapse' required: - field _types.mapping.GeoShapeProperty: description: 'The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons.' allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: coerce: type: boolean ignore_malformed: type: boolean ignore_z_value: type: boolean index: type: boolean orientation: allOf: - $ref: '#/components/schemas/_types.mapping.GeoOrientation' strategy: allOf: - $ref: '#/components/schemas/_types.mapping.GeoStrategy' type: type: string enum: - geo_shape required: - type _types.DateTime: description: 'A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.' oneOf: - type: string - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' _types.query_dsl.RangeQueryBase: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. type: object gte: description: Greater than or equal to. type: object lt: description: Less than. type: object lte: description: Less than or equal to. type: object _types.query_dsl.NumericDecayFunction: allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBasedoubledouble' - type: object _types.mapping.Subobjects: type: string enum: - 'true' - 'false' _types.aggregations.FormattableMetricAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: format: type: string ingest._types.CommunityIDProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: source_ip: description: Field containing the source IP address. default: source.ip allOf: - $ref: '#/components/schemas/_types.Field' source_port: description: Field containing the source port. default: source.port allOf: - $ref: '#/components/schemas/_types.Field' destination_ip: description: Field containing the destination IP address. default: destination.ip allOf: - $ref: '#/components/schemas/_types.Field' destination_port: description: Field containing the destination port. default: destination.port allOf: - $ref: '#/components/schemas/_types.Field' iana_number: description: Field containing the IANA number. default: network.iana_number allOf: - $ref: '#/components/schemas/_types.Field' icmp_type: description: Field containing the ICMP type. default: icmp.type allOf: - $ref: '#/components/schemas/_types.Field' icmp_code: description: Field containing the ICMP code. default: icmp.code allOf: - $ref: '#/components/schemas/_types.Field' transport: description: 'Field containing the transport protocol name or number. Used only when the iana_number field is not present. The following protocol names are currently supported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp' default: network.transport allOf: - $ref: '#/components/schemas/_types.Field' target_field: description: Output field for the community ID. default: network.community_id allOf: - $ref: '#/components/schemas/_types.Field' seed: description: 'Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.' default: 0.0 type: number ignore_missing: description: 'If true and any required fields are missing, the processor quietly exits without modifying the document.' default: true type: boolean _types.query_dsl.UntypedRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBase' - type: object properties: format: description: Date format used to convert `date` values in the query. allOf: - $ref: '#/components/schemas/_types.DateFormat' time_zone: description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. allOf: - $ref: '#/components/schemas/_types.TimeZone' _types.IndexName: type: string _types.aggregations.GeoLineSort: type: object properties: field: description: The name of the numeric field to use as the sort key for ordering the points. allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.mapping.SizeField: type: object properties: enabled: type: boolean required: - enabled _types.mapping.LongRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - long_range required: - type ingest._types.ShapeType: type: string enum: - geo_shape - shape ingest._types.TrimProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The string-valued field to trim whitespace from. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean target_field: description: 'The field to assign the trimmed value to. By default, the field is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.mapping.FieldAliasProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: path: allOf: - $ref: '#/components/schemas/_types.Field' type: type: string enum: - alias required: - type _types.aggregations.MultiTermLookup: allOf: - type: object properties: missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' - type: object properties: field: description: 'A field from which to retrieve terms. It is required if `script` is not provided.' allOf: - $ref: '#/components/schemas/_types.Field' script: description: 'A script to calculate terms to aggregate on. It is required if `field` is not provided.' allOf: - $ref: '#/components/schemas/_types.Script' minProperties: 1 maxProperties: 1 _types.query_dsl.DecayFunctionBaseGeoLocationDistance: type: object properties: multi_value_mode: description: Determines how the distance is calculated when a field used for computing the decay contains multiple values. default: min allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode' _types.aggregations.CompositeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: after: description: When paginating, use the `after_key` value returned in the previous response to retrieve the next page. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregateKey' size: description: The number of composite buckets that should be returned. default: 10.0 type: number sources: description: 'The value sources used to build composite buckets. Keys are returned in the order of the `sources` definition.' type: array items: type: object additionalProperties: $ref: '#/components/schemas/_types.aggregations.CompositeAggregationSource' minProperties: 1 maxProperties: 1 text_structure._types.FieldStat: type: object properties: count: type: number cardinality: type: number top_hits: type: array items: $ref: '#/components/schemas/text_structure._types.TopHit' mean_value: type: number median_value: type: number max_value: type: number min_value: type: number earliest: type: string latest: type: string required: - count - cardinality - top_hits _types.query_dsl.SemanticQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: description: The field to query, which must be a semantic_text field type type: string query: description: The query text type: string required: - field - query _types.aggregations.InferenceAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: model_id: description: The ID or alias for the trained model. allOf: - $ref: '#/components/schemas/_types.Name' inference_config: description: Contains the inference type and its options. allOf: - $ref: '#/components/schemas/_types.aggregations.InferenceConfigContainer' required: - model_id _types.aggregations.HoltWintersMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - holt_winters settings: allOf: - $ref: '#/components/schemas/_types.aggregations.HoltWintersModelSettings' required: - model - settings _types.query_dsl.TextQueryType: type: string enum: - best_fields - most_fields - cross_fields - phrase - phrase_prefix - bool_prefix _types.analysis.StopWords: description: 'Language value, such as _arabic_ or _thai_. Defaults to _english_. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words.' oneOf: - $ref: '#/components/schemas/_types.analysis.StopWordLanguage' - type: array items: type: string _types.mapping.PassthroughObjectProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: type: type: string enum: - passthrough enabled: type: boolean priority: type: number time_series_dimension: type: boolean _types.aggregations.ScriptedMetricAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: combine_script: description: 'Runs once on each shard after document collection is complete. Allows the aggregation to consolidate the state returned from each shard.' allOf: - $ref: '#/components/schemas/_types.Script' init_script: description: 'Runs prior to any collection of documents. Allows the aggregation to set up any initial state.' allOf: - $ref: '#/components/schemas/_types.Script' map_script: description: 'Run once per document collected. If no `combine_script` is specified, the resulting state needs to be stored in the `state` object.' allOf: - $ref: '#/components/schemas/_types.Script' params: description: 'A global object with script parameters for `init`, `map` and `combine` scripts. It is shared between the scripts.' type: object additionalProperties: type: object reduce_script: description: 'Runs once on the coordinating node after all shards have returned their results. The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard.' allOf: - $ref: '#/components/schemas/_types.Script' _types.aggregations.StatsBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.query_dsl.RangeQueryBaselong: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. type: number gte: description: Greater than or equal to. type: number lt: description: Less than. type: number lte: description: Less than or equal to. type: number ingest._types.InferenceProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: model_id: description: The ID or alias for the trained model, or the ID of the deployment. allOf: - $ref: '#/components/schemas/_types.Id' target_field: description: Field added to incoming documents to contain results objects. default: ml.inference. allOf: - $ref: '#/components/schemas/_types.Field' field_map: description: 'Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration.' type: object additionalProperties: type: object inference_config: description: Contains the inference type and its options. allOf: - $ref: '#/components/schemas/ingest._types.InferenceConfig' input_output: description: 'Input fields for inference and output (destination) fields for the inference results. This option is incompatible with the target_field and field_map options.' oneOf: - $ref: '#/components/schemas/ingest._types.InputConfig' - type: array items: $ref: '#/components/schemas/ingest._types.InputConfig' ignore_missing: description: 'If true and any of the input fields defined in input_ouput are missing then those missing fields are quietly ignored, otherwise a missing field causes a failure. Only applies when using input_output configurations to explicitly list the input fields.' type: boolean required: - model_id _types.mapping.RankVectorProperty: description: Technical preview allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - rank_vectors element_type: allOf: - $ref: '#/components/schemas/_types.mapping.RankVectorElementType' dims: type: number required: - type _types.mapping.ShapeProperty: description: 'The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as rectangles and polygons.' allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: coerce: type: boolean ignore_malformed: type: boolean ignore_z_value: type: boolean orientation: allOf: - $ref: '#/components/schemas/_types.mapping.GeoOrientation' type: type: string enum: - shape required: - type _types.mapping.IcuCollationProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - icu_collation_keyword norms: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' index: description: Should the field be searchable? type: boolean null_value: description: Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. type: string rules: type: string language: type: string country: type: string variant: type: string strength: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationStrength' decomposition: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationDecomposition' alternate: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationAlternate' case_level: type: boolean case_first: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationCaseFirst' numeric: type: boolean variable_top: type: string hiragana_quaternary_mode: type: boolean required: - type ingest._types.GeoGridTileType: type: string enum: - geotile - geohex - geohash ingest._types.InferenceConfigRegression: type: object properties: results_field: description: The field that is added to incoming documents to contain the inference prediction. default: _prediction allOf: - $ref: '#/components/schemas/_types.Field' num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. default: 0.0 type: number _types.mapping.NestedProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: enabled: type: boolean include_in_parent: type: boolean include_in_root: type: boolean type: type: string enum: - nested required: - type _types.aggregations.BucketPathAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: buckets_path: description: Path to the buckets that contain one set of values to correlate. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketsPath' _types.mapping.FlattenedProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: boost: type: number depth_limit: type: number doc_values: type: boolean eager_global_ordinals: type: boolean index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' null_value: type: string preserve_leaf_arrays: description: 'How leaf arrays are represented in synthetic source. When set to `lossy`, leaf arrays are sorted, de-nulled, and deduplicated in the returned synthetic source. When set to `exact`, leaf arrays preserve order, nulls, and duplicates.' allOf: - $ref: '#/components/schemas/_types.mapping.PreserveLeafArrays' similarity: type: string split_queries_on_whitespace: type: boolean time_series_dimensions: type: array items: type: string type: type: string enum: - flattened required: - type _types.aggregations.AggregationRange: type: object properties: from: description: Start of the range (inclusive). oneOf: - type: number - type: - string - 'null' key: description: Custom key to return the range with. type: string to: description: End of the range (exclusive). oneOf: - type: number - type: - string - 'null' _types.DateFormat: type: string _types.DiversifyRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: type: description: The diversification strategy to apply. allOf: - $ref: '#/components/schemas/_types.DiversifyRetrieverTypes' field: description: The document field on which to diversify results on. type: string retriever: description: The nested retriever whose results will be diversified. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' size: description: The number of top documents to return after diversification. type: number rank_window_size: description: The number of top documents from the nested retriever to consider for diversification. type: number query_vector: description: The query vector used for diversification. allOf: - $ref: '#/components/schemas/_types.QueryVector' query_vector_builder: description: a dense vector query vector builder to use instead of a static query_vector allOf: - $ref: '#/components/schemas/_types.QueryVectorBuilder' lambda: description: Controls the trade-off between relevance and diversity for MMR. A value of 0.0 focuses solely on diversity, while a value of 1.0 focuses solely on relevance. Required for MMR type: number required: - type - field - retriever _types.query_dsl.TextExpansionQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: model_id: description: The text expansion NLP model to use type: string model_text: description: The query text type: string pruning_config: description: Token pruning configurations x-state: Experimental; Added in 8.13.0 allOf: - $ref: '#/components/schemas/_types.TokenPruningConfig' required: - model_id - model_text _types.mapping.PropertyBase: type: object properties: meta: description: Metadata about the field. type: object additionalProperties: type: string properties: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' ignore_above: type: number dynamic: allOf: - $ref: '#/components/schemas/_types.mapping.DynamicMapping' fields: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' synthetic_source_keep: allOf: - $ref: '#/components/schemas/_types.mapping.SyntheticSourceKeepEnum' ingest._types.RerouteProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: destination: description: A static value for the target. Can’t be set when the dataset or namespace option is set. type: string dataset: description: 'Field references or a static value for the dataset part of the data stream name. In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. Example values are nginx.access and nginx.error. Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). When resolving field references, the processor replaces invalid characters with _. Uses the part of the index name as a fallback if all field references resolve to a null, missing, or non-string value. default {{data_stream.dataset}}' oneOf: - type: string - type: array items: type: string namespace: description: 'Field references or a static value for the namespace part of the data stream name. See the criteria for index names for allowed characters. Must be no longer than 100 characters. Supports field references with a mustache-like syntax (denoted as {{double}} or {{{triple}}} curly braces). When resolving field references, the processor replaces invalid characters with _. Uses the part of the index name as a fallback if all field references resolve to a null, missing, or non-string value. default {{data_stream.namespace}}' oneOf: - type: string - type: array items: type: string _types.mapping.DenseVectorElementType: type: string enum: - bit - byte - float - bfloat16 _types.aggregations.ExtendedStatsBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: sigma: description: The number of standard deviations above/below the mean to display. type: number _types.GeoHash: type: string _types.query_dsl.WildcardQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: case_insensitive: description: Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. x-state: Generally available; Added in 7.10.0 type: boolean rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' value: description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. type: string wildcard: description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. type: string _global.search._types.HighlighterOrder: type: string enum: - score _types.query_dsl.FuzzyQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: max_expansions: description: Maximum number of variations created. default: 50.0 type: number prefix_length: description: Number of beginning characters left unchanged when creating expansions. default: 0.0 type: number rewrite: description: Number of beginning characters left unchanged when creating expansions. default: constant_score allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' transpositions: description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). default: true type: boolean fuzziness: description: Maximum edit distance allowed for matching. allOf: - $ref: '#/components/schemas/_types.Fuzziness' value: description: Term you wish to find in the provided field. oneOf: - type: string - type: number - type: boolean required: - value _types.Id: type: string _types.InnerRetriever: type: object properties: retriever: allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' weight: type: number normalizer: allOf: - $ref: '#/components/schemas/_types.ScoreNormalizer' required: - retriever - weight - normalizer _types.query_dsl.SparseVectorQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query allOf: - type: object properties: field: description: 'The name of the field that contains the token-weight pairs to be searched against. This field must be a mapped sparse_vector field.' allOf: - $ref: '#/components/schemas/_types.Field' query: description: 'The query text you want to use for search. If inference_id is specified, query must also be specified.' type: string prune: description: 'Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false' x-state: Generally available; Added in 8.15.0 type: boolean pruning_config: description: 'Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.' x-state: Generally available; Added in 8.15.0 allOf: - $ref: '#/components/schemas/_types.TokenPruningConfig' required: - field - type: object properties: query_vector: description: 'Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.' type: object additionalProperties: type: number inference_id: description: 'The inference ID to use to convert the query text into token-weight pairs. It must be the same inference ID that was used to create the tokens from the input text. Only one of inference_id and query_vector is allowed. If inference_id is specified, query must also be specified. Only one of inference_id or query_vector may be supplied in a request.' allOf: - $ref: '#/components/schemas/_types.Id' minProperties: 1 maxProperties: 1 ingest._types.IpLocationProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: database_file: description: The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. default: GeoLite2-City.mmdb type: string field: description: The field to get the ip address from for the geographical lookup. allOf: - $ref: '#/components/schemas/_types.Field' first_only: description: If `true`, only the first found IP location data will be returned, even if the field contains an array. default: true type: boolean ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean properties: description: Controls what properties are added to the `target_field` based on the IP location lookup. type: array items: type: string target_field: description: The field that will hold the geographical information looked up from the MaxMind database. default: geoip allOf: - $ref: '#/components/schemas/_types.Field' download_database_on_pipeline_creation: description: 'If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.' type: boolean required: - field _types.SlicedScroll: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' id: allOf: - $ref: '#/components/schemas/_types.Id' max: type: number required: - id - max _types.aggregations.SignificantTextAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: background_filter: description: A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' chi_square: description: Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.ChiSquareHeuristic' exclude: description: Values to exclude. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' execution_hint: description: Determines whether the aggregation will use field values directly or global ordinals. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint' field: description: The field from which to return significant text. allOf: - $ref: '#/components/schemas/_types.Field' filter_duplicate_text: description: Whether to out duplicate text to deal with noisy data. type: boolean gnd: description: Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic' include: description: Values to include. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' jlh: description: Use JLH score as the significance score. allOf: - $ref: '#/components/schemas/_types.EmptyObject' min_doc_count: description: Only return values that are found in more than `min_doc_count` hits. default: 3.0 type: number mutual_information: description: Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.MutualInformationHeuristic' percentage: description: A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentageScoreHeuristic' script_heuristic: description: Customized score, implemented via a script. allOf: - $ref: '#/components/schemas/_types.aggregations.ScriptedHeuristic' shard_min_doc_count: description: 'Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.' type: number shard_size: description: 'The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.' type: number size: description: The number of buckets returned out of the overall terms list. type: number source_fields: description: Overrides the JSON `_source` fields from which text will be analyzed. allOf: - $ref: '#/components/schemas/_types.Fields' _types.aggregations.SignificantTermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: background_filter: description: A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' chi_square: description: Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.ChiSquareHeuristic' exclude: description: Terms to exclude. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' execution_hint: description: 'Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint' field: description: The field from which to return significant terms. allOf: - $ref: '#/components/schemas/_types.Field' gnd: description: Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic' include: description: Terms to include. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' jlh: description: Use JLH score as the significance score. allOf: - $ref: '#/components/schemas/_types.EmptyObject' min_doc_count: description: Only return terms that are found in more than `min_doc_count` hits. default: 3.0 type: number mutual_information: description: Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.MutualInformationHeuristic' percentage: description: A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentageScoreHeuristic' script_heuristic: description: Customized score, implemented via a script. allOf: - $ref: '#/components/schemas/_types.aggregations.ScriptedHeuristic' p_value: description: 'Significant terms heuristic that calculates the p-value between the term existing in foreground and background sets. The p-value is the probability of obtaining test results at least as extreme as the results actually observed, under the assumption that the null hypothesis is correct. The p-value is calculated assuming that the foreground set and the background set are independent https://en.wikipedia.org/wiki/Bernoulli_trial, with the null hypothesis that the probabilities are the same.' allOf: - $ref: '#/components/schemas/_types.aggregations.PValueHeuristic' shard_min_doc_count: description: 'Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.' type: number shard_size: description: 'Can be used to control the volumes of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.' type: number size: description: The number of buckets returned out of the overall terms list. type: number _types.mapping.BinaryProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - binary required: - type _types.mapping.AggregateMetricDoubleProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - aggregate_metric_double default_metric: type: string ignore_malformed: type: boolean metrics: type: array items: type: string time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' required: - type - default_metric - metrics _types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: origin: description: 'Date or point of origin used to calculate distances. If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. Date Math, such as `now-1h`, is supported. If the field value is a `geo_point` field, the `origin` value must be a geopoint.' allOf: - $ref: '#/components/schemas/_types.GeoLocation' pivot: description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value. If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.' allOf: - $ref: '#/components/schemas/_types.Distance' field: description: 'Name of the field used to calculate distances. This field must meet the following criteria: be a `date`, `date_nanos` or `geo_point` field; have an `index` mapping parameter value of `true`, which is the default; have an `doc_values` mapping parameter value of `true`, which is the default.' allOf: - $ref: '#/components/schemas/_types.Field' required: - origin - pivot - field _types.query_dsl.MultiValueMode: type: string enum: - min - max - avg - sum _types.Sort: oneOf: - $ref: '#/components/schemas/_types.SortCombinations' - type: array items: $ref: '#/components/schemas/_types.SortCombinations' _types.query_dsl.TermsSetQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: minimum_should_match: description: Specification describing number of matching terms required to return a document. x-state: Generally available; Added in 8.10.0 allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' minimum_should_match_field: description: Numeric field containing the number of matching terms required to return a document. allOf: - $ref: '#/components/schemas/_types.Field' minimum_should_match_script: description: Custom script containing the number of matching terms required to return a document. allOf: - $ref: '#/components/schemas/_types.Script' terms: description: Array of terms you wish to find in the provided field. type: array items: $ref: '#/components/schemas/_types.FieldValue' required: - terms _types.aggregations.GoogleNormalizedDistanceHeuristic: type: object properties: background_is_superset: description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean _types.aggregations.TermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: collect_mode: description: 'Determines how child aggregations should be calculated: breadth-first or depth-first.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationCollectMode' exclude: description: 'Values to exclude. Accepts regular expressions and partitions.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' execution_hint: description: Determines whether the aggregation will use field values directly or global ordinals. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint' field: description: The field from which to return terms. allOf: - $ref: '#/components/schemas/_types.Field' include: description: 'Values to include. Accepts regular expressions and partitions.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' min_doc_count: description: Only return values that are found in more than `min_doc_count` hits. default: 1.0 type: number missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' missing_order: allOf: - $ref: '#/components/schemas/_types.aggregations.MissingOrder' missing_bucket: type: boolean value_type: description: Coerced unmapped fields into the specified type. type: string order: description: 'Specifies the sort order of the buckets. Defaults to sorting by descending document count.' allOf: - $ref: '#/components/schemas/_types.aggregations.AggregateOrder' script: allOf: - $ref: '#/components/schemas/_types.Script' shard_min_doc_count: description: 'Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.' type: number shard_size: description: 'The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.' type: number show_term_doc_count_error: description: Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. type: boolean size: description: The number of buckets returned out of the overall terms list. default: 10.0 type: number format: type: string _types.analysis.IcuCollationAlternate: type: string enum: - shifted - non-ignorable _types.query_dsl.ConstantScoreQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: filter: description: 'Filter query you wish to run. Any returned documents must match this query. Filter queries do not calculate relevance scores. To speed up performance, Elasticsearch automatically caches frequently used filter queries.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - filter _types.query_dsl.DateRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBaseDateMath' - type: object properties: format: description: Date format used to convert `date` values in the query. allOf: - $ref: '#/components/schemas/_types.DateFormat' time_zone: description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. allOf: - $ref: '#/components/schemas/_types.TimeZone' ingest._types.NetworkDirectionProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: source_ip: description: Field containing the source IP address. default: source.ip allOf: - $ref: '#/components/schemas/_types.Field' destination_ip: description: Field containing the destination IP address. default: destination.ip allOf: - $ref: '#/components/schemas/_types.Field' target_field: description: Output field for the network direction. default: network.direction allOf: - $ref: '#/components/schemas/_types.Field' internal_networks: description: 'List of internal networks. Supports IPv4 and IPv6 addresses and ranges in CIDR notation. Also supports the named ranges listed below. These may be constructed with template snippets. Must specify only one of internal_networks or internal_networks_field.' type: array items: type: string internal_networks_field: description: 'A field on the given document to read the internal_networks configuration from.' allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: 'If true and any required fields are missing, the processor quietly exits without modifying the document.' default: true type: boolean _types.query_dsl.MatchPhraseQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string query: description: Query terms that are analyzed and turned into a phrase query. type: string slop: description: Maximum number of positions allowed between matching tokens. default: 0.0 type: number zero_terms_query: description: Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. default: '''none''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery' required: - query _types.query_dsl.FunctionBoostMode: type: string enum: - multiply - replace - sum - avg - max - min _types.query_dsl.DateDecayFunction: allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBaseDateMathDuration' - type: object _types.query_dsl.DecayFunctionBasedoubledouble: type: object properties: multi_value_mode: description: Determines how the distance is calculated when a field used for computing the decay contains multiple values. default: min allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode' _types.query_dsl.HasParentQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: 'Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the `parent_type`.' default: false type: boolean inner_hits: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits description: If defined, each search hit will contain inner hits. allOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' parent_type: description: Name of the parent relationship mapped for the `join` field. allOf: - $ref: '#/components/schemas/_types.RelationName' query: description: 'Query you wish to run on parent documents of the `parent_type` field. If a parent document matches the search, the query returns its child documents.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' score: description: Indicates whether the relevance score of a matching parent document is aggregated into its child documents. default: false type: boolean required: - parent_type - query _types.query_dsl.SpanMultiTermQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: match: description: Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - match _types.SortOrder: type: string enum: - asc - desc _types.mapping.CountedKeywordProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - counted_keyword index: type: boolean required: - type ingest._types.ProcessorBase: type: object properties: description: description: 'Description of the processor. Useful for describing the purpose of the processor or its configuration.' type: string if: description: Conditionally execute the processor. allOf: - $ref: '#/components/schemas/_types.Script' ignore_failure: description: Ignore failures for the processor. type: boolean on_failure: description: Handle failures for the processor. type: array items: $ref: '#/components/schemas/ingest._types.ProcessorContainer' tag: description: 'Identifier for the processor. Useful for debugging and metrics.' type: string _types.query_dsl.RankFeatureQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: description: '`rank_feature` or `rank_features` field used to boost relevance scores.' allOf: - $ref: '#/components/schemas/_types.Field' saturation: description: Saturation function used to boost relevance scores based on the value of the rank feature `field`. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation' log: description: Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm' linear: description: Linear function used to boost relevance scores based on the value of the rank feature `field`. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear' sigmoid: description: Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid' required: - field _types.aggregations.HoltMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - holt settings: allOf: - $ref: '#/components/schemas/_types.aggregations.HoltLinearModelSettings' required: - model - settings ingest._types.RegisteredDomainProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: Field containing the source FQDN. allOf: - $ref: '#/components/schemas/_types.Field' target_field: description: 'Object field containing extracted domain components. If an empty string, the processor adds components to the document’s root.' allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: 'If true and any required fields are missing, the processor quietly exits without modifying the document.' default: true type: boolean required: - field _types.query_dsl.SpanFirstQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: end: description: Controls the maximum end position permitted in a match. type: number match: description: Can be any other span type query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - end - match _types.query_dsl.MatchBoolPrefixQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string fuzziness: description: 'Maximum edit distance allowed for matching. Can be applied to the term subqueries constructed for all terms but the final term.' allOf: - $ref: '#/components/schemas/_types.Fuzziness' fuzzy_rewrite: description: 'Method used to rewrite the query. Can be applied to the term subqueries constructed for all terms but the final term.' allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' fuzzy_transpositions: description: 'If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). Can be applied to the term subqueries constructed for all terms but the final term.' default: true type: boolean max_expansions: description: 'Maximum number of terms to which the query will expand. Can be applied to the term subqueries constructed for all terms but the final term.' default: 50.0 type: number minimum_should_match: description: 'Minimum number of clauses that must match for a document to be returned. Applied to the constructed bool query.' allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' operator: description: 'Boolean logic used to interpret text in the query value. Applied to the constructed bool query.' default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' prefix_length: description: 'Number of beginning characters left unchanged for fuzzy matching. Can be applied to the term subqueries constructed for all terms but the final term.' default: 0.0 type: number query: description: 'Terms you wish to find in the provided field. The last term is used in a prefix query.' type: string required: - query _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. oneOf: - $ref: '#/components/schemas/_types.Id' - 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: description: The retriever whose results rules should be applied to. allOf: - $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 _types.analysis.StopWordLanguage: type: string enum: - _arabic_ - _armenian_ - _basque_ - _bengali_ - _brazilian_ - _bulgarian_ - _catalan_ - _cjk_ - _czech_ - _danish_ - _dutch_ - _english_ - _estonian_ - _finnish_ - _french_ - _galician_ - _german_ - _greek_ - _hindi_ - _hungarian_ - _indonesian_ - _irish_ - _italian_ - _latvian_ - _lithuanian_ - _norwegian_ - _persian_ - _portuguese_ - _romanian_ - _russian_ - _serbian_ - _sorani_ - _spanish_ - _swedish_ - _thai_ - _turkish_ - _none_ _types.query_dsl.FieldValueFactorModifier: type: string enum: - none - log - log1p - log2p - ln - ln1p - ln2p - square - sqrt - reciprocal _types.GeoHashPrecision: description: A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". oneOf: - type: number - type: string _types.mapping.RankVectorElementType: type: string enum: - byte - float - bit _types.Fields: oneOf: - $ref: '#/components/schemas/_types.Field' - type: array items: $ref: '#/components/schemas/_types.Field' _types.ulong: type: number _types.mapping.CompletionProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: analyzer: type: string contexts: type: array items: $ref: '#/components/schemas/_types.mapping.SuggestContext' max_input_length: type: number preserve_position_increments: type: boolean preserve_separators: type: boolean search_analyzer: type: string type: type: string enum: - completion required: - type _types.mapping.JoinProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: relations: type: object additionalProperties: oneOf: - $ref: '#/components/schemas/_types.RelationName' - type: array items: $ref: '#/components/schemas/_types.RelationName' eager_global_ordinals: type: boolean type: type: string enum: - join required: - type _types.query_dsl.SpanNearQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: clauses: description: Array of one or more other span type queries. type: array items: $ref: '#/components/schemas/_types.query_dsl.SpanQuery' in_order: description: Controls whether matches are required to be in-order. type: boolean slop: description: Controls the maximum number of intervening unmatched positions permitted. type: number required: - clauses _global.search._types.ScoreMode: type: string enum: - avg - max - min - multiply - total _types.aggregations.PercentageScoreHeuristic: type: object _types.mapping.SyntheticSourceKeepEnum: type: string enum: - none - arrays - all _types.mapping.PointProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: ignore_malformed: type: boolean ignore_z_value: type: boolean null_value: type: string type: type: string enum: - point required: - type _types.mapping.GeoPointMetricType: type: string enum: - gauge - counter - position _types.query_dsl.IntervalsFuzzy: type: object properties: analyzer: description: Analyzer used to normalize the term. type: string fuzziness: description: Maximum edit distance allowed for matching. default: auto allOf: - $ref: '#/components/schemas/_types.Fuzziness' prefix_length: description: Number of beginning characters left unchanged when creating expansions. default: 0.0 type: number term: description: The term to match. type: string transpositions: description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). default: true type: boolean use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' required: - term _types.aggregations.MutualInformationHeuristic: type: object properties: background_is_superset: description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean include_negatives: description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. type: boolean _types.aggregations.GeoLineAggregation: type: object properties: point: description: The name of the geo_point field. allOf: - $ref: '#/components/schemas/_types.aggregations.GeoLinePoint' sort: description: 'The name of the numeric field to use as the sort key for ordering the points. When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeoLineSort' include_sort: description: When `true`, returns an additional array of the sort values in the feature properties. type: boolean sort_order: description: The order in which the line is sorted (ascending or descending). default: asc allOf: - $ref: '#/components/schemas/_types.SortOrder' size: description: 'The maximum length of the line represented in the aggregation. Valid sizes are between 1 and 10000.' default: 10000.0 type: number required: - point _types.PinnedRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retriever: description: Inner retriever. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' ids: type: array items: type: string docs: type: array items: $ref: '#/components/schemas/_types.SpecifiedDocument' rank_window_size: type: number required: - retriever _types.RRFRetrieverComponent: description: Wraps a retriever with an optional weight for RRF scoring. type: object properties: retriever: description: The nested retriever configuration. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' weight: description: Weight multiplier for this retriever's contribution to the RRF score. Higher values increase influence. Defaults to 1.0 if not specified. Must be non-negative. default: 1.0 type: number required: - retriever ingest._types.InferenceConfigClassification: type: object properties: num_top_classes: description: Specifies the number of top class predictions to return. default: 0.0 type: number num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. default: 0.0 type: number results_field: description: The field that is added to incoming documents to contain the inference prediction. default: _prediction allOf: - $ref: '#/components/schemas/_types.Field' top_classes_results_field: description: Specifies the field to which the top classes are written. default: top_classes allOf: - $ref: '#/components/schemas/_types.Field' prediction_field_type: description: 'Specifies the type of the predicted field to write. Valid values are: `string`, `number`, `boolean`.' type: string _types.ScriptField: type: object properties: script: allOf: - $ref: '#/components/schemas/_types.Script' ignore_failure: type: boolean required: - script _types.mapping.DateNanosProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number format: type: string ignore_malformed: type: boolean index: type: boolean script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' null_value: allOf: - $ref: '#/components/schemas/_types.DateTime' precision_step: type: number type: type: string enum: - date_nanos required: - type _types.aggregations.EwmaMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - ewma settings: allOf: - $ref: '#/components/schemas/_types.aggregations.EwmaModelSettings' required: - model - settings _types.query_dsl.CombinedFieldsOperator: type: string enum: - or - and _types.aggregations.AutoDateHistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: buckets: description: The target number of buckets. default: 10.0 type: number field: description: The field on which to run the aggregation. allOf: - $ref: '#/components/schemas/_types.Field' format: description: 'The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used.' type: string minimum_interval: description: 'The minimum rounding interval. This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`.' oneOf: - $ref: '#/components/schemas/_types.aggregations.MinimumInterval' - type: - string - 'null' missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.DateTime' offset: description: Time zone specified as a ISO 8601 UTC offset. type: string params: type: object additionalProperties: type: object script: allOf: - $ref: '#/components/schemas/_types.Script' time_zone: description: Time zone ID. allOf: - $ref: '#/components/schemas/_types.TimeZone' _types.aggregations.PercentileRanksAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: keyed: description: 'By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to `false` to disable this behavior.' default: true type: boolean values: description: An array of values for which to calculate the percentile ranks. oneOf: - type: array items: type: number - type: - string - 'null' hdr: description: Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. allOf: - $ref: '#/components/schemas/_types.aggregations.HdrMethod' tdigest: description: Sets parameters for the default TDigest algorithm used to calculate percentile ranks. allOf: - $ref: '#/components/schemas/_types.aggregations.TDigest' _types.query_dsl.Operator: type: string enum: - and - AND - or - OR _types.query_dsl.RuleQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: organic: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' ruleset_ids: oneOf: - $ref: '#/components/schemas/_types.Id' - type: array items: $ref: '#/components/schemas/_types.Id' ruleset_id: type: string match_criteria: type: object required: - organic - match_criteria _types.mapping.DenseVectorIndexOptionsType: type: string enum: - bbq_flat - bbq_hnsw - bbq_disk - flat - hnsw - int4_flat - int4_hnsw - int8_flat - int8_hnsw ml._types.ClassificationInferenceOptions: type: object properties: num_top_classes: description: Specifies the number of top class predictions to return. Defaults to 0. type: number num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. default: 0.0 type: number prediction_field_type: description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.' type: string results_field: description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. type: string top_classes_results_field: description: Specifies the field to which the top classes are written. Defaults to top_classes. type: string _types.query_dsl.RankFeatureFunctionLinear: allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction' - type: object _types.RrfRank: allOf: - $ref: '#/components/schemas/_types.RankBase' - type: object properties: rank_constant: description: How much influence documents in individual result sets per query have over the final ranked result set type: number rank_window_size: description: Size of the individual result sets per query type: number _types.aggregations.PipelineAggregationBase: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation' - type: object properties: format: description: '`DecimalFormat` pattern for the output value. If specified, the formatted value is returned in the aggregation’s `value_as_string` property.' type: string gap_policy: description: Policy to apply when gaps are found in the data. default: skip allOf: - $ref: '#/components/schemas/_types.aggregations.GapPolicy' _types.KnnSearch: type: object properties: field: description: The name of the vector field to search against allOf: - $ref: '#/components/schemas/_types.Field' query_vector: description: The query vector allOf: - $ref: '#/components/schemas/_types.QueryVector' query_vector_builder: description: The query vector builder. You must provide a query_vector_builder or query_vector, but not both. allOf: - $ref: '#/components/schemas/_types.QueryVectorBuilder' k: description: The final number of nearest neighbors to return as top hits type: number num_candidates: description: The number of nearest neighbor candidates to consider per shard type: number visit_percentage: description: The percentage of vectors to explore per shard while doing knn search with bbq_disk x-state: Generally available; Added in 9.2.0 type: number boost: description: Boost value to apply to kNN scores type: number filter: description: Filters for the kNN search query oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' similarity: description: The minimum similarity for a vector to be considered a match type: number inner_hits: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits description: If defined, each search hit will contain inner hits. allOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' rescore_vector: description: Apply oversampling and rescoring to quantized vectors x-state: Generally available; Added in 8.18.0 allOf: - $ref: '#/components/schemas/_types.RescoreVector' _name: type: string required: - field _types.query_dsl.FunctionScoreQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: boost_mode: description: Defines how he newly computed score is combined with the score of the query default: multiply allOf: - $ref: '#/components/schemas/_types.query_dsl.FunctionBoostMode' functions: description: One or more functions that compute a new score for each document returned by the query. type: array items: $ref: '#/components/schemas/_types.query_dsl.FunctionScoreContainer' max_boost: description: Restricts the new score to not exceed the provided limit. type: number min_score: description: Excludes documents that do not meet the provided score threshold. type: number query: description: A query that determines the documents for which a new score is computed. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' score_mode: description: Specifies how the computed scores are combined default: multiply allOf: - $ref: '#/components/schemas/_types.query_dsl.FunctionScoreMode' _types.mapping.CompositeSubField: type: object properties: type: allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeFieldType' required: - type _types.query_dsl.GeoShapeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: 'Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped.' default: false type: boolean _types.mapping.RankFeatureProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: positive_score_impact: type: boolean type: type: string enum: - rank_feature required: - type _types.mapping.SparseVectorProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: store: type: boolean type: type: string enum: - sparse_vector index_options: description: 'Additional index options for the sparse vector field that controls the token pruning behavior of the sparse vector field.' x-state: Generally available; Added in 8.19.0 allOf: - $ref: '#/components/schemas/_types.mapping.SparseVectorIndexOptions' required: - type _types.aggregations.MovingFunctionAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: script: description: The script that should be executed on each window of data. type: string shift: description: 'By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right.' default: 0.0 type: number window: description: The size of window to "slide" across the histogram. type: number _types.query_dsl.FieldAndFormat: description: A reference to a field with formatting instructions on how to return the value type: object properties: field: description: A wildcard pattern. The request returns values for field names matching this pattern. allOf: - $ref: '#/components/schemas/_types.Field' format: description: The format in which the values are returned. type: string include_unmapped: type: boolean required: - field _types.GeoHexCell: description: A map hex cell (H3) reference type: string _types.aggregations.TopMetricsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: metrics: description: The fields of the top document to return. oneOf: - $ref: '#/components/schemas/_types.aggregations.TopMetricsValue' - type: array items: $ref: '#/components/schemas/_types.aggregations.TopMetricsValue' size: description: The number of top documents from which to return metrics. default: 1.0 type: number sort: description: The sort order of the documents. allOf: - $ref: '#/components/schemas/_types.Sort' _types.GeoHashLocation: type: object properties: geohash: allOf: - $ref: '#/components/schemas/_types.GeoHash' required: - geohash _types.SortOptions: type: object properties: _score: allOf: - $ref: '#/components/schemas/_types.ScoreSort' _doc: allOf: - $ref: '#/components/schemas/_types.ScoreSort' _geo_distance: allOf: - $ref: '#/components/schemas/_types.GeoDistanceSort' _script: allOf: - $ref: '#/components/schemas/_types.ScriptSort' minProperties: 1 maxProperties: 1 _types.aggregations.BoxplotAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number execution_hint: description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases). To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.' default: default allOf: - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint' _types.ByteSize: oneOf: - type: number - type: string _types.mapping.ShortNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - short null_value: allOf: - $ref: '#/components/schemas/_types.short' required: - type _types.query_dsl.TermsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object ingest._types.KeyValueProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: exclude_keys: description: List of keys to exclude from document. type: array items: type: string field: description: 'The field to be parsed. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Field' field_split: description: Regex pattern to use for splitting key-value pairs. type: string ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean include_keys: description: 'List of keys to filter and insert into document. Defaults to including all keys.' type: array items: type: string prefix: description: Prefix to be added to extracted keys. default: 'null' type: string strip_brackets: description: If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. default: false type: boolean target_field: description: 'The field to insert the extracted keys into. Defaults to the root of the document. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Field' trim_key: description: String of characters to trim from extracted keys. type: string trim_value: description: String of characters to trim from extracted values. type: string value_split: description: Regex pattern to use for splitting the key from the value within a key-value pair. type: string required: - field - field_split - value_split _global.search._types.BoundaryScanner: type: string enum: - chars - sentence - word text_structure._types.FormatType: type: string enum: - delimited - ndjson - semi_structured_text - xml _types.ScoreNormalizer: type: string enum: - none - minmax - l2_norm ingest._types.CircleProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: error_distance: description: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). type: number field: description: The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean shape_type: description: 'Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`.' allOf: - $ref: '#/components/schemas/ingest._types.ShapeType' target_field: description: 'The field to assign the polygon shape to By default, the field is updated in-place.' allOf: - $ref: '#/components/schemas/_types.Field' required: - error_distance - field - shape_type _types.aggregations.GeohexGridAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: 'Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geohex_grid` aggregates all array values.' allOf: - $ref: '#/components/schemas/_types.Field' precision: description: 'Integer zoom of the key used to defined cells or buckets in the results. Value should be between 0-15.' default: 6.0 type: number bounds: description: Bounding box used to filter the geo-points in each bucket. allOf: - $ref: '#/components/schemas/_types.GeoBounds' size: description: Maximum number of buckets to return. default: 10000.0 type: number shard_size: description: Number of buckets returned from each shard. type: number required: - field _types.Field: description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields. type: string _types.mapping.DynamicMapping: type: string enum: - strict - runtime - 'true' - 'false' _types.query_dsl.RankFeatureFunctionSaturation: allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction' - type: object properties: pivot: description: Configurable pivot value so that the result will be less than 0.5. type: number _types.aggregations.StatsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.mapping.TermVectorOption: type: string enum: - 'no' - 'yes' - with_offsets - with_positions - with_positions_offsets - with_positions_offsets_payloads - with_positions_payloads _types.GeoDistanceSort: type: object properties: mode: allOf: - $ref: '#/components/schemas/_types.SortMode' distance_type: allOf: - $ref: '#/components/schemas/_types.GeoDistanceType' ignore_unmapped: type: boolean order: allOf: - $ref: '#/components/schemas/_types.SortOrder' unit: allOf: - $ref: '#/components/schemas/_types.DistanceUnit' nested: allOf: - $ref: '#/components/schemas/_types.NestedSortValue' ingest._types.InferenceConfig: type: object properties: regression: description: Regression configuration for inference. allOf: - $ref: '#/components/schemas/ingest._types.InferenceConfigRegression' classification: description: Classification configuration for inference. allOf: - $ref: '#/components/schemas/ingest._types.InferenceConfigClassification' minProperties: 1 maxProperties: 1 _types.mapping.SemanticTextIndexOptions: type: object properties: dense_vector: allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorIndexOptions' sparse_vector: allOf: - $ref: '#/components/schemas/_types.mapping.SparseVectorIndexOptions' _types.DateMath: type: string ingest._types.AttachmentProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to get the base64 encoded field from. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and field does not exist, the processor quietly exits without modifying the document. default: false type: boolean indexed_chars: description: 'The number of chars being used for extraction to prevent huge fields. Use `-1` for no limit.' default: 100000.0 type: number indexed_chars_field: description: Field name from which you can overwrite the number of chars being used for extraction. default: 'null' allOf: - $ref: '#/components/schemas/_types.Field' max_field_bytes: description: 'Maximum allowed size of the attachment `field` value in bytes: length of a string (if base64 in JSON, checked before base64 decoding) or byte array length for binary (for example, CBOR). If set to `-1`, there is no per-processor limit. The node setting `ingest.attachment.max_field_size` also applies.' default: '-1' x-state: Generally available; Added in 9.5.0 allOf: - $ref: '#/components/schemas/_types.ByteSize' properties: description: 'Array of properties to select to be stored. Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`.' type: array items: type: string target_field: description: The field that will hold the attachment information. default: attachment allOf: - $ref: '#/components/schemas/_types.Field' remove_binary: description: If true, the binary field will be removed from the document default: false type: boolean resource_name: description: 'Field containing the name of the resource to decode. If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.' type: string required: - field _types.mapping.RuntimeFields: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.RuntimeField' _types.TimeZone: type: string _types.query_dsl.MatchPhrasePrefixQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert text in the query value into tokens. type: string max_expansions: description: Maximum number of terms to which the last provided term of the query value will expand. default: 50.0 type: number query: description: Text you wish to find in the provided field. type: string slop: description: Maximum number of positions allowed between matching tokens. default: 0.0 type: number zero_terms_query: description: Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. default: none allOf: - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery' required: - query _types.aggregations.CartesianCentroidAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object _types.Embedding: type: object properties: inference_id: type: string input: allOf: - $ref: '#/components/schemas/_types.KnnEmbeddingInput' timeout: allOf: - $ref: '#/components/schemas/_types.Duration' required: - input _types.GeoShapeRelation: type: string enum: - intersects - disjoint - within - contains _types.mapping.ObjectProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: enabled: type: boolean subobjects: allOf: - $ref: '#/components/schemas/_types.mapping.Subobjects' type: type: string enum: - object _types.query_dsl.SpanTermQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: value: allOf: - $ref: '#/components/schemas/_types.FieldValue' required: - value _types.CoordsGeoBounds: type: object properties: top: type: number bottom: type: number left: type: number right: type: number required: - top - bottom - left - right _types.query_dsl.MultiMatchQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string auto_generate_synonyms_phrase_query: description: If `true`, match phrase queries are automatically created for multi-term synonyms. default: true type: boolean cutoff_frequency: deprecated: true type: number fields: description: 'The fields to be queried. Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`.' allOf: - $ref: '#/components/schemas/_types.Fields' fuzziness: description: Maximum edit distance allowed for matching. allOf: - $ref: '#/components/schemas/_types.Fuzziness' fuzzy_rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' fuzzy_transpositions: description: 'If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). Can be applied to the term subqueries constructed for all terms but the final term.' default: true type: boolean lenient: description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. default: false type: boolean max_expansions: description: Maximum number of terms to which the query will expand. default: 50.0 type: number minimum_should_match: description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' operator: description: Boolean logic used to interpret text in the query value. default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. default: 0.0 type: number query: description: Text, number, boolean value or date you wish to find in the provided field. type: string slop: description: Maximum number of positions allowed between matching tokens. default: 0.0 type: number tie_breaker: description: Determines how scores for each per-term blended query and scores across groups are combined. default: 0.0 type: number type: description: How `the` multi_match query is executed internally. default: '''best_fields''' allOf: - $ref: '#/components/schemas/_types.query_dsl.TextQueryType' zero_terms_query: description: Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. default: '''none''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery' required: - query ingest._types.DissectProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: append_separator: description: The character(s) that separate the appended fields. default: '""' type: string field: description: The field to dissect. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean pattern: description: The pattern to apply to the field. type: string required: - field - pattern _types.InferenceStringGroup: oneOf: - $ref: '#/components/schemas/_types.InferenceString' - type: array items: $ref: '#/components/schemas/_types.InferenceString' _types.query_dsl.GeoExecution: type: string enum: - memory - indexed _types.aggregations.MetricAggregationBase: type: object properties: field: description: The field on which to run the aggregation. allOf: - $ref: '#/components/schemas/_types.Field' missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' script: allOf: - $ref: '#/components/schemas/_types.Script' _types.query_dsl.UntypedDistanceFeatureQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBase' - type: object _types.Script: type: object properties: source: description: The script source. allOf: - $ref: '#/components/schemas/_types.ScriptSource' id: description: The `id` for a stored script. allOf: - $ref: '#/components/schemas/_types.Id' params: description: 'Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.' type: object additionalProperties: type: object lang: description: Specifies the language the script is written in. default: painless allOf: - $ref: '#/components/schemas/_types.ScriptLanguage' options: type: object additionalProperties: type: string _types.query_dsl.ChildScoreMode: type: string enum: - none - avg - sum - max - min _types.GeoLocation: description: 'A latitude/longitude as a 2 dimensional point. It can be represented in various ways: - as a `{lat, long}` object - as a geo hash value - as a `[lon, lat]` array - as a string in `", "` or WKT point formats' oneOf: - $ref: '#/components/schemas/_types.LatLonGeoLocation' - $ref: '#/components/schemas/_types.GeoHashLocation' - type: array items: type: number - type: string _types.mapping.DateProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number fielddata: allOf: - $ref: '#/components/schemas/indices._types.NumericFielddata' format: type: string ignore_malformed: type: boolean index: type: boolean script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' null_value: allOf: - $ref: '#/components/schemas/_types.DateTime' precision_step: type: number locale: type: string type: type: string enum: - date required: - type _types.aggregations.CompositeAggregationBase: type: object properties: field: description: Either `field` or `script` must be present allOf: - $ref: '#/components/schemas/_types.Field' missing_bucket: type: boolean missing_order: allOf: - $ref: '#/components/schemas/_types.aggregations.MissingOrder' script: description: Either `field` or `script` must be present allOf: - $ref: '#/components/schemas/_types.Script' value_type: allOf: - $ref: '#/components/schemas/_types.aggregations.ValueType' order: allOf: - $ref: '#/components/schemas/_types.SortOrder' _types.aggregations.MatrixStatsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MatrixAggregation' - type: object properties: mode: description: Array value the aggregation will use for array or multi-valued fields. default: avg allOf: - $ref: '#/components/schemas/_types.SortMode' _types.aggregations.TTestAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: a: description: Test population A. allOf: - $ref: '#/components/schemas/_types.aggregations.TestPopulation' b: description: Test population B. allOf: - $ref: '#/components/schemas/_types.aggregations.TestPopulation' type: description: The type of test. default: heteroscedastic allOf: - $ref: '#/components/schemas/_types.aggregations.TTestType' _types.aggregations.ScriptedHeuristic: type: object properties: script: allOf: - $ref: '#/components/schemas/_types.Script' required: - script _types.mapping.RuntimeFieldFetchFields: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' format: type: string required: - field _types.aggregations.FrequentItemSetsAggregation: type: object properties: fields: description: Fields to analyze. type: array items: $ref: '#/components/schemas/_types.aggregations.FrequentItemSetsField' minimum_set_size: description: The minimum size of one item set. default: 1.0 type: number minimum_support: description: The minimum support of one item set. default: 0.1 type: number size: description: The number of top item sets to return. default: 10.0 type: number filter: description: Query that filters documents from analysis. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - fields _types.aggregations.FiltersAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: filters: description: Collection of queries from which to build buckets. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketsQueryContainer' other_bucket: description: Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. type: boolean other_bucket_key: description: The key with which the other bucket is returned. default: _other_ type: string keyed: description: 'By default, the named filters aggregation returns the buckets as an object. Set to `false` to return the buckets as an array of objects.' default: true type: boolean _types.mapping.RangePropertyBase: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number coerce: type: boolean index: type: boolean _types.query_dsl.IntervalsAnyOf: type: object properties: intervals: description: An array of rules to match. type: array items: $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' filter: description: Rule used to filter returned intervals. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter' required: - intervals _types.aggregations.PValueHeuristic: type: object properties: background_is_superset: type: boolean normalize_above: description: 'Should the results be normalized when above the given value. Allows for consistent significance results at various scales. Note: `0` is a special value which means no normalization' default: 0.0 type: number _types.aggregations.BucketCorrelationAggregation: description: A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation' - type: object properties: function: description: The correlation function to execute. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunction' required: - function _types.GeoTile: description: A map tile reference, represented as `{zoom}/{x}/{y}` type: string text_structure.test_grok_pattern.MatchedText: type: object properties: matched: type: boolean fields: type: object additionalProperties: type: array items: $ref: '#/components/schemas/text_structure.test_grok_pattern.MatchedField' required: - matched _global.search._types.HighlighterType: anyOf: - type: string enum: - plain - fvh - unified - type: string _types.WktGeoBounds: type: object properties: wkt: type: string required: - wkt _types.aggregations.ChangePointAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.mapping.RuntimeFieldType: type: string enum: - boolean - composite - date - double - geo_point - geo_shape - ip - keyword - long - lookup _types.query_dsl.CombinedFieldsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: fields: description: List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. type: array items: $ref: '#/components/schemas/_types.Field' query: description: 'Text to search for in the provided `fields`. The `combined_fields` query analyzes the provided text before performing a search.' type: string auto_generate_synonyms_phrase_query: description: If true, match phrase queries are automatically created for multi-term synonyms. default: true type: boolean operator: description: Boolean logic used to interpret text in the query value. default: or allOf: - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsOperator' minimum_should_match: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' zero_terms_query: description: Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. default: none allOf: - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms' required: - fields - query _types.TextEmbedding: type: object properties: model_id: description: 'Model ID is required for all dense_vector fields but may be inferred for semantic_text fields' x-state: Generally available; Added in 8.18.0 type: string model_text: description: The text to be converted into a vector by the specified model type: string required: - model_text _types.mapping.FloatRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - float_range required: - type _types.RescorerRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retriever: description: Inner retriever. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' rescore: oneOf: - $ref: '#/components/schemas/_global.search._types.Rescore' - type: array items: $ref: '#/components/schemas/_global.search._types.Rescore' required: - retriever - rescore _types.query_dsl.DistanceFeatureQuery: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query oneOf: - $ref: '#/components/schemas/_types.query_dsl.UntypedDistanceFeatureQuery' - $ref: '#/components/schemas/_types.query_dsl.GeoDistanceFeatureQuery' - $ref: '#/components/schemas/_types.query_dsl.DateDistanceFeatureQuery' ingest._types.LowercaseProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to make lowercase. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean target_field: description: 'The field to assign the converted value to. By default, the field is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.mapping.SemanticTextProperty: type: object properties: type: type: string enum: - semantic_text meta: type: object additionalProperties: type: string inference_id: description: 'Inference endpoint that will be used to generate embeddings for the field. This parameter cannot be updated. Use the Create inference API to create the endpoint. If `search_inference_id` is specified, the inference endpoint will only be used at index time. If the `inference_id` is not specified, it will default to `.jina-embeddings-v5-text-small` if the cluster is authorized to use the Elastic Inference Service, otherwise it will default to `.elser-2-elasticsearch`. The `.elser-2-elasticsearch` inference endpoint relies on a local ML node to run the ELSER model.' default: .jina-embeddings-v5-text-small allOf: - $ref: '#/components/schemas/_types.Id' search_inference_id: description: 'Inference endpoint that will be used to generate embeddings at query time. You can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint. If not specified, the inference endpoint defined by inference_id will be used at both index and query time.' allOf: - $ref: '#/components/schemas/_types.Id' index_options: description: 'Settings for index_options that override any defaults used by semantic_text, for example specific quantization settings.' allOf: - $ref: '#/components/schemas/_types.mapping.SemanticTextIndexOptions' chunking_settings: description: 'Settings for chunking text into smaller passages. If specified, these will override the chunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated, they will not be applied to existing documents until they are reindexed.' oneOf: - $ref: '#/components/schemas/_types.mapping.ChunkingSettings' - type: - string - 'null' fields: description: 'Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.' type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' required: - type _types.aggregations.CartesianBoundsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object _types.GeoBounds: description: 'A geo bounding box. It can be represented in various ways: - as 4 top/bottom/left/right coordinates - as 2 top_left / bottom_right points - as 2 top_right / bottom_left points - as a WKT bounding box' oneOf: - $ref: '#/components/schemas/_types.CoordsGeoBounds' - $ref: '#/components/schemas/_types.TopLeftBottomRightGeoBounds' - $ref: '#/components/schemas/_types.TopRightBottomLeftGeoBounds' - $ref: '#/components/schemas/_types.WktGeoBounds' _global.search._types.SearchRequestBody: type: object properties: aggregations: externalDocs: url: https://www.elastic.co/docs/explore-analyze/query-filter/aggregations description: Defines the aggregations that are run as part of the search request. type: object additionalProperties: $ref: '#/components/schemas/_types.aggregations.AggregationContainer' collapse: description: Collapses search results the values of the specified field. allOf: - $ref: '#/components/schemas/_global.search._types.FieldCollapse' explain: description: If `true`, the request returns detailed information about score computation as part of a hit. default: false type: boolean ext: description: Configuration of search extensions defined by Elasticsearch plugins. type: object additionalProperties: type: object from: description: 'The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.' default: 0.0 type: number highlight: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting description: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. allOf: - $ref: '#/components/schemas/_global.search._types.Highlight' track_total_hits: description: 'Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.' default: '10000' allOf: - $ref: '#/components/schemas/_global.search._types.TrackHits' indices_boost: externalDocs: url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores description: 'Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score.' type: array items: type: object additionalProperties: type: number minProperties: 1 maxProperties: 1 docvalue_fields: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields description: 'An array of wildcard (`*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response.' type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' knn: externalDocs: url: https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn description: The approximate kNN search to run. x-state: Generally available; Added in 8.4.0 oneOf: - $ref: '#/components/schemas/_types.KnnSearch' - type: array items: $ref: '#/components/schemas/_types.KnnSearch' rank: description: The Reciprocal Rank Fusion (RRF) to use. x-state: Generally available; Added in 8.8.0 allOf: - $ref: '#/components/schemas/_types.RankContainer' min_score: description: 'The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results or results collected by aggregations.' type: number post_filter: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/filter-search-results description: 'Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' profile: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-profile description: 'Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.' default: false type: boolean query: externalDocs: url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl description: The search definition using the Query DSL. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' rescore: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/rescore-search-results description: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. oneOf: - $ref: '#/components/schemas/_global.search._types.Rescore' - type: array items: $ref: '#/components/schemas/_global.search._types.Rescore' retriever: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers 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`.' x-state: Generally available; Added in 8.14.0 allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' script_fields: description: Retrieve a script evaluation (based on different fields) for each hit. type: object additionalProperties: $ref: '#/components/schemas/_types.ScriptField' search_after: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after description: Used to retrieve the next page of hits using a set of sort values from the previous page. allOf: - $ref: '#/components/schemas/_types.SortResults' size: description: 'The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property.' default: 10.0 type: number slice: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#slice-scroll description: Split a scrolled search into multiple slices that can be consumed independently. allOf: - $ref: '#/components/schemas/_types.SlicedScroll' sort: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results description: A comma-separated list of : pairs. allOf: - $ref: '#/components/schemas/_types.Sort' _source: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering description: 'The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. If the `stored_fields` property is specified, the `_source` property defaults to `false`. Otherwise, it defaults to `true`.' allOf: - $ref: '#/components/schemas/_global.search._types.SourceConfig' fields: description: 'An array of wildcard (`*`) field patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response.' type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' suggest: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-suggesters description: Defines a suggester that provides similar looking terms based on a provided text. allOf: - $ref: '#/components/schemas/_global.search._types.Suggester' terminate_after: description: 'The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early.' default: 0.0 type: number timeout: description: 'The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.' type: string track_scores: description: If `true`, calculate and return document scores, even if the scores are not used for sorting. default: false type: boolean version: description: If `true`, the request returns the document version as part of a hit. default: false type: boolean seq_no_primary_term: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control description: If `true`, the request returns sequence number and primary term of the last modification of each hit. type: boolean stored_fields: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields description: 'A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` property defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response.' allOf: - $ref: '#/components/schemas/_types.Fields' pit: description: 'Limit the search to a point in time (PIT). If you provide a PIT, you cannot specify an `` in the request path.' allOf: - $ref: '#/components/schemas/_global.search._types.PointInTimeReference' runtime_mappings: externalDocs: url: https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request description: 'One or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.' allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeFields' stats: description: 'The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.' type: array items: type: string _types.mapping.IpProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number index: type: boolean ignore_malformed: type: boolean null_value: type: string on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' script: allOf: - $ref: '#/components/schemas/_types.Script' time_series_dimension: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. x-state: Experimental type: boolean type: type: string enum: - ip required: - type _types.TopLeftBottomRightGeoBounds: type: object properties: top_left: allOf: - $ref: '#/components/schemas/_types.GeoLocation' bottom_right: allOf: - $ref: '#/components/schemas/_types.GeoLocation' required: - top_left - bottom_right _types.query_dsl.IntervalsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query type: object properties: all_of: description: Returns matches that span a combination of other rules. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsAllOf' any_of: description: Returns intervals produced by any of its sub-rules. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsAnyOf' fuzzy: description: Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFuzzy' match: description: Matches analyzed text. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsMatch' prefix: description: Matches terms that start with a specified set of characters. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsPrefix' range: allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsRange' regexp: allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsRegexp' wildcard: description: Matches terms using a wildcard pattern. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsWildcard' minProperties: 1 maxProperties: 1 _types.NestedSortValue: type: object properties: filter: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' max_children: type: number nested: allOf: - $ref: '#/components/schemas/_types.NestedSortValue' path: allOf: - $ref: '#/components/schemas/_types.Field' required: - path _types.query_dsl.RankFeatureFunction: type: object _global.search._types.SourceFilter: type: object properties: exclude_vectors: description: 'If `true`, vector fields are excluded from the returned source. This option takes precedence over `includes`: any vector field will remain excluded even if it matches an `includes` rule.' type: boolean excludes: description: A list of fields to exclude from the returned source. allOf: - $ref: '#/components/schemas/_types.Fields' includes: description: A list of fields to include in the returned source. allOf: - $ref: '#/components/schemas/_types.Fields' _types.QueryVectorBuilder: type: object properties: embedding: allOf: - $ref: '#/components/schemas/_types.Embedding' text_embedding: allOf: - $ref: '#/components/schemas/_types.TextEmbedding' lookup: description: 'Lookup a vector from an existing document. Must reference a dense_vector field and a single value.' x-state: Generally available; Added in 9.4.0 allOf: - $ref: '#/components/schemas/_types.LookupQueryVectorBuilder' minProperties: 1 maxProperties: 1 _types.query_dsl.SpanNotQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: dist: description: 'The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both `pre` and `post`.' type: number exclude: description: Span query whose matches must not overlap those returned. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' include: description: Span query whose matches are filtered. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' post: description: The number of tokens after the include span that can’t have overlap with the exclude span. default: 0.0 type: number pre: description: The number of tokens before the include span that can’t have overlap with the exclude span. default: 0.0 type: number required: - exclude - include _types.mapping.TokenCountProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: analyzer: type: string boost: type: number index: type: boolean null_value: type: number enable_position_increments: type: boolean type: type: string enum: - token_count required: - type _types.aggregations.MovingAverageAggregationBase: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: minimize: type: boolean predict: type: number window: type: number _types.Ids: oneOf: - $ref: '#/components/schemas/_types.Id' - type: array items: $ref: '#/components/schemas/_types.Id' _types.query_dsl.RegexpQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: case_insensitive: description: 'Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. When `false`, case sensitivity of matching depends on the underlying field’s mapping.' default: false x-state: Generally available; Added in 7.10.0 type: boolean flags: description: Enables optional operators for the regular expression. type: string max_determinized_states: description: Maximum number of automaton states required for the query. default: 10000.0 type: number rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' value: description: Regular expression for terms you wish to find in the provided field. type: string required: - value _types.DiversifyRetrieverTypes: type: string enum: - mmr _types.aggregations.FieldDateMath: description: 'A date range limit, represented either as a DateMath expression or a number expressed according to the target field''s precision.' oneOf: - $ref: '#/components/schemas/_types.DateMath' - type: number ingest._types.CsvProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: empty_value: description: 'Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes (`""`).' type: object field: description: The field to extract data from. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean quote: description: Quote used in CSV, has to be single character string. default: '"' type: string separator: description: Separator used in CSV, has to be single character string. default: ',' type: string target_fields: description: The array of fields to assign extracted values to. allOf: - $ref: '#/components/schemas/_types.Fields' trim: description: Trim whitespaces in unquoted fields. type: boolean required: - field - target_fields _types.Metadata: type: object additionalProperties: type: object _types.aggregations.AverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.GeoDistanceType: type: string enum: - arc - plane _types.TokenPruningConfig: type: object properties: tokens_freq_ratio_threshold: description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. default: 5.0 type: number tokens_weight_threshold: description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned. default: 0.4 type: number only_score_pruned_tokens: description: Whether to only score pruned tokens, vs only scoring kept tokens. default: false type: boolean _types.TopRightBottomLeftGeoBounds: type: object properties: top_right: allOf: - $ref: '#/components/schemas/_types.GeoLocation' bottom_left: allOf: - $ref: '#/components/schemas/_types.GeoLocation' required: - top_right - bottom_left indices._types.NumericFielddataFormat: type: string enum: - array - disabled ingest._types.InputConfig: type: object properties: input_field: type: string output_field: type: string required: - input_field - output_field _types.query_dsl.QueryBase: type: object properties: boost: description: 'Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.' default: 1.0 type: number _name: type: string _types.query_dsl.PercolateQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: document: description: The source of the document being percolated. type: object documents: description: An array of sources of the documents being percolated. type: array items: type: object field: description: Field that holds the indexed queries. The field must use the `percolator` mapping type. allOf: - $ref: '#/components/schemas/_types.Field' id: description: The ID of a stored document to percolate. allOf: - $ref: '#/components/schemas/_types.Id' index: description: The index of a stored document to percolate. allOf: - $ref: '#/components/schemas/_types.IndexName' name: description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. type: string preference: description: Preference used to fetch document to percolate. type: string routing: description: Routing used to fetch document to percolate. type: string version: description: The expected version of a stored document to percolate. allOf: - $ref: '#/components/schemas/_types.VersionNumber' required: - field _types.query_dsl.IntervalsWildcard: type: object properties: analyzer: description: 'Analyzer used to analyze the `pattern`. Defaults to the top-level field''s analyzer.' type: string pattern: description: Wildcard pattern used to find matching terms. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' required: - pattern _types.aggregations.TermsExclude: oneOf: - type: string - type: array items: type: string _types.mapping.HistogramProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: ignore_malformed: type: boolean time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' type: type: string enum: - histogram required: - type _types.query_dsl.WrapperQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: query: description: 'A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings' type: string required: - query _types.query_dsl.FieldValueFactorScoreFunction: type: object properties: field: description: Field to be extracted from the document. allOf: - $ref: '#/components/schemas/_types.Field' factor: description: Optional factor to multiply the field value with. default: 1.0 type: number missing: description: 'Value used if the document doesn’t have that field. The modifier and factor are still applied to it as though it were read from the document.' type: number modifier: description: Modifier to apply to the field value. allOf: - $ref: '#/components/schemas/_types.query_dsl.FieldValueFactorModifier' required: - field _types.aggregations.TermsAggregationExecutionHint: type: string enum: - map - global_ordinals - global_ordinals_hash - global_ordinals_low_cardinality ingest._types.ConvertProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field whose value is to be converted. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean target_field: description: 'The field to assign the converted value to. By default, the `field` is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' type: description: The type to convert the existing value to. allOf: - $ref: '#/components/schemas/ingest._types.ConvertType' required: - field - type _types.aggregations.SerialDifferencingAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: lag: description: 'The historical bucket to subtract from the current value. Must be a positive, non-zero integer.' type: number ingest._types.FingerprintProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: fields: description: 'Array of fields to include in the fingerprint. For objects, the processor hashes both the field key and value. For other fields, the processor hashes only the field value.' allOf: - $ref: '#/components/schemas/_types.Fields' target_field: description: Output field for the fingerprint. default: fingerprint allOf: - $ref: '#/components/schemas/_types.Field' salt: description: Salt value for the hash function. type: string method: description: 'The hash method used to compute the fingerprint. Must be one of MD5, SHA-1, SHA-256, SHA-512, or MurmurHash3.' default: SHA-1 allOf: - $ref: '#/components/schemas/ingest._types.FingerprintDigest' ignore_missing: description: 'If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.' default: false type: boolean required: - fields _types.query_dsl.QueryContainer: externalDocs: url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl description: An Elasticsearch Query DSL (Domain Specific Language) object that defines a query. type: object properties: bool: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query description: matches documents matching boolean combinations of other queries. allOf: - $ref: '#/components/schemas/_types.query_dsl.BoolQuery' boosting: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query description: Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query. allOf: - $ref: '#/components/schemas/_types.query_dsl.BoostingQuery' common: deprecated: true type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.CommonTermsQuery' minProperties: 1 maxProperties: 1 combined_fields: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query description: The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field. x-state: Generally available; Added in 7.13.0 allOf: - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsQuery' constant_score: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query description: Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value. allOf: - $ref: '#/components/schemas/_types.query_dsl.ConstantScoreQuery' dis_max: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query description: 'Returns documents matching one or more wrapped queries, called query clauses or clauses. If 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.' allOf: - $ref: '#/components/schemas/_types.query_dsl.DisMaxQuery' distance_feature: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query description: 'Boosts the relevance score of documents closer to a provided origin date or point. For example, you can use this query to give more weight to documents closer to a certain date or location.' allOf: - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQuery' exists: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query description: Returns documents that contain an indexed value for a field. allOf: - $ref: '#/components/schemas/_types.query_dsl.ExistsQuery' function_score: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query description: The `function_score` enables you to modify the score of documents that are retrieved by a query. allOf: - $ref: '#/components/schemas/_types.query_dsl.FunctionScoreQuery' fuzzy: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.FuzzyQuery' minProperties: 1 maxProperties: 1 geo_bounding_box: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query description: Matches geo_point and geo_shape values that intersect a bounding box. allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery' geo_distance: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query description: Matches `geo_point` and `geo_shape` values within a given distance of a geopoint. allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoDistanceQuery' geo_grid: description: Matches `geo_point` and `geo_shape` values that intersect a grid cell from a GeoGrid aggregation. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.GeoGridQuery' minProperties: 1 maxProperties: 1 geo_polygon: deprecated: true allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoPolygonQuery' geo_shape: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query description: Filter documents indexed using either the `geo_shape` or the `geo_point` type. allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoShapeQuery' has_child: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query description: Returns parent documents whose joined child documents match a provided query. allOf: - $ref: '#/components/schemas/_types.query_dsl.HasChildQuery' has_parent: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query description: Returns child documents whose joined parent document matches a provided query. allOf: - $ref: '#/components/schemas/_types.query_dsl.HasParentQuery' ids: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query description: 'Returns documents based on their IDs. This query uses document IDs stored in the `_id` field.' allOf: - $ref: '#/components/schemas/_types.query_dsl.IdsQuery' intervals: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query description: Returns documents based on the order and proximity of matching terms. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.IntervalsQuery' minProperties: 1 maxProperties: 1 knn: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query description: 'Finds the k nearest vectors to a query vector, as measured by a similarity metric. knn query finds nearest vectors through approximate search on indexed dense_vectors.' allOf: - $ref: '#/components/schemas/_types.KnnQuery' match: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query description: 'Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.MatchQuery' minProperties: 1 maxProperties: 1 match_all: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query description: Matches all documents, giving them all a `_score` of 1.0. allOf: - $ref: '#/components/schemas/_types.query_dsl.MatchAllQuery' match_bool_prefix: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query description: 'Analyzes its input and constructs a `bool` query from the terms. Each term except the last is used in a `term` query. The last term is used in a prefix query.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.MatchBoolPrefixQuery' minProperties: 1 maxProperties: 1 match_none: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query description: Matches no documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.MatchNoneQuery' match_phrase: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase description: Analyzes the text and creates a phrase query out of the analyzed text. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.MatchPhraseQuery' minProperties: 1 maxProperties: 1 match_phrase_prefix: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix description: 'Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.MatchPhrasePrefixQuery' minProperties: 1 maxProperties: 1 more_like_this: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query description: Returns documents that are "like" a given set of documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.MoreLikeThisQuery' multi_match: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query description: 'Enables you to search for a provided text, number, date or boolean value across multiple fields. The provided text is analyzed before matching.' allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiMatchQuery' nested: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query description: 'Wraps another query to search nested fields. If an object matches the search, the nested query returns the root parent document.' allOf: - $ref: '#/components/schemas/_types.query_dsl.NestedQuery' parent_id: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query description: Returns child documents joined to a specific parent document. allOf: - $ref: '#/components/schemas/_types.query_dsl.ParentIdQuery' percolate: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query description: Matches queries stored in an index. allOf: - $ref: '#/components/schemas/_types.query_dsl.PercolateQuery' pinned: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query description: Promotes selected documents to rank higher than those matching a given query. allOf: - $ref: '#/components/schemas/_types.query_dsl.PinnedQuery' prefix: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query description: Returns documents that contain a specific prefix in a provided field. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.PrefixQuery' minProperties: 1 maxProperties: 1 query_string: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query description: Returns documents based on a provided query string, using a parser with a strict syntax. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryStringQuery' range: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query description: Returns documents that contain terms within a provided range. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.RangeQuery' minProperties: 1 maxProperties: 1 rank_feature: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query description: Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureQuery' regexp: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query description: Returns documents that contain terms matching a regular expression. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.RegexpQuery' minProperties: 1 maxProperties: 1 rule: allOf: - $ref: '#/components/schemas/_types.query_dsl.RuleQuery' script: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query description: 'Filters documents based on a provided script. The script query is typically used in a filter context.' allOf: - $ref: '#/components/schemas/_types.query_dsl.ScriptQuery' script_score: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query description: Uses a script to provide a custom score for returned documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.ScriptScoreQuery' semantic: description: A semantic query to semantic_text field types x-state: Generally available; Added in 8.15.0 allOf: - $ref: '#/components/schemas/_types.query_dsl.SemanticQuery' shape: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query description: Queries documents that contain fields indexed using the `shape` type. allOf: - $ref: '#/components/schemas/_types.query_dsl.ShapeQuery' simple_query_string: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query description: Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax. allOf: - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringQuery' span_containing: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query description: Returns matches which enclose another span query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanContainingQuery' span_field_masking: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query description: Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery' span_first: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query description: Matches spans near the beginning of a field. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanFirstQuery' span_multi: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query 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. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanMultiTermQuery' span_near: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query description: 'Matches spans which are near one another. You can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanNearQuery' span_not: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query 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. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanNotQuery' span_or: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query description: Matches the union of its span clauses. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanOrQuery' span_term: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query description: Matches spans containing a term. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.SpanTermQuery' minProperties: 1 maxProperties: 1 span_within: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query description: Returns matches which are enclosed inside another span query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanWithinQuery' sparse_vector: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query 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. x-state: Generally available; Added in 8.15.0 allOf: - $ref: '#/components/schemas/_types.query_dsl.SparseVectorQuery' term: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query description: 'Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field''s value, including whitespace and capitalization.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.TermQuery' minProperties: 1 maxProperties: 1 terms: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query description: 'Returns documents that contain one or more exact terms in a provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization.' allOf: - $ref: '#/components/schemas/_types.query_dsl.TermsQuery' terms_set: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query description: 'Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.TermsSetQuery' minProperties: 1 maxProperties: 1 text_expansion: deprecated: true externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query 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. x-state: Generally available; Added in 8.8.0 type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.TextExpansionQuery' minProperties: 1 maxProperties: 1 weighted_tokens: deprecated: true externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query description: Supports returning text_expansion query results by sending in precomputed tokens with the query. x-state: Generally available; Added in 8.13.0 type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.WeightedTokensQuery' minProperties: 1 maxProperties: 1 wildcard: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query description: Returns documents that contain terms matching a wildcard pattern. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.WildcardQuery' minProperties: 1 maxProperties: 1 wrapper: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query description: A query that accepts any other query as base64 encoded string. allOf: - $ref: '#/components/schemas/_types.query_dsl.WrapperQuery' type: deprecated: true allOf: - $ref: '#/components/schemas/_types.query_dsl.TypeQuery' minProperties: 1 maxProperties: 1 _types.mapping.ConstantKeywordProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: value: type: object type: type: string enum: - constant_keyword required: - type _types.aggregations.MinimumInterval: type: string enum: - second - minute - hour - day - month - year _types.ScoreSort: type: object properties: order: allOf: - $ref: '#/components/schemas/_types.SortOrder' _types.aggregations.BucketSortAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: from: description: Buckets in positions prior to `from` will be truncated. type: number gap_policy: description: The policy to apply when gaps are found in the data. default: skip allOf: - $ref: '#/components/schemas/_types.aggregations.GapPolicy' size: description: 'The number of buckets to return. Defaults to all buckets of the parent aggregation.' type: number sort: description: The list of fields to sort on. allOf: - $ref: '#/components/schemas/_types.Sort' _types.query_dsl.CommonTermsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: type: string cutoff_frequency: type: number high_freq_operator: allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' low_freq_operator: allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' minimum_should_match: allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' query: type: string required: - query _spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag: description: 'A set of flags that can be represented as a single enum value or a set of values that are encoded as a pipe-separated string Depending on the target language, code generators can use this hint to generate language specific flags enum constructs and the corresponding (de-)serialization code.' oneOf: - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringFlag' - type: string _types.KnnQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: description: The name of the vector field to search against allOf: - $ref: '#/components/schemas/_types.Field' query_vector: description: The query vector allOf: - $ref: '#/components/schemas/_types.QueryVector' query_vector_builder: description: The query vector builder. You must provide a query_vector_builder or query_vector, but not both. allOf: - $ref: '#/components/schemas/_types.QueryVectorBuilder' num_candidates: description: The number of nearest neighbor candidates to consider per shard type: number visit_percentage: description: The percentage of vectors to explore per shard while doing knn search with bbq_disk x-state: Generally available; Added in 9.2.0 type: number k: description: The final number of nearest neighbors to return as top hits type: number filter: description: Filters for the kNN search query oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' similarity: description: The minimum similarity for a vector to be considered a match type: number rescore_vector: description: Apply oversampling and rescoring to quantized vectors x-state: Generally available; Added in 8.18.0 allOf: - $ref: '#/components/schemas/_types.RescoreVector' required: - field _types.Fuzziness: oneOf: - type: string - type: number _types.EmptyObject: description: For empty Class assignments type: object _types.SortMode: type: string enum: - min - max - sum - avg - median _types.query_dsl.PinnedDoc: type: object properties: _id: description: The unique document ID. allOf: - $ref: '#/components/schemas/_types.Id' _index: description: The index that contains the document. allOf: - $ref: '#/components/schemas/_types.IndexName' required: - _id ingest._types.CefProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field containing the CEF message. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean target_field: description: 'The field to assign the converted value to. By default, the `target_field` is ''cef''' default: '''cef''' allOf: - $ref: '#/components/schemas/_types.Field' ignore_empty_values: description: If `true` and value is anempty string in extensions, the processor quietly exits without modifying the document. default: false type: boolean timezone: description: The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. default: UTC type: string required: - field ingest._types.UppercaseProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to make uppercase. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean target_field: description: 'The field to assign the converted value to. By default, the field is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field _global.search._types.Rescore: allOf: - type: object properties: window_size: type: number - type: object properties: query: allOf: - $ref: '#/components/schemas/_global.search._types.RescoreQuery' learning_to_rank: allOf: - $ref: '#/components/schemas/_global.search._types.LearningToRank' script: allOf: - $ref: '#/components/schemas/_global.search._types.ScriptRescore' minProperties: 1 maxProperties: 1 _types.QueryVector: type: array items: type: number _types.aggregations.BucketsQueryContainer: description: 'Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.' oneOf: - type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' _types.mapping.MatchOnlyTextProperty: description: 'A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field effectively stores data the same way as a text field that only indexes documents (index_options: docs) and disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries that need positions such as the match_phrase query perform slower as they need to look at the _source document to verify whether a phrase matches. All queries return constant scores that are equal to 1.0.' type: object properties: type: type: string enum: - match_only_text fields: description: 'Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.' type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' meta: description: Metadata about the field. type: object additionalProperties: type: string copy_to: description: 'Allows you to copy the values of multiple fields into a group field, which can then be queried as a single field.' allOf: - $ref: '#/components/schemas/_types.Fields' required: - type _types.query_dsl.DistanceFeatureQueryBase: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: origin: description: 'Date or point of origin used to calculate distances. If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. Date Math, such as `now-1h`, is supported. If the field value is a `geo_point` field, the `origin` value must be a geopoint.' type: object pivot: description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value. If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.' type: object field: description: 'Name of the field used to calculate distances. This field must meet the following criteria: be a `date`, `date_nanos` or `geo_point` field; have an `index` mapping parameter value of `true`, which is the default; have an `doc_values` mapping parameter value of `true`, which is the default.' allOf: - $ref: '#/components/schemas/_types.Field' required: - origin - pivot - field ingest._types.TerminateProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object _types.Name: type: string _types.aggregations.SumBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.aggregations.Missing: oneOf: - type: string - type: number - type: number - type: boolean _types.aggregations.DateHistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: calendar_interval: description: 'Calendar-aware interval. Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.' allOf: - $ref: '#/components/schemas/_types.aggregations.CalendarInterval' extended_bounds: description: Enables extending the bounds of the histogram beyond the data itself. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath' hard_bounds: description: Limits the histogram to specified bounds. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath' field: description: The date field whose values are use to build a histogram. allOf: - $ref: '#/components/schemas/_types.Field' fixed_interval: description: 'Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.' allOf: - $ref: '#/components/schemas/_types.Duration' format: description: 'The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used.' type: string interval: deprecated: true allOf: - $ref: '#/components/schemas/_types.Duration' min_doc_count: description: 'Only returns buckets that have `min_doc_count` number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned.' type: number missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.DateTime' offset: description: Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. allOf: - $ref: '#/components/schemas/_types.Duration' order: description: The sort order of the returned buckets. allOf: - $ref: '#/components/schemas/_types.aggregations.AggregateOrder' params: type: object additionalProperties: type: object script: allOf: - $ref: '#/components/schemas/_types.Script' time_zone: description: 'Time zone used for bucketing and rounding. Defaults to Coordinated Universal Time (UTC).' allOf: - $ref: '#/components/schemas/_types.TimeZone' keyed: description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. type: boolean _types.mapping.DocValuesConfig: description: Configuration object for doc values when sub-parameters are needed. type: object properties: multi_value: description: 'If `false`, the field is treated as single-valued, enabling optimized storage. Only has an effect when columnar index mode is active.' default: true x-state: Experimental type: boolean nullability: description: 'If `false`, every document must provide a non-null value for the field: a document that omits the field, sets it to `null`, or supplies only null values (an empty array or an all-null array) is rejected at index time. A field that defines `null_value` is always exempt, since the configured default removes the absence of a value. Only has an effect when columnar index mode is active.' default: true x-state: Experimental type: boolean _types.query_dsl.RangeQueryBasedouble: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. type: number gte: description: Greater than or equal to. type: number lt: description: Less than. type: number lte: description: Less than or equal to. type: number _types.query_dsl.BoostingQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: negative_boost: description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. type: number negative: description: Query used to decrease the relevance score of matching documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' positive: description: Any returned documents must match this query. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - negative_boost - negative - positive _types.query_dsl.IdsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: values: description: An array of document IDs. allOf: - $ref: '#/components/schemas/_types.Ids' _global.search._types.HighlighterEncoder: type: string enum: - default - html _types.query_dsl.QueryStringQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: allow_leading_wildcard: description: If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. default: true type: boolean analyzer: description: Analyzer used to convert text in the query string into tokens. type: string analyze_wildcard: description: If `true`, the query attempts to analyze wildcard terms in the query string. default: false type: boolean auto_generate_synonyms_phrase_query: description: If `true`, match phrase queries are automatically created for multi-term synonyms. default: true type: boolean default_field: description: 'Default field to search if no field is provided in the query string. Supports wildcards (`*`). Defaults to the `index.query.default_field` index setting, which has a default value of `*`.' allOf: - $ref: '#/components/schemas/_types.Field' default_operator: description: Default boolean logic used to interpret text in the query string if no operators are specified. default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' enable_position_increments: description: If `true`, enable position increments in queries constructed from a `query_string` search. default: true type: boolean escape: default: false type: boolean fields: description: Array of fields to search. Supports wildcards (`*`). type: array items: $ref: '#/components/schemas/_types.Field' fuzziness: description: Maximum edit distance allowed for fuzzy matching. allOf: - $ref: '#/components/schemas/_types.Fuzziness' fuzzy_max_expansions: description: Maximum number of terms to which the query expands for fuzzy matching. default: 50.0 type: number fuzzy_prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. default: 0.0 type: number fuzzy_rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). default: true type: boolean lenient: description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. default: false type: boolean max_determinized_states: description: Maximum number of automaton states required for the query. default: 10000.0 type: number minimum_should_match: description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' phrase_slop: description: Maximum number of positions allowed between matching tokens for phrases. default: 0.0 type: number query: description: Query string you wish to parse and use for search. type: string quote_analyzer: description: 'Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter.' type: string quote_field_suffix: description: 'Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.' type: string rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' tie_breaker: description: How to combine the queries generated from the individual search terms in the resulting `dis_max` query. type: number time_zone: description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. allOf: - $ref: '#/components/schemas/_types.TimeZone' type: description: Determines how the query matches and scores documents. default: '''best_fields''' allOf: - $ref: '#/components/schemas/_types.query_dsl.TextQueryType' required: - query _types.mapping.SearchAsYouTypeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: analyzer: type: string index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' max_shingle_size: type: number norms: type: boolean search_analyzer: type: string search_quote_analyzer: type: string similarity: oneOf: - type: string - type: - string - 'null' term_vector: allOf: - $ref: '#/components/schemas/_types.mapping.TermVectorOption' type: type: string enum: - search_as_you_type required: - type _types.query_dsl.SpanWithinQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: big: description: 'Can be any span query. Matching spans from `little` that are enclosed within `big` are returned.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' little: description: 'Can be any span query. Matching spans from `little` that are enclosed within `big` are returned.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - big - little _types.MultiTermQueryRewrite: type: string _types.aggregations.WeightedAverageValue: type: object properties: field: description: The field from which to extract the values or weights. allOf: - $ref: '#/components/schemas/_types.Field' missing: description: A value or weight to use if the field is missing. type: number script: allOf: - $ref: '#/components/schemas/_types.Script' _types.query_dsl.IntervalsRegexp: type: object properties: analyzer: description: Analyzer used to analyze the `prefix`. type: string pattern: description: Regex pattern. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' required: - pattern _types.query_dsl.DecayFunctionBaseDateMathDuration: type: object properties: multi_value_mode: description: Determines how the distance is calculated when a field used for computing the decay contains multiple values. default: min allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode' _global.search._types.InnerHits: type: object properties: name: description: 'The name for the particular inner hit definition in the response. Useful when a search request contains multiple inner hits.' allOf: - $ref: '#/components/schemas/_types.Name' size: description: The maximum number of hits to return per `inner_hits`. default: 3.0 type: number from: description: Inner hit starting document offset. default: 0.0 type: number collapse: allOf: - $ref: '#/components/schemas/_global.search._types.FieldCollapse' docvalue_fields: type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' explain: type: boolean highlight: allOf: - $ref: '#/components/schemas/_global.search._types.Highlight' ignore_unmapped: type: boolean script_fields: type: object additionalProperties: $ref: '#/components/schemas/_types.ScriptField' seq_no_primary_term: type: boolean field: type: array items: $ref: '#/components/schemas/_types.Field' fields: type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' sort: description: 'How the inner hits should be sorted per `inner_hits`. By default, inner hits are sorted by score.' allOf: - $ref: '#/components/schemas/_types.Sort' _source: allOf: - $ref: '#/components/schemas/_global.search._types.SourceConfig' stored_fields: allOf: - $ref: '#/components/schemas/_types.Fields' track_scores: default: false type: boolean version: type: boolean _types.query_dsl.SpanQuery: type: object properties: span_containing: description: Accepts a list of span queries, but only returns those spans which also match a second span query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanContainingQuery' span_field_masking: description: Allows queries like `span_near` or `span_or` across different fields. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery' span_first: description: Accepts another span query whose matches must appear within the first N positions of the field. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanFirstQuery' span_gap: allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanGapQuery' span_multi: description: Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanMultiTermQuery' span_near: description: Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanNearQuery' span_not: description: Wraps another span query, and excludes any documents which match that query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanNotQuery' span_or: description: Combines multiple span queries and returns documents which match any of the specified queries. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanOrQuery' span_term: description: The equivalent of the `term` query but for use with other span queries. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.SpanTermQuery' minProperties: 1 maxProperties: 1 span_within: description: The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanWithinQuery' minProperties: 1 maxProperties: 1 _types.aggregations.TDigestExecutionHint: type: string enum: - default - high_accuracy _global.search._types.RescoreQuery: type: object properties: rescore_query: description: 'The query to use for rescoring. This query is only run on the Top-K results returned by the `query` and `post_filter` phases.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' query_weight: description: Relative importance of the original query versus the rescore query. default: 1.0 type: number rescore_query_weight: description: Relative importance of the rescore query versus the original query. default: 1.0 type: number score_mode: description: Determines how scores are combined. default: total allOf: - $ref: '#/components/schemas/_global.search._types.ScoreMode' required: - rescore_query _types.aggregations.MissingOrder: type: string enum: - first - last - default _types.ScriptLanguage: anyOf: - type: string enum: - painless - expression - mustache - java - type: string _types.mapping.DynamicTemplate: allOf: - type: object properties: match: oneOf: - type: string - type: array items: type: string path_match: oneOf: - type: string - type: array items: type: string unmatch: oneOf: - type: string - type: array items: type: string path_unmatch: oneOf: - type: string - type: array items: type: string match_mapping_type: oneOf: - type: string - type: array items: type: string unmatch_mapping_type: oneOf: - type: string - type: array items: type: string match_pattern: allOf: - $ref: '#/components/schemas/_types.mapping.MatchType' - type: object properties: mapping: allOf: - $ref: '#/components/schemas/_types.mapping.Property' runtime: allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeField' minProperties: 1 maxProperties: 1 _types.query_dsl.SpanGapQuery: description: Can only be used as a clause in a span_near query. type: object additionalProperties: type: number minProperties: 1 maxProperties: 1 ingest._types.BytesProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to convert. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean target_field: description: 'The field to assign the converted value to. By default, the field is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.query_dsl.ExistsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: description: Name of the field you wish to search. allOf: - $ref: '#/components/schemas/_types.Field' required: - field ingest._types.ForeachProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: Field containing array or object values. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. default: false type: boolean processor: description: Ingest processor to run on each element. allOf: - $ref: '#/components/schemas/ingest._types.ProcessorContainer' required: - field - processor _types.RankBase: type: object ingest._types.UserAgentProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field containing the user agent string. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean regex_file: description: The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. type: string target_field: description: The field that will be filled with the user agent details. default: user_agent allOf: - $ref: '#/components/schemas/_types.Field' properties: description: Controls what properties are added to `target_field`. default: - name - os - device - original - version type: array items: $ref: '#/components/schemas/ingest._types.UserAgentProperty' extract_device_type: description: Extracts device type from the user agent string on a best-effort basis. default: false x-state: Beta; Added in 8.9.0 type: boolean required: - field ingest._types.JsonProcessorConflictStrategy: type: string enum: - replace - merge ingest._types.SetProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: copy_from: description: 'The origin field which will be copied to `field`, cannot set `value` simultaneously. Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc.' allOf: - $ref: '#/components/schemas/_types.Field' field: description: 'The field to insert, upsert, or update. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Field' ignore_empty_value: description: If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. default: false type: boolean media_type: description: 'The media type for encoding `value`. Applies only when value is a template snippet. Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`.' default: '"application/json"' type: string override: description: 'If `true` processor will update fields with pre-existing non-null-valued field. When set to `false`, such fields will not be touched.' default: true type: boolean value: description: 'The value to be set for the field. Supports template snippets. May specify only one of `value` or `copy_from`.' type: object required: - field _types.RetrieverContainer: type: object properties: standard: description: A retriever that replaces the functionality of a traditional query. allOf: - $ref: '#/components/schemas/_types.StandardRetriever' knn: description: A retriever that replaces the functionality of a knn search. allOf: - $ref: '#/components/schemas/_types.KnnRetriever' rrf: description: A retriever that produces top documents from reciprocal rank fusion (RRF). allOf: - $ref: '#/components/schemas/_types.RRFRetriever' text_similarity_reranker: description: A retriever that reranks the top documents based on a reranking model using the InferenceAPI allOf: - $ref: '#/components/schemas/_types.TextSimilarityReranker' rule: description: A retriever that replaces the functionality of a rule query. allOf: - $ref: '#/components/schemas/_types.RuleRetriever' rescorer: description: A retriever that re-scores only the results produced by its child retriever. allOf: - $ref: '#/components/schemas/_types.RescorerRetriever' linear: description: A retriever that supports the combination of different retrievers through a weighted linear combination. allOf: - $ref: '#/components/schemas/_types.LinearRetriever' pinned: description: 'A pinned retriever applies pinned documents to the underlying retriever. This retriever will rewrite to a PinnedQueryBuilder.' allOf: - $ref: '#/components/schemas/_types.PinnedRetriever' diversify: description: A retriever that diversifies the results from its child retriever. allOf: - $ref: '#/components/schemas/_types.DiversifyRetriever' minProperties: 1 maxProperties: 1 ingest._types.UrlDecodeProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to decode. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean target_field: description: 'The field to assign the converted value to. By default, the field is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.query_dsl.ParentIdQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: id: description: ID of the parent document. allOf: - $ref: '#/components/schemas/_types.Id' ignore_unmapped: description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. default: false type: boolean type: description: Name of the child relationship mapped for the `join` field. allOf: - $ref: '#/components/schemas/_types.RelationName' _types.mapping.SuggestContext: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.Name' path: allOf: - $ref: '#/components/schemas/_types.Field' type: type: string precision: oneOf: - type: number - type: string required: - name - type _types.RelationName: type: string _types.query_dsl.GeoPolygonQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: validation_method: default: '''strict''' allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod' ignore_unmapped: type: boolean _types.mapping.TimeSeriesMetricType: type: string enum: - gauge - counter - summary - histogram - position indices._types.FielddataFrequencyFilter: type: object properties: max: type: number min: type: number min_segment_size: type: number required: - max - min - min_segment_size ingest._types.RemoveProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: Fields to be removed. Supports template snippets. allOf: - $ref: '#/components/schemas/_types.Fields' keep: description: Fields to be kept. When set, all fields other than those specified are removed. allOf: - $ref: '#/components/schemas/_types.Fields' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean required: - field _types.query_dsl.MatchAllQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object _types.KnnRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: field: description: The name of the vector field to search against. type: string query_vector: description: Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. allOf: - $ref: '#/components/schemas/_types.QueryVector' query_vector_builder: description: Defines a model to build a query vector. allOf: - $ref: '#/components/schemas/_types.QueryVectorBuilder' k: description: Number of nearest neighbors to return as top hits. type: number num_candidates: description: Number of nearest neighbor candidates to consider per shard. type: number visit_percentage: description: The percentage of vectors to explore per shard while doing knn search with bbq_disk x-state: Generally available; Added in 9.2.0 type: number similarity: description: The minimum similarity required for a document to be considered a match. type: number rescore_vector: description: Apply oversampling and rescoring to quantized vectors x-state: Generally available; Added in 8.18.0 allOf: - $ref: '#/components/schemas/_types.RescoreVector' required: - field - k _types.mapping.ChunkRescorerChunkingSettings: type: object properties: max_chunk_size: description: 'The maximum size of a chunk in words. This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). This value should not exceed the window size for the associated model.' default: 250.0 type: number overlap: description: 'The number of overlapping words for chunks. It is applicable only to a `word` chunking strategy. This value cannot be higher than half the `max_chunk_size` value.' default: 100.0 type: number sentence_overlap: description: 'The number of overlapping sentences for chunks. It is applicable only for a `sentence` chunking strategy. It can be either `1` or `0`.' default: 1.0 type: number separator_group: description: 'Only applicable to the `recursive` strategy and required when using it. Sets a predefined list of separators in the saved chunking settings based on the selected text type. Values can be `markdown` or `plaintext`. Using this parameter is an alternative to manually specifying a custom `separators` list.' type: string separators: description: 'Only applicable to the `recursive` strategy and required when using it. A list of strings used as possible split points when chunking text. Each string can be a plain string or a regular expression (regex) pattern. The system tries each separator in order to split the text, starting from the first item in the list. After splitting, it attempts to recombine smaller pieces into larger chunks that stay within the `max_chunk_size` limit, to reduce the total number of chunks generated.' type: array items: type: string strategy: externalDocs: url: https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies description: "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation." default: sentence type: string required: - max_chunk_size _types.aggregations.IpPrefixAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The IP address field to aggregation on. The field mapping type must be `ip`. allOf: - $ref: '#/components/schemas/_types.Field' prefix_length: description: 'Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. For IPv6 addresses the accepted range is [0, 128].' type: number is_ipv6: description: Defines whether the prefix applies to IPv6 addresses. default: false type: boolean append_prefix_length: description: Defines whether the prefix length is appended to IP address keys in the response. default: false type: boolean keyed: description: Defines whether buckets are returned as a hash rather than an array in the response. type: boolean min_doc_count: description: Minimum number of documents in a bucket for it to be included in the response. default: 1.0 type: number required: - field - prefix_length _types.analysis.IcuCollationCaseFirst: type: string enum: - lower - upper _types.mapping.IndexField: type: object properties: enabled: type: boolean required: - enabled _types.mapping.TypeMapping: type: object properties: all_field: allOf: - $ref: '#/components/schemas/_types.mapping.AllField' date_detection: type: boolean dynamic: allOf: - $ref: '#/components/schemas/_types.mapping.DynamicMapping' dynamic_date_formats: type: array items: type: string dynamic_templates: type: array items: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.DynamicTemplate' minProperties: 1 maxProperties: 1 _field_names: allOf: - $ref: '#/components/schemas/_types.mapping.FieldNamesField' index_field: allOf: - $ref: '#/components/schemas/_types.mapping.IndexField' _meta: allOf: - $ref: '#/components/schemas/_types.Metadata' numeric_detection: type: boolean properties: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' _routing: allOf: - $ref: '#/components/schemas/_types.mapping.RoutingField' _size: allOf: - $ref: '#/components/schemas/_types.mapping.SizeField' _source: allOf: - $ref: '#/components/schemas/_types.mapping.SourceField' runtime: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.RuntimeField' enabled: type: boolean subobjects: allOf: - $ref: '#/components/schemas/_types.mapping.Subobjects' _data_stream_timestamp: x-state: Generally available; Added in 7.16.0 allOf: - $ref: '#/components/schemas/_types.mapping.DataStreamTimestamp' _types.aggregations.MissingAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The name of the field. allOf: - $ref: '#/components/schemas/_types.Field' missing: allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' _types.aggregations.MaxAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.aggregations.BucketKsAggregation: description: 'A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred to as a "K-S test" from now on) against a provided distribution, and the distribution implied by the documents counts in the configured sibling aggregation. Specifically, for some metric, assuming that the percentile intervals of the metric are known beforehand or have been computed by an aggregation, then one would use range aggregation for the sibling to compute the p-value of the distribution difference between the metric and the restriction of that metric to a subset of the documents. A natural use case is if the sibling aggregation range aggregation nested in a terms aggregation, in which case one compares the overall distribution of metric to its restriction to each term.' allOf: - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation' - type: object properties: alternative: description: 'A list of string values indicating which K-S test alternative to calculate. The valid values are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used when calculating the K-S test. Default value is all possible alternative hypotheses.' type: array items: type: string fractions: description: 'A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a metric to define the bucket end points.' type: array items: type: number sampling_method: description: 'Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, and `lower_tail`.' type: string _types.KnnEmbeddingInput: description: 'Knn embedding input. Either a string, an object or array of objects' oneOf: - type: string - $ref: '#/components/schemas/_types.InferenceStringGroup' _types.RRFRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retrievers: description: A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. Each retriever can optionally include a weight parameter. type: array items: $ref: '#/components/schemas/_types.RRFRetrieverEntry' rank_constant: description: This value determines how much influence documents in individual result sets per query have over the final ranked result set. type: number rank_window_size: description: This value determines the size of the individual result sets per query. type: number query: type: string fields: type: array items: type: string required: - retrievers _types.InferenceString: type: object properties: type: description: The type of data that the value represents. allOf: - $ref: '#/components/schemas/inference._types.EmbeddingContentType' format: description: The format of the data. If null, the default data format for the given type is used. oneOf: - $ref: '#/components/schemas/inference._types.EmbeddingContentFormat' - type: - string - 'null' value: description: String which may be raw text, or the string representation of some other data such as an image in base64. type: string required: - type - value _global.search._types.HighlightField: allOf: - $ref: '#/components/schemas/_global.search._types.HighlightBase' - type: object properties: fragment_offset: type: number matched_fields: allOf: - $ref: '#/components/schemas/_types.Fields' _types.aggregations.SumAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.aggregations.ExtendedStatsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: sigma: description: The number of standard deviations above/below the mean to display. type: number _global.search._types.LearningToRank: type: object properties: model_id: description: The unique identifier of the trained model uploaded to Elasticsearch type: string params: description: Named parameters to be passed to the query templates used for feature type: object additionalProperties: type: object required: - model_id _types.ScriptSortType: type: string enum: - string - number - version _types.mapping.ChunkingSettings: type: object properties: strategy: externalDocs: url: https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies description: "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation." default: sentence type: string max_chunk_size: description: 'The maximum size of a chunk in words. This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). This value should not exceed the window size for the associated model.' default: 250.0 type: number overlap: description: 'The number of overlapping words for chunks. It is applicable only to a `word` chunking strategy. This value cannot be higher than half the `max_chunk_size` value.' default: 100.0 type: number sentence_overlap: description: 'The number of overlapping sentences for chunks. It is applicable only for a `sentence` chunking strategy. It can be either `1` or `0`.' default: 1.0 type: number separator_group: description: 'Only applicable to the `recursive` strategy and required when using it. Sets a predefined list of separators in the saved chunking settings based on the selected text type. Values can be `markdown` or `plaintext`. Using this parameter is an alternative to manually specifying a custom `separators` list.' type: string separators: description: 'Only applicable to the `recursive` strategy and required when using it. A list of strings used as possible split points when chunking text. Each string can be a plain string or a regular expression (regex) pattern. The system tries each separator in order to split the text, starting from the first item in the list. After splitting, it attempts to recombine smaller pieces into larger chunks that stay within the `max_chunk_size` limit, to reduce the total number of chunks generated.' type: array items: type: string required: - strategy - max_chunk_size _types.mapping.IndexOptions: type: string enum: - docs - freqs - positions - offsets _types.mapping.DenseVectorProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - dense_vector dims: description: 'Number of vector dimensions. Can''t exceed `4096`. If `dims` is not specified, it will be set to the length of the first vector added to the field.' type: number element_type: description: The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`. default: float allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorElementType' index: description: If `true`, you can search this field using the kNN search API. default: true type: boolean index_options: description: 'An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters that influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the expense of slower indexing speed. This parameter can only be specified when `index` is `true`.' allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorIndexOptions' similarity: description: 'The vector similarity metric to use in kNN search. Documents are ranked by their vector field''s similarity to the query vector. The `_score` of each document will be derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds to a higher ranking. Defaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`. `bit` vectors only support `l2_norm` as their similarity metric. This parameter can only be specified when `index` is `true`.' allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorSimilarity' required: - type _types.query_dsl.IntervalsContainer: type: object properties: all_of: description: Returns matches that span a combination of other rules. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsAllOf' any_of: description: Returns intervals produced by any of its sub-rules. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsAnyOf' fuzzy: description: Matches analyzed text. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFuzzy' match: description: Matches analyzed text. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsMatch' prefix: description: Matches terms that start with a specified set of characters. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsPrefix' range: allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsRange' regexp: allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsRegexp' wildcard: description: Matches terms using a wildcard pattern. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsWildcard' minProperties: 1 maxProperties: 1 ml._types.RegressionInferenceOptions: type: object properties: results_field: description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. allOf: - $ref: '#/components/schemas/_types.Field' num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. default: 0.0 type: number _types.mapping.DenseVectorSimilarity: type: string enum: - cosine - dot_product - l2_norm - max_inner_product _types.mapping.RuntimeField: type: object properties: fields: description: For type `composite` type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.CompositeSubField' fetch_fields: description: For type `lookup` type: array items: $ref: '#/components/schemas/_types.mapping.RuntimeFieldFetchFields' format: description: A custom format for `date` type runtime fields. type: string input_field: description: For type `lookup` allOf: - $ref: '#/components/schemas/_types.Field' target_field: description: For type `lookup` allOf: - $ref: '#/components/schemas/_types.Field' target_index: description: For type `lookup` allOf: - $ref: '#/components/schemas/_types.IndexName' script: description: Painless script executed at query time. allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' type: description: 'Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.' allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeFieldType' required: - type _types.mapping.DoubleNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - double null_value: type: number required: - type _types.query_dsl.RandomScoreFunction: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' seed: oneOf: - type: number - type: string _types.aggregations.MedianAbsoluteDeviationAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. default: 1000.0 type: number execution_hint: description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases). To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.' default: default allOf: - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint' _types.query_dsl.LikeDocument: type: object properties: doc: description: A document not present in the index. type: object fields: type: array items: $ref: '#/components/schemas/_types.Field' _id: description: ID of a document. allOf: - $ref: '#/components/schemas/_types.Id' _index: description: Index of a document. allOf: - $ref: '#/components/schemas/_types.IndexName' per_field_analyzer: description: Overrides the default analyzer. type: object additionalProperties: type: string routing: allOf: - $ref: '#/components/schemas/_types.Routing' version: allOf: - $ref: '#/components/schemas/_types.VersionNumber' version_type: default: '''internal''' allOf: - $ref: '#/components/schemas/_types.VersionType' _types.aggregations.RangeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The date field whose values are use to build ranges. allOf: - $ref: '#/components/schemas/_types.Field' missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' type: number ranges: description: An array of ranges used to bucket documents. type: array items: $ref: '#/components/schemas/_types.aggregations.AggregationRange' script: allOf: - $ref: '#/components/schemas/_types.Script' keyed: description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. type: boolean format: type: string ingest._types.ScriptProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: id: description: 'ID of a stored script. If no `source` is specified, this parameter is required.' allOf: - $ref: '#/components/schemas/_types.Id' lang: description: Script language. default: painless allOf: - $ref: '#/components/schemas/_types.ScriptLanguage' params: description: Object containing parameters for the script. type: object additionalProperties: type: object source: description: 'Inline script. If no `id` is specified, this parameter is required.' allOf: - $ref: '#/components/schemas/_types.ScriptSource' _types.analysis.IcuCollationStrength: type: string enum: - primary - secondary - tertiary - quaternary - identical _types.mapping.DocValues: description: Defines whether doc values are enabled for a field. Can be a simple boolean, or a configuration object for finer-grained control over sub-parameters such as `multi_value`. oneOf: - type: boolean - $ref: '#/components/schemas/_types.mapping.DocValuesConfig' _types.mapping.PercolatorProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - percolator required: - type _types.aggregations.SamplerAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: shard_size: description: Limits how many top-scoring documents are collected in the sample processed on each shard. default: 100.0 type: number _types.query_dsl.PinnedQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query allOf: - type: object properties: organic: description: Any choice of query used to rank documents which will be ranked below the "pinned" documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - organic - type: object properties: ids: description: 'Document IDs listed in the order they are to appear in results. Required if `docs` is not specified.' type: array items: $ref: '#/components/schemas/_types.Id' docs: description: 'Documents listed in the order they are to appear in results. Required if `ids` is not specified.' type: array items: $ref: '#/components/schemas/_types.query_dsl.PinnedDoc' minProperties: 1 maxProperties: 1 _global.search._types.HighlighterTagsSchema: type: string enum: - styled _types.mapping.DynamicProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - '{dynamic_type}' enabled: type: boolean null_value: allOf: - $ref: '#/components/schemas/_types.FieldValue' boost: type: number coerce: type: boolean script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' ignore_malformed: type: boolean time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' analyzer: type: string eager_global_ordinals: type: boolean index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' index_phrases: type: boolean index_prefixes: oneOf: - $ref: '#/components/schemas/_types.mapping.TextIndexPrefixes' - type: - string - 'null' norms: type: boolean position_increment_gap: type: number search_analyzer: type: string search_quote_analyzer: type: string term_vector: allOf: - $ref: '#/components/schemas/_types.mapping.TermVectorOption' format: type: string precision_step: type: number locale: type: string required: - type _types.aggregations.IpRangeAggregationRange: type: object properties: from: description: Start of the range. oneOf: - type: string - type: - string - 'null' mask: description: IP range defined as a CIDR mask. type: string to: description: End of the range. oneOf: - type: string - type: - string - 'null' _types.ScriptSort: type: object properties: order: allOf: - $ref: '#/components/schemas/_types.SortOrder' script: allOf: - $ref: '#/components/schemas/_types.Script' type: allOf: - $ref: '#/components/schemas/_types.ScriptSortType' mode: allOf: - $ref: '#/components/schemas/_types.SortMode' nested: allOf: - $ref: '#/components/schemas/_types.NestedSortValue' required: - script _types.query_dsl.FunctionScoreContainer: allOf: - type: object properties: filter: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' weight: type: number _name: description: A name to identify which function matched and influenced the score. x-state: Generally available; Added in 9.4.0 type: string - type: object properties: exp: description: Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin. allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunction' gauss: description: Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin. allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunction' linear: description: Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin. allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunction' field_value_factor: description: 'Function allows you to use a field from a document to influence the score. It’s similar to using the script_score function, however, it avoids the overhead of scripting.' allOf: - $ref: '#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction' random_score: description: 'Generates scores that are uniformly distributed from 0 up to but not including 1. In case you want scores to be reproducible, it is possible to provide a `seed` and `field`.' allOf: - $ref: '#/components/schemas/_types.query_dsl.RandomScoreFunction' script_score: description: Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression. allOf: - $ref: '#/components/schemas/_types.query_dsl.ScriptScoreFunction' minProperties: 1 maxProperties: 1 _types.aggregations.HoltWintersType: type: string enum: - add - mult ingest._types.AppendProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: 'The field to be appended to. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Field' value: description: The value to be appended. Supports template snippets. May specify only one of `value` or `copy_from`. oneOf: - type: object - type: array items: type: object media_type: description: 'The media type for encoding `value`. Applies only when value is a template snippet. Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`.' default: '"application/json"' type: string copy_from: description: The origin field which will be appended to `field`, cannot set `value` simultaneously. allOf: - $ref: '#/components/schemas/_types.Field' allow_duplicates: description: If `false`, the processor does not append values already present in the field. default: true type: boolean ignore_empty_values: description: 'If `true`, the processor will skip empty values from the source (e.g. empty strings, and null values), rather than appending them to the field.' default: false type: boolean required: - field inference._types.EmbeddingContentFormat: type: string enum: - text - base64 _types.query_dsl.IntervalsAllOf: type: object properties: intervals: description: An array of rules to combine. All rules must produce a match in a document for the overall source to match. type: array items: $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' max_gaps: description: 'Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches.' default: -1.0 type: number ordered: description: If `true`, intervals produced by the rules should appear in the order in which they are specified. default: false type: boolean filter: description: Rule used to filter returned intervals. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter' required: - intervals _types.aggregations.RandomSamplerAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: probability: description: 'The probability that a document will be included in the aggregated data. Must be greater than 0, less than 0.5, or exactly 1. The lower the probability, the fewer documents are matched.' type: number seed: description: 'The seed to generate the random sampling of documents. When a seed is provided, the random subset of documents is the same between calls.' type: number shard_seed: description: When combined with seed, setting shard_seed ensures 100% consistent sampling over shards where data is exactly the same. x-state: Generally available; Added in 8.14.0 type: number required: - probability _types.query_dsl.ShapeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: When set to `true` the query ignores an unmapped field and will not match any documents. type: boolean _types.aggregations.NormalizeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: method: description: The specific method to apply. allOf: - $ref: '#/components/schemas/_types.aggregations.NormalizeMethod' _types.aggregations.MovingAverageAggregation: discriminator: propertyName: model mapping: ewma: '#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation' holt: '#/components/schemas/_types.aggregations.HoltMovingAverageAggregation' holt_winters: '#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation' linear: '#/components/schemas/_types.aggregations.LinearMovingAverageAggregation' simple: '#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation' oneOf: - $ref: '#/components/schemas/_types.aggregations.LinearMovingAverageAggregation' - $ref: '#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation' - $ref: '#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation' - $ref: '#/components/schemas/_types.aggregations.HoltMovingAverageAggregation' - $ref: '#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation' _types.query_dsl.SimpleQueryStringFlags: description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX` allOf: - $ref: '#/components/schemas/_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag' _types.mapping.PreserveLeafArrays: type: string enum: - lossy - exact _types.aggregations.CompositeDateHistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase' - type: object properties: format: type: string calendar_interval: description: Either `calendar_interval` or `fixed_interval` must be present allOf: - $ref: '#/components/schemas/_types.DurationLarge' fixed_interval: description: Either `calendar_interval` or `fixed_interval` must be present allOf: - $ref: '#/components/schemas/_types.DurationLarge' offset: allOf: - $ref: '#/components/schemas/_types.Duration' time_zone: allOf: - $ref: '#/components/schemas/_types.TimeZone' ingest._types.ConvertType: type: string enum: - integer - long - double - float - boolean - ip - string - auto _types.aggregations.CardinalityAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: precision_threshold: description: 'A unique count below which counts are expected to be close to accurate. This allows to trade memory for accuracy.' default: 3000.0 type: number rehash: type: boolean execution_hint: description: Mechanism by which cardinality aggregations is run. allOf: - $ref: '#/components/schemas/_types.aggregations.CardinalityExecutionMode' _types.query_dsl.RangeRelation: type: string enum: - within - contains - intersects _types.mapping.Property: discriminator: propertyName: type mapping: aggregate_metric_double: '#/components/schemas/_types.mapping.AggregateMetricDoubleProperty' alias: '#/components/schemas/_types.mapping.FieldAliasProperty' binary: '#/components/schemas/_types.mapping.BinaryProperty' boolean: '#/components/schemas/_types.mapping.BooleanProperty' byte: '#/components/schemas/_types.mapping.ByteNumberProperty' completion: '#/components/schemas/_types.mapping.CompletionProperty' constant_keyword: '#/components/schemas/_types.mapping.ConstantKeywordProperty' counted_keyword: '#/components/schemas/_types.mapping.CountedKeywordProperty' date: '#/components/schemas/_types.mapping.DateProperty' date_nanos: '#/components/schemas/_types.mapping.DateNanosProperty' date_range: '#/components/schemas/_types.mapping.DateRangeProperty' dense_vector: '#/components/schemas/_types.mapping.DenseVectorProperty' double: '#/components/schemas/_types.mapping.DoubleNumberProperty' double_range: '#/components/schemas/_types.mapping.DoubleRangeProperty' exponential_histogram: '#/components/schemas/_types.mapping.ExponentialHistogramProperty' flattened: '#/components/schemas/_types.mapping.FlattenedProperty' float: '#/components/schemas/_types.mapping.FloatNumberProperty' float_range: '#/components/schemas/_types.mapping.FloatRangeProperty' geo_point: '#/components/schemas/_types.mapping.GeoPointProperty' geo_shape: '#/components/schemas/_types.mapping.GeoShapeProperty' half_float: '#/components/schemas/_types.mapping.HalfFloatNumberProperty' histogram: '#/components/schemas/_types.mapping.HistogramProperty' icu_collation_keyword: '#/components/schemas/_types.mapping.IcuCollationProperty' integer: '#/components/schemas/_types.mapping.IntegerNumberProperty' integer_range: '#/components/schemas/_types.mapping.IntegerRangeProperty' ip: '#/components/schemas/_types.mapping.IpProperty' ip_range: '#/components/schemas/_types.mapping.IpRangeProperty' join: '#/components/schemas/_types.mapping.JoinProperty' keyword: '#/components/schemas/_types.mapping.KeywordProperty' long: '#/components/schemas/_types.mapping.LongNumberProperty' long_range: '#/components/schemas/_types.mapping.LongRangeProperty' match_only_text: '#/components/schemas/_types.mapping.MatchOnlyTextProperty' murmur3: '#/components/schemas/_types.mapping.Murmur3HashProperty' nested: '#/components/schemas/_types.mapping.NestedProperty' object: '#/components/schemas/_types.mapping.ObjectProperty' passthrough: '#/components/schemas/_types.mapping.PassthroughObjectProperty' percolator: '#/components/schemas/_types.mapping.PercolatorProperty' point: '#/components/schemas/_types.mapping.PointProperty' rank_feature: '#/components/schemas/_types.mapping.RankFeatureProperty' rank_features: '#/components/schemas/_types.mapping.RankFeaturesProperty' rank_vectors: '#/components/schemas/_types.mapping.RankVectorProperty' scaled_float: '#/components/schemas/_types.mapping.ScaledFloatNumberProperty' search_as_you_type: '#/components/schemas/_types.mapping.SearchAsYouTypeProperty' semantic_text: '#/components/schemas/_types.mapping.SemanticTextProperty' shape: '#/components/schemas/_types.mapping.ShapeProperty' short: '#/components/schemas/_types.mapping.ShortNumberProperty' sparse_vector: '#/components/schemas/_types.mapping.SparseVectorProperty' text: '#/components/schemas/_types.mapping.TextProperty' token_count: '#/components/schemas/_types.mapping.TokenCountProperty' unsigned_long: '#/components/schemas/_types.mapping.UnsignedLongNumberProperty' version: '#/components/schemas/_types.mapping.VersionProperty' wildcard: '#/components/schemas/_types.mapping.WildcardProperty' '{dynamic_type}': '#/components/schemas/_types.mapping.DynamicProperty' oneOf: - $ref: '#/components/schemas/_types.mapping.BinaryProperty' - $ref: '#/components/schemas/_types.mapping.BooleanProperty' - $ref: '#/components/schemas/_types.mapping.DynamicProperty' - $ref: '#/components/schemas/_types.mapping.JoinProperty' - $ref: '#/components/schemas/_types.mapping.KeywordProperty' - $ref: '#/components/schemas/_types.mapping.MatchOnlyTextProperty' - $ref: '#/components/schemas/_types.mapping.PercolatorProperty' - $ref: '#/components/schemas/_types.mapping.RankFeatureProperty' - $ref: '#/components/schemas/_types.mapping.RankFeaturesProperty' - $ref: '#/components/schemas/_types.mapping.SearchAsYouTypeProperty' - $ref: '#/components/schemas/_types.mapping.TextProperty' - $ref: '#/components/schemas/_types.mapping.VersionProperty' - $ref: '#/components/schemas/_types.mapping.WildcardProperty' - $ref: '#/components/schemas/_types.mapping.DateNanosProperty' - $ref: '#/components/schemas/_types.mapping.DateProperty' - $ref: '#/components/schemas/_types.mapping.AggregateMetricDoubleProperty' - $ref: '#/components/schemas/_types.mapping.DenseVectorProperty' - $ref: '#/components/schemas/_types.mapping.FlattenedProperty' - $ref: '#/components/schemas/_types.mapping.NestedProperty' - $ref: '#/components/schemas/_types.mapping.ObjectProperty' - $ref: '#/components/schemas/_types.mapping.PassthroughObjectProperty' - $ref: '#/components/schemas/_types.mapping.RankVectorProperty' - $ref: '#/components/schemas/_types.mapping.SemanticTextProperty' - $ref: '#/components/schemas/_types.mapping.SparseVectorProperty' - $ref: '#/components/schemas/_types.mapping.CompletionProperty' - $ref: '#/components/schemas/_types.mapping.ConstantKeywordProperty' - $ref: '#/components/schemas/_types.mapping.CountedKeywordProperty' - $ref: '#/components/schemas/_types.mapping.FieldAliasProperty' - $ref: '#/components/schemas/_types.mapping.HistogramProperty' - $ref: '#/components/schemas/_types.mapping.ExponentialHistogramProperty' - $ref: '#/components/schemas/_types.mapping.IpProperty' - $ref: '#/components/schemas/_types.mapping.Murmur3HashProperty' - $ref: '#/components/schemas/_types.mapping.TokenCountProperty' - $ref: '#/components/schemas/_types.mapping.GeoPointProperty' - $ref: '#/components/schemas/_types.mapping.GeoShapeProperty' - $ref: '#/components/schemas/_types.mapping.PointProperty' - $ref: '#/components/schemas/_types.mapping.ShapeProperty' - $ref: '#/components/schemas/_types.mapping.ByteNumberProperty' - $ref: '#/components/schemas/_types.mapping.DoubleNumberProperty' - $ref: '#/components/schemas/_types.mapping.FloatNumberProperty' - $ref: '#/components/schemas/_types.mapping.HalfFloatNumberProperty' - $ref: '#/components/schemas/_types.mapping.IntegerNumberProperty' - $ref: '#/components/schemas/_types.mapping.LongNumberProperty' - $ref: '#/components/schemas/_types.mapping.ScaledFloatNumberProperty' - $ref: '#/components/schemas/_types.mapping.ShortNumberProperty' - $ref: '#/components/schemas/_types.mapping.UnsignedLongNumberProperty' - $ref: '#/components/schemas/_types.mapping.DateRangeProperty' - $ref: '#/components/schemas/_types.mapping.DoubleRangeProperty' - $ref: '#/components/schemas/_types.mapping.FloatRangeProperty' - $ref: '#/components/schemas/_types.mapping.IntegerRangeProperty' - $ref: '#/components/schemas/_types.mapping.IpRangeProperty' - $ref: '#/components/schemas/_types.mapping.LongRangeProperty' - $ref: '#/components/schemas/_types.mapping.IcuCollationProperty' ingest._types.SplitProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to split. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean preserve_trailing: description: Preserves empty trailing fields, if any. default: false type: boolean separator: description: A regex which matches the separator, for example, `,` or `\s+`. type: string target_field: description: 'The field to assign the split value to. By default, the field is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field - separator ingest._types.GeoGridProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: 'The field to interpret as a geo-tile.= The field format is determined by the `tile_type`.' type: string tile_type: description: 'Three tile formats are understood: geohash, geotile and geohex.' allOf: - $ref: '#/components/schemas/ingest._types.GeoGridTileType' target_field: description: The field to assign the polygon shape to, by default, the `field` is updated in-place. default: field allOf: - $ref: '#/components/schemas/_types.Field' parent_field: description: If specified and a parent tile exists, save that tile address to this field. allOf: - $ref: '#/components/schemas/_types.Field' children_field: description: If specified and children tiles exist, save those tile addresses to this field as an array of strings. allOf: - $ref: '#/components/schemas/_types.Field' non_children_field: description: If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings. allOf: - $ref: '#/components/schemas/_types.Field' precision_field: description: If specified, save the tile precision (zoom) as an integer to this field. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean target_format: description: Which format to save the generated polygon in. default: geojson allOf: - $ref: '#/components/schemas/ingest._types.GeoGridTargetFormat' required: - field - tile_type _types.query_dsl.DecayFunction: oneOf: - $ref: '#/components/schemas/_types.query_dsl.UntypedDecayFunction' - $ref: '#/components/schemas/_types.query_dsl.DateDecayFunction' - $ref: '#/components/schemas/_types.query_dsl.NumericDecayFunction' - $ref: '#/components/schemas/_types.query_dsl.GeoDecayFunction' _types.query_dsl.PrefixQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' value: description: Beginning characters of terms you wish to find in the provided field. type: string case_insensitive: description: 'Allows case insensitive matching of the value with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping.' default: false x-state: Generally available; Added in 7.10.0 type: boolean required: - value _types.analysis.IcuCollationDecomposition: type: string enum: - 'no' - identical _global.search._types.SourceConfig: description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. oneOf: - type: boolean - $ref: '#/components/schemas/_global.search._types.SourceFilter' _global.search._types.HighlightBase: type: object properties: type: allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterType' boundary_chars: description: A string that contains each boundary character. default: .,!? \t\n type: string boundary_max_scan: description: How far to scan for boundary characters. default: 20.0 type: number boundary_scanner: description: 'Specifies how to break the highlighted fragments: chars, sentence, or word. Only valid for the unified and fvh highlighters. Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter.' allOf: - $ref: '#/components/schemas/_global.search._types.BoundaryScanner' boundary_scanner_locale: description: 'Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`.' default: Locale.ROOT type: string force_source: deprecated: true type: boolean fragmenter: description: 'Specifies how text should be broken up in highlight snippets: `simple` or `span`. Only valid for the `plain` highlighter.' default: span allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterFragmenter' fragment_size: description: The size of the highlighted fragment in characters. default: 100.0 type: number highlight_filter: type: boolean highlight_query: description: 'Highlight matches for a query other than the search query. This is especially useful if you use a rescore query because those are not taken into account by highlighting by default.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' max_fragment_length: type: number max_analyzed_offset: description: 'If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting.' type: number no_match_size: description: The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. default: 0.0 type: number number_of_fragments: description: 'The maximum number of fragments to return. If the number of fragments is set to `0`, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If `number_of_fragments` is `0`, `fragment_size` is ignored.' default: 5.0 type: number options: type: object additionalProperties: type: object order: description: 'Sorts highlighted fragments by score when set to `score`. By default, fragments will be output in the order they appear in the field (order: `none`). Setting this option to `score` will output the most relevant fragments first. Each highlighter applies its own logic to compute relevancy scores.' default: none allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterOrder' phrase_limit: description: 'Controls the number of matching phrases in a document that are considered. Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory. When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the `fvh` highlighter.' default: 256.0 type: number post_tags: description: 'Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags.' type: array items: type: string pre_tags: description: 'Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags.' type: array items: type: string require_field_match: description: 'By default, only fields that contains a query match are highlighted. Set to `false` to highlight all fields.' default: true type: boolean tags_schema: description: Set to `styled` to use the built-in tag schema. allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterTagsSchema' _types.DurationLarge: description: 'A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and `y` (year)' type: string _types.LatLonGeoLocation: type: object properties: lat: description: Latitude type: number lon: description: Longitude type: number required: - lat - lon _types.aggregations.PercentilesAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: keyed: description: 'By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to `false` to disable this behavior.' default: true type: boolean percents: description: The percentiles to calculate. oneOf: - type: number - type: array items: type: number hdr: description: Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. allOf: - $ref: '#/components/schemas/_types.aggregations.HdrMethod' tdigest: description: Sets parameters for the default TDigest algorithm used to calculate percentiles. allOf: - $ref: '#/components/schemas/_types.aggregations.TDigest' _types.aggregations.NormalizeMethod: type: string enum: - rescale_0_1 - rescale_0_100 - percent_of_sum - mean - z-score - softmax _types.aggregations.VariableWidthHistogramAggregation: type: object properties: field: description: The name of the field. allOf: - $ref: '#/components/schemas/_types.Field' buckets: description: The target number of buckets. default: 10.0 type: number shard_size: description: 'The number of buckets that the coordinating node will request from each shard. Defaults to `buckets * 50`.' type: number initial_buffer: description: 'Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. Defaults to `min(10 * shard_size, 50000)`.' type: number script: allOf: - $ref: '#/components/schemas/_types.Script' _types.aggregations.RateAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: unit: description: 'The interval used to calculate the rate. By default, the interval of the `date_histogram` is used.' allOf: - $ref: '#/components/schemas/_types.aggregations.CalendarInterval' mode: description: How the rate is calculated. default: sum allOf: - $ref: '#/components/schemas/_types.aggregations.RateMode' ingest._types.SortProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to be sorted. allOf: - $ref: '#/components/schemas/_types.Field' order: description: 'The sort order to use. Accepts `"asc"` or `"desc"`.' default: asc allOf: - $ref: '#/components/schemas/_types.SortOrder' target_field: description: 'The field to assign the sorted value to. By default, the field is updated in-place.' allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.aggregations.CategorizeTextAggregation: description: 'A multi-bucket aggregation that groups semi-structured text into buckets. Each text field is re-analyzed using a custom analyzer. The resulting tokens are then categorized creating buckets of similarly formatted text values. This aggregation works best with machine generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.' allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: field: description: The semi-structured text field to categorize. allOf: - $ref: '#/components/schemas/_types.Field' max_unique_tokens: description: 'The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. Smaller values use less memory and create fewer categories. Larger values will use more memory and create narrower categories. Max allowed value is 100.' default: 50.0 type: number max_matched_tokens: description: 'The maximum number of token positions to match on before attempting to merge categories. Larger values will use more memory and create narrower categories. Max allowed value is 100.' default: 5.0 type: number similarity_threshold: description: 'The minimum percentage of tokens that must match for text to be added to the category bucket. Must be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory usage and create narrower categories.' default: 50.0 type: number categorization_filters: description: 'This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters.' type: array items: type: string categorization_analyzer: externalDocs: url: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze description: 'The categorization analyzer specifies how the text is analyzed and tokenized before being categorized. The syntax is very similar to that used to define the analyzer in the analyze API. This property cannot be used at the same time as `categorization_filters`.' allOf: - $ref: '#/components/schemas/_types.aggregations.CategorizeTextAnalyzer' shard_size: description: The number of categorization buckets to return from each shard before merging all the results. type: number size: description: The number of buckets to return. default: 10.0 type: number min_doc_count: description: The minimum number of documents in a bucket to be returned to the results. type: number shard_min_doc_count: description: The minimum number of documents in a bucket to be returned from the shard before merging. type: number required: - field _types.query_dsl.IntervalsFilter: type: object properties: after: description: Query used to return intervals that follow an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' before: description: Query used to return intervals that occur before an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' contained_by: description: Query used to return intervals contained by an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' containing: description: Query used to return intervals that contain an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' not_contained_by: description: Query used to return intervals that are **not** contained by an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' not_containing: description: Query used to return intervals that do **not** contain an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' not_overlapping: description: Query used to return intervals that do **not** overlap with an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' overlapping: description: Query used to return intervals that overlap with an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' script: description: 'Script used to return matching documents. This script must return a boolean value: `true` or `false`.' allOf: - $ref: '#/components/schemas/_types.Script' minProperties: 1 maxProperties: 1 _types.aggregations.TestPopulation: type: object properties: field: description: The field to aggregate. allOf: - $ref: '#/components/schemas/_types.Field' script: allOf: - $ref: '#/components/schemas/_types.Script' filter: description: A filter used to define a set of records to run unpaired t-test on. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - field _types.aggregations.CustomCategorizeTextAnalyzer: type: object properties: char_filter: type: array items: type: string tokenizer: type: string filter: type: array items: type: string _types.mapping.GeoStrategy: type: string enum: - recursive - term ingest._types.FailProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: message: description: 'The error message thrown by the processor. Supports template snippets.' type: string required: - message _types.aggregations.MultiTermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: collect_mode: description: Specifies the strategy for data collection. default: breadth_first allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationCollectMode' order: description: 'Specifies the sort order of the buckets. Defaults to sorting by descending document count.' allOf: - $ref: '#/components/schemas/_types.aggregations.AggregateOrder' min_doc_count: description: The minimum number of documents in a bucket for it to be returned. default: 1.0 type: number shard_min_doc_count: description: The minimum number of documents in a bucket on each shard for it to be returned. default: 1.0 type: number shard_size: description: 'The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.' type: number show_term_doc_count_error: description: Calculates the doc count error on per term basis. default: false type: boolean size: description: The number of term buckets should be returned out of the overall terms list. default: 10.0 type: number terms: description: The field from which to generate sets of terms. type: array items: $ref: '#/components/schemas/_types.aggregations.MultiTermLookup' required: - terms _types.short: type: number _global.search._types.Highlight: allOf: - $ref: '#/components/schemas/_global.search._types.HighlightBase' - type: object properties: encoder: allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterEncoder' fields: oneOf: - type: object additionalProperties: $ref: '#/components/schemas/_global.search._types.HighlightField' minProperties: 1 maxProperties: 1 - type: array items: type: object additionalProperties: $ref: '#/components/schemas/_global.search._types.HighlightField' minProperties: 1 maxProperties: 1 required: - fields _types.query_dsl.SpanFieldMaskingQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' query: allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - field - query _types.aggregations.GeoLinePoint: type: object properties: field: description: The name of the geo_point field. allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.aggregations.AdjacencyMatrixAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: filters: description: 'Filters used to create buckets. At least one filter is required.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' separator: description: Separator used to concatenate filter names. Defaults to &. type: string _types.query_dsl.ScriptQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: script: description: 'Contains a script to run as a query. This script must return a boolean value, `true` or `false`.' allOf: - $ref: '#/components/schemas/_types.Script' required: - script _types.query_dsl.RangeQueryBaseDateMath: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. allOf: - $ref: '#/components/schemas/_types.DateMath' gte: description: Greater than or equal to. allOf: - $ref: '#/components/schemas/_types.DateMath' lt: description: Less than. allOf: - $ref: '#/components/schemas/_types.DateMath' lte: description: Less than or equal to. allOf: - $ref: '#/components/schemas/_types.DateMath' _types.mapping.WildcardProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - wildcard null_value: x-state: Generally available; Added in 7.15.0 type: string required: - type _types.query_dsl.RangeQuery: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query oneOf: - $ref: '#/components/schemas/_types.query_dsl.UntypedRangeQuery' - $ref: '#/components/schemas/_types.query_dsl.DateRangeQuery' - $ref: '#/components/schemas/_types.query_dsl.NumberRangeQuery' - $ref: '#/components/schemas/_types.query_dsl.LongNumberRangeQuery' - $ref: '#/components/schemas/_types.query_dsl.TermRangeQuery' _types.mapping.FloatNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - float null_value: type: number required: - type _types.mapping.GeoOrientation: type: string enum: - right - RIGHT - counterclockwise - ccw - left - LEFT - clockwise - cw _types.Distance: type: string _types.aggregations.TopMetricsValue: type: object properties: field: description: A field to return as a metric. allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.aggregations.CumulativeSumAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.aggregations.GeoTileGridAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: 'Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geotile_grid` aggregates all array values.' allOf: - $ref: '#/components/schemas/_types.Field' precision: description: 'Integer zoom of the key used to define cells/buckets in the results. Values outside of the range [0,29] will be rejected.' default: '7' allOf: - $ref: '#/components/schemas/_types.GeoTilePrecision' shard_size: description: 'Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard.' type: number size: description: The maximum number of buckets to return. default: 10000.0 type: number bounds: description: A bounding box to filter the geo-points or geo-shapes in each bucket. allOf: - $ref: '#/components/schemas/_types.GeoBounds' _types.mapping.SourceField: type: object properties: enabled: type: boolean excludes: type: array items: type: string includes: type: array items: type: string mode: allOf: - $ref: '#/components/schemas/_types.mapping.SourceFieldMode' _types.query_dsl.DecayFunctionBase: type: object properties: multi_value_mode: description: Determines how the distance is calculated when a field used for computing the decay contains multiple values. default: min allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode' ingest._types.PipelineConfig: type: object properties: description: description: Description of the ingest pipeline. type: string version: description: Version number used by external systems to track ingest pipelines. allOf: - $ref: '#/components/schemas/_types.VersionNumber' processors: description: 'Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.' type: array items: $ref: '#/components/schemas/ingest._types.ProcessorContainer' required: - processors _types.query_dsl.GeoDistanceFeatureQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance' - type: object _global.search._types.HighlighterFragmenter: type: string enum: - simple - span text_structure._types.TopHit: type: object properties: count: type: number value: type: object required: - count - value _types.mapping.Murmur3HashProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - murmur3 required: - type _types.FieldValue: description: A field value. oneOf: - type: number - type: number - type: string - type: boolean - type: - string - 'null' _types.RankContainer: type: object properties: rrf: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reciprocal-rank-fusion description: The reciprocal rank fusion parameters allOf: - $ref: '#/components/schemas/_types.RrfRank' minProperties: 1 maxProperties: 1 _types.query_dsl.IntervalsPrefix: type: object properties: analyzer: description: Analyzer used to analyze the `prefix`. type: string prefix: description: Beginning characters of terms you wish to find in the top-level field. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' required: - prefix _types.mapping.LongNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - long null_value: type: number required: - type _types.aggregations.BucketAggregationBase: description: Base type for bucket aggregations. These aggregations also accept sub-aggregations. allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object _types.aggregations.ChiSquareHeuristic: type: object properties: background_is_superset: description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean include_negatives: description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. type: boolean required: - background_is_superset - include_negatives _types.mapping.IntegerRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - integer_range required: - type _global.search._types.PointInTimeReference: type: object properties: id: allOf: - $ref: '#/components/schemas/_types.Id' keep_alive: allOf: - $ref: '#/components/schemas/_types.Duration' required: - id _types.mapping.DocValuesPropertyBase: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: doc_values: allOf: - $ref: '#/components/schemas/_types.mapping.DocValues' _types.mapping.IpRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - ip_range required: - type _types.query_dsl.MoreLikeThisQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: externalDocs: url: https://www.elastic.co/docs/manage-data/data-store/text-analysis description: 'The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields.' type: string boost_terms: description: 'Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0).' default: 0.0 type: number fail_on_unsupported_field: description: Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). default: true type: boolean fields: description: 'A list of fields to fetch and analyze the text from. Defaults to the `index.query.default_field` index setting, which has a default value of `*`.' type: array items: $ref: '#/components/schemas/_types.Field' include: description: Specifies whether the input documents should also be included in the search results returned. default: false type: boolean like: description: Specifies free form text and/or a single or multiple documents for which you want to find similar documents. oneOf: - $ref: '#/components/schemas/_types.query_dsl.Like' - type: array items: $ref: '#/components/schemas/_types.query_dsl.Like' max_doc_freq: description: The maximum document frequency above which the terms are ignored from the input document. type: number max_query_terms: description: The maximum number of query terms that can be selected. default: 25.0 type: number max_word_length: description: 'The maximum word length above which the terms are ignored. Defaults to unbounded (`0`).' default: 0.0 type: number min_doc_freq: description: The minimum document frequency below which the terms are ignored from the input document. default: 5.0 type: number minimum_should_match: description: After the disjunctive query has been formed, this parameter controls the number of terms that must match. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' min_term_freq: description: The minimum term frequency below which the terms are ignored from the input document. default: 2.0 type: number min_word_length: description: The minimum word length below which the terms are ignored. default: 0.0 type: number routing: type: string stop_words: description: 'An array of stop words. Any word in this set is ignored.' allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' unlike: description: Used in combination with `like` to exclude documents that match a set of terms. oneOf: - $ref: '#/components/schemas/_types.query_dsl.Like' - type: array items: $ref: '#/components/schemas/_types.query_dsl.Like' version: allOf: - $ref: '#/components/schemas/_types.VersionNumber' version_type: default: '''internal''' allOf: - $ref: '#/components/schemas/_types.VersionType' required: - like _types.aggregations.CompositeTermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase' - type: object _types.query_dsl.RankFeatureFunctionSigmoid: allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction' - type: object properties: pivot: description: Configurable pivot value so that the result will be less than 0.5. type: number exponent: description: Configurable Exponent. type: number required: - pivot - exponent _types.RescoreVector: type: object properties: oversample: description: Applies the specified oversample factor to k on the approximate kNN search type: number required: - oversample _types.aggregations.TermsAggregationCollectMode: type: string enum: - depth_first - breadth_first _types.aggregations.WeightedAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: format: description: A numeric response formatter. type: string value: description: Configuration for the field that provides the values. allOf: - $ref: '#/components/schemas/_types.aggregations.WeightedAverageValue' value_type: allOf: - $ref: '#/components/schemas/_types.aggregations.ValueType' weight: description: Configuration for the field or script that provides the weights. allOf: - $ref: '#/components/schemas/_types.aggregations.WeightedAverageValue' _types.query_dsl.Like: description: Text that we want similar documents for or a lookup to a document's field for the text. oneOf: - type: string - $ref: '#/components/schemas/_types.query_dsl.LikeDocument' _types.RRFRetrieverEntry: description: Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight. oneOf: - $ref: '#/components/schemas/_types.RetrieverContainer' - $ref: '#/components/schemas/_types.RRFRetrieverComponent' _types.aggregations.AggregationContainer: allOf: - type: object properties: aggregations: description: 'Sub-aggregations for this aggregation. Only applies to bucket aggregations.' type: object additionalProperties: $ref: '#/components/schemas/_types.aggregations.AggregationContainer' meta: allOf: - $ref: '#/components/schemas/_types.Metadata' - type: object properties: adjacency_matrix: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation description: 'A bucket aggregation returning a form of adjacency matrix. The request provides a collection of named filter expressions, similar to the `filters` aggregation. Each bucket in the response represents a non-empty cell in the matrix of intersecting filters.' allOf: - $ref: '#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation' auto_date_histogram: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation 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. allOf: - $ref: '#/components/schemas/_types.aggregations.AutoDateHistogramAggregation' avg: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation description: A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.AverageAggregation' avg_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation description: 'A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation. The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.' allOf: - $ref: '#/components/schemas/_types.aggregations.AverageBucketAggregation' boxplot: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation description: A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.BoxplotAggregation' bucket_script: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation description: A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketScriptAggregation' bucket_selector: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation description: A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketSelectorAggregation' bucket_sort: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation description: A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketSortAggregation' bucket_count_ks_test: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation 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. x-state: Experimental allOf: - $ref: '#/components/schemas/_types.aggregations.BucketKsAggregation' bucket_correlation: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation description: A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation. x-state: Experimental allOf: - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationAggregation' cardinality: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation description: A single-value metrics aggregation that calculates an approximate count of distinct values. allOf: - $ref: '#/components/schemas/_types.aggregations.CardinalityAggregation' cartesian_bounds: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cartesian-bounds-aggregation description: A metric aggregation that computes the spatial bounding box containing all values for a Point or Shape field. allOf: - $ref: '#/components/schemas/_types.aggregations.CartesianBoundsAggregation' cartesian_centroid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cartesian-centroid-aggregation description: A metric aggregation that computes the weighted centroid from all coordinate values for point and shape fields. allOf: - $ref: '#/components/schemas/_types.aggregations.CartesianCentroidAggregation' categorize_text: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation description: A multi-bucket aggregation that groups semi-structured text into buckets. x-state: Experimental allOf: - $ref: '#/components/schemas/_types.aggregations.CategorizeTextAggregation' change_point: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-change-point-aggregation description: 'A sibling pipeline that detects, spikes, dips, and change points in a metric. Given a distribution of values provided by the sibling multi-bucket aggregation, this aggregation indicates the bucket of any spike or dip and/or the bucket at which the largest change in the distribution of values, if they are statistically significant. There must be at least 22 bucketed values. Fewer than 1,000 is preferred.' allOf: - $ref: '#/components/schemas/_types.aggregations.ChangePointAggregation' children: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation description: A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field. allOf: - $ref: '#/components/schemas/_types.aggregations.ChildrenAggregation' composite: description: 'A multi-bucket aggregation that creates composite buckets from different sources. Unlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.' allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregation' cumulative_cardinality: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation description: A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation' cumulative_sum: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation description: A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CumulativeSumAggregation' date_histogram: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation description: 'A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values.' allOf: - $ref: '#/components/schemas/_types.aggregations.DateHistogramAggregation' date_range: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation description: A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket. allOf: - $ref: '#/components/schemas/_types.aggregations.DateRangeAggregation' derivative: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation description: A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.DerivativeAggregation' diversified_sampler: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation description: 'A filtering aggregation used to limit any sub aggregations'' processing to a sample of the top-scoring documents. Similar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.' allOf: - $ref: '#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation' extended_stats: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation description: A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedStatsAggregation' extended_stats_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation description: A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation' frequent_item_sets: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation description: A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together. allOf: - $ref: '#/components/schemas/_types.aggregations.FrequentItemSetsAggregation' filter: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation description: A single bucket aggregation that narrows the set of documents to those that match a query. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' filters: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation description: A multi-bucket aggregation where each bucket contains the documents that match a query. allOf: - $ref: '#/components/schemas/_types.aggregations.FiltersAggregation' geo_bounds: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation description: A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field. allOf: - $ref: '#/components/schemas/_types.aggregations.GeoBoundsAggregation' geo_centroid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation description: A metric aggregation that computes the weighted centroid from all coordinate values for geo fields. allOf: - $ref: '#/components/schemas/_types.aggregations.GeoCentroidAggregation' geo_distance: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation description: 'A multi-bucket aggregation that works on `geo_point` fields. Evaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeoDistanceAggregation' geohash_grid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell is labeled using a geohash which is of user-definable precision.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeoHashGridAggregation' geo_line: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line description: Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field. allOf: - $ref: '#/components/schemas/_types.aggregations.GeoLineAggregation' geotile_grid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell corresponds to a map tile as used by many online map sites.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeoTileGridAggregation' geohex_grid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell corresponds to a H3 cell index and is labeled using the H3Index representation.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeohexGridAggregation' global: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation description: 'Defines a single bucket of all the documents within the search execution context. This context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.' allOf: - $ref: '#/components/schemas/_types.aggregations.GlobalAggregation' histogram: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation description: 'A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values.' allOf: - $ref: '#/components/schemas/_types.aggregations.HistogramAggregation' ip_range: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation description: A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket. allOf: - $ref: '#/components/schemas/_types.aggregations.IpRangeAggregation' ip_prefix: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation description: A bucket aggregation that groups documents based on the network or sub-network of an IP address. allOf: - $ref: '#/components/schemas/_types.aggregations.IpPrefixAggregation' inference: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation description: A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.InferenceAggregation' line: allOf: - $ref: '#/components/schemas/_types.aggregations.GeoLineAggregation' matrix_stats: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation description: 'A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.' allOf: - $ref: '#/components/schemas/_types.aggregations.MatrixStatsAggregation' max: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation description: A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.MaxAggregation' max_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation 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). allOf: - $ref: '#/components/schemas/_types.aggregations.MaxBucketAggregation' median_absolute_deviation: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation description: A single-value aggregation that approximates the median absolute deviation of its search results. allOf: - $ref: '#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation' min: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation description: A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.MinAggregation' min_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation 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). allOf: - $ref: '#/components/schemas/_types.aggregations.MinBucketAggregation' missing: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation 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). allOf: - $ref: '#/components/schemas/_types.aggregations.MissingAggregation' moving_avg: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregation' moving_percentiles: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation description: Given an ordered series of percentiles, "slides" a window across those percentiles and computes cumulative percentiles. allOf: - $ref: '#/components/schemas/_types.aggregations.MovingPercentilesAggregation' moving_fn: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation description: 'Given an ordered series of data, "slides" a window across the data and runs a custom script on each window of data. For convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.' allOf: - $ref: '#/components/schemas/_types.aggregations.MovingFunctionAggregation' multi_terms: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation description: A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values. allOf: - $ref: '#/components/schemas/_types.aggregations.MultiTermsAggregation' nested: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation description: A special single bucket aggregation that enables aggregating nested documents. allOf: - $ref: '#/components/schemas/_types.aggregations.NestedAggregation' normalize: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation description: A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value. allOf: - $ref: '#/components/schemas/_types.aggregations.NormalizeAggregation' parent: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation description: A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field. allOf: - $ref: '#/components/schemas/_types.aggregations.ParentAggregation' percentile_ranks: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation description: A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentileRanksAggregation' percentiles: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation description: A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentilesAggregation' percentiles_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation description: A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentilesBucketAggregation' range: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation description: A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket. allOf: - $ref: '#/components/schemas/_types.aggregations.RangeAggregation' rare_terms: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation 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. allOf: - $ref: '#/components/schemas/_types.aggregations.RareTermsAggregation' rate: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation description: 'Calculates a rate of documents or a field in each bucket. Can only be used inside a `date_histogram` or `composite` aggregation.' allOf: - $ref: '#/components/schemas/_types.aggregations.RateAggregation' reverse_nested: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation description: 'A special single bucket aggregation that enables aggregating on parent documents from nested documents. Should only be defined inside a `nested` aggregation.' allOf: - $ref: '#/components/schemas/_types.aggregations.ReverseNestedAggregation' random_sampler: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation description: 'A single bucket aggregation that randomly includes documents in the aggregated results. Sampling provides significant speed improvement at the cost of accuracy.' x-state: Experimental; Added in 8.1.0 allOf: - $ref: '#/components/schemas/_types.aggregations.RandomSamplerAggregation' sampler: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation description: A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents. allOf: - $ref: '#/components/schemas/_types.aggregations.SamplerAggregation' scripted_metric: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation description: A metric aggregation that uses scripts to provide a metric output. allOf: - $ref: '#/components/schemas/_types.aggregations.ScriptedMetricAggregation' serial_diff: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation description: An aggregation that subtracts values in a time series from themselves at different time lags or periods. allOf: - $ref: '#/components/schemas/_types.aggregations.SerialDifferencingAggregation' significant_terms: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation description: Returns interesting or unusual occurrences of terms in a set. allOf: - $ref: '#/components/schemas/_types.aggregations.SignificantTermsAggregation' significant_text: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation description: Returns interesting or unusual occurrences of free-text terms in a set. allOf: - $ref: '#/components/schemas/_types.aggregations.SignificantTextAggregation' stats: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation description: A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.StatsAggregation' stats_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation description: A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.StatsBucketAggregation' string_stats: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation description: A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.StringStatsAggregation' sum: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation description: A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.SumAggregation' sum_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation description: A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.SumBucketAggregation' terms: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation description: A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregation' time_series: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation description: 'The time series aggregation queries data created using a time series index. This is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.' x-state: Experimental allOf: - $ref: '#/components/schemas/_types.aggregations.TimeSeriesAggregation' top_hits: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation description: A metric aggregation that returns the top matching documents per bucket. allOf: - $ref: '#/components/schemas/_types.aggregations.TopHitsAggregation' t_test: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation 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. allOf: - $ref: '#/components/schemas/_types.aggregations.TTestAggregation' top_metrics: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics description: A metric aggregation that selects metrics from the document with the largest or smallest sort value. allOf: - $ref: '#/components/schemas/_types.aggregations.TopMetricsAggregation' value_count: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation description: A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.ValueCountAggregation' weighted_avg: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation description: A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.WeightedAverageAggregation' variable_width_histogram: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation 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. allOf: - $ref: '#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation' minProperties: 1 maxProperties: 1 _types.MinimumShouldMatch: description: The minimum number of terms that should match as integer, percentage or range oneOf: - type: number - type: string _types.aggregations.FrequentItemSetsField: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' exclude: description: 'Values to exclude. Can be regular expression strings or arrays of strings of exact terms.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' include: description: 'Values to include. Can be regular expression strings or arrays of strings of exact terms.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' required: - field _types.aggregations.CategorizeTextAnalyzer: oneOf: - type: string - $ref: '#/components/schemas/_types.aggregations.CustomCategorizeTextAnalyzer' _types.query_dsl.ScriptScoreQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: min_score: description: Documents with a score lower than this floating point number are excluded from the search results. type: number query: description: Query used to return documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' script: description: 'Script used to compute the score of documents returned by the query. Important: final relevance scores from the `script_score` query cannot be negative.' allOf: - $ref: '#/components/schemas/_types.Script' required: - query - script _types.mapping.DenseVectorIndexOptions: type: object properties: confidence_interval: description: 'The confidence interval to use when quantizing the vectors. Can be any value between and including `0.90` and `1.0` or exactly `0`. When the value is `0`, this indicates that dynamic quantiles should be calculated for optimized quantization. When between `0.90` and `1.0`, this value restricts the values used when calculating the quantization thresholds. For example, a value of `0.95` will only use the middle `95%` of the values when calculating the quantization thresholds (e.g. the highest and lowest `2.5%` of values will be ignored). Defaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4` for dynamic quantile calculation. Only applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat` index types.' type: number ef_construction: description: 'The number of candidates to track while assembling the list of nearest neighbors for each new node. Only applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types.' default: 100.0 type: number m: description: 'The number of neighbors each node will be connected to in the HNSW graph. Only applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types.' default: 16.0 type: number type: description: The type of kNN algorithm to use. allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorIndexOptionsType' rescore_vector: description: The rescore vector options. This is only applicable to `bbq_disk`, `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`, `bbq_flat`, `int4_flat`, and `int8_flat` index types. allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorIndexOptionsRescoreVector' on_disk_rescore: description: '`true` if vector rescoring should be done on-disk Only applicable to `bbq_disk`, `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`' default: false x-state: Experimental; Added in 9.3.0 type: boolean flat_index_threshold: description: 'The segment document count threshold below which HNSW graph construction is skipped in favor of brute-force flat search. `-1` (default) defers to format defaults: `300` for `bbq_hnsw`, `150` for `hnsw`, `int8_hnsw`, and `int4_hnsw`. `0` always builds the graph. A positive value overrides the format default. Only applicable to `hnsw`, `int8_hnsw`, `int4_hnsw`, and `bbq_hnsw` index types.' default: -1.0 x-state: Generally available; Added in 9.4.0 type: number required: - type _types.aggregations.ReverseNestedAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: path: description: 'Defines the nested object field that should be joined back to. The default is empty, which means that it joins back to the root/main document level.' allOf: - $ref: '#/components/schemas/_types.Field' _types.aggregations.GeoHashGridAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: bounds: description: The bounding box to filter the points in each bucket. allOf: - $ref: '#/components/schemas/_types.GeoBounds' field: description: 'Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geohash_grid` aggregates all array values.' allOf: - $ref: '#/components/schemas/_types.Field' precision: description: The string length of the geohashes used to define cells/buckets in the results. default: '5' allOf: - $ref: '#/components/schemas/_types.GeoHashPrecision' shard_size: description: 'Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard.' type: number size: description: The maximum number of geohash buckets to return. default: 10000.0 type: number _types.query_dsl.NestedQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. default: false type: boolean inner_hits: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits description: If defined, each search hit will contain inner hits. allOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' path: description: Path to the nested object you wish to search. allOf: - $ref: '#/components/schemas/_types.Field' query: description: Query you wish to run on nested objects in the path. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' score_mode: description: How scores for matching child objects affect the root parent document’s relevance score. default: '''avg''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ChildScoreMode' required: - path - query _types.query_dsl.TermQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: value: description: Term you wish to find in the provided field. allOf: - $ref: '#/components/schemas/_types.FieldValue' case_insensitive: description: 'Allows case insensitive matching of the value with the indexed field values when set to `true`. When `false`, the case sensitivity of matching depends on the underlying field’s mapping.' default: false x-state: Generally available; Added in 7.10.0 type: boolean required: - value _types.aggregations.EwmaModelSettings: type: object properties: alpha: type: number _types.mapping.SparseVectorIndexOptions: type: object properties: prune: description: 'Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false' x-state: Generally available; Added in 8.19.0 type: boolean pruning_config: description: 'Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.' x-state: Generally available; Added in 8.19.0 allOf: - $ref: '#/components/schemas/_types.TokenPruningConfig' _types.aggregations.FormatMetricAggregationBase: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: format: type: string _types.aggregations.ExtendedBoundsFieldDateMath: type: object properties: max: description: Maximum value for the bound. allOf: - $ref: '#/components/schemas/_types.aggregations.FieldDateMath' min: description: Minimum value for the bound. allOf: - $ref: '#/components/schemas/_types.aggregations.FieldDateMath' _types.query_dsl.GeoGridQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: geotile: allOf: - $ref: '#/components/schemas/_types.GeoTile' geohash: allOf: - $ref: '#/components/schemas/_types.GeoHash' geohex: allOf: - $ref: '#/components/schemas/_types.GeoHexCell' minProperties: 1 maxProperties: 1 _types.DistanceUnit: type: string enum: - in - ft - yd - mi - nmi - km - m - cm - mm _types.query_dsl.NumberRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBasedouble' - type: object _types.aggregations.AverageBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.aggregations.CardinalityExecutionMode: type: string enum: - global_ordinals - segment_ordinals - direct - save_memory_heuristic - save_time_heuristic _types.aggregations.RateMode: type: string enum: - sum - value_count _types.aggregations.CompositeGeoTileGridAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase' - type: object properties: precision: type: number bounds: allOf: - $ref: '#/components/schemas/_types.GeoBounds' _types.aggregations.DerivativeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.aggregations.CompositeHistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase' - type: object properties: interval: type: number required: - interval _types.aggregations.HdrMethod: type: object properties: number_of_significant_value_digits: description: Specifies the resolution of values for the histogram in number of significant digits. type: number _types.VersionNumber: type: number _global.search._types.TrackHits: description: 'Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.' oneOf: - type: boolean - type: number _types.query_dsl.FunctionScoreMode: type: string enum: - multiply - sum - avg - first - max - min _types.mapping.AllField: type: object properties: analyzer: type: string enabled: type: boolean omit_norms: type: boolean search_analyzer: type: string similarity: type: string store: type: boolean store_term_vector_offsets: type: boolean store_term_vector_payloads: type: boolean store_term_vector_positions: type: boolean store_term_vectors: type: boolean required: - analyzer - enabled - omit_norms - search_analyzer - similarity - store - store_term_vector_offsets - store_term_vector_payloads - store_term_vector_positions - store_term_vectors _types.mapping.NumberPropertyBase: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number coerce: type: boolean ignore_malformed: type: boolean index: type: boolean on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' script: allOf: - $ref: '#/components/schemas/_types.Script' time_series_metric: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. x-state: Experimental allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' time_series_dimension: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. default: false x-state: Experimental type: boolean indices._types.NumericFielddata: type: object properties: format: allOf: - $ref: '#/components/schemas/indices._types.NumericFielddataFormat' required: - format _types.query_dsl.GeoValidationMethod: type: string enum: - coerce - ignore_malformed - strict ingest._types.PipelineProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: name: description: 'The name of the pipeline to execute. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Name' ignore_missing_pipeline: description: Whether to ignore missing pipelines instead of failing. default: false type: boolean required: - name _types.aggregations.BucketCorrelationFunctionCountCorrelation: type: object properties: indicator: description: The indicator with which to correlate the configured `bucket_path` values. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator' required: - indicator ingest._types.DateIndexNameProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: date_formats: description: 'An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.' type: array items: type: string date_rounding: description: 'How to round the date when formatting the date into the index name. Valid values are: `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second). Supports template snippets.' type: string field: description: The field to get the date or timestamp from. allOf: - $ref: '#/components/schemas/_types.Field' index_name_format: description: 'The format to be used when printing the parsed date into the index name. A valid java time pattern is expected here. Supports template snippets.' default: yyyy-MM-dd type: string index_name_prefix: description: 'A prefix of the index name to be prepended before the printed date. Supports template snippets.' type: string locale: description: The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. default: ENGLISH type: string timezone: description: The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. default: UTC type: string required: - date_rounding - field text_structure.test_grok_pattern.MatchedField: type: object properties: match: type: string offset: type: number length: type: number required: - match - offset - length _types.query_dsl.LongNumberRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBaselong' - type: object _types.Duration: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units description: 'A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.' oneOf: - type: string - type: string enum: - '-1' - type: string enum: - '0' _types.mapping.TextIndexPrefixes: type: object properties: max_chars: type: number min_chars: type: number _types.query_dsl.DistanceFeatureQueryBaseDateMathDuration: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: origin: description: 'Date or point of origin used to calculate distances. If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. Date Math, such as `now-1h`, is supported. If the field value is a `geo_point` field, the `origin` value must be a geopoint.' allOf: - $ref: '#/components/schemas/_types.DateMath' pivot: description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value. If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.' allOf: - $ref: '#/components/schemas/_types.Duration' field: description: 'Name of the field used to calculate distances. This field must meet the following criteria: be a `date`, `date_nanos` or `geo_point` field; have an `index` mapping parameter value of `true`, which is the default; have an `doc_values` mapping parameter value of `true`, which is the default.' allOf: - $ref: '#/components/schemas/_types.Field' required: - origin - pivot - field _types.query_dsl.TermRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBasestring' - type: object ingest._types.ProcessorContainer: type: object properties: append: description: 'Appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. Accepts a single value or an array of values.' allOf: - $ref: '#/components/schemas/ingest._types.AppendProcessor' attachment: description: The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika. allOf: - $ref: '#/components/schemas/ingest._types.AttachmentProcessor' bytes: description: 'Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`). If the field is an array of strings, all members of the array will be converted. Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.' allOf: - $ref: '#/components/schemas/ingest._types.BytesProcessor' cef: description: Converts a CEF message into a structured format. allOf: - $ref: '#/components/schemas/ingest._types.CefProcessor' circle: description: Converts circle definitions of shapes to regular polygons which approximate them. allOf: - $ref: '#/components/schemas/ingest._types.CircleProcessor' community_id: description: 'Computes the Community ID for network flow data as defined in the Community ID Specification. You can use a community ID to correlate network events related to a single flow.' allOf: - $ref: '#/components/schemas/ingest._types.CommunityIDProcessor' convert: description: 'Converts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted.' allOf: - $ref: '#/components/schemas/ingest._types.ConvertProcessor' csv: description: 'Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.' allOf: - $ref: '#/components/schemas/ingest._types.CsvProcessor' date: description: Parses dates from fields, and then uses the date or timestamp as the timestamp for the document. allOf: - $ref: '#/components/schemas/ingest._types.DateProcessor' date_index_name: description: The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support. allOf: - $ref: '#/components/schemas/ingest._types.DateIndexNameProcessor' dissect: description: Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern. allOf: - $ref: '#/components/schemas/ingest._types.DissectProcessor' dot_expander: description: 'Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor.' allOf: - $ref: '#/components/schemas/ingest._types.DotExpanderProcessor' drop: description: 'Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.' allOf: - $ref: '#/components/schemas/ingest._types.DropProcessor' enrich: description: The `enrich` processor can enrich documents with data from another index. allOf: - $ref: '#/components/schemas/ingest._types.EnrichProcessor' fail: description: 'Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.' allOf: - $ref: '#/components/schemas/ingest._types.FailProcessor' fingerprint: description: 'Computes a hash of the document’s content. You can use this hash for content fingerprinting.' allOf: - $ref: '#/components/schemas/ingest._types.FingerprintProcessor' foreach: description: Runs an ingest processor on each element of an array or object. allOf: - $ref: '#/components/schemas/ingest._types.ForeachProcessor' ip_location: description: Currently an undocumented alias for GeoIP Processor. allOf: - $ref: '#/components/schemas/ingest._types.IpLocationProcessor' geo_grid: description: 'Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape. This is useful if there is a need to interact with the tile shapes as spatially indexable fields.' allOf: - $ref: '#/components/schemas/ingest._types.GeoGridProcessor' geoip: description: The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address. allOf: - $ref: '#/components/schemas/ingest._types.GeoIpProcessor' grok: description: 'Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.' allOf: - $ref: '#/components/schemas/ingest._types.GrokProcessor' gsub: description: 'Converts a string field by applying a regular expression and a replacement. If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception.' allOf: - $ref: '#/components/schemas/ingest._types.GsubProcessor' html_strip: description: 'Removes HTML tags from the field. If the field is an array of strings, HTML tags will be removed from all members of the array.' allOf: - $ref: '#/components/schemas/ingest._types.HtmlStripProcessor' inference: description: Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline. allOf: - $ref: '#/components/schemas/ingest._types.InferenceProcessor' join: description: 'Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.' allOf: - $ref: '#/components/schemas/ingest._types.JoinProcessor' json: description: Parses a string containing JSON data into a structured object, string, or other value. allOf: - $ref: '#/components/schemas/ingest._types.JsonProcessor' kv: description: This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety. allOf: - $ref: '#/components/schemas/ingest._types.KeyValueProcessor' lowercase: description: 'Converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted.' allOf: - $ref: '#/components/schemas/ingest._types.LowercaseProcessor' network_direction: description: 'Calculates the network direction given a source IP address, destination IP address, and a list of internal networks.' allOf: - $ref: '#/components/schemas/ingest._types.NetworkDirectionProcessor' pipeline: description: Executes another pipeline. allOf: - $ref: '#/components/schemas/ingest._types.PipelineProcessor' redact: description: 'The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns. The processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses. Text that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred.' allOf: - $ref: '#/components/schemas/ingest._types.RedactProcessor' registered_domain: description: 'Extracts the registered domain (also known as the effective top-level domain or eTLD), sub-domain, and top-level domain from a fully qualified domain name (FQDN). Uses the registered domains defined in the Mozilla Public Suffix List.' allOf: - $ref: '#/components/schemas/ingest._types.RegisteredDomainProcessor' remove: description: 'Removes existing fields. If one field doesn’t exist, an exception will be thrown.' allOf: - $ref: '#/components/schemas/ingest._types.RemoveProcessor' rename: description: 'Renames an existing field. If the field doesn’t exist or the new name is already used, an exception will be thrown.' allOf: - $ref: '#/components/schemas/ingest._types.RenameProcessor' reroute: description: 'Routes a document to another target index or data stream. When setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set. When the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.' allOf: - $ref: '#/components/schemas/ingest._types.RerouteProcessor' script: description: 'Runs an inline or stored script on incoming documents. The script runs in the `ingest` context.' allOf: - $ref: '#/components/schemas/ingest._types.ScriptProcessor' set: description: 'Adds a field with the specified value. If the field already exists, its value will be replaced with the provided one.' allOf: - $ref: '#/components/schemas/ingest._types.SetProcessor' set_security_user: description: Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest. allOf: - $ref: '#/components/schemas/ingest._types.SetSecurityUserProcessor' sort: description: 'Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically. Throws an error when the field is not an array.' allOf: - $ref: '#/components/schemas/ingest._types.SortProcessor' split: description: 'Splits a field into an array using a separator character. Only works on string fields.' allOf: - $ref: '#/components/schemas/ingest._types.SplitProcessor' terminate: description: 'Terminates the current ingest pipeline, causing no further processors to be run. This will normally be executed conditionally, using the `if` option.' allOf: - $ref: '#/components/schemas/ingest._types.TerminateProcessor' trim: description: 'Trims whitespace from a field. If the field is an array of strings, all members of the array will be trimmed. This only works on leading and trailing whitespace.' allOf: - $ref: '#/components/schemas/ingest._types.TrimProcessor' uppercase: description: 'Converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted.' allOf: - $ref: '#/components/schemas/ingest._types.UppercaseProcessor' urldecode: description: 'URL-decodes a string. If the field is an array of strings, all members of the array will be decoded.' allOf: - $ref: '#/components/schemas/ingest._types.UrlDecodeProcessor' uri_parts: description: 'Parses a Uniform Resource Identifier (URI) string and extracts its components as an object. This URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password.' allOf: - $ref: '#/components/schemas/ingest._types.UriPartsProcessor' user_agent: description: 'The `user_agent` processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the `user_agent` field.' allOf: - $ref: '#/components/schemas/ingest._types.UserAgentProcessor' minProperties: 1 maxProperties: 1 _types.aggregations.DateRangeExpression: type: object properties: from: description: Start of the range (inclusive). allOf: - $ref: '#/components/schemas/_types.aggregations.FieldDateMath' key: description: Custom key to return the range with. type: string to: description: End of the range (exclusive). allOf: - $ref: '#/components/schemas/_types.aggregations.FieldDateMath' _types.aggregations.ValueType: type: string enum: - string - long - double - number - date - date_nanos - ip - numeric - geo_point - boolean _global.search._types.Suggester: type: object properties: text: description: Global suggest text, to avoid repetition when the same text is used in several suggesters type: string ingest._types.JsonProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: add_to_root: description: 'Flag that forces the parsed JSON to be added at the top level of the document. `target_field` must not be set when this option is chosen.' default: false type: boolean add_to_root_conflict_strategy: description: 'When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden. When set to `merge`, conflicting fields will be merged. Only applicable `if add_to_root` is set to true.' allOf: - $ref: '#/components/schemas/ingest._types.JsonProcessorConflictStrategy' allow_duplicate_keys: description: 'When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins.' default: false type: boolean field: description: The field to be parsed. allOf: - $ref: '#/components/schemas/_types.Field' target_field: description: 'The field that the converted structured object will be written into. Any existing content in this field will be overwritten.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.aggregations.GeoBoundsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: wrap_longitude: description: Specifies whether the bounding box should be allowed to overlap the international date line. default: true type: boolean _types.LinearRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retrievers: description: Inner retrievers. type: array items: $ref: '#/components/schemas/_types.InnerRetriever' rank_window_size: type: number query: type: string fields: type: array items: type: string normalizer: allOf: - $ref: '#/components/schemas/_types.ScoreNormalizer' _types.mapping.UnsignedLongNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - unsigned_long null_value: allOf: - $ref: '#/components/schemas/_types.ulong' required: - type _types.LookupQueryVectorBuilder: type: object properties: id: description: The ID of the document to fetch the vector from type: string index: description: The name of the index to fetch the document from type: string path: description: The name of the field containing the vector type: string routing: description: The routing value to use when fetching the document type: string required: - id - index - path _types.query_dsl.MatchNoneQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object _types.query_dsl.UntypedDecayFunction: allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBase' - type: object _types.aggregations.SimpleMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - simple settings: allOf: - $ref: '#/components/schemas/_types.EmptyObject' required: - model - settings ingest._types.SetSecurityUserProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to store the user information into. allOf: - $ref: '#/components/schemas/_types.Field' properties: description: Controls what user related properties are added to the field. type: array items: type: string required: - field text_structure._types.EcsCompatibilityType: type: string enum: - disabled - v1 _types.mapping.OnScriptError: type: string enum: - fail - continue _types.query_dsl.ZeroTermsQuery: type: string enum: - all - none ingest._types.DropProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object _types.mapping.ScaledFloatNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - scaled_float null_value: type: number scaling_factor: type: number required: - type _types.uint: type: number _types.RetrieverBase: type: object properties: filter: description: Query to filter the documents that can match. oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' min_score: description: Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. type: number _name: description: Retriever name. type: string _types.mapping.TextProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: analyzer: type: string boost: type: number eager_global_ordinals: type: boolean fielddata: type: boolean fielddata_frequency_filter: allOf: - $ref: '#/components/schemas/indices._types.FielddataFrequencyFilter' index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' index_phrases: type: boolean index_prefixes: oneOf: - $ref: '#/components/schemas/_types.mapping.TextIndexPrefixes' - type: - string - 'null' norms: type: boolean position_increment_gap: type: number search_analyzer: type: string search_quote_analyzer: type: string similarity: oneOf: - type: string - type: - string - 'null' term_vector: allOf: - $ref: '#/components/schemas/_types.mapping.TermVectorOption' type: type: string enum: - text required: - type _types.aggregations.TDigest: type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number execution_hint: description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases). To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.' default: default allOf: - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint' _types.VersionType: type: string enum: - internal - external - external_gte text_structure.find_structure.FindStructureFormat: type: string enum: - ndjson - xml - delimited - semi_structured_text _types.StandardRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: query: description: Defines a query to retrieve a set of top documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' search_after: description: Defines a search after object parameter used for pagination. allOf: - $ref: '#/components/schemas/_types.SortResults' terminate_after: description: Maximum number of documents to collect for each shard. type: number sort: description: A sort object that that specifies the order of matching documents. allOf: - $ref: '#/components/schemas/_types.Sort' collapse: description: Collapses the top documents by a specified key into a single top document per key. allOf: - $ref: '#/components/schemas/_global.search._types.FieldCollapse' _types.aggregations.GeoDistanceAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: distance_type: description: The distance calculation type. default: arc allOf: - $ref: '#/components/schemas/_types.GeoDistanceType' field: description: A field of type `geo_point` used to evaluate the distance. allOf: - $ref: '#/components/schemas/_types.Field' origin: description: The origin used to evaluate the distance. allOf: - $ref: '#/components/schemas/_types.GeoLocation' ranges: description: An array of ranges used to bucket documents. type: array items: $ref: '#/components/schemas/_types.aggregations.AggregationRange' unit: description: The distance unit. default: m allOf: - $ref: '#/components/schemas/_types.DistanceUnit' _types.aggregations.RareTermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: exclude: description: Terms that should be excluded from the aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' field: description: The field from which to return rare terms. allOf: - $ref: '#/components/schemas/_types.Field' include: description: Terms that should be included in the aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' max_doc_count: description: The maximum number of documents a term should appear in. default: 1.0 type: number missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' precision: description: 'The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage.' default: 0.001 type: number value_type: type: string _types.aggregations.ExtendedBoundsdouble: type: object properties: max: description: Maximum value for the bound. type: number min: description: Minimum value for the bound. type: number _types.aggregations.BucketScriptAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: script: description: The script to run for this aggregation. allOf: - $ref: '#/components/schemas/_types.Script' _types.aggregations.TermsInclude: oneOf: - type: string - type: array items: type: string - $ref: '#/components/schemas/_types.aggregations.TermsPartition' _types.aggregations.LinearMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - linear settings: allOf: - $ref: '#/components/schemas/_types.EmptyObject' required: - model - settings ingest._types.GeoIpProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: database_file: description: The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. default: GeoLite2-City.mmdb type: string field: description: The field to get the ip address from for the geographical lookup. allOf: - $ref: '#/components/schemas/_types.Field' first_only: description: If `true`, only the first found geoip data will be returned, even if the field contains an array. default: true type: boolean ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean properties: description: Controls what properties are added to the `target_field` based on the geoip lookup. type: array items: type: string target_field: description: The field that will hold the geographical information looked up from the MaxMind database. default: geoip allOf: - $ref: '#/components/schemas/_types.Field' download_database_on_pipeline_creation: description: 'If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index.' type: boolean required: - field _types.aggregations.ValueCountAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormattableMetricAggregation' - type: object _types.query_dsl.HasChildQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. default: false type: boolean inner_hits: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits description: If defined, each search hit will contain inner hits. allOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' max_children: description: 'Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.' type: number min_children: description: 'Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.' type: number query: description: 'Query you wish to run on child documents of the `type` field. If a child document matches the search, the query returns the parent document.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' score_mode: description: Indicates how scores for matching child documents affect the root parent document’s relevance score. default: '''none''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ChildScoreMode' type: description: Name of the child relationship mapped for the `join` field. allOf: - $ref: '#/components/schemas/_types.RelationName' required: - query - type _types.query_dsl.DateDistanceFeatureQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration' - type: object _types.aggregations.GlobalAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object _types.mapping.DenseVectorIndexOptionsRescoreVector: type: object properties: oversample: description: 'The oversampling factor to use when searching for the nearest neighbor. This is only applicable to the quantized formats: `bbq_*`, `int4_*`, and `int8_*`. When provided, `oversample * k` vectors will be gathered and then their scores will be re-computed with the original vectors. valid values are between `1.0` and `10.0` (inclusive), or `0` exactly to disable oversampling.' type: number required: - oversample _types.aggregations.Aggregation: type: object ingest._types.GsubProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to apply the replacement to. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. default: false type: boolean pattern: description: The pattern to be replaced. type: string replacement: description: The string to replace the matching patterns with. type: string target_field: description: 'The field to assign the converted value to By default, the `field` is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field - pattern - replacement ingest._types.UriPartsProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: Field containing the URI string. allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean keep_original: description: If `true`, the processor copies the unparsed URI to `.original`. default: true type: boolean remove_if_successful: description: 'If `true`, the processor removes the `field` after parsing the URI string. If parsing fails, the processor does not remove the `field`.' default: false type: boolean target_field: description: Output field for the URI object. default: url allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.query_dsl.SpanOrQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: clauses: description: Array of one or more other span type queries. type: array items: $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - clauses _types.aggregations.TimeSeriesAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: size: description: The maximum number of results to return. default: 10000.0 type: number keyed: description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. type: boolean _types.query_dsl.BoolQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: filter: description: 'The clause (query) must appear in matching documents. However, unlike `must`, the score of the query will be ignored.' oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' minimum_should_match: description: Specifies the number or percentage of `should` clauses returned documents must match. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' must: description: The clause (query) must appear in matching documents and will contribute to the score. oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' must_not: description: 'The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of `0` is returned for all documents.' oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' should: description: The clause (query) should appear in the matching document. oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' _types.SpecifiedDocument: type: object properties: index: allOf: - $ref: '#/components/schemas/_types.IndexName' id: allOf: - $ref: '#/components/schemas/_types.Id' required: - id _types.query_dsl.SimpleQueryStringQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert text in the query string into tokens. type: string analyze_wildcard: description: If `true`, the query attempts to analyze wildcard terms in the query string. default: false type: boolean auto_generate_synonyms_phrase_query: description: If `true`, the parser creates a match_phrase query for each multi-position token. default: true type: boolean default_operator: description: Default boolean logic used to interpret text in the query string if no operators are specified. default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' fields: description: 'Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (`^`) notation. Defaults to the `index.query.default_field index` setting, which has a default value of `*`.' type: array items: $ref: '#/components/schemas/_types.Field' flags: description: List of enabled operators for the simple query string syntax. default: ALL allOf: - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringFlags' fuzzy_max_expansions: description: Maximum number of terms to which the query expands for fuzzy matching. default: 50.0 type: number fuzzy_prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. default: 0.0 type: number fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean lenient: description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. default: false type: boolean minimum_should_match: description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' query: description: Query string in the simple query string syntax you wish to parse and use for search. type: string quote_field_suffix: description: Suffix appended to quoted text in the query string. type: string required: - query _types.aggregations.InferenceConfigContainer: type: object properties: regression: description: Regression configuration for inference. allOf: - $ref: '#/components/schemas/ml._types.RegressionInferenceOptions' classification: description: Classification configuration for inference. allOf: - $ref: '#/components/schemas/ml._types.ClassificationInferenceOptions' minProperties: 1 maxProperties: 1 ingest._types.UserAgentProperty: type: string enum: - name - os - device - original - version _types.SortCombinations: oneOf: - $ref: '#/components/schemas/_types.Field' - $ref: '#/components/schemas/_types.SortOptions' _types.aggregations.GapPolicy: type: string enum: - skip - insert_zeros - keep_values _types.query_dsl.RangeQueryBasestring: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. type: string gte: description: Greater than or equal to. type: string lt: description: Less than. type: string lte: description: Less than or equal to. type: string _types.query_dsl.ScriptScoreFunction: type: object properties: script: description: A script that computes a score. allOf: - $ref: '#/components/schemas/_types.Script' required: - script _types.aggregations.DiversifiedSamplerAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: execution_hint: description: The type of value used for de-duplication. default: global_ordinals allOf: - $ref: '#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint' max_docs_per_value: description: Limits how many documents are permitted per choice of de-duplicating value. default: 1.0 type: number script: allOf: - $ref: '#/components/schemas/_types.Script' shard_size: description: Limits how many top-scoring documents are collected in the sample processed on each shard. default: 100.0 type: number field: description: The field used to provide values used for de-duplication. allOf: - $ref: '#/components/schemas/_types.Field' _types.aggregations.NestedAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: path: description: The path to the field of type `nested`. allOf: - $ref: '#/components/schemas/_types.Field' ingest._types.GeoGridTargetFormat: type: string enum: - geojson - wkt _types.aggregations.CalendarInterval: type: string enum: - second - 1s - minute - 1m - hour - 1h - day - 1d - week - 1w - month - 1M - quarter - 1q - year - 1y _types.mapping.FieldNamesField: type: object properties: enabled: type: boolean required: - enabled _types.ScriptSource: oneOf: - type: string - $ref: '#/components/schemas/_global.search._types.SearchRequestBody' _types.mapping.DoubleRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - double_range required: - type ingest._types.RenameProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: 'The field to be renamed. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean target_field: description: 'The new name of the field. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Field' required: - field - target_field _types.mapping.SourceFieldMode: type: string enum: - disabled - stored - synthetic _types.aggregations.CompositeAggregateKey: type: object additionalProperties: $ref: '#/components/schemas/_types.FieldValue' _types.mapping.GeoPointProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: ignore_malformed: type: boolean ignore_z_value: type: boolean null_value: allOf: - $ref: '#/components/schemas/_types.GeoLocation' index: type: boolean on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' script: allOf: - $ref: '#/components/schemas/_types.Script' type: type: string enum: - geo_point time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.GeoPointMetricType' required: - type _types.query_dsl.MatchQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string auto_generate_synonyms_phrase_query: description: If `true`, match phrase queries are automatically created for multi-term synonyms. default: true type: boolean cutoff_frequency: deprecated: true type: number fuzziness: description: Maximum edit distance allowed for matching. allOf: - $ref: '#/components/schemas/_types.Fuzziness' fuzzy_rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). default: true type: boolean lenient: description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. default: false type: boolean max_expansions: description: Maximum number of terms to which the query will expand. default: 50.0 type: number minimum_should_match: description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' operator: description: Boolean logic used to interpret text in the query value. default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. default: 0.0 type: number query: description: Text, number, boolean value or date you wish to find in the provided field. oneOf: - type: string - type: number - type: boolean zero_terms_query: description: Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. default: '''none''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery' required: - query _types.aggregations.CumulativeCardinalityAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.mapping.RankFeaturesProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: positive_score_impact: type: boolean type: type: string enum: - rank_features required: - type _types.query_dsl.SimpleQueryStringFlag: type: string enum: - NONE - AND - NOT - OR - PREFIX - PHRASE - PRECEDENCE - ESCAPE - WHITESPACE - FUZZY - NEAR - SLOP - ALL _types.query_dsl.WeightedTokensQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: tokens: description: The tokens representing this query oneOf: - type: object additionalProperties: type: number - type: array items: type: object additionalProperties: type: number pruning_config: description: Token pruning configurations allOf: - $ref: '#/components/schemas/_types.TokenPruningConfig' required: - tokens _types.mapping.ByteNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - byte null_value: allOf: - $ref: '#/components/schemas/_types.byte' required: - type _types.Routing: description: Only to be used in query and path parameters, as the array form is actually a csv oneOf: - type: string - type: array items: type: string ingest._types.EnrichProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: 'The field in the input document that matches the policies match_field used to retrieve the enrichment data. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. default: false type: boolean max_matches: description: 'The maximum number of matched documents to include under the configured target field. The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128.' default: 1.0 type: number override: description: 'If processor will update fields with pre-existing non-null-valued field. When set to `false`, such fields will not be touched.' default: true type: boolean policy_name: description: The name of the enrich policy to use. type: string shape_relation: description: 'A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. This option is only used for `geo_match` enrich policy types.' default: INTERSECTS allOf: - $ref: '#/components/schemas/_types.GeoShapeRelation' target_field: description: 'Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy. Supports template snippets.' allOf: - $ref: '#/components/schemas/_types.Field' required: - field - policy_name - target_field _types.aggregations.BucketsPath: description: 'Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type. Please refer to each aggregation''s documentation to know what buckets path forms they accept.' oneOf: - type: string - type: array items: type: string - type: object additionalProperties: type: string _types.aggregations.MinBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.mapping.ExponentialHistogramProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' type: type: string enum: - exponential_histogram required: - type _types.aggregations.GeoCentroidAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: count: type: number location: allOf: - $ref: '#/components/schemas/_types.GeoLocation' _types.mapping.HalfFloatNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - half_float null_value: type: number required: - type _types.query_dsl.IntervalsRange: type: object properties: analyzer: description: Analyzer used to analyze the `prefix`. type: string gte: description: Lower term, either gte or gt must be provided. type: string gt: description: Lower term, either gte or gt must be provided. type: string lte: description: Upper term, either lte or lt must be provided. type: string lt: description: Upper term, either lte or lt must be provided. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' _global.search._types.ScriptRescore: type: object properties: script: allOf: - $ref: '#/components/schemas/_types.Script' required: - script _types.mapping.KeywordProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number eager_global_ordinals: type: boolean index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' normalizer: type: string norms: type: boolean null_value: type: string similarity: oneOf: - type: string - type: - string - 'null' split_queries_on_whitespace: type: boolean time_series_dimension: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. x-state: Experimental type: boolean type: type: string enum: - keyword required: - type ingest._types.DateProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: The field to get the date from. allOf: - $ref: '#/components/schemas/_types.Field' formats: description: 'An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.' type: array items: type: string locale: description: 'The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets.' default: ENGLISH type: string target_field: description: The field that will hold the parsed date. default: '@timestamp' allOf: - $ref: '#/components/schemas/_types.Field' timezone: description: 'The timezone to use when parsing the date. Supports template snippets.' default: UTC type: string output_format: description: 'The format to use when writing the date to target_field. Must be a valid java time pattern.' default: yyyy-MM-dd'T'HH:mm:ss.SSSXXX type: string required: - field - formats _types.query_dsl.RankFeatureFunctionLogarithm: allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction' - type: object properties: scaling_factor: description: Configurable scaling factor. type: number required: - scaling_factor _types.query_dsl.GeoDistanceQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: distance: description: 'The radius of the circle centred on the specified location. Points which fall into this circle are considered to be matches.' allOf: - $ref: '#/components/schemas/_types.Distance' distance_type: description: 'How to compute the distance. Set to `plane` for a faster calculation that''s inaccurate on long distances and close to the poles.' default: '''arc''' allOf: - $ref: '#/components/schemas/_types.GeoDistanceType' validation_method: description: 'Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. Set to `COERCE` to also try to infer correct latitude or longitude.' default: '''strict''' allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod' ignore_unmapped: description: 'Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped.' default: false type: boolean required: - distance _types.query_dsl.GeoDecayFunction: allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBaseGeoLocationDistance' - type: object _types.aggregations.BucketCorrelationFunction: type: object properties: count_correlation: description: The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation' required: - count_correlation _types.query_dsl.IntervalsMatch: type: object properties: analyzer: description: Analyzer used to analyze terms in the query. type: string max_gaps: description: 'Maximum number of positions between the matching terms. Terms further apart than this are not considered matches.' default: -1.0 type: number ordered: description: If `true`, matching terms must appear in their specified order. default: false type: boolean query: description: Text you wish to find in the provided field. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' filter: description: An optional interval filter. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter' required: - query _types.mapping.RoutingField: type: object properties: required: type: boolean required: - required _types.aggregations.PercentilesBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: percents: description: The list of percentiles to calculate. type: array items: type: number _types.ChunkRescorer: type: object properties: size: description: The number of chunks per document to evaluate for reranking. type: number chunking_settings: description: Chunking settings to apply allOf: - $ref: '#/components/schemas/_types.mapping.ChunkRescorerChunkingSettings' _types.mapping.DateRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: format: type: string type: type: string enum: - date_range required: - type inference._types.EmbeddingContentType: type: string enum: - text - image - audio - video - pdf _types.aggregations.IpRangeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The date field whose values are used to build ranges. allOf: - $ref: '#/components/schemas/_types.Field' ranges: description: Array of IP ranges. type: array items: $ref: '#/components/schemas/_types.aggregations.IpRangeAggregationRange' _types.mapping.BooleanProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number fielddata: allOf: - $ref: '#/components/schemas/indices._types.NumericFielddata' index: type: boolean null_value: type: boolean ignore_malformed: type: boolean script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' time_series_dimension: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. x-state: Experimental type: boolean type: type: string enum: - boolean required: - type ingest._types.FingerprintDigest: type: string enum: - MD5 - SHA-1 - SHA-256 - SHA-512 - MurmurHash3 _types.aggregations.AggregateOrder: oneOf: - type: object additionalProperties: $ref: '#/components/schemas/_types.SortOrder' minProperties: 1 maxProperties: 1 - type: array items: type: object additionalProperties: $ref: '#/components/schemas/_types.SortOrder' minProperties: 1 maxProperties: 1 _types.aggregations.MinAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.aggregations.CompositeAggregationSource: type: object properties: terms: description: A terms aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeTermsAggregation' histogram: description: A histogram aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeHistogramAggregation' date_histogram: description: A date histogram aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation' geotile_grid: description: A geotile grid aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation' minProperties: 1 maxProperties: 1 _types.GrokPattern: type: string _types.aggregations.HoltLinearModelSettings: type: object properties: alpha: type: number beta: type: number ingest._types.JoinProcessor: allOf: - $ref: '#/components/schemas/ingest._types.ProcessorBase' - type: object properties: field: description: Field containing array values to join. allOf: - $ref: '#/components/schemas/_types.Field' separator: description: The separator character. type: string target_field: description: 'The field to assign the joined value to. By default, the field is updated in-place.' default: field allOf: - $ref: '#/components/schemas/_types.Field' required: - field - separator _types.UnitMillis: description: Time unit for milliseconds type: number parameters: text_structure.find_message_structure-timestamp_format: in: query name: timestamp_format description: 'The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz` Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS ''in'' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.' deprecated: false schema: type: string style: form text_structure.find_message_structure-quote: in: query name: quote description: 'If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote (`"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.' deprecated: false schema: type: string style: form text_structure.find_message_structure-delimiter: in: query name: delimiter description: 'If you the format is `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.' deprecated: false schema: type: string style: form text_structure.find_message_structure-explain: in: query name: explain description: If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. deprecated: false schema: default: false type: boolean style: form text_structure.find_message_structure-should_parse_recursively: in: query name: should_parse_recursively description: 'If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively. The nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting. Anything beyond that depth is parsed as an `object` type field. For formats other than `ndjson`, this parameter is ignored.' deprecated: false schema: default: false type: boolean style: form text_structure.find_message_structure-column_names: in: query name: column_names description: 'If the format is `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", for example.' deprecated: false schema: oneOf: - type: string - type: array items: type: string style: form text_structure.find_message_structure-format: in: query name: format description: 'The high level structure of the text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.' deprecated: false schema: $ref: '#/components/schemas/text_structure._types.FormatType' style: form text_structure.test_grok_pattern-ecs_compatibility: in: query name: ecs_compatibility description: 'The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. Valid values are `disabled` and `v1`.' deprecated: false schema: default: disabled type: string style: form text_structure.find_message_structure-timestamp_field: in: query name: timestamp_field description: 'The name of the field that contains the primary timestamp of each record in the text. In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text.' deprecated: false schema: $ref: '#/components/schemas/_types.Field' style: form text_structure.find_message_structure-timeout: in: query name: timeout description: 'The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires, it will be stopped.' deprecated: false schema: default: 25s allOf: - $ref: '#/components/schemas/_types.Duration' style: form text_structure.find_message_structure-grok_pattern: in: query name: grok_pattern description: 'If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern.' deprecated: false schema: $ref: '#/components/schemas/_types.GrokPattern' style: form text_structure.find_message_structure-ecs_compatibility: in: query name: ecs_compatibility description: 'The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.' deprecated: false schema: default: disabled allOf: - $ref: '#/components/schemas/text_structure._types.EcsCompatibilityType' style: form text_structure.find_message_structure-should_trim_fields: in: query name: should_trim_fields description: 'If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. Otherwise, the default value is `false`.' deprecated: false schema: type: boolean style: form responses: text_structure.test_grok_pattern-200: description: '' content: application/json: schema: type: object properties: matches: type: array items: $ref: '#/components/schemas/text_structure.test_grok_pattern.MatchedText' required: - matches examples: TestGrokPatternResponseExample1: description: A successful response from `GET _text_structure/test_grok_pattern`. value: "{\n \"matches\": [\n {\n \"matched\": true,\n \"fields\": {\n \"first_name\": [\n {\n \"match\": \"John\",\n \"offset\": 6,\n \"length\": 4\n }\n ],\n \"last_name\": [\n {\n \"match\": \"Doe\",\n \"offset\": 11,\n \"length\": 3\n }\n ]\n }\n },\n {\n \"matched\": false\n }\n ]\n}" text_structure.find_message_structure-200: description: '' content: application/json: schema: type: object properties: charset: type: string ecs_compatibility: allOf: - $ref: '#/components/schemas/text_structure._types.EcsCompatibilityType' field_stats: type: object additionalProperties: $ref: '#/components/schemas/text_structure._types.FieldStat' format: allOf: - $ref: '#/components/schemas/text_structure._types.FormatType' grok_pattern: allOf: - $ref: '#/components/schemas/_types.GrokPattern' java_timestamp_formats: type: array items: type: string joda_timestamp_formats: type: array items: type: string ingest_pipeline: allOf: - $ref: '#/components/schemas/ingest._types.PipelineConfig' mappings: allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' multiline_start_pattern: type: string need_client_timezone: type: boolean num_lines_analyzed: type: number num_messages_analyzed: type: number sample_start: type: string timestamp_field: allOf: - $ref: '#/components/schemas/_types.Field' required: - charset - field_stats - format - ingest_pipeline - mappings - need_client_timezone - num_lines_analyzed - num_messages_analyzed - sample_start examples: FindMessageStructureResponseExample1: description: A successful response from `POST _text_structure/find_message_structure`. value: "{\n \"num_lines_analyzed\" : 22,\n \"num_messages_analyzed\" : 22,\n \"sample_start\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\\n[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\\n\",\n \"charset\" : \"UTF-8\",\n \"format\" : \"semi_structured_text\",\n \"multiline_start_pattern\" : \"^\\\\[\\\\b\\\\d{4}-\\\\d{2}-\\\\d{2}[T ]\\\\d{2}:\\\\d{2}\",\n \"grok_pattern\" : \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\",\n \"ecs_compatibility\" : \"disabled\",\n \"timestamp_field\" : \"timestamp\",\n \"joda_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"java_timestamp_formats\" : [\n \"ISO8601\"\n ],\n \"need_client_timezone\" : true,\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"loglevel\" : {\n \"type\" : \"keyword\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n },\n \"ingest_pipeline\" : {\n \"description\" : \"Ingest pipeline created by text structure finder\",\n \"processors\" : [\n {\n \"grok\" : {\n \"field\" : \"message\",\n \"patterns\" : [\n \"\\\\[%{TIMESTAMP_ISO8601:timestamp}\\\\]\\\\[%{LOGLEVEL:loglevel} \\\\]\\\\[.*\"\n ],\n \"ecs_compatibility\" : \"disabled\"\n }\n },\n {\n \"date\" : {\n \"field\" : \"timestamp\",\n \"timezone\" : \"{{ event.timezone }}\",\n \"formats\" : [\n \"ISO8601\"\n ]\n }\n },\n {\n \"remove\" : {\n \"field\" : \"timestamp\"\n }\n }\n ]\n },\n \"field_stats\" : {\n \"loglevel\" : {\n \"count\" : 22,\n \"cardinality\" : 1,\n \"top_hits\" : [\n {\n \"value\" : \"INFO\",\n \"count\" : 22\n }\n ]\n },\n \"message\" : {\n \"count\" : 22,\n \"cardinality\" : 22,\n \"top_hits\" : [\n {\n \"value\" : \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"count\" : 1\n },\n {\n \"value\" : \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"count\" : 1\n }\n ]\n },\n \"timestamp\" : {\n \"count\" : 22,\n \"cardinality\" : 14,\n \"earliest\" : \"2024-03-05T10:52:36,256\",\n \"latest\" : \"2024-03-05T10:52:49,199\",\n \"top_hits\" : [\n {\n \"value\" : \"2024-03-05T10:52:41,044\",\n \"count\" : 6\n },\n {\n \"value\" : \"2024-03-05T10:52:41,043\",\n \"count\" : 3\n },\n {\n \"value\" : \"2024-03-05T10:52:41,059\",\n \"count\" : 2\n },\n {\n \"value\" : \"2024-03-05T10:52:36,256\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,038\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:41,042\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:43,291\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:46,098\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,227\",\n \"count\" : 1\n },\n {\n \"value\" : \"2024-03-05T10:52:47,259\",\n \"count\" : 1\n }\n ]\n }\n }\n}" requestBodies: text_structure.find_message_structure: content: application/json: schema: type: object properties: messages: description: The list of messages you want to analyze. type: array items: type: string required: - messages examples: FindMessageStructureRequestExample1: description: 'Run `POST _text_structure/find_message_structure` to analyze Elasticsearch log files. ' value: "{\n \"messages\": [\n \"[2024-03-05T10:52:36,256][INFO ][o.a.l.u.VectorUtilPanamaProvider] [laptop] Java vector incubator API enabled; uses preferredBitSize=128\",\n \"[2024-03-05T10:52:41,038][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-url]\",\n \"[2024-03-05T10:52:41,042][INFO ][o.e.p.PluginsService ] [laptop] loaded module [rest-root]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-core]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-redact]\",\n \"[2024-03-05T10:52:41,043][INFO ][o.e.p.PluginsService ] [laptop] loaded module [ingest-user-agent]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-monitoring]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [repository-s3]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-analytics]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-ent-search]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-autoscaling]\",\n \"[2024-03-05T10:52:41,044][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-painless]]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [lang-expression]\",\n \"[2024-03-05T10:52:41,059][INFO ][o.e.p.PluginsService ] [laptop] loaded module [x-pack-eql]\",\n \"[2024-03-05T10:52:43,291][INFO ][o.e.e.NodeEnvironment ] [laptop] heap size [16gb], compressed ordinary object pointers [true]\",\n \"[2024-03-05T10:52:46,098][INFO ][o.e.x.s.Security ] [laptop] Security is enabled\",\n \"[2024-03-05T10:52:47,227][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] Profiling is enabled\",\n \"[2024-03-05T10:52:47,259][INFO ][o.e.x.p.ProfilingPlugin ] [laptop] profiling index templates will not be installed or reinstalled\",\n \"[2024-03-05T10:52:47,755][INFO ][o.e.i.r.RecoverySettings ] [laptop] using rate limit [40mb] with [default=40mb, read=0b, write=0b, max=0b]\",\n \"[2024-03-05T10:52:47,787][INFO ][o.e.d.DiscoveryModule ] [laptop] using discovery type [multi-node] and seed hosts providers [settings]\",\n \"[2024-03-05T10:52:49,188][INFO ][o.e.n.Node ] [laptop] initialized\",\n \"[2024-03-05T10:52:49,199][INFO ][o.e.n.Node ] [laptop] starting ...\"\n ]\n}" required: true text_structure.test_grok_pattern: content: application/json: schema: type: object properties: grok_pattern: description: The Grok pattern to run on the text. allOf: - $ref: '#/components/schemas/_types.GrokPattern' text: description: The lines of text to run the Grok pattern on. type: array items: type: string required: - grok_pattern - text examples: TestGrokPatternRequestExample1: description: Run `GET _text_structure/test_grok_pattern` to test a Grok pattern. value: "{\n \"grok_pattern\": \"Hello %{WORD:first_name} %{WORD:last_name}\",\n \"text\": [\n \"Hello John Doe\",\n \"this does not match\"\n ]\n}" required: true