Run multiple templated searches | Elasticsearch API documentation

Get the cluster health status

GET /_cat/health

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

Query parameters

time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.
ts boolean

If true, returns HH:MM:SS and Unix epoch timestamps.
h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

Responses

200 application/json
Hide response attributes Show response attributes object
- epoch number | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  UnitSeconds number StringifiedEpochTimeUnitSeconds string
  
  Time unit for seconds
- timestamp string
  
  Time of day, expressed as HH:MM:SS
- cluster string
  
  cluster name
- status string
  
  health status
- node.total string
  
  total number of nodes
- node.data string
  
  number of nodes that can store data
- shards string
  
  total number of shards
- pri string
  
  number of primary shards
- relo string
  
  number of relocating nodes
- init string
  
  number of initializing nodes
- unassign.pri string
  
  number of unassigned primary shards
- unassign string
  
  number of unassigned shards
- pending_tasks string
  
  number of pending tasks
- max_task_wait_time string
  
  wait time of longest task pending
- active_shards_percent string
  
  active number of shards in percent

GET /_cat/health

curl \
 --request GET 'http://api.example.com/_cat/health' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps.

[
  {
    "epoch": "1475871424",
    "timestamp": "16:17:04",
    "cluster": "elasticsearch",
    "status": "green",
    "node.total": "1",
    "node.data": "1",
    "shards": "1",
    "pri": "1",
    "relo": "0",
    "init": "0",
    "unassign": "0",
    "unassign.pri": "0",
    "pending_tasks": "0",
    "max_task_wait_time": "-",
    "active_shards_percent": "100.0%"
  }
]

Get anomaly detection jobs Added in 7.7.0

GET /_cat/ml/anomaly_detectors/{job_id}

Api key auth Basic auth Bearer auth

Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.

Path parameters

job_id string Required

Identifier for the anomaly detection job.

Query parameters

allow_no_match boolean
Specifies what to do when the request:
- Contains wildcard expressions and there are no jobs that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches.
If true, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.
bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
h string | array[string]

Comma-separated list of column names to display.
s string | array[string]

Comma-separated list of column names or column aliases used to sort the response.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
- state string
  
  Values are closing, closed, opened, failed, or opening.
- opened_time string
  
  For open jobs only, the amount of time the job has been opened.
- assignment_explanation string
  
  For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.
- data.processed_records string
  
  The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the processed_record_count is the number of aggregation results processed, not the number of Elasticsearch documents.
- data.processed_fields string
  
  The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count.
- data.input_bytes number | string
  
  One of:
  ByteSize number ByteSize string
- data.input_records string
  
  The number of input documents posted to the anomaly detection job.
- data.input_fields string
  
  The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.
- data.invalid_dates string
  
  The number of input documents with either a missing date field or a date that could not be parsed.
- data.missing_fields string
  
  The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high missing_field_count is often not an indication of data issues. It is not necessarily a cause for concern.
- data.out_of_order_timestamps string
  
  The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order.
- data.empty_buckets string
  
  The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your bucket_span or using functions that are tolerant to gaps in data such as mean, non_null_sum or non_zero_count.
- data.sparse_buckets string
  
  The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer bucket_span.
- data.buckets string
  
  The total number of buckets processed.
- data.earliest_record string
  
  The timestamp of the earliest chronologically input document.
- data.latest_record string
  
  The timestamp of the latest chronologically input document.
- data.last string
  
  The timestamp at which data was last analyzed, according to server time.
- data.last_empty_bucket string
  
  The timestamp of the last bucket that did not contain any data.
- data.last_sparse_bucket string
  
  The timestamp of the last bucket that was considered sparse.
- model.bytes number | string
  
  One of:
  ByteSize number ByteSize string
- model.memory_status string
  
  Values are ok, soft_limit, or hard_limit.
- model.bytes_exceeded number | string
  
  One of:
  ByteSize number ByteSize string
- model.memory_limit string
  
  The upper limit for model memory usage, checked on increasing values.
- model.by_fields string
  
  The number of by field values that were analyzed by the models. This value is cumulative for all detectors in the job.
- model.over_fields string
  
  The number of over field values that were analyzed by the models. This value is cumulative for all detectors in the job.
- model.partition_fields string
  
  The number of partition field values that were analyzed by the models. This value is cumulative for all detectors in the job.
- model.bucket_allocation_failures string
  
  The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a hard_limit: memory_status property value.
- model.categorization_status string
  
  Values are ok or warn.
- model.categorized_doc_count string
  
  The number of documents that have had a field categorized.
- model.total_category_count string
  
  The number of categories created by categorization.
- model.frequent_category_count string
  
  The number of categories that match more than 1% of categorized documents.
- model.rare_category_count string
  
  The number of categories that match just one categorized document.
- model.dead_category_count string
  
  The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training.
- model.failed_category_count string
  
  The number of times that categorization wanted to create a new category but couldn’t because the job had hit its model_memory_limit. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed.
- model.log_time string
  
  The timestamp when the model stats were gathered, according to server time.
- model.timestamp string
  
  The timestamp of the last record when the model stats were gathered.
- forecasts.total string
  
  The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist.
- forecasts.memory.min string
  
  The minimum memory usage in bytes for forecasts related to the anomaly detection job.
- forecasts.memory.max string
  
  The maximum memory usage in bytes for forecasts related to the anomaly detection job.
- forecasts.memory.avg string
  
  The average memory usage in bytes for forecasts related to the anomaly detection job.
- forecasts.memory.total string
  
  The total memory usage in bytes for forecasts related to the anomaly detection job.
- forecasts.records.min string
  
  The minimum number of model_forecast documents written for forecasts related to the anomaly detection job.
- forecasts.records.max string
  
  The maximum number of model_forecast documents written for forecasts related to the anomaly detection job.
- forecasts.records.avg string
  
  The average number of model_forecast documents written for forecasts related to the anomaly detection job.
- forecasts.records.total string
  
  The total number of model_forecast documents written for forecasts related to the anomaly detection job.
- forecasts.time.min string
  
  The minimum runtime in milliseconds for forecasts related to the anomaly detection job.
- forecasts.time.max string
  
  The maximum runtime in milliseconds for forecasts related to the anomaly detection job.
- forecasts.time.avg string
  
  The average runtime in milliseconds for forecasts related to the anomaly detection job.
- forecasts.time.total string
  
  The total runtime in milliseconds for forecasts related to the anomaly detection job.
- node.id string
- node.name string
  
  The name of the assigned node.
- node.ephemeral_id string
- node.address string
  
  The network address of the assigned node.
- buckets.count string
  
  The number of bucket results produced by the job.
- buckets.time.total string
  
  The sum of all bucket processing times, in milliseconds.
- buckets.time.min string
  
  The minimum of all bucket processing times, in milliseconds.
- buckets.time.max string
  
  The maximum of all bucket processing times, in milliseconds.
- buckets.time.exp_avg string
  
  The exponential moving average of all bucket processing times, in milliseconds.
- buckets.time.exp_avg_hour string
  
  The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.

GET /_cat/ml/anomaly_detectors/{job_id}

curl \
 --request GET 'http://api.example.com/_cat/ml/anomaly_detectors/{job_id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.

[
  {
    "id": "high_sum_total_sales",
    "s": "closed",
    "dpr": "14022",
    "mb": "1.5mb"
  },
  {
    "id": "low_request_rate",
    "s": "closed",
    "dpr": "1216",
    "mb": "40.5kb"
  },
  {
    "id": "response_code_rates",
    "s": "closed",
    "dpr": "28146",
    "mb": "132.7kb"
  },
  {
    "id": "url_scanning",
    "s": "closed",
    "dpr": "28146",
    "mb": "501.6kb"
  }
]

Create or update a connector Beta

PUT /_connector/{connector_id}

Api key auth Basic auth Bearer auth

Path parameters

connector_id string Required

The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.

application/json

Body

description string
index_name string
is_native boolean
language string
name string
service_type string

Responses

200 application/json
Hide response attributes Show response attributes object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.
- id string Required

PUT /_connector/{connector_id}

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"index_name\": \"search-google-drive\",\n  \"name\": \"My Connector\",\n  \"service_type\": \"google_drive\"\n}"'

Request examples

{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "service_type": "google_drive"
}

{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "description": "My Connector to sync data to Elastic index from Google Drive",
  "service_type": "google_drive",
  "language": "english"
}

Response examples (200)

{
  "result": "created",
  "id": "my-connector"
}

Set a connector sync job error Technical preview

PUT /_connector/_sync_job/{connector_sync_job_id}/_error

Api key auth Basic auth Bearer auth

Set the error field for a connector sync job and set its status to error.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

Path parameters

connector_sync_job_id string Required

The unique identifier for the connector sync job.

application/json

Body Required

error string Required

The error for the connector sync job error field.

Responses

200 application/json

PUT /_connector/_sync_job/{connector_sync_job_id}/_error

curl \
 --request PUT 'http://api.example.com/_connector/_sync_job/{connector_sync_job_id}/_error' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"error\": \"some-error\"\n}"'

Request example

{
    "error": "some-error"
}

Response examples (200)

{}

Activate the connector draft filter Technical preview

PUT /_connector/{connector_id}/_filtering/_activate

Api key auth Basic auth Bearer auth

Activates the valid draft filtering for a connector.

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_filtering/_activate

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_filtering/_activate' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "result": "created"
}

Get term vector information

GET /{index}/_termvectors/{id}

Api key auth Basic auth Bearer auth

Get information and statistics about terms in the fields of a particular document.

You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request. You can specify the fields you are interested in through the fields parameter or by adding the fields to the request body. For example:

GET /my-index-000001/_termvectors/1?fields=message

Fields can be specified using wildcards, similar to the multi match query.

Term vectors are real-time by default, not near real-time. This can be changed by setting realtime parameter to false.

You can request three types of values: term information, term statistics, and field statistics. By default, all term information and field statistics are returned for all fields but term statistics are excluded.

Term information

term frequency in the field (always returned)
term positions (positions: true)
start and end offsets (offsets: true)
term payloads (payloads: true), as base64 encoded bytes

If the requested information wasn't stored in the index, it will be computed on the fly if possible. Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.

Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.

Behaviour

The term and field statistics are not accurate. Deleted documents are not taken into account. The information is only retrieved for the shard the requested document resides in. The term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context. By default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected. Use routing only to hit a particular shard.

Path parameters

index string Required

The name of the index that contains the document.
id string Required

A unique identifier for the document.

Query parameters

fields string | array[string]

A comma-separated list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.
field_statistics boolean
If true, the response includes:
- The document count (how many documents contain this field).
- The sum of document frequencies (the sum of document frequencies for all terms in this field).
- The sum of total term frequencies (the sum of total term frequencies of each term in this field).
offsets boolean

If true, the response includes term offsets.
payloads boolean

If true, the response includes term payloads.
positions boolean

If true, the response includes term positions.
preference string

The node or shard the operation should be performed on. It is random by default.
realtime boolean

If true, the request is real-time as opposed to near-real-time.
routing string

A custom value that is used to route operations to a specific shard.
term_statistics boolean
If true, the response includes:
- The total term frequency (how often a term occurs in all documents).
- The document frequency (the number of documents containing the current term).
By default these values are not returned since term statistics can have a serious performance impact.
version number

If true, returns the document version as part of a hit.
version_type string

The version type.

Values are internal, external, external_gte, or force.

application/json

Body

doc object

An artificial document (a document not present in the index) for which you want to retrieve term vectors.
filter object
Hide filter attributes Show filter attributes object
- max_doc_freq number
  
  Ignore words which occur in more than this many docs. Defaults to unbounded.
- max_num_terms number
  
  The maximum number of terms that must be returned per field.
- max_term_freq number
  
  Ignore words with more than this frequency in the source doc. It defaults to unbounded.
- max_word_length number
  
  The maximum word length above which words will be ignored. Defaults to unbounded.
- min_doc_freq number
  
  Ignore terms which do not occur in at least this many docs.
- min_term_freq number
  
  Ignore words with less than this frequency in the source doc.
- min_word_length number
  
  The minimum word length below which words will be ignored.
per_field_analyzer object

Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.
Hide per_field_analyzer attribute Show per_field_analyzer attribute object
- * string Additional properties
fields string | array[string]
field_statistics boolean
If true, the response includes:
- The document count (how many documents contain this field).
- The sum of document frequencies (the sum of document frequencies for all terms in this field).
- The sum of total term frequencies (the sum of total term frequencies of each term in this field).
offsets boolean

If true, the response includes term offsets.
payloads boolean

If true, the response includes term payloads.
positions boolean

If true, the response includes term positions.
term_statistics boolean
If true, the response includes:
- The total term frequency (how often a term occurs in all documents).
- The document frequency (the number of documents containing the current term).
By default these values are not returned since term statistics can have a serious performance impact.
routing string
version number
version_type string

Values are internal, external, external_gte, or force.

Responses

200 application/json
Hide response attributes Show response attributes object
- found boolean Required
- _id string
- _index string Required
- term_vectors object
  
  Hide term_vectors attribute Show term_vectors attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  field_statistics object
  
  Hide field_statistics attributes Show field_statistics attributes object
  
  doc_count number Required
  
  sum_doc_freq number Required
  
  sum_ttf number Required
  
  terms object Required
  
  Hide terms attribute Show terms attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  doc_freq number
  
  score number
  
  term_freq number Required
  
  tokens array[object]
  
  ttf number
- took number Required
- _version number Required

GET /{index}/_termvectors/{id}

curl \
 --request GET 'http://api.example.com/{index}/_termvectors/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"fields\" : [\"text\"],\n  \"offsets\" : true,\n  \"payloads\" : true,\n  \"positions\" : true,\n  \"term_statistics\" : true,\n  \"field_statistics\" : true\n}"'

Request examples

Run `GET /my-index-000001/_termvectors/1` to return all information and statistics for field `text` in document 1.

{
  "fields" : ["text"],
  "offsets" : true,
  "payloads" : true,
  "positions" : true,
  "term_statistics" : true,
  "field_statistics" : true
}

Run `GET /my-index-000001/_termvectors/1` to set per-field analyzers. A different analyzer than the one at the field may be provided by using the `per_field_analyzer` parameter.

{
  "doc" : {
    "fullname" : "John Doe",
    "text" : "test test test"
  },
  "fields": ["fullname"],
  "per_field_analyzer" : {
    "fullname": "keyword"
  }
}

Run `GET /imdb/_termvectors` to filter the terms returned based on their tf-idf scores. It returns the three most "interesting" keywords from the artificial document having the given "plot" field value. Notice that the keyword "Tony" or any stop words are not part of the response, as their tf-idf must be too low.

{
  "doc": {
    "plot": "When wealthy industrialist Tony Stark is forced to build an armored suit after a life-threatening incident, he ultimately decides to use its technology to fight against evil."
  },
  "term_statistics": true,
  "field_statistics": true,
  "positions": false,
  "offsets": false,
  "filter": {
    "max_num_terms": 3,
    "min_term_freq": 1,
    "min_doc_freq": 1
  }
}

Run `GET /my-index-000001/_termvectors/1`. Term vectors which are not explicitly stored in the index are automatically computed on the fly. This request returns all information and statistics for the fields in document 1, even though the terms haven't been explicitly stored in the index. Note that for the field text, the terms are not regenerated.

{
  "fields" : ["text", "some_field_without_term_vectors"],
  "offsets" : true,
  "positions" : true,
  "term_statistics" : true,
  "field_statistics" : true
}

Run `GET /my-index-000001/_termvectors`. Term vectors can be generated for artificial documents, that is for documents not present in the index. If dynamic mapping is turned on (default), the document fields not in the original mapping will be dynamically created.

{
  "doc" : {
    "fullname" : "John Doe",
    "text" : "test test test"
  }
}

Response examples (200)

A successful response from `GET /my-index-000001/_termvectors/1`.

{
  "_index": "my-index-000001",
  "_id": "1",
  "_version": 1,
  "found": true,
  "took": 6,
  "term_vectors": {
    "text": {
      "field_statistics": {
        "sum_doc_freq": 4,
        "doc_count": 2,
        "sum_ttf": 6
      },
      "terms": {
        "test": {
          "doc_freq": 2,
          "ttf": 4,
          "term_freq": 3,
          "tokens": [
            {
              "position": 0,
              "start_offset": 0,
              "end_offset": 4,
              "payload": "d29yZA=="
            },
            {
              "position": 1,
              "start_offset": 5,
              "end_offset": 9,
              "payload": "d29yZA=="
            },
            {
              "position": 2,
              "start_offset": 10,
              "end_offset": 14,
              "payload": "d29yZA=="
            }
          ]
        }
      }
    }
  }
}

A successful response from `GET /my-index-000001/_termvectors` with `per_field_analyzer` in the request body.

{
  "_index": "my-index-000001",
  "_version": 0,
  "found": true,
  "took": 6,
  "term_vectors": {
    "fullname": {
      "field_statistics": {
          "sum_doc_freq": 2,
          "doc_count": 4,
          "sum_ttf": 4
      },
      "terms": {
          "John Doe": {
            "term_freq": 1,
            "tokens": [
                {
                  "position": 0,
                  "start_offset": 0,
                  "end_offset": 8
                }
            ]
          }
      }
    }
  }
}

A successful response from `GET /my-index-000001/_termvectors` with a `filter` in the request body.

{
  "_index": "imdb",
  "_version": 0,
  "found": true,
  "term_vectors": {
      "plot": {
        "field_statistics": {
            "sum_doc_freq": 3384269,
            "doc_count": 176214,
            "sum_ttf": 3753460
        },
        "terms": {
            "armored": {
              "doc_freq": 27,
              "ttf": 27,
              "term_freq": 1,
              "score": 9.74725
            },
            "industrialist": {
              "doc_freq": 88,
              "ttf": 88,
              "term_freq": 1,
              "score": 8.590818
            },
            "stark": {
              "doc_freq": 44,
              "ttf": 47,
              "term_freq": 1,
              "score": 9.272792
            }
        }
      }
  }
}

Create or update an index template Added in 7.9.0

POST /_index_template/{name}

Api key auth Basic auth Bearer auth

Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. Index templates are applied during data stream or index creation. For data streams, these settings and mappings are applied when the stream's backing indices are created. Settings and mappings specified in a create index API request override any settings or mappings specified in an index template. Changes to index templates do not affect existing indices, including the existing backing indices of a data stream.

You can use C-style /* *\/ block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket.

Multiple matching templates

If multiple index templates match the name of a new index or data stream, the template with the highest priority is used.

Multiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.

Composing aliases, mappings, and settings

When multiple component templates are specified in the composed_of field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates. Any mappings, settings, or aliases from the parent index template are merged in next. Finally, any configuration on the index request itself is merged. Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration. If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one. This recursive merging strategy applies not only to field mappings, but also root options like dynamic_templates and meta. If an earlier component contains a dynamic_templates block, then by default new dynamic_templates entries are appended onto the end. If an entry already exists with the same key, then it is overwritten by the new definition.

Path parameters

name string Required

Index or template name

Query parameters

create boolean

If true, this request cannot replace or update existing index templates.
master_timeout string

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
cause string

User defined reason for creating/updating the index template

application/json

Body Required

index_patterns string | array[string]
composed_of array[string]

An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
template object
Hide template attributes Show template attributes object
- aliases object
  
  Aliases to add. If the index template includes a data_stream object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the index_routing, routing, and search_routing options.
  Hide aliases attribute Show aliases attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  filter object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  index_routing string
  
  is_hidden boolean
  
  If true, the alias is hidden. All indices for the alias must have the same is_hidden value.
  
  is_write_index boolean
  
  If true, the index is the write index for the alias.
  
  routing string
  
  search_routing string
- mappings object
  Hide mappings attributes Show mappings attributes object
  
  all_field object
  
  Hide all_field attributes Show all_field attributes object
  
  analyzer string Required
  
  enabled boolean Required
  
  omit_norms boolean Required
  
  search_analyzer string Required
  
  similarity string Required
  
  store boolean Required
  
  store_term_vector_offsets boolean Required
  
  store_term_vector_payloads boolean Required
  
  store_term_vector_positions boolean Required
  
  store_term_vectors boolean Required
  
  date_detection boolean
  
  dynamic string
  
  Values are strict, runtime, true, or false.
  
  dynamic_date_formats array[string]
  
  dynamic_templates array[object]
  
  _field_names object
  
  Hide _field_names attribute Show _field_names attribute object
  
  enabled boolean Required
  
  index_field object
  
  Hide index_field attribute Show index_field attribute object
  
  enabled boolean Required
  
  _meta object
  
  Hide _meta attribute Show _meta attribute object
  
  * object Additional properties
  
  numeric_detection boolean
  
  properties object
  
  _routing object
  
  Hide _routing attribute Show _routing attribute object
  
  required boolean Required
  
  _size object
  
  Hide _size attribute Show _size attribute object
  
  enabled boolean Required
  
  _source object
  
  Hide _source attributes Show _source attributes object
  
  compress boolean
  
  compress_threshold string
  
  enabled boolean
  
  excludes array[string]
  
  includes array[string]
  
  mode string
  
  Values are disabled, stored, or synthetic.
  
  runtime object
  
  Hide runtime attribute Show runtime attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  fields object
  
  For type composite
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  type string Required
  
  Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
  
  fetch_fields array[object]
  
  For type lookup
  
  Hide fetch_fields attributes Show fetch_fields attributes object
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  format string
  
  format string
  
  A custom format for date type runtime fields.
  
  input_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  target_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  target_index string
  
  script object
  
  Hide script attributes Show script attributes object
  
  source string | object
  
  One of:
  ScriptSource string ScriptSource object
  
  id string
  
  params object
  
  Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
  
  Hide params attribute Show params attribute object
  
  * object Additional properties
  
  lang string
  
  Any of:
  ScriptLanguage string ScriptLanguage string
  
  Values are painless, expression, mustache, or java.
  
  options object
  
  Hide options attribute Show options attribute object
  
  * string Additional properties
  
  type string Required
  
  Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
  
  enabled boolean
  
  subobjects string
  
  Values are true, false, or auto.
  
  _data_stream_timestamp object
  
  Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object
  
  enabled boolean Required
- settings object
  Hide settings attributes Show settings attributes object
  
  index object
  
  mode string
  
  routing_path string | array[string]
  
  One of:
  string-1 string array-2 array[string]
  
  soft_deletes object
  
  Hide soft_deletes attributes Show soft_deletes attributes object
  
  enabled boolean
  
  Indicates whether soft deletes are enabled on the index.
  
  retention_lease object
  
  Hide retention_lease attribute Show retention_lease attribute object
  
  period string Required
  
  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.
  
  sort object
  
  Hide sort attributes Show sort attributes object
  
  field string | array[string]
  
  order string | array[string]
  
  One of:
  SegmentSortOrder string array-2 array[string]
  
  Values are asc, ASC, desc, or DESC.
  
  mode string | array[string]
  
  One of:
  SegmentSortMode string array-2 array[string]
  
  Values are min, MIN, max, or MAX.
  
  missing string | array[string]
  
  One of:
  SegmentSortMissing string array-2 array[string]
  
  Values are _last or _first.
  
  number_of_shards number | string
  
  One of:
  number-1 number string-2 string
  
  number_of_replicas number | string
  
  One of:
  number-1 number string-2 string
  
  number_of_routing_shards number
  
  check_on_startup string
  
  Values are true, false, or checksum.
  
  codec string
  
  routing_partition_size number | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedinteger number Stringifiedinteger string
  
  load_fixed_bitset_filters_eagerly boolean
  
  hidden boolean | string
  
  One of:
  boolean-1 boolean string-2 string
  
  auto_expand_replicas string | null
  
  One of:
  string-1 string NullValue string | null
  
  merge object
  
  Hide merge attribute Show merge attribute object
  
  scheduler object
  
  Hide scheduler attributes Show scheduler attributes object
  
  max_thread_count number | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedinteger number Stringifiedinteger string
  
  max_merge_count number | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedinteger number Stringifiedinteger string
  
  search object
  
  Hide search attributes Show search attributes object
  
  idle object
  
  Hide idle attribute Show idle attribute object
  
  after string
  
  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.
  
  slowlog object
  
  Hide slowlog attributes Show slowlog attributes object
  
  level string
  
  source number
  
  reformat boolean
  
  threshold object
  
  Hide threshold attributes Show threshold attributes object
  
  query object
  
  Hide query attributes Show query attributes object
  
  warn string
  
  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.
  
  info string
  
  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.
  
  debug string
  
  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.
  
  trace string
  
  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.
  
  fetch object
  
  Hide fetch attributes Show fetch attributes object
  
  warn string
  
  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.
  
  info string
  
  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.
  
  debug string
  
  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.
  
  trace string
  
  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.
  
  refresh_interval string
  
  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.
  
  max_result_window number
  
  max_inner_result_window number
  
  max_rescore_window number
  
  max_docvalue_fields_search number
  
  max_script_fields number
  
  max_ngram_diff number
  
  max_shingle_diff number
  
  blocks object
  
  Hide blocks attributes Show blocks attributes object
  
  read_only boolean | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedboolean boolean Stringifiedboolean string
  
  read_only_allow_delete boolean | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedboolean boolean Stringifiedboolean string
  
  read boolean | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedboolean boolean Stringifiedboolean string
  
  write boolean | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedboolean boolean Stringifiedboolean string
  
  metadata boolean | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedboolean boolean Stringifiedboolean string
  
  max_refresh_listeners number
  
  analyze object
  
  Hide analyze attribute Show analyze attribute object
  
  max_token_count number | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedinteger number Stringifiedinteger string
  
  highlight object
  
  Hide highlight attribute Show highlight attribute object
  
  max_analyzed_offset number
  
  max_terms_count number
  
  max_regex_length number
  
  routing object
  
  Hide routing attributes Show routing attributes object
  
  allocation object
  
  Hide allocation attributes Show allocation attributes object
  
  enable string
  
  Values are all, primaries, new_primaries, or none.
  
  include object
  
  Hide include attributes Show include attributes object
  
  _tier_preference string
  
  _id string
  
  initial_recovery object
  
  Hide initial_recovery attribute Show initial_recovery attribute object
  
  _id string
  
  disk object
  
  Hide disk attribute Show disk attribute object
  
  threshold_enabled boolean | string
  
  One of:
  boolean-1 boolean string-2 string
  
  rebalance object
  
  Hide rebalance attribute Show rebalance attribute object
  
  enable string Required
  
  Values are all, primaries, replicas, or none.
  
  gc_deletes string
  
  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.
  
  default_pipeline string
  
  final_pipeline string
  
  lifecycle object
  
  Hide lifecycle attributes Show lifecycle attributes object
  
  name string
  
  indexing_complete boolean | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedboolean boolean Stringifiedboolean string
  
  origination_date number
  
  If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds.
  
  parse_origination_date boolean
  
  Set to true to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^{.*-{date_format}-\d+,} where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.
  
  step object
  
  Hide step attribute Show step attribute object
  
  wait_time_threshold string
  
  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.
  
  rollover_alias string
  
  The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indices, see Rollover.
  
  prefer_ilm boolean | string
  
  Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index).
  
  One of:
  boolean-1 boolean string-2 string
  
  provided_name string
  
  creation_date number | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  UnitMillis number StringifiedEpochTimeUnitMillis string
  
  Time unit for milliseconds
  
  creation_date_string string | number
  
  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.
  
  One of:
  DateTime string UnitMillis number
  
  uuid string
  
  version object
  
  Hide version attributes Show version attributes object
  
  created string
  
  created_string string
  
  verified_before_close boolean | string
  
  One of:
  boolean-1 boolean string-2 string
  
  format string | number
  
  One of:
  string-1 string number-2 number
  
  max_slices_per_scroll number
  
  translog object
  
  Hide translog attributes Show translog attributes object
  
  sync_interval string
  
  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.
  
  durability string
  
  Values are request, REQUEST, async, or ASYNC.
  
  flush_threshold_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  retention object
  
  Hide retention attributes Show retention attributes object
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  age string
  
  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.
  
  query_string object
  
  Hide query_string attribute Show query_string attribute object
  
  lenient boolean | string Required
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  Stringifiedboolean boolean Stringifiedboolean string
  
  priority number | string
  
  One of:
  number-1 number string-2 string
  
  top_metrics_max_size number
  
  analysis object
  
  Hide analysis attributes Show analysis attributes object
  
  analyzer object
  
  char_filter object
  
  filter object
  
  normalizer object
  
  tokenizer object
  
  settings object
  
  time_series object
  
  Hide time_series attributes Show time_series attributes object
  
  end_time string | number
  
  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.
  
  One of:
  DateTime string UnitMillis number
  
  start_time string | number
  
  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.
  
  One of:
  DateTime string UnitMillis number
  
  queries object
  
  Hide queries attribute Show queries attribute object
  
  cache object
  
  Hide cache attribute Show cache attribute object
  
  enabled boolean Required
  
  similarity object
  
  Configure custom similarity settings to customize how search results are scored.
  
  mapping object
  
  Hide mapping attributes Show mapping attributes object
  
  coerce boolean
  
  total_fields object
  
  Hide total_fields attributes Show total_fields attributes object
  
  limit number | string
  
  The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources.
  
  One of:
  number-1 number string-2 string
  
  ignore_dynamic_beyond_limit boolean | string
  
  This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. The fields that were not added to the mapping will be added to the _ignored field.
  
  One of:
  boolean-1 boolean string-2 string
  
  depth object
  
  Hide depth attribute Show depth attribute object
  
  limit number
  
  The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.
  
  nested_fields object
  
  Hide nested_fields attribute Show nested_fields attribute object
  
  limit number
  
  The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index.
  
  nested_objects object
  
  Hide nested_objects attribute Show nested_objects attribute object
  
  limit number
  
  The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects.
  
  field_name_length object
  
  Hide field_name_length attribute Show field_name_length attribute object
  
  limit number
  
  Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is Long.MAX_VALUE (no limit).
  
  dimension_fields object
  
  Hide dimension_fields attribute Show dimension_fields attribute object
  
  limit number
  
  [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
  
  source object
  
  Hide source attribute Show source attribute object
  
  mode string Required
  
  Values are disabled, stored, or synthetic.
  
  ignore_malformed boolean | string
  
  One of:
  boolean-1 boolean string-2 string
  
  indexing.slowlog object
  
  Hide indexing.slowlog attributes Show indexing.slowlog attributes object
  
  level string
  
  source number
  
  reformat boolean
  
  threshold object
  
  Hide threshold attribute Show threshold attribute object
  
  index object
  
  Hide index attributes Show index attributes object
  
  warn string
  
  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.
  
  info string
  
  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.
  
  debug string
  
  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.
  
  trace string
  
  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.
  
  indexing_pressure object
  
  Hide indexing_pressure attribute Show indexing_pressure attribute object
  
  memory object Required
  
  Hide memory attribute Show memory attribute object
  
  limit number
  
  Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, the node will reject new replica operations. Defaults to 10% of the heap.
  
  store object
  
  Hide store attributes Show store attributes object
  
  type string Required
  
  Any of:
  StorageType string StorageType string
  
  Values are fs, niofs, mmapfs, or hybridfs.
  
  allow_mmap boolean
  
  You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping.
- lifecycle object
  Hide lifecycle attributes Show lifecycle attributes object
  
  data_retention string
  
  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.
  
  downsampling object
  
  Hide downsampling attribute Show downsampling attribute object
  
  rounds array[object] Required
  
  The list of downsampling rounds to execute as part of this downsampling configuration
  
  Hide rounds attributes Show rounds attributes object
  
  after string Required
  
  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.
  
  config object Required
  
  Hide config attribute Show config attribute object
  
  fixed_interval string Required
  
  A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
  
  enabled boolean
  
  If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
data_stream object
Hide data_stream attributes Show data_stream attributes object
- hidden boolean
- allow_custom_routing boolean
priority number

Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.
version number
_meta object
Hide _meta attribute Show _meta attribute object
- * object Additional properties
allow_auto_create boolean

This setting overrides the value of the action.auto_create_index cluster setting. If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.
ignore_missing_component_templates array[string]

The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist
deprecated boolean

Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.

Responses

200 application/json
Hide response attribute Show response attribute object
- acknowledged boolean Required
  
  For a successful response, this value is always true. On failure, an exception is returned instead.

POST /_index_template/{name}

curl \
 --request POST 'http://api.example.com/_index_template/{name}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"index_patterns\" : [\"template*\"],\n  \"priority\" : 1,\n  \"template\": {\n    \"settings\" : {\n      \"number_of_shards\" : 2\n    }\n  }\n}"'

Request examples

{
  "index_patterns" : ["template*"],
  "priority" : 1,
  "template": {
    "settings" : {
      "number_of_shards" : 2
    }
  }
}

You can include index aliases in an index template. During index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to.

{
  "index_patterns": [
    "template*"
  ],
  "template": {
    "settings": {
      "number_of_shards": 1
    },
    "aliases": {
      "alias1": {},
      "alias2": {
        "filter": {
          "term": {
            "user.id": "kimchy"
          }
        },
        "routing": "shard-1"
      },
      "{index}-alias": {}
    }
  }
}

Response examples (200)

{
  "acknowledged": true
}

Get index statistics Added in 1.3.0

GET /{index}/_stats/{metric}

Api key auth Basic auth Bearer auth

For data streams, the API retrieves statistics for the stream's backing indices.

By default, the returned statistics are index-level with primaries and total aggregations. primaries are the values for only the primary shards. total are the accumulated values for both primary and replica shards.

To get shard-level statistics, set the level parameter to shards.

NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.

Path parameters

index string | array[string] Required

A comma-separated list of index names; use _all or empty string to perform the operation on all indices
metric string | array[string] Required

Limit the information returned the specific metrics.

Query parameters

completion_fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
expand_wildcards string | array[string]

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.
fielddata_fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in the statistics.
forbid_closed_indices boolean

If true, statistics are not collected from closed indices.
groups string | array[string]

Comma-separated list of search groups to include in the search statistics.
include_segment_file_sizes boolean

If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
include_unloaded_segments boolean

If true, the response includes information from segments that are not loaded into memory.
level string

Indicates whether statistics are aggregated at the cluster, index, or shard level.

Values are cluster, indices, or shards.

Responses

200 application/json
Hide response attributes Show response attributes object
- indices object
  
  Hide indices attribute Show indices attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  primaries object
  
  Hide primaries attributes Show primaries attributes object
  
  completion object
  
  Hide completion attributes Show completion attributes object
  
  size_in_bytes number Required
  
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  docs object
  
  Hide docs attributes Show docs attributes object
  
  count number Required
  
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  
  deleted number
  
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  
  fielddata object
  
  Hide fielddata attributes Show fielddata attributes object
  
  evictions number
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  flush object
  
  Hide flush attributes Show flush attributes object
  
  periodic number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  get object
  
  Hide get attributes Show get attributes object
  
  current number Required
  
  exists_time string
  
  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.
  
  exists_time_in_millis number
  
  Time unit for milliseconds
  
  exists_total number Required
  
  missing_time string
  
  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.
  
  missing_time_in_millis number
  
  Time unit for milliseconds
  
  missing_total number Required
  
  time string
  
  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.
  
  time_in_millis number
  
  Time unit for milliseconds
  
  total number Required
  
  indexing object
  
  Hide indexing attributes Show indexing attributes object
  
  index_current number Required
  
  delete_current number Required
  
  delete_time string
  
  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.
  
  delete_time_in_millis number
  
  Time unit for milliseconds
  
  delete_total number Required
  
  is_throttled boolean Required
  
  noop_update_total number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis number
  
  Time unit for milliseconds
  
  index_time string
  
  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.
  
  index_time_in_millis number
  
  Time unit for milliseconds
  
  index_total number Required
  
  index_failed number Required
  
  types object
  
  Hide types attribute Show types attribute object
  
  * object
  
  write_load number
  
  recent_write_load number
  
  peak_write_load number
  
  indices object Additional properties
  
  merges object
  
  Hide merges attributes Show merges attributes object
  
  current number Required
  
  current_docs number Required
  
  current_size string
  
  current_size_in_bytes number Required
  
  total number Required
  
  total_auto_throttle string
  
  total_auto_throttle_in_bytes number Required
  
  total_docs number Required
  
  total_size string
  
  total_size_in_bytes number Required
  
  total_stopped_time string
  
  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.
  
  total_stopped_time_in_millis number
  
  Time unit for milliseconds
  
  total_throttled_time string
  
  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.
  
  total_throttled_time_in_millis number
  
  Time unit for milliseconds
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  query_cache object
  
  Hide query_cache attributes Show query_cache attributes object
  
  cache_count number Required
  
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  
  cache_size number Required
  
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  
  evictions number Required
  
  Total number of query cache evictions across all shards assigned to selected nodes.
  
  hit_count number Required
  
  Total count of query cache hits across all shards assigned to selected nodes.
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  
  miss_count number Required
  
  Total count of query cache misses across all shards assigned to selected nodes.
  
  total_count number Required
  
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  
  recovery object
  
  Hide recovery attributes Show recovery attributes object
  
  current_as_source number Required
  
  current_as_target number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis number
  
  Time unit for milliseconds
  
  refresh object
  
  Hide refresh attributes Show refresh attributes object
  
  external_total number Required
  
  external_total_time_in_millis number
  
  Time unit for milliseconds
  
  listeners number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  request_cache object
  
  Hide request_cache attributes Show request_cache attributes object
  
  evictions number Required
  
  hit_count number Required
  
  memory_size string
  
  memory_size_in_bytes number Required
  
  miss_count number Required
  
  search object
  
  Hide search attributes Show search attributes object
  
  fetch_current number Required
  
  fetch_time string
  
  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.
  
  fetch_time_in_millis number
  
  Time unit for milliseconds
  
  fetch_total number Required
  
  open_contexts number
  
  query_current number Required
  
  query_time string
  
  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.
  
  query_time_in_millis number
  
  Time unit for milliseconds
  
  query_total number Required
  
  scroll_current number Required
  
  scroll_time string
  
  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.
  
  scroll_time_in_millis number
  
  Time unit for milliseconds
  
  scroll_total number Required
  
  suggest_current number Required
  
  suggest_time string
  
  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.
  
  suggest_time_in_millis number
  
  Time unit for milliseconds
  
  suggest_total number Required
  
  groups object
  
  Hide groups attribute Show groups attribute object
  
  * object
  
  segments object
  
  Hide segments attributes Show segments attributes object
  
  count number Required
  
  Total number of segments across all shards assigned to selected nodes.
  
  doc_values_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  doc_values_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  
  file_sizes object Required
  
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  
  Hide file_sizes attribute Show file_sizes attribute object
  
  * object Additional properties
  
  fixed_bit_set number | string
  
  One of:
  ByteSize number ByteSize string
  
  fixed_bit_set_memory_in_bytes number Required
  
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  
  index_writer_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  index_writer_max_memory_in_bytes number
  
  index_writer_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  
  max_unsafe_auto_id_timestamp number Required
  
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  
  memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  
  norms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  norms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  
  points_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  points_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  
  stored_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  stored_fields_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  
  terms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  
  terms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectory_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectors_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  
  version_map_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  version_map_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  
  store object
  
  Hide store attributes Show store attributes object
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  size_in_bytes number Required
  
  Total size, in bytes, of all shards assigned to selected nodes.
  
  reserved number | string
  
  One of:
  ByteSize number ByteSize string
  
  reserved_in_bytes number Required
  
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  
  total_data_set_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_data_set_size_in_bytes number
  
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  
  translog object
  
  Hide translog attributes Show translog attributes object
  
  earliest_last_modified_age number Required
  
  operations number Required
  
  size string
  
  size_in_bytes number Required
  
  uncommitted_operations number Required
  
  uncommitted_size string
  
  uncommitted_size_in_bytes number Required
  
  warmer object
  
  Hide warmer attributes Show warmer attributes object
  
  current number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  bulk object
  
  Hide bulk attributes Show bulk attributes object
  
  total_operations number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  total_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_size_in_bytes number Required
  
  avg_time string
  
  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.
  
  avg_time_in_millis number
  
  Time unit for milliseconds
  
  avg_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  avg_size_in_bytes number Required
  
  shard_stats object
  
  Hide shard_stats attribute Show shard_stats attribute object
  
  total_count number Required
  
  shards object
  
  Hide shards attribute Show shards attribute object
  
  * array[object] Additional properties
  
  Hide * attributes Show * attributes object
  
  commit object
  
  completion object
  
  docs object
  
  fielddata object
  
  flush object
  
  get object
  
  indexing object
  
  mappings object
  
  merges object
  
  shard_path object
  
  query_cache object
  
  recovery object
  
  refresh object
  
  request_cache object
  
  retention_leases object
  
  routing object
  
  search object
  
  segments object
  
  seq_no object
  
  store object
  
  translog object
  
  warmer object
  
  bulk object
  
  shards object
  
  shard_stats object
  
  indices object Additional properties
  
  total object
  
  Hide total attributes Show total attributes object
  
  completion object
  
  Hide completion attributes Show completion attributes object
  
  size_in_bytes number Required
  
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  docs object
  
  Hide docs attributes Show docs attributes object
  
  count number Required
  
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  
  deleted number
  
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  
  fielddata object
  
  Hide fielddata attributes Show fielddata attributes object
  
  evictions number
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  flush object
  
  Hide flush attributes Show flush attributes object
  
  periodic number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  get object
  
  Hide get attributes Show get attributes object
  
  current number Required
  
  exists_time string
  
  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.
  
  exists_time_in_millis number
  
  Time unit for milliseconds
  
  exists_total number Required
  
  missing_time string
  
  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.
  
  missing_time_in_millis number
  
  Time unit for milliseconds
  
  missing_total number Required
  
  time string
  
  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.
  
  time_in_millis number
  
  Time unit for milliseconds
  
  total number Required
  
  indexing object
  
  Hide indexing attributes Show indexing attributes object
  
  index_current number Required
  
  delete_current number Required
  
  delete_time string
  
  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.
  
  delete_time_in_millis number
  
  Time unit for milliseconds
  
  delete_total number Required
  
  is_throttled boolean Required
  
  noop_update_total number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis number
  
  Time unit for milliseconds
  
  index_time string
  
  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.
  
  index_time_in_millis number
  
  Time unit for milliseconds
  
  index_total number Required
  
  index_failed number Required
  
  types object
  
  Hide types attribute Show types attribute object
  
  * object
  
  write_load number
  
  recent_write_load number
  
  peak_write_load number
  
  indices object Additional properties
  
  merges object
  
  Hide merges attributes Show merges attributes object
  
  current number Required
  
  current_docs number Required
  
  current_size string
  
  current_size_in_bytes number Required
  
  total number Required
  
  total_auto_throttle string
  
  total_auto_throttle_in_bytes number Required
  
  total_docs number Required
  
  total_size string
  
  total_size_in_bytes number Required
  
  total_stopped_time string
  
  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.
  
  total_stopped_time_in_millis number
  
  Time unit for milliseconds
  
  total_throttled_time string
  
  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.
  
  total_throttled_time_in_millis number
  
  Time unit for milliseconds
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  query_cache object
  
  Hide query_cache attributes Show query_cache attributes object
  
  cache_count number Required
  
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  
  cache_size number Required
  
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  
  evictions number Required
  
  Total number of query cache evictions across all shards assigned to selected nodes.
  
  hit_count number Required
  
  Total count of query cache hits across all shards assigned to selected nodes.
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  
  miss_count number Required
  
  Total count of query cache misses across all shards assigned to selected nodes.
  
  total_count number Required
  
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  
  recovery object
  
  Hide recovery attributes Show recovery attributes object
  
  current_as_source number Required
  
  current_as_target number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis number
  
  Time unit for milliseconds
  
  refresh object
  
  Hide refresh attributes Show refresh attributes object
  
  external_total number Required
  
  external_total_time_in_millis number
  
  Time unit for milliseconds
  
  listeners number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  request_cache object
  
  Hide request_cache attributes Show request_cache attributes object
  
  evictions number Required
  
  hit_count number Required
  
  memory_size string
  
  memory_size_in_bytes number Required
  
  miss_count number Required
  
  search object
  
  Hide search attributes Show search attributes object
  
  fetch_current number Required
  
  fetch_time string
  
  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.
  
  fetch_time_in_millis number
  
  Time unit for milliseconds
  
  fetch_total number Required
  
  open_contexts number
  
  query_current number Required
  
  query_time string
  
  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.
  
  query_time_in_millis number
  
  Time unit for milliseconds
  
  query_total number Required
  
  scroll_current number Required
  
  scroll_time string
  
  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.
  
  scroll_time_in_millis number
  
  Time unit for milliseconds
  
  scroll_total number Required
  
  suggest_current number Required
  
  suggest_time string
  
  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.
  
  suggest_time_in_millis number
  
  Time unit for milliseconds
  
  suggest_total number Required
  
  groups object
  
  Hide groups attribute Show groups attribute object
  
  * object
  
  segments object
  
  Hide segments attributes Show segments attributes object
  
  count number Required
  
  Total number of segments across all shards assigned to selected nodes.
  
  doc_values_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  doc_values_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  
  file_sizes object Required
  
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  
  Hide file_sizes attribute Show file_sizes attribute object
  
  * object Additional properties
  
  fixed_bit_set number | string
  
  One of:
  ByteSize number ByteSize string
  
  fixed_bit_set_memory_in_bytes number Required
  
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  
  index_writer_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  index_writer_max_memory_in_bytes number
  
  index_writer_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  
  max_unsafe_auto_id_timestamp number Required
  
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  
  memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  
  norms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  norms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  
  points_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  points_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  
  stored_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  stored_fields_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  
  terms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  
  terms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectory_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectors_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  
  version_map_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  version_map_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  
  store object
  
  Hide store attributes Show store attributes object
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  size_in_bytes number Required
  
  Total size, in bytes, of all shards assigned to selected nodes.
  
  reserved number | string
  
  One of:
  ByteSize number ByteSize string
  
  reserved_in_bytes number Required
  
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  
  total_data_set_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_data_set_size_in_bytes number
  
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  
  translog object
  
  Hide translog attributes Show translog attributes object
  
  earliest_last_modified_age number Required
  
  operations number Required
  
  size string
  
  size_in_bytes number Required
  
  uncommitted_operations number Required
  
  uncommitted_size string
  
  uncommitted_size_in_bytes number Required
  
  warmer object
  
  Hide warmer attributes Show warmer attributes object
  
  current number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  bulk object
  
  Hide bulk attributes Show bulk attributes object
  
  total_operations number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  total_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_size_in_bytes number Required
  
  avg_time string
  
  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.
  
  avg_time_in_millis number
  
  Time unit for milliseconds
  
  avg_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  avg_size_in_bytes number Required
  
  shard_stats object
  
  Hide shard_stats attribute Show shard_stats attribute object
  
  total_count number Required
  
  uuid string
  
  health string
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  status string
  
  Values are open or close.
- _shards object Required
  
  Hide _shards attributes Show _shards attributes object
  
  failed number Required
  
  successful number Required
  
  total number Required
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  index string
  
  node string
  
  reason object Required
  
  Hide reason attributes Show reason attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  shard number Required
  
  status string
  
  skipped number
- _all object Required Additional properties
  
  Hide _all attributes Show _all attributes object
  
  primaries object
  
  Hide primaries attributes Show primaries attributes object
  
  completion object
  
  Hide completion attributes Show completion attributes object
  
  size_in_bytes number Required
  
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  size
  
  size_in_bytes number Required
  
  docs object
  
  Hide docs attributes Show docs attributes object
  
  count number Required
  
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  
  deleted number
  
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  
  fielddata object
  
  Hide fielddata attributes Show fielddata attributes object
  
  evictions number
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  memory_size
  
  memory_size_in_bytes number Required
  
  flush object
  
  Hide flush attributes Show flush attributes object
  
  periodic number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  get object
  
  Hide get attributes Show get attributes object
  
  current number Required
  
  exists_time string
  
  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.
  
  exists_time_in_millis number
  
  Time unit for milliseconds
  
  exists_total number Required
  
  missing_time string
  
  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.
  
  missing_time_in_millis number
  
  Time unit for milliseconds
  
  missing_total number Required
  
  time string
  
  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.
  
  time_in_millis number
  
  Time unit for milliseconds
  
  total number Required
  
  indexing object
  
  Hide indexing attributes Show indexing attributes object
  
  index_current number Required
  
  delete_current number Required
  
  delete_time string
  
  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.
  
  delete_time_in_millis number
  
  Time unit for milliseconds
  
  delete_total number Required
  
  is_throttled boolean Required
  
  noop_update_total number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis number
  
  Time unit for milliseconds
  
  index_time string
  
  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.
  
  index_time_in_millis number
  
  Time unit for milliseconds
  
  index_total number Required
  
  index_failed number Required
  
  types object
  
  Hide types attribute Show types attribute object
  
  * object
  
  write_load number
  
  recent_write_load number
  
  peak_write_load number
  
  indices object Additional properties
  
  merges object
  
  Hide merges attributes Show merges attributes object
  
  current number Required
  
  current_docs number Required
  
  current_size string
  
  current_size_in_bytes number Required
  
  total number Required
  
  total_auto_throttle string
  
  total_auto_throttle_in_bytes number Required
  
  total_docs number Required
  
  total_size string
  
  total_size_in_bytes number Required
  
  total_stopped_time string
  
  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.
  
  total_stopped_time_in_millis number
  
  Time unit for milliseconds
  
  total_throttled_time string
  
  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.
  
  total_throttled_time_in_millis number
  
  Time unit for milliseconds
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  query_cache object
  
  Hide query_cache attributes Show query_cache attributes object
  
  cache_count number Required
  
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  
  cache_size number Required
  
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  
  evictions number Required
  
  Total number of query cache evictions across all shards assigned to selected nodes.
  
  hit_count number Required
  
  Total count of query cache hits across all shards assigned to selected nodes.
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  
  miss_count number Required
  
  Total count of query cache misses across all shards assigned to selected nodes.
  
  total_count number Required
  
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  
  recovery object
  
  Hide recovery attributes Show recovery attributes object
  
  current_as_source number Required
  
  current_as_target number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis number
  
  Time unit for milliseconds
  
  refresh object
  
  Hide refresh attributes Show refresh attributes object
  
  external_total number Required
  
  external_total_time_in_millis number
  
  Time unit for milliseconds
  
  listeners number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  request_cache object
  
  Hide request_cache attributes Show request_cache attributes object
  
  evictions number Required
  
  hit_count number Required
  
  memory_size string
  
  memory_size_in_bytes number Required
  
  miss_count number Required
  
  search object
  
  Hide search attributes Show search attributes object
  
  fetch_current number Required
  
  fetch_time string
  
  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.
  
  fetch_time_in_millis number
  
  Time unit for milliseconds
  
  fetch_total number Required
  
  open_contexts number
  
  query_current number Required
  
  query_time string
  
  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.
  
  query_time_in_millis number
  
  Time unit for milliseconds
  
  query_total number Required
  
  scroll_current number Required
  
  scroll_time string
  
  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.
  
  scroll_time_in_millis number
  
  Time unit for milliseconds
  
  scroll_total number Required
  
  suggest_current number Required
  
  suggest_time string
  
  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.
  
  suggest_time_in_millis number
  
  Time unit for milliseconds
  
  suggest_total number Required
  
  groups object
  
  Hide groups attribute Show groups attribute object
  
  * object
  
  segments object
  
  Hide segments attributes Show segments attributes object
  
  count number Required
  
  Total number of segments across all shards assigned to selected nodes.
  
  doc_values_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  doc_values_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  
  file_sizes object Required
  
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  
  Hide file_sizes attribute Show file_sizes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  description string Required
  
  size_in_bytes number Required
  
  min_size_in_bytes number
  
  max_size_in_bytes number
  
  average_size_in_bytes number
  
  count number
  
  fixed_bit_set number | string
  
  One of:
  ByteSize number ByteSize string
  
  fixed_bit_set_memory_in_bytes number Required
  
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  
  index_writer_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  index_writer_max_memory_in_bytes number
  
  index_writer_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  
  max_unsafe_auto_id_timestamp number Required
  
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  
  memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  
  norms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  norms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  
  points_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  points_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  
  stored_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  stored_fields_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  
  terms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  
  terms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectory_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectors_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  
  version_map_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  version_map_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  
  store object
  
  Hide store attributes Show store attributes object
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  size_in_bytes number Required
  
  Total size, in bytes, of all shards assigned to selected nodes.
  
  reserved number | string
  
  One of:
  ByteSize number ByteSize string
  
  reserved_in_bytes number Required
  
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  
  total_data_set_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_data_set_size_in_bytes number
  
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  
  translog object
  
  Hide translog attributes Show translog attributes object
  
  earliest_last_modified_age number Required
  
  operations number Required
  
  size string
  
  size_in_bytes number Required
  
  uncommitted_operations number Required
  
  uncommitted_size string
  
  uncommitted_size_in_bytes number Required
  
  warmer object
  
  Hide warmer attributes Show warmer attributes object
  
  current number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  bulk object
  
  Hide bulk attributes Show bulk attributes object
  
  total_operations number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  total_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_size_in_bytes number Required
  
  avg_time string
  
  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.
  
  avg_time_in_millis number
  
  Time unit for milliseconds
  
  avg_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  avg_size_in_bytes number Required
  
  shard_stats object
  
  Hide shard_stats attribute Show shard_stats attribute object
  
  total_count number Required
  
  shards object
  
  Hide shards attribute Show shards attribute object
  
  * array[object] Additional properties
  
  Hide * attributes Show * attributes object
  
  commit object
  
  Hide commit attributes Show commit attributes object
  
  generation number Required
  
  id string Required
  
  num_docs number Required
  
  user_data object Required
  
  completion object
  
  Hide completion attributes Show completion attributes object
  
  size_in_bytes number Required
  
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  
  size
  
  fields object
  
  docs object
  
  Hide docs attributes Show docs attributes object
  
  count number Required
  
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  
  deleted number
  
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  
  fielddata object
  
  Hide fielddata attributes Show fielddata attributes object
  
  evictions number
  
  memory_size
  
  memory_size_in_bytes number Required
  
  fields object
  
  flush object
  
  Hide flush attributes Show flush attributes object
  
  periodic number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis
  
  get object
  
  Hide get attributes Show get attributes object
  
  current number Required
  
  exists_time string
  
  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.
  
  exists_time_in_millis
  
  exists_total number Required
  
  missing_time string
  
  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.
  
  missing_time_in_millis
  
  missing_total number Required
  
  time string
  
  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.
  
  time_in_millis
  
  total number Required
  
  indexing object
  
  Hide indexing attributes Show indexing attributes object
  
  index_current number Required
  
  delete_current number Required
  
  delete_time string
  
  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.
  
  delete_time_in_millis
  
  delete_total number Required
  
  is_throttled boolean Required
  
  noop_update_total number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis
  
  index_time string
  
  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.
  
  index_time_in_millis
  
  index_total number Required
  
  index_failed number Required
  
  types object
  
  write_load number
  
  recent_write_load number
  
  peak_write_load number
  
  mappings object
  
  Hide mappings attributes Show mappings attributes object
  
  total_count number Required
  
  total_estimated_overhead
  
  total_estimated_overhead_in_bytes number Required
  
  merges object
  
  Hide merges attributes Show merges attributes object
  
  current number Required
  
  current_docs number Required
  
  current_size string
  
  current_size_in_bytes number Required
  
  total number Required
  
  total_auto_throttle string
  
  total_auto_throttle_in_bytes number Required
  
  total_docs number Required
  
  total_size string
  
  total_size_in_bytes number Required
  
  total_stopped_time string
  
  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.
  
  total_stopped_time_in_millis
  
  total_throttled_time string
  
  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.
  
  total_throttled_time_in_millis
  
  total_time string
  
  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.
  
  total_time_in_millis
  
  shard_path object
  
  Hide shard_path attributes Show shard_path attributes object
  
  data_path string Required
  
  is_custom_data_path boolean Required
  
  state_path string Required
  
  query_cache object
  
  Hide query_cache attributes Show query_cache attributes object
  
  cache_count number Required
  
  cache_size number Required
  
  evictions number Required
  
  hit_count number Required
  
  memory_size_in_bytes number Required
  
  miss_count number Required
  
  total_count number Required
  
  recovery object
  
  Hide recovery attributes Show recovery attributes object
  
  current_as_source number Required
  
  current_as_target number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis
  
  refresh object
  
  Hide refresh attributes Show refresh attributes object
  
  external_total number Required
  
  external_total_time_in_millis
  
  listeners number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis
  
  request_cache object
  
  Hide request_cache attributes Show request_cache attributes object
  
  evictions number Required
  
  hit_count number Required
  
  memory_size string
  
  memory_size_in_bytes number Required
  
  miss_count number Required
  
  retention_leases object
  
  Hide retention_leases attributes Show retention_leases attributes object
  
  primary_term number Required
  
  version number Required
  
  leases array[object] Required
  
  routing object
  
  Hide routing attributes Show routing attributes object
  
  node string Required
  
  primary boolean Required
  
  relocating_node
  
  state string Required
  
  Values are UNASSIGNED, INITIALIZING, STARTED, or RELOCATING.
  
  search object
  
  Hide search attributes Show search attributes object
  
  fetch_current number Required
  
  fetch_time string
  
  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.
  
  fetch_time_in_millis
  
  fetch_total number Required
  
  open_contexts number
  
  query_current number Required
  
  query_time string
  
  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.
  
  query_time_in_millis
  
  query_total number Required
  
  scroll_current number Required
  
  scroll_time string
  
  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.
  
  scroll_time_in_millis
  
  scroll_total number Required
  
  suggest_current number Required
  
  suggest_time string
  
  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.
  
  suggest_time_in_millis
  
  suggest_total number Required
  
  groups object
  
  segments object
  
  Hide segments attributes Show segments attributes object
  
  count number Required
  
  Total number of segments across all shards assigned to selected nodes.
  
  doc_values_memory
  
  doc_values_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  
  file_sizes object Required
  
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  
  fixed_bit_set
  
  fixed_bit_set_memory_in_bytes number Required
  
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  
  index_writer_memory
  
  index_writer_max_memory_in_bytes number
  
  index_writer_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  
  max_unsafe_auto_id_timestamp number Required
  
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  
  memory
  
  memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  
  norms_memory
  
  norms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  
  points_memory
  
  points_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  
  stored_memory
  
  stored_fields_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  
  terms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  
  terms_memory
  
  term_vectory_memory
  
  term_vectors_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  
  version_map_memory
  
  version_map_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  
  seq_no object
  
  Hide seq_no attributes Show seq_no attributes object
  
  global_checkpoint number Required
  
  local_checkpoint number Required
  
  max_seq_no number Required
  
  store object
  
  Hide store attributes Show store attributes object
  
  size
  
  size_in_bytes number Required
  
  Total size, in bytes, of all shards assigned to selected nodes.
  
  reserved
  
  reserved_in_bytes number Required
  
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  
  total_data_set_size
  
  total_data_set_size_in_bytes number
  
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  
  translog object
  
  Hide translog attributes Show translog attributes object
  
  earliest_last_modified_age number Required
  
  operations number Required
  
  size string
  
  size_in_bytes number Required
  
  uncommitted_operations number Required
  
  uncommitted_size string
  
  uncommitted_size_in_bytes number Required
  
  warmer object
  
  Hide warmer attributes Show warmer attributes object
  
  current number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis
  
  bulk object
  
  Hide bulk attributes Show bulk attributes object
  
  total_operations number Required
  
  total_time string
  
  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.
  
  total_time_in_millis
  
  total_size
  
  total_size_in_bytes number Required
  
  avg_time string
  
  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.
  
  avg_time_in_millis
  
  avg_size
  
  avg_size_in_bytes number Required
  
  shards object
  
  Hide shards attribute Show shards attribute object
  
  * object Additional properties
  
  shard_stats object
  
  Hide shard_stats attribute Show shard_stats attribute object
  
  total_count number Required
  
  indices object Additional properties
  
  total object
  
  Hide total attributes Show total attributes object
  
  completion object
  
  Hide completion attributes Show completion attributes object
  
  size_in_bytes number Required
  
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  size
  
  size_in_bytes number Required
  
  docs object
  
  Hide docs attributes Show docs attributes object
  
  count number Required
  
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  
  deleted number
  
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  
  fielddata object
  
  Hide fielddata attributes Show fielddata attributes object
  
  evictions number
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  memory_size
  
  memory_size_in_bytes number Required
  
  flush object
  
  Hide flush attributes Show flush attributes object
  
  periodic number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  get object
  
  Hide get attributes Show get attributes object
  
  current number Required
  
  exists_time string
  
  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.
  
  exists_time_in_millis number
  
  Time unit for milliseconds
  
  exists_total number Required
  
  missing_time string
  
  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.
  
  missing_time_in_millis number
  
  Time unit for milliseconds
  
  missing_total number Required
  
  time string
  
  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.
  
  time_in_millis number
  
  Time unit for milliseconds
  
  total number Required
  
  indexing object
  
  Hide indexing attributes Show indexing attributes object
  
  index_current number Required
  
  delete_current number Required
  
  delete_time string
  
  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.
  
  delete_time_in_millis number
  
  Time unit for milliseconds
  
  delete_total number Required
  
  is_throttled boolean Required
  
  noop_update_total number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis number
  
  Time unit for milliseconds
  
  index_time string
  
  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.
  
  index_time_in_millis number
  
  Time unit for milliseconds
  
  index_total number Required
  
  index_failed number Required
  
  types object
  
  Hide types attribute Show types attribute object
  
  * object
  
  write_load number
  
  recent_write_load number
  
  peak_write_load number
  
  indices object Additional properties
  
  merges object
  
  Hide merges attributes Show merges attributes object
  
  current number Required
  
  current_docs number Required
  
  current_size string
  
  current_size_in_bytes number Required
  
  total number Required
  
  total_auto_throttle string
  
  total_auto_throttle_in_bytes number Required
  
  total_docs number Required
  
  total_size string
  
  total_size_in_bytes number Required
  
  total_stopped_time string
  
  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.
  
  total_stopped_time_in_millis number
  
  Time unit for milliseconds
  
  total_throttled_time string
  
  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.
  
  total_throttled_time_in_millis number
  
  Time unit for milliseconds
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  query_cache object
  
  Hide query_cache attributes Show query_cache attributes object
  
  cache_count number Required
  
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  
  cache_size number Required
  
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  
  evictions number Required
  
  Total number of query cache evictions across all shards assigned to selected nodes.
  
  hit_count number Required
  
  Total count of query cache hits across all shards assigned to selected nodes.
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  
  miss_count number Required
  
  Total count of query cache misses across all shards assigned to selected nodes.
  
  total_count number Required
  
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  
  recovery object
  
  Hide recovery attributes Show recovery attributes object
  
  current_as_source number Required
  
  current_as_target number Required
  
  throttle_time string
  
  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.
  
  throttle_time_in_millis number
  
  Time unit for milliseconds
  
  refresh object
  
  Hide refresh attributes Show refresh attributes object
  
  external_total number Required
  
  external_total_time_in_millis number
  
  Time unit for milliseconds
  
  listeners number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  request_cache object
  
  Hide request_cache attributes Show request_cache attributes object
  
  evictions number Required
  
  hit_count number Required
  
  memory_size string
  
  memory_size_in_bytes number Required
  
  miss_count number Required
  
  search object
  
  Hide search attributes Show search attributes object
  
  fetch_current number Required
  
  fetch_time string
  
  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.
  
  fetch_time_in_millis number
  
  Time unit for milliseconds
  
  fetch_total number Required
  
  open_contexts number
  
  query_current number Required
  
  query_time string
  
  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.
  
  query_time_in_millis number
  
  Time unit for milliseconds
  
  query_total number Required
  
  scroll_current number Required
  
  scroll_time string
  
  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.
  
  scroll_time_in_millis number
  
  Time unit for milliseconds
  
  scroll_total number Required
  
  suggest_current number Required
  
  suggest_time string
  
  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.
  
  suggest_time_in_millis number
  
  Time unit for milliseconds
  
  suggest_total number Required
  
  groups object
  
  Hide groups attribute Show groups attribute object
  
  * object
  
  segments object
  
  Hide segments attributes Show segments attributes object
  
  count number Required
  
  Total number of segments across all shards assigned to selected nodes.
  
  doc_values_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  doc_values_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  
  file_sizes object Required
  
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  
  Hide file_sizes attribute Show file_sizes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  description string Required
  
  size_in_bytes number Required
  
  min_size_in_bytes number
  
  max_size_in_bytes number
  
  average_size_in_bytes number
  
  count number
  
  fixed_bit_set number | string
  
  One of:
  ByteSize number ByteSize string
  
  fixed_bit_set_memory_in_bytes number Required
  
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  
  index_writer_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  index_writer_max_memory_in_bytes number
  
  index_writer_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  
  max_unsafe_auto_id_timestamp number Required
  
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  
  memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  
  norms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  norms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  
  points_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  points_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  
  stored_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  stored_fields_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  
  terms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  
  terms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectory_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectors_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  
  version_map_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  version_map_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  
  store object
  
  Hide store attributes Show store attributes object
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  size_in_bytes number Required
  
  Total size, in bytes, of all shards assigned to selected nodes.
  
  reserved number | string
  
  One of:
  ByteSize number ByteSize string
  
  reserved_in_bytes number Required
  
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  
  total_data_set_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_data_set_size_in_bytes number
  
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  
  translog object
  
  Hide translog attributes Show translog attributes object
  
  earliest_last_modified_age number Required
  
  operations number Required
  
  size string
  
  size_in_bytes number Required
  
  uncommitted_operations number Required
  
  uncommitted_size string
  
  uncommitted_size_in_bytes number Required
  
  warmer object
  
  Hide warmer attributes Show warmer attributes object
  
  current number Required
  
  total number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  bulk object
  
  Hide bulk attributes Show bulk attributes object
  
  total_operations number Required
  
  total_time string
  
  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.
  
  total_time_in_millis number
  
  Time unit for milliseconds
  
  total_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_size_in_bytes number Required
  
  avg_time string
  
  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.
  
  avg_time_in_millis number
  
  Time unit for milliseconds
  
  avg_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  avg_size_in_bytes number Required
  
  shard_stats object
  
  Hide shard_stats attribute Show shard_stats attribute object
  
  total_count number Required
  
  uuid string
  
  health string
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  status string
  
  Values are open or close.

GET /{index}/_stats/{metric}

curl \
 --request GET 'http://api.example.com/{index}/_stats/{metric}' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "indices": {
    "additionalProperty1": {
      "primaries": {
        "completion": {
          "size_in_bytes": 42.0,
          "": 42.0,
          "fields": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        },
        "docs": {
          "count": 42.0,
          "deleted": 42.0
        },
        "fielddata": {
          "evictions": 42.0,
          "": 42.0,
          "memory_size_in_bytes": 42.0,
          "fields": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        },
        "flush": {
          "periodic": 42.0,
          "total": 42.0,
          "total_time": "string",
          "": 42.0
        },
        "get": {
          "current": 42.0,
          "exists_time": "string",
          "": 42.0,
          "exists_total": 42.0,
          "missing_time": "string",
          "missing_total": 42.0,
          "time": "string",
          "total": 42.0
        },
        "indexing": {
          "index_current": 42.0,
          "delete_current": 42.0,
          "delete_time": "string",
          "": 42.0,
          "delete_total": 42.0,
          "is_throttled": true,
          "noop_update_total": 42.0,
          "throttle_time": "string",
          "index_time": "string",
          "index_total": 42.0,
          "index_failed": 42.0,
          "types": {
            "*": {}
          },
          "write_load": 42.0,
          "recent_write_load": 42.0,
          "peak_write_load": 42.0
        },
        "additionalProperty1": {},
        "additionalProperty2": {},
        "merges": {
          "current": 42.0,
          "current_docs": 42.0,
          "current_size": "string",
          "current_size_in_bytes": 42.0,
          "total": 42.0,
          "total_auto_throttle": "string",
          "total_auto_throttle_in_bytes": 42.0,
          "total_docs": 42.0,
          "total_size": "string",
          "total_size_in_bytes": 42.0,
          "total_stopped_time": "string",
          "": 42.0,
          "total_throttled_time": "string",
          "total_time": "string"
        },
        "query_cache": {
          "cache_count": 42.0,
          "cache_size": 42.0,
          "evictions": 42.0,
          "hit_count": 42.0,
          "": 42.0,
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0,
          "total_count": 42.0
        },
        "recovery": {
          "current_as_source": 42.0,
          "current_as_target": 42.0,
          "throttle_time": "string",
          "": 42.0
        },
        "refresh": {
          "external_total": 42.0,
          "": 42.0,
          "listeners": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "request_cache": {
          "evictions": 42.0,
          "hit_count": 42.0,
          "memory_size": "string",
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0
        },
        "search": {
          "fetch_current": 42.0,
          "fetch_time": "string",
          "": 42.0,
          "fetch_total": 42.0,
          "open_contexts": 42.0,
          "query_current": 42.0,
          "query_time": "string",
          "query_total": 42.0,
          "scroll_current": 42.0,
          "scroll_time": "string",
          "scroll_total": 42.0,
          "suggest_current": 42.0,
          "suggest_time": "string",
          "suggest_total": 42.0,
          "groups": {
            "*": {}
          }
        },
        "segments": {
          "count": 42.0,
          "": 42.0,
          "doc_values_memory_in_bytes": 42.0,
          "file_sizes": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "fixed_bit_set_memory_in_bytes": 42.0,
          "index_writer_max_memory_in_bytes": 42.0,
          "index_writer_memory_in_bytes": 42.0,
          "max_unsafe_auto_id_timestamp": 42.0,
          "memory_in_bytes": 42.0,
          "norms_memory_in_bytes": 42.0,
          "points_memory_in_bytes": 42.0,
          "stored_fields_memory_in_bytes": 42.0,
          "terms_memory_in_bytes": 42.0,
          "term_vectors_memory_in_bytes": 42.0,
          "version_map_memory_in_bytes": 42.0
        },
        "store": {
          "": 42.0,
          "size_in_bytes": 42.0,
          "reserved_in_bytes": 42.0,
          "total_data_set_size_in_bytes": 42.0
        },
        "translog": {
          "earliest_last_modified_age": 42.0,
          "operations": 42.0,
          "size": "string",
          "size_in_bytes": 42.0,
          "uncommitted_operations": 42.0,
          "uncommitted_size": "string",
          "uncommitted_size_in_bytes": 42.0
        },
        "warmer": {
          "current": 42.0,
          "total": 42.0,
          "total_time": "string",
          "": 42.0
        },
        "bulk": {
          "total_operations": 42.0,
          "total_time": "string",
          "": 42.0,
          "total_size_in_bytes": 42.0,
          "avg_time": "string",
          "avg_size_in_bytes": 42.0
        },
        "shard_stats": {
          "total_count": 42.0
        }
      },
      "shards": {
        "additionalProperty1": [
          {
            "commit": {},
            "completion": {},
            "docs": {},
            "fielddata": {},
            "flush": {},
            "get": {},
            "indexing": {},
            "mappings": {},
            "merges": {},
            "shard_path": {},
            "query_cache": {},
            "recovery": {},
            "refresh": {},
            "request_cache": {},
            "retention_leases": {},
            "routing": {},
            "search": {},
            "segments": {},
            "seq_no": {},
            "store": {},
            "translog": {},
            "warmer": {},
            "bulk": {},
            "shards": {},
            "shard_stats": {},
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        ],
        "additionalProperty2": [
          {
            "commit": {},
            "completion": {},
            "docs": {},
            "fielddata": {},
            "flush": {},
            "get": {},
            "indexing": {},
            "mappings": {},
            "merges": {},
            "shard_path": {},
            "query_cache": {},
            "recovery": {},
            "refresh": {},
            "request_cache": {},
            "retention_leases": {},
            "routing": {},
            "search": {},
            "segments": {},
            "seq_no": {},
            "store": {},
            "translog": {},
            "warmer": {},
            "bulk": {},
            "shards": {},
            "shard_stats": {},
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        ]
      },
      "total": {
        "completion": {
          "size_in_bytes": 42.0,
          "": 42.0,
          "fields": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        },
        "docs": {
          "count": 42.0,
          "deleted": 42.0
        },
        "fielddata": {
          "evictions": 42.0,
          "": 42.0,
          "memory_size_in_bytes": 42.0,
          "fields": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        },
        "flush": {
          "periodic": 42.0,
          "total": 42.0,
          "total_time": "string",
          "": 42.0
        },
        "get": {
          "current": 42.0,
          "exists_time": "string",
          "": 42.0,
          "exists_total": 42.0,
          "missing_time": "string",
          "missing_total": 42.0,
          "time": "string",
          "total": 42.0
        },
        "indexing": {
          "index_current": 42.0,
          "delete_current": 42.0,
          "delete_time": "string",
          "": 42.0,
          "delete_total": 42.0,
          "is_throttled": true,
          "noop_update_total": 42.0,
          "throttle_time": "string",
          "index_time": "string",
          "index_total": 42.0,
          "index_failed": 42.0,
          "types": {
            "*": {}
          },
          "write_load": 42.0,
          "recent_write_load": 42.0,
          "peak_write_load": 42.0
        },
        "additionalProperty1": {},
        "additionalProperty2": {},
        "merges": {
          "current": 42.0,
          "current_docs": 42.0,
          "current_size": "string",
          "current_size_in_bytes": 42.0,
          "total": 42.0,
          "total_auto_throttle": "string",
          "total_auto_throttle_in_bytes": 42.0,
          "total_docs": 42.0,
          "total_size": "string",
          "total_size_in_bytes": 42.0,
          "total_stopped_time": "string",
          "": 42.0,
          "total_throttled_time": "string",
          "total_time": "string"
        },
        "query_cache": {
          "cache_count": 42.0,
          "cache_size": 42.0,
          "evictions": 42.0,
          "hit_count": 42.0,
          "": 42.0,
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0,
          "total_count": 42.0
        },
        "recovery": {
          "current_as_source": 42.0,
          "current_as_target": 42.0,
          "throttle_time": "string",
          "": 42.0
        },
        "refresh": {
          "external_total": 42.0,
          "": 42.0,
          "listeners": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "request_cache": {
          "evictions": 42.0,
          "hit_count": 42.0,
          "memory_size": "string",
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0
        },
        "search": {
          "fetch_current": 42.0,
          "fetch_time": "string",
          "": 42.0,
          "fetch_total": 42.0,
          "open_contexts": 42.0,
          "query_current": 42.0,
          "query_time": "string",
          "query_total": 42.0,
          "scroll_current": 42.0,
          "scroll_time": "string",
          "scroll_total": 42.0,
          "suggest_current": 42.0,
          "suggest_time": "string",
          "suggest_total": 42.0,
          "groups": {
            "*": {}
          }
        },
        "segments": {
          "count": 42.0,
          "": 42.0,
          "doc_values_memory_in_bytes": 42.0,
          "file_sizes": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "fixed_bit_set_memory_in_bytes": 42.0,
          "index_writer_max_memory_in_bytes": 42.0,
          "index_writer_memory_in_bytes": 42.0,
          "max_unsafe_auto_id_timestamp": 42.0,
          "memory_in_bytes": 42.0,
          "norms_memory_in_bytes": 42.0,
          "points_memory_in_bytes": 42.0,
          "stored_fields_memory_in_bytes": 42.0,
          "terms_memory_in_bytes": 42.0,
          "term_vectors_memory_in_bytes": 42.0,
          "version_map_memory_in_bytes": 42.0
        },
        "store": {
          "": 42.0,
          "size_in_bytes": 42.0,
          "reserved_in_bytes": 42.0,
          "total_data_set_size_in_bytes": 42.0
        },
        "translog": {
          "earliest_last_modified_age": 42.0,
          "operations": 42.0,
          "size": "string",
          "size_in_bytes": 42.0,
          "uncommitted_operations": 42.0,
          "uncommitted_size": "string",
          "uncommitted_size_in_bytes": 42.0
        },
        "warmer": {
          "current": 42.0,
          "total": 42.0,
          "total_time": "string",
          "": 42.0
        },
        "bulk": {
          "total_operations": 42.0,
          "total_time": "string",
          "": 42.0,
          "total_size_in_bytes": 42.0,
          "avg_time": "string",
          "avg_size_in_bytes": 42.0
        },
        "shard_stats": {
          "total_count": 42.0
        }
      },
      "uuid": "string",
      "health": "green",
      "status": "open"
    },
    "additionalProperty2": {
      "primaries": {
        "completion": {
          "size_in_bytes": 42.0,
          "": 42.0,
          "fields": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        },
        "docs": {
          "count": 42.0,
          "deleted": 42.0
        },
        "fielddata": {
          "evictions": 42.0,
          "": 42.0,
          "memory_size_in_bytes": 42.0,
          "fields": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        },
        "flush": {
          "periodic": 42.0,
          "total": 42.0,
          "total_time": "string",
          "": 42.0
        },
        "get": {
          "current": 42.0,
          "exists_time": "string",
          "": 42.0,
          "exists_total": 42.0,
          "missing_time": "string",
          "missing_total": 42.0,
          "time": "string",
          "total": 42.0
        },
        "indexing": {
          "index_current": 42.0,
          "delete_current": 42.0,
          "delete_time": "string",
          "": 42.0,
          "delete_total": 42.0,
          "is_throttled": true,
          "noop_update_total": 42.0,
          "throttle_time": "string",
          "index_time": "string",
          "index_total": 42.0,
          "index_failed": 42.0,
          "types": {
            "*": {}
          },
          "write_load": 42.0,
          "recent_write_load": 42.0,
          "peak_write_load": 42.0
        },
        "additionalProperty1": {},
        "additionalProperty2": {},
        "merges": {
          "current": 42.0,
          "current_docs": 42.0,
          "current_size": "string",
          "current_size_in_bytes": 42.0,
          "total": 42.0,
          "total_auto_throttle": "string",
          "total_auto_throttle_in_bytes": 42.0,
          "total_docs": 42.0,
          "total_size": "string",
          "total_size_in_bytes": 42.0,
          "total_stopped_time": "string",
          "": 42.0,
          "total_throttled_time": "string",
          "total_time": "string"
        },
        "query_cache": {
          "cache_count": 42.0,
          "cache_size": 42.0,
          "evictions": 42.0,
          "hit_count": 42.0,
          "": 42.0,
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0,
          "total_count": 42.0
        },
        "recovery": {
          "current_as_source": 42.0,
          "current_as_target": 42.0,
          "throttle_time": "string",
          "": 42.0
        },
        "refresh": {
          "external_total": 42.0,
          "": 42.0,
          "listeners": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "request_cache": {
          "evictions": 42.0,
          "hit_count": 42.0,
          "memory_size": "string",
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0
        },
        "search": {
          "fetch_current": 42.0,
          "fetch_time": "string",
          "": 42.0,
          "fetch_total": 42.0,
          "open_contexts": 42.0,
          "query_current": 42.0,
          "query_time": "string",
          "query_total": 42.0,
          "scroll_current": 42.0,
          "scroll_time": "string",
          "scroll_total": 42.0,
          "suggest_current": 42.0,
          "suggest_time": "string",
          "suggest_total": 42.0,
          "groups": {
            "*": {}
          }
        },
        "segments": {
          "count": 42.0,
          "": 42.0,
          "doc_values_memory_in_bytes": 42.0,
          "file_sizes": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "fixed_bit_set_memory_in_bytes": 42.0,
          "index_writer_max_memory_in_bytes": 42.0,
          "index_writer_memory_in_bytes": 42.0,
          "max_unsafe_auto_id_timestamp": 42.0,
          "memory_in_bytes": 42.0,
          "norms_memory_in_bytes": 42.0,
          "points_memory_in_bytes": 42.0,
          "stored_fields_memory_in_bytes": 42.0,
          "terms_memory_in_bytes": 42.0,
          "term_vectors_memory_in_bytes": 42.0,
          "version_map_memory_in_bytes": 42.0
        },
        "store": {
          "": 42.0,
          "size_in_bytes": 42.0,
          "reserved_in_bytes": 42.0,
          "total_data_set_size_in_bytes": 42.0
        },
        "translog": {
          "earliest_last_modified_age": 42.0,
          "operations": 42.0,
          "size": "string",
          "size_in_bytes": 42.0,
          "uncommitted_operations": 42.0,
          "uncommitted_size": "string",
          "uncommitted_size_in_bytes": 42.0
        },
        "warmer": {
          "current": 42.0,
          "total": 42.0,
          "total_time": "string",
          "": 42.0
        },
        "bulk": {
          "total_operations": 42.0,
          "total_time": "string",
          "": 42.0,
          "total_size_in_bytes": 42.0,
          "avg_time": "string",
          "avg_size_in_bytes": 42.0
        },
        "shard_stats": {
          "total_count": 42.0
        }
      },
      "shards": {
        "additionalProperty1": [
          {
            "commit": {},
            "completion": {},
            "docs": {},
            "fielddata": {},
            "flush": {},
            "get": {},
            "indexing": {},
            "mappings": {},
            "merges": {},
            "shard_path": {},
            "query_cache": {},
            "recovery": {},
            "refresh": {},
            "request_cache": {},
            "retention_leases": {},
            "routing": {},
            "search": {},
            "segments": {},
            "seq_no": {},
            "store": {},
            "translog": {},
            "warmer": {},
            "bulk": {},
            "shards": {},
            "shard_stats": {},
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        ],
        "additionalProperty2": [
          {
            "commit": {},
            "completion": {},
            "docs": {},
            "fielddata": {},
            "flush": {},
            "get": {},
            "indexing": {},
            "mappings": {},
            "merges": {},
            "shard_path": {},
            "query_cache": {},
            "recovery": {},
            "refresh": {},
            "request_cache": {},
            "retention_leases": {},
            "routing": {},
            "search": {},
            "segments": {},
            "seq_no": {},
            "store": {},
            "translog": {},
            "warmer": {},
            "bulk": {},
            "shards": {},
            "shard_stats": {},
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        ]
      },
      "total": {
        "completion": {
          "size_in_bytes": 42.0,
          "": 42.0,
          "fields": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        },
        "docs": {
          "count": 42.0,
          "deleted": 42.0
        },
        "fielddata": {
          "evictions": 42.0,
          "": 42.0,
          "memory_size_in_bytes": 42.0,
          "fields": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          }
        },
        "flush": {
          "periodic": 42.0,
          "total": 42.0,
          "total_time": "string",
          "": 42.0
        },
        "get": {
          "current": 42.0,
          "exists_time": "string",
          "": 42.0,
          "exists_total": 42.0,
          "missing_time": "string",
          "missing_total": 42.0,
          "time": "string",
          "total": 42.0
        },
        "indexing": {
          "index_current": 42.0,
          "delete_current": 42.0,
          "delete_time": "string",
          "": 42.0,
          "delete_total": 42.0,
          "is_throttled": true,
          "noop_update_total": 42.0,
          "throttle_time": "string",
          "index_time": "string",
          "index_total": 42.0,
          "index_failed": 42.0,
          "types": {
            "*": {}
          },
          "write_load": 42.0,
          "recent_write_load": 42.0,
          "peak_write_load": 42.0
        },
        "additionalProperty1": {},
        "additionalProperty2": {},
        "merges": {
          "current": 42.0,
          "current_docs": 42.0,
          "current_size": "string",
          "current_size_in_bytes": 42.0,
          "total": 42.0,
          "total_auto_throttle": "string",
          "total_auto_throttle_in_bytes": 42.0,
          "total_docs": 42.0,
          "total_size": "string",
          "total_size_in_bytes": 42.0,
          "total_stopped_time": "string",
          "": 42.0,
          "total_throttled_time": "string",
          "total_time": "string"
        },
        "query_cache": {
          "cache_count": 42.0,
          "cache_size": 42.0,
          "evictions": 42.0,
          "hit_count": 42.0,
          "": 42.0,
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0,
          "total_count": 42.0
        },
        "recovery": {
          "current_as_source": 42.0,
          "current_as_target": 42.0,
          "throttle_time": "string",
          "": 42.0
        },
        "refresh": {
          "external_total": 42.0,
          "": 42.0,
          "listeners": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "request_cache": {
          "evictions": 42.0,
          "hit_count": 42.0,
          "memory_size": "string",
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0
        },
        "search": {
          "fetch_current": 42.0,
          "fetch_time": "string",
          "": 42.0,
          "fetch_total": 42.0,
          "open_contexts": 42.0,
          "query_current": 42.0,
          "query_time": "string",
          "query_total": 42.0,
          "scroll_current": 42.0,
          "scroll_time": "string",
          "scroll_total": 42.0,
          "suggest_current": 42.0,
          "suggest_time": "string",
          "suggest_total": 42.0,
          "groups": {
            "*": {}
          }
        },
        "segments": {
          "count": 42.0,
          "": 42.0,
          "doc_values_memory_in_bytes": 42.0,
          "file_sizes": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "fixed_bit_set_memory_in_bytes": 42.0,
          "index_writer_max_memory_in_bytes": 42.0,
          "index_writer_memory_in_bytes": 42.0,
          "max_unsafe_auto_id_timestamp": 42.0,
          "memory_in_bytes": 42.0,
          "norms_memory_in_bytes": 42.0,
          "points_memory_in_bytes": 42.0,
          "stored_fields_memory_in_bytes": 42.0,
          "terms_memory_in_bytes": 42.0,
          "term_vectors_memory_in_bytes": 42.0,
          "version_map_memory_in_bytes": 42.0
        },
        "store": {
          "": 42.0,
          "size_in_bytes": 42.0,
          "reserved_in_bytes": 42.0,
          "total_data_set_size_in_bytes": 42.0
        },
        "translog": {
          "earliest_last_modified_age": 42.0,
          "operations": 42.0,
          "size": "string",
          "size_in_bytes": 42.0,
          "uncommitted_operations": 42.0,
          "uncommitted_size": "string",
          "uncommitted_size_in_bytes": 42.0
        },
        "warmer": {
          "current": 42.0,
          "total": 42.0,
          "total_time": "string",
          "": 42.0
        },
        "bulk": {
          "total_operations": 42.0,
          "total_time": "string",
          "": 42.0,
          "total_size_in_bytes": 42.0,
          "avg_time": "string",
          "avg_size_in_bytes": 42.0
        },
        "shard_stats": {
          "total_count": 42.0
        }
      },
      "uuid": "string",
      "health": "green",
      "status": "open"
    }
  },
  "_shards": {
    "failed": 42.0,
    "successful": 42.0,
    "total": 42.0,
    "failures": [
      {
        "index": "string",
        "node": "string",
        "reason": {
          "type": "string",
          "reason": "string",
          "stack_trace": "string",
          "caused_by": {},
          "root_cause": [
            {}
          ],
          "suppressed": [
            {}
          ]
        },
        "shard": 42.0,
        "status": "string"
      }
    ],
    "skipped": 42.0
  },
  "additionalProperty1": {
    "primaries": {
      "completion": {
        "size_in_bytes": 42.0,
        "": 42.0,
        "fields": {
          "additionalProperty1": {
            "size_in_bytes": 42.0
          },
          "additionalProperty2": {
            "size_in_bytes": 42.0
          }
        }
      },
      "docs": {
        "count": 42.0,
        "deleted": 42.0
      },
      "fielddata": {
        "evictions": 42.0,
        "": 42.0,
        "memory_size_in_bytes": 42.0,
        "fields": {
          "additionalProperty1": {
            "memory_size_in_bytes": 42.0
          },
          "additionalProperty2": {
            "memory_size_in_bytes": 42.0
          }
        }
      },
      "flush": {
        "periodic": 42.0,
        "total": 42.0,
        "total_time": "string",
        "": 42.0
      },
      "get": {
        "current": 42.0,
        "exists_time": "string",
        "": 42.0,
        "exists_total": 42.0,
        "missing_time": "string",
        "missing_total": 42.0,
        "time": "string",
        "total": 42.0
      },
      "indexing": {
        "index_current": 42.0,
        "delete_current": 42.0,
        "delete_time": "string",
        "": 42.0,
        "delete_total": 42.0,
        "is_throttled": true,
        "noop_update_total": 42.0,
        "throttle_time": "string",
        "index_time": "string",
        "index_total": 42.0,
        "index_failed": 42.0,
        "types": {
          "*": {}
        },
        "write_load": 42.0,
        "recent_write_load": 42.0,
        "peak_write_load": 42.0
      },
      "additionalProperty1": {},
      "additionalProperty2": {},
      "merges": {
        "current": 42.0,
        "current_docs": 42.0,
        "current_size": "string",
        "current_size_in_bytes": 42.0,
        "total": 42.0,
        "total_auto_throttle": "string",
        "total_auto_throttle_in_bytes": 42.0,
        "total_docs": 42.0,
        "total_size": "string",
        "total_size_in_bytes": 42.0,
        "total_stopped_time": "string",
        "": 42.0,
        "total_throttled_time": "string",
        "total_time": "string"
      },
      "query_cache": {
        "cache_count": 42.0,
        "cache_size": 42.0,
        "evictions": 42.0,
        "hit_count": 42.0,
        "": 42.0,
        "memory_size_in_bytes": 42.0,
        "miss_count": 42.0,
        "total_count": 42.0
      },
      "recovery": {
        "current_as_source": 42.0,
        "current_as_target": 42.0,
        "throttle_time": "string",
        "": 42.0
      },
      "refresh": {
        "external_total": 42.0,
        "": 42.0,
        "listeners": 42.0,
        "total": 42.0,
        "total_time": "string"
      },
      "request_cache": {
        "evictions": 42.0,
        "hit_count": 42.0,
        "memory_size": "string",
        "memory_size_in_bytes": 42.0,
        "miss_count": 42.0
      },
      "search": {
        "fetch_current": 42.0,
        "fetch_time": "string",
        "": 42.0,
        "fetch_total": 42.0,
        "open_contexts": 42.0,
        "query_current": 42.0,
        "query_time": "string",
        "query_total": 42.0,
        "scroll_current": 42.0,
        "scroll_time": "string",
        "scroll_total": 42.0,
        "suggest_current": 42.0,
        "suggest_time": "string",
        "suggest_total": 42.0,
        "groups": {
          "*": {}
        }
      },
      "segments": {
        "count": 42.0,
        "": 42.0,
        "doc_values_memory_in_bytes": 42.0,
        "file_sizes": {
          "additionalProperty1": {
            "description": "string",
            "size_in_bytes": 42.0,
            "min_size_in_bytes": 42.0,
            "max_size_in_bytes": 42.0,
            "average_size_in_bytes": 42.0,
            "count": 42.0
          },
          "additionalProperty2": {
            "description": "string",
            "size_in_bytes": 42.0,
            "min_size_in_bytes": 42.0,
            "max_size_in_bytes": 42.0,
            "average_size_in_bytes": 42.0,
            "count": 42.0
          }
        },
        "fixed_bit_set_memory_in_bytes": 42.0,
        "index_writer_max_memory_in_bytes": 42.0,
        "index_writer_memory_in_bytes": 42.0,
        "max_unsafe_auto_id_timestamp": 42.0,
        "memory_in_bytes": 42.0,
        "norms_memory_in_bytes": 42.0,
        "points_memory_in_bytes": 42.0,
        "stored_fields_memory_in_bytes": 42.0,
        "terms_memory_in_bytes": 42.0,
        "term_vectors_memory_in_bytes": 42.0,
        "version_map_memory_in_bytes": 42.0
      },
      "store": {
        "": 42.0,
        "size_in_bytes": 42.0,
        "reserved_in_bytes": 42.0,
        "total_data_set_size_in_bytes": 42.0
      },
      "translog": {
        "earliest_last_modified_age": 42.0,
        "operations": 42.0,
        "size": "string",
        "size_in_bytes": 42.0,
        "uncommitted_operations": 42.0,
        "uncommitted_size": "string",
        "uncommitted_size_in_bytes": 42.0
      },
      "warmer": {
        "current": 42.0,
        "total": 42.0,
        "total_time": "string",
        "": 42.0
      },
      "bulk": {
        "total_operations": 42.0,
        "total_time": "string",
        "": 42.0,
        "total_size_in_bytes": 42.0,
        "avg_time": "string",
        "avg_size_in_bytes": 42.0
      },
      "shard_stats": {
        "total_count": 42.0
      }
    },
    "shards": {
      "additionalProperty1": [
        {
          "commit": {
            "generation": 42.0,
            "id": "string",
            "num_docs": 42.0,
            "user_data": {}
          },
          "completion": {
            "size_in_bytes": 42.0,
            "fields": {}
          },
          "docs": {
            "count": 42.0,
            "deleted": 42.0
          },
          "fielddata": {
            "evictions": 42.0,
            "memory_size_in_bytes": 42.0,
            "fields": {}
          },
          "flush": {
            "periodic": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "get": {
            "current": 42.0,
            "exists_time": "string",
            "exists_total": 42.0,
            "missing_time": "string",
            "missing_total": 42.0,
            "time": "string",
            "total": 42.0
          },
          "indexing": {
            "index_current": 42.0,
            "delete_current": 42.0,
            "delete_time": "string",
            "delete_total": 42.0,
            "is_throttled": true,
            "noop_update_total": 42.0,
            "throttle_time": "string",
            "index_time": "string",
            "index_total": 42.0,
            "index_failed": 42.0,
            "types": {},
            "write_load": 42.0,
            "recent_write_load": 42.0,
            "peak_write_load": 42.0
          },
          "mappings": {
            "total_count": 42.0,
            "total_estimated_overhead_in_bytes": 42.0
          },
          "merges": {
            "current": 42.0,
            "current_docs": 42.0,
            "current_size": "string",
            "current_size_in_bytes": 42.0,
            "total": 42.0,
            "total_auto_throttle": "string",
            "total_auto_throttle_in_bytes": 42.0,
            "total_docs": 42.0,
            "total_size": "string",
            "total_size_in_bytes": 42.0,
            "total_stopped_time": "string",
            "total_throttled_time": "string",
            "total_time": "string"
          },
          "shard_path": {
            "data_path": "string",
            "is_custom_data_path": true,
            "state_path": "string"
          },
          "query_cache": {
            "cache_count": 42.0,
            "cache_size": 42.0,
            "evictions": 42.0,
            "hit_count": 42.0,
            "memory_size_in_bytes": 42.0,
            "miss_count": 42.0,
            "total_count": 42.0
          },
          "recovery": {
            "current_as_source": 42.0,
            "current_as_target": 42.0,
            "throttle_time": "string"
          },
          "refresh": {
            "external_total": 42.0,
            "listeners": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "request_cache": {
            "evictions": 42.0,
            "hit_count": 42.0,
            "memory_size": "string",
            "memory_size_in_bytes": 42.0,
            "miss_count": 42.0
          },
          "retention_leases": {
            "primary_term": 42.0,
            "version": 42.0,
            "leases": [
              {}
            ]
          },
          "routing": {
            "node": "string",
            "primary": true,
            "state": "UNASSIGNED"
          },
          "search": {
            "fetch_current": 42.0,
            "fetch_time": "string",
            "fetch_total": 42.0,
            "open_contexts": 42.0,
            "query_current": 42.0,
            "query_time": "string",
            "query_total": 42.0,
            "scroll_current": 42.0,
            "scroll_time": "string",
            "scroll_total": 42.0,
            "suggest_current": 42.0,
            "suggest_time": "string",
            "suggest_total": 42.0,
            "groups": {}
          },
          "segments": {
            "count": 42.0,
            "doc_values_memory_in_bytes": 42.0,
            "file_sizes": {},
            "fixed_bit_set_memory_in_bytes": 42.0,
            "index_writer_max_memory_in_bytes": 42.0,
            "index_writer_memory_in_bytes": 42.0,
            "max_unsafe_auto_id_timestamp": 42.0,
            "memory_in_bytes": 42.0,
            "norms_memory_in_bytes": 42.0,
            "points_memory_in_bytes": 42.0,
            "stored_fields_memory_in_bytes": 42.0,
            "terms_memory_in_bytes": 42.0,
            "term_vectors_memory_in_bytes": 42.0,
            "version_map_memory_in_bytes": 42.0
          },
          "seq_no": {
            "global_checkpoint": 42.0,
            "local_checkpoint": 42.0,
            "max_seq_no": 42.0
          },
          "store": {
            "size_in_bytes": 42.0,
            "reserved_in_bytes": 42.0,
            "total_data_set_size_in_bytes": 42.0
          },
          "translog": {
            "earliest_last_modified_age": 42.0,
            "operations": 42.0,
            "size": "string",
            "size_in_bytes": 42.0,
            "uncommitted_operations": 42.0,
            "uncommitted_size": "string",
            "uncommitted_size_in_bytes": 42.0
          },
          "warmer": {
            "current": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "bulk": {
            "total_operations": 42.0,
            "total_time": "string",
            "total_size_in_bytes": 42.0,
            "avg_time": "string",
            "avg_size_in_bytes": 42.0
          },
          "shards": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "shard_stats": {
            "total_count": 42.0
          },
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      ],
      "additionalProperty2": [
        {
          "commit": {
            "generation": 42.0,
            "id": "string",
            "num_docs": 42.0,
            "user_data": {}
          },
          "completion": {
            "size_in_bytes": 42.0,
            "fields": {}
          },
          "docs": {
            "count": 42.0,
            "deleted": 42.0
          },
          "fielddata": {
            "evictions": 42.0,
            "memory_size_in_bytes": 42.0,
            "fields": {}
          },
          "flush": {
            "periodic": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "get": {
            "current": 42.0,
            "exists_time": "string",
            "exists_total": 42.0,
            "missing_time": "string",
            "missing_total": 42.0,
            "time": "string",
            "total": 42.0
          },
          "indexing": {
            "index_current": 42.0,
            "delete_current": 42.0,
            "delete_time": "string",
            "delete_total": 42.0,
            "is_throttled": true,
            "noop_update_total": 42.0,
            "throttle_time": "string",
            "index_time": "string",
            "index_total": 42.0,
            "index_failed": 42.0,
            "types": {},
            "write_load": 42.0,
            "recent_write_load": 42.0,
            "peak_write_load": 42.0
          },
          "mappings": {
            "total_count": 42.0,
            "total_estimated_overhead_in_bytes": 42.0
          },
          "merges": {
            "current": 42.0,
            "current_docs": 42.0,
            "current_size": "string",
            "current_size_in_bytes": 42.0,
            "total": 42.0,
            "total_auto_throttle": "string",
            "total_auto_throttle_in_bytes": 42.0,
            "total_docs": 42.0,
            "total_size": "string",
            "total_size_in_bytes": 42.0,
            "total_stopped_time": "string",
            "total_throttled_time": "string",
            "total_time": "string"
          },
          "shard_path": {
            "data_path": "string",
            "is_custom_data_path": true,
            "state_path": "string"
          },
          "query_cache": {
            "cache_count": 42.0,
            "cache_size": 42.0,
            "evictions": 42.0,
            "hit_count": 42.0,
            "memory_size_in_bytes": 42.0,
            "miss_count": 42.0,
            "total_count": 42.0
          },
          "recovery": {
            "current_as_source": 42.0,
            "current_as_target": 42.0,
            "throttle_time": "string"
          },
          "refresh": {
            "external_total": 42.0,
            "listeners": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "request_cache": {
            "evictions": 42.0,
            "hit_count": 42.0,
            "memory_size": "string",
            "memory_size_in_bytes": 42.0,
            "miss_count": 42.0
          },
          "retention_leases": {
            "primary_term": 42.0,
            "version": 42.0,
            "leases": [
              {}
            ]
          },
          "routing": {
            "node": "string",
            "primary": true,
            "state": "UNASSIGNED"
          },
          "search": {
            "fetch_current": 42.0,
            "fetch_time": "string",
            "fetch_total": 42.0,
            "open_contexts": 42.0,
            "query_current": 42.0,
            "query_time": "string",
            "query_total": 42.0,
            "scroll_current": 42.0,
            "scroll_time": "string",
            "scroll_total": 42.0,
            "suggest_current": 42.0,
            "suggest_time": "string",
            "suggest_total": 42.0,
            "groups": {}
          },
          "segments": {
            "count": 42.0,
            "doc_values_memory_in_bytes": 42.0,
            "file_sizes": {},
            "fixed_bit_set_memory_in_bytes": 42.0,
            "index_writer_max_memory_in_bytes": 42.0,
            "index_writer_memory_in_bytes": 42.0,
            "max_unsafe_auto_id_timestamp": 42.0,
            "memory_in_bytes": 42.0,
            "norms_memory_in_bytes": 42.0,
            "points_memory_in_bytes": 42.0,
            "stored_fields_memory_in_bytes": 42.0,
            "terms_memory_in_bytes": 42.0,
            "term_vectors_memory_in_bytes": 42.0,
            "version_map_memory_in_bytes": 42.0
          },
          "seq_no": {
            "global_checkpoint": 42.0,
            "local_checkpoint": 42.0,
            "max_seq_no": 42.0
          },
          "store": {
            "size_in_bytes": 42.0,
            "reserved_in_bytes": 42.0,
            "total_data_set_size_in_bytes": 42.0
          },
          "translog": {
            "earliest_last_modified_age": 42.0,
            "operations": 42.0,
            "size": "string",
            "size_in_bytes": 42.0,
            "uncommitted_operations": 42.0,
            "uncommitted_size": "string",
            "uncommitted_size_in_bytes": 42.0
          },
          "warmer": {
            "current": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "bulk": {
            "total_operations": 42.0,
            "total_time": "string",
            "total_size_in_bytes": 42.0,
            "avg_time": "string",
            "avg_size_in_bytes": 42.0
          },
          "shards": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "shard_stats": {
            "total_count": 42.0
          },
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      ]
    },
    "total": {
      "completion": {
        "size_in_bytes": 42.0,
        "": 42.0,
        "fields": {
          "additionalProperty1": {
            "size_in_bytes": 42.0
          },
          "additionalProperty2": {
            "size_in_bytes": 42.0
          }
        }
      },
      "docs": {
        "count": 42.0,
        "deleted": 42.0
      },
      "fielddata": {
        "evictions": 42.0,
        "": 42.0,
        "memory_size_in_bytes": 42.0,
        "fields": {
          "additionalProperty1": {
            "memory_size_in_bytes": 42.0
          },
          "additionalProperty2": {
            "memory_size_in_bytes": 42.0
          }
        }
      },
      "flush": {
        "periodic": 42.0,
        "total": 42.0,
        "total_time": "string",
        "": 42.0
      },
      "get": {
        "current": 42.0,
        "exists_time": "string",
        "": 42.0,
        "exists_total": 42.0,
        "missing_time": "string",
        "missing_total": 42.0,
        "time": "string",
        "total": 42.0
      },
      "indexing": {
        "index_current": 42.0,
        "delete_current": 42.0,
        "delete_time": "string",
        "": 42.0,
        "delete_total": 42.0,
        "is_throttled": true,
        "noop_update_total": 42.0,
        "throttle_time": "string",
        "index_time": "string",
        "index_total": 42.0,
        "index_failed": 42.0,
        "types": {
          "*": {}
        },
        "write_load": 42.0,
        "recent_write_load": 42.0,
        "peak_write_load": 42.0
      },
      "additionalProperty1": {},
      "additionalProperty2": {},
      "merges": {
        "current": 42.0,
        "current_docs": 42.0,
        "current_size": "string",
        "current_size_in_bytes": 42.0,
        "total": 42.0,
        "total_auto_throttle": "string",
        "total_auto_throttle_in_bytes": 42.0,
        "total_docs": 42.0,
        "total_size": "string",
        "total_size_in_bytes": 42.0,
        "total_stopped_time": "string",
        "": 42.0,
        "total_throttled_time": "string",
        "total_time": "string"
      },
      "query_cache": {
        "cache_count": 42.0,
        "cache_size": 42.0,
        "evictions": 42.0,
        "hit_count": 42.0,
        "": 42.0,
        "memory_size_in_bytes": 42.0,
        "miss_count": 42.0,
        "total_count": 42.0
      },
      "recovery": {
        "current_as_source": 42.0,
        "current_as_target": 42.0,
        "throttle_time": "string",
        "": 42.0
      },
      "refresh": {
        "external_total": 42.0,
        "": 42.0,
        "listeners": 42.0,
        "total": 42.0,
        "total_time": "string"
      },
      "request_cache": {
        "evictions": 42.0,
        "hit_count": 42.0,
        "memory_size": "string",
        "memory_size_in_bytes": 42.0,
        "miss_count": 42.0
      },
      "search": {
        "fetch_current": 42.0,
        "fetch_time": "string",
        "": 42.0,
        "fetch_total": 42.0,
        "open_contexts": 42.0,
        "query_current": 42.0,
        "query_time": "string",
        "query_total": 42.0,
        "scroll_current": 42.0,
        "scroll_time": "string",
        "scroll_total": 42.0,
        "suggest_current": 42.0,
        "suggest_time": "string",
        "suggest_total": 42.0,
        "groups": {
          "*": {}
        }
      },
      "segments": {
        "count": 42.0,
        "": 42.0,
        "doc_values_memory_in_bytes": 42.0,
        "file_sizes": {
          "additionalProperty1": {
            "description": "string",
            "size_in_bytes": 42.0,
            "min_size_in_bytes": 42.0,
            "max_size_in_bytes": 42.0,
            "average_size_in_bytes": 42.0,
            "count": 42.0
          },
          "additionalProperty2": {
            "description": "string",
            "size_in_bytes": 42.0,
            "min_size_in_bytes": 42.0,
            "max_size_in_bytes": 42.0,
            "average_size_in_bytes": 42.0,
            "count": 42.0
          }
        },
        "fixed_bit_set_memory_in_bytes": 42.0,
        "index_writer_max_memory_in_bytes": 42.0,
        "index_writer_memory_in_bytes": 42.0,
        "max_unsafe_auto_id_timestamp": 42.0,
        "memory_in_bytes": 42.0,
        "norms_memory_in_bytes": 42.0,
        "points_memory_in_bytes": 42.0,
        "stored_fields_memory_in_bytes": 42.0,
        "terms_memory_in_bytes": 42.0,
        "term_vectors_memory_in_bytes": 42.0,
        "version_map_memory_in_bytes": 42.0
      },
      "store": {
        "": 42.0,
        "size_in_bytes": 42.0,
        "reserved_in_bytes": 42.0,
        "total_data_set_size_in_bytes": 42.0
      },
      "translog": {
        "earliest_last_modified_age": 42.0,
        "operations": 42.0,
        "size": "string",
        "size_in_bytes": 42.0,
        "uncommitted_operations": 42.0,
        "uncommitted_size": "string",
        "uncommitted_size_in_bytes": 42.0
      },
      "warmer": {
        "current": 42.0,
        "total": 42.0,
        "total_time": "string",
        "": 42.0
      },
      "bulk": {
        "total_operations": 42.0,
        "total_time": "string",
        "": 42.0,
        "total_size_in_bytes": 42.0,
        "avg_time": "string",
        "avg_size_in_bytes": 42.0
      },
      "shard_stats": {
        "total_count": 42.0
      }
    },
    "uuid": "string",
    "health": "green",
    "status": "open"
  },
  "additionalProperty2": {
    "primaries": {
      "completion": {
        "size_in_bytes": 42.0,
        "": 42.0,
        "fields": {
          "additionalProperty1": {
            "size_in_bytes": 42.0
          },
          "additionalProperty2": {
            "size_in_bytes": 42.0
          }
        }
      },
      "docs": {
        "count": 42.0,
        "deleted": 42.0
      },
      "fielddata": {
        "evictions": 42.0,
        "": 42.0,
        "memory_size_in_bytes": 42.0,
        "fields": {
          "additionalProperty1": {
            "memory_size_in_bytes": 42.0
          },
          "additionalProperty2": {
            "memory_size_in_bytes": 42.0
          }
        }
      },
      "flush": {
        "periodic": 42.0,
        "total": 42.0,
        "total_time": "string",
        "": 42.0
      },
      "get": {
        "current": 42.0,
        "exists_time": "string",
        "": 42.0,
        "exists_total": 42.0,
        "missing_time": "string",
        "missing_total": 42.0,
        "time": "string",
        "total": 42.0
      },
      "indexing": {
        "index_current": 42.0,
        "delete_current": 42.0,
        "delete_time": "string",
        "": 42.0,
        "delete_total": 42.0,
        "is_throttled": true,
        "noop_update_total": 42.0,
        "throttle_time": "string",
        "index_time": "string",
        "index_total": 42.0,
        "index_failed": 42.0,
        "types": {
          "*": {}
        },
        "write_load": 42.0,
        "recent_write_load": 42.0,
        "peak_write_load": 42.0
      },
      "additionalProperty1": {},
      "additionalProperty2": {},
      "merges": {
        "current": 42.0,
        "current_docs": 42.0,
        "current_size": "string",
        "current_size_in_bytes": 42.0,
        "total": 42.0,
        "total_auto_throttle": "string",
        "total_auto_throttle_in_bytes": 42.0,
        "total_docs": 42.0,
        "total_size": "string",
        "total_size_in_bytes": 42.0,
        "total_stopped_time": "string",
        "": 42.0,
        "total_throttled_time": "string",
        "total_time": "string"
      },
      "query_cache": {
        "cache_count": 42.0,
        "cache_size": 42.0,
        "evictions": 42.0,
        "hit_count": 42.0,
        "": 42.0,
        "memory_size_in_bytes": 42.0,
        "miss_count": 42.0,
        "total_count": 42.0
      },
      "recovery": {
        "current_as_source": 42.0,
        "current_as_target": 42.0,
        "throttle_time": "string",
        "": 42.0
      },
      "refresh": {
        "external_total": 42.0,
        "": 42.0,
        "listeners": 42.0,
        "total": 42.0,
        "total_time": "string"
      },
      "request_cache": {
        "evictions": 42.0,
        "hit_count": 42.0,
        "memory_size": "string",
        "memory_size_in_bytes": 42.0,
        "miss_count": 42.0
      },
      "search": {
        "fetch_current": 42.0,
        "fetch_time": "string",
        "": 42.0,
        "fetch_total": 42.0,
        "open_contexts": 42.0,
        "query_current": 42.0,
        "query_time": "string",
        "query_total": 42.0,
        "scroll_current": 42.0,
        "scroll_time": "string",
        "scroll_total": 42.0,
        "suggest_current": 42.0,
        "suggest_time": "string",
        "suggest_total": 42.0,
        "groups": {
          "*": {}
        }
      },
      "segments": {
        "count": 42.0,
        "": 42.0,
        "doc_values_memory_in_bytes": 42.0,
        "file_sizes": {
          "additionalProperty1": {
            "description": "string",
            "size_in_bytes": 42.0,
            "min_size_in_bytes": 42.0,
            "max_size_in_bytes": 42.0,
            "average_size_in_bytes": 42.0,
            "count": 42.0
          },
          "additionalProperty2": {
            "description": "string",
            "size_in_bytes": 42.0,
            "min_size_in_bytes": 42.0,
            "max_size_in_bytes": 42.0,
            "average_size_in_bytes": 42.0,
            "count": 42.0
          }
        },
        "fixed_bit_set_memory_in_bytes": 42.0,
        "index_writer_max_memory_in_bytes": 42.0,
        "index_writer_memory_in_bytes": 42.0,
        "max_unsafe_auto_id_timestamp": 42.0,
        "memory_in_bytes": 42.0,
        "norms_memory_in_bytes": 42.0,
        "points_memory_in_bytes": 42.0,
        "stored_fields_memory_in_bytes": 42.0,
        "terms_memory_in_bytes": 42.0,
        "term_vectors_memory_in_bytes": 42.0,
        "version_map_memory_in_bytes": 42.0
      },
      "store": {
        "": 42.0,
        "size_in_bytes": 42.0,
        "reserved_in_bytes": 42.0,
        "total_data_set_size_in_bytes": 42.0
      },
      "translog": {
        "earliest_last_modified_age": 42.0,
        "operations": 42.0,
        "size": "string",
        "size_in_bytes": 42.0,
        "uncommitted_operations": 42.0,
        "uncommitted_size": "string",
        "uncommitted_size_in_bytes": 42.0
      },
      "warmer": {
        "current": 42.0,
        "total": 42.0,
        "total_time": "string",
        "": 42.0
      },
      "bulk": {
        "total_operations": 42.0,
        "total_time": "string",
        "": 42.0,
        "total_size_in_bytes": 42.0,
        "avg_time": "string",
        "avg_size_in_bytes": 42.0
      },
      "shard_stats": {
        "total_count": 42.0
      }
    },
    "shards": {
      "additionalProperty1": [
        {
          "commit": {
            "generation": 42.0,
            "id": "string",
            "num_docs": 42.0,
            "user_data": {}
          },
          "completion": {
            "size_in_bytes": 42.0,
            "fields": {}
          },
          "docs": {
            "count": 42.0,
            "deleted": 42.0
          },
          "fielddata": {
            "evictions": 42.0,
            "memory_size_in_bytes": 42.0,
            "fields": {}
          },
          "flush": {
            "periodic": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "get": {
            "current": 42.0,
            "exists_time": "string",
            "exists_total": 42.0,
            "missing_time": "string",
            "missing_total": 42.0,
            "time": "string",
            "total": 42.0
          },
          "indexing": {
            "index_current": 42.0,
            "delete_current": 42.0,
            "delete_time": "string",
            "delete_total": 42.0,
            "is_throttled": true,
            "noop_update_total": 42.0,
            "throttle_time": "string",
            "index_time": "string",
            "index_total": 42.0,
            "index_failed": 42.0,
            "types": {},
            "write_load": 42.0,
            "recent_write_load": 42.0,
            "peak_write_load": 42.0
          },
          "mappings": {
            "total_count": 42.0,
            "total_estimated_overhead_in_bytes": 42.0
          },
          "merges": {
            "current": 42.0,
            "current_docs": 42.0,
            "current_size": "string",
            "current_size_in_bytes": 42.0,
            "total": 42.0,
            "total_auto_throttle": "string",
            "total_auto_throttle_in_bytes": 42.0,
            "total_docs": 42.0,
            "total_size": "string",
            "total_size_in_bytes": 42.0,
            "total_stopped_time": "string",
            "total_throttled_time": "string",
            "total_time": "string"
          },
          "shard_path": {
            "data_path": "string",
            "is_custom_data_path": true,
            "state_path": "string"
          },
          "query_cache": {
            "cache_count": 42.0,
            "cache_size": 42.0,
            "evictions": 42.0,
            "hit_count": 42.0,
            "memory_size_in_bytes": 42.0,
            "miss_count": 42.0,
            "total_count": 42.0
          },
          "recovery": {
            "current_as_source": 42.0,
            "current_as_target": 42.0,
            "throttle_time": "string"
          },
          "refresh": {
            "external_total": 42.0,
            "listeners": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "request_cache": {
            "evictions": 42.0,
            "hit_count": 42.0,
            "memory_size": "string",
            "memory_size_in_bytes": 42.0,
            "miss_count": 42.0
          },
          "retention_leases": {
            "primary_term": 42.0,
            "version": 42.0,
            "leases": [
              {}
            ]
          },
          "routing": {
            "node": "string",
            "primary": true,
            "state": "UNASSIGNED"
          },
          "search": {
            "fetch_current": 42.0,
            "fetch_time": "string",
            "fetch_total": 42.0,
            "open_contexts": 42.0,
            "query_current": 42.0,
            "query_time": "string",
            "query_total": 42.0,
            "scroll_current": 42.0,
            "scroll_time": "string",
            "scroll_total": 42.0,
            "suggest_current": 42.0,
            "suggest_time": "string",
            "suggest_total": 42.0,
            "groups": {}
          },
          "segments": {
            "count": 42.0,
            "doc_values_memory_in_bytes": 42.0,
            "file_sizes": {},
            "fixed_bit_set_memory_in_bytes": 42.0,
            "index_writer_max_memory_in_bytes": 42.0,
            "index_writer_memory_in_bytes": 42.0,
            "max_unsafe_auto_id_timestamp": 42.0,
            "memory_in_bytes": 42.0,
            "norms_memory_in_bytes": 42.0,
            "points_memory_in_bytes": 42.0,
            "stored_fields_memory_in_bytes": 42.0,
            "terms_memory_in_bytes": 42.0,
            "term_vectors_memory_in_bytes": 42.0,
            "version_map_memory_in_bytes": 42.0
          },
          "seq_no": {
            "global_checkpoint": 42.0,
            "local_checkpoint": 42.0,
            "max_seq_no": 42.0
          },
          "store": {
            "size_in_bytes": 42.0,
            "reserved_in_bytes": 42.0,
            "total_data_set_size_in_bytes": 42.0
          },
          "translog": {
            "earliest_last_modified_age": 42.0,
            "operations": 42.0,
            "size": "string",
            "size_in_bytes": 42.0,
            "uncommitted_operations": 42.0,
            "uncommitted_size": "string",
            "uncommitted_size_in_bytes": 42.0
          },
          "warmer": {
            "current": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "bulk": {
            "total_operations": 42.0,
            "total_time": "string",
            "total_size_in_bytes": 42.0,
            "avg_time": "string",
            "avg_size_in_bytes": 42.0
          },
          "shards": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "shard_stats": {
            "total_count": 42.0
          },
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      ],
      "additionalProperty2": [
        {
          "commit": {
            "generation": 42.0,
            "id": "string",
            "num_docs": 42.0,
            "user_data": {}
          },
          "completion": {
            "size_in_bytes": 42.0,
            "fields": {}
          },
          "docs": {
            "count": 42.0,
            "deleted": 42.0
          },
          "fielddata": {
            "evictions": 42.0,
            "memory_size_in_bytes": 42.0,
            "fields": {}
          },
          "flush": {
            "periodic": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "get": {
            "current": 42.0,
            "exists_time": "string",
            "exists_total": 42.0,
            "missing_time": "string",
            "missing_total": 42.0,
            "time": "string",
            "total": 42.0
          },
          "indexing": {
            "index_current": 42.0,
            "delete_current": 42.0,
            "delete_time": "string",
            "delete_total": 42.0,
            "is_throttled": true,
            "noop_update_total": 42.0,
            "throttle_time": "string",
            "index_time": "string",
            "index_total": 42.0,
            "index_failed": 42.0,
            "types": {},
            "write_load": 42.0,
            "recent_write_load": 42.0,
            "peak_write_load": 42.0
          },
          "mappings": {
            "total_count": 42.0,
            "total_estimated_overhead_in_bytes": 42.0
          },
          "merges": {
            "current": 42.0,
            "current_docs": 42.0,
            "current_size": "string",
            "current_size_in_bytes": 42.0,
            "total": 42.0,
            "total_auto_throttle": "string",
            "total_auto_throttle_in_bytes": 42.0,
            "total_docs": 42.0,
            "total_size": "string",
            "total_size_in_bytes": 42.0,
            "total_stopped_time": "string",
            "total_throttled_time": "string",
            "total_time": "string"
          },
          "shard_path": {
            "data_path": "string",
            "is_custom_data_path": true,
            "state_path": "string"
          },
          "query_cache": {
            "cache_count": 42.0,
            "cache_size": 42.0,
            "evictions": 42.0,
            "hit_count": 42.0,
            "memory_size_in_bytes": 42.0,
            "miss_count": 42.0,
            "total_count": 42.0
          },
          "recovery": {
            "current_as_source": 42.0,
            "current_as_target": 42.0,
            "throttle_time": "string"
          },
          "refresh": {
            "external_total": 42.0,
            "listeners": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "request_cache": {
            "evictions": 42.0,
            "hit_count": 42.0,
            "memory_size": "string",
            "memory_size_in_bytes": 42.0,
            "miss_count": 42.0
          },
          "retention_leases": {
            "primary_term": 42.0,
            "version": 42.0,
            "leases": [
              {}
            ]
          },
          "routing": {
            "node": "string",
            "primary": true,
            "state": "UNASSIGNED"
          },
          "search": {
            "fetch_current": 42.0,
            "fetch_time": "string",
            "fetch_total": 42.0,
            "open_contexts": 42.0,
            "query_current": 42.0,
            "query_time": "string",
            "query_total": 42.0,
            "scroll_current": 42.0,
            "scroll_time": "string",
            "scroll_total": 42.0,
            "suggest_current": 42.0,
            "suggest_time": "string",
            "suggest_total": 42.0,
            "groups": {}
          },
          "segments": {
            "count": 42.0,
            "doc_values_memory_in_bytes": 42.0,
            "file_sizes": {},
            "fixed_bit_set_memory_in_bytes": 42.0,
            "index_writer_max_memory_in_bytes": 42.0,
            "index_writer_memory_in_bytes": 42.0,
            "max_unsafe_auto_id_timestamp": 42.0,
            "memory_in_bytes": 42.0,
            "norms_memory_in_bytes": 42.0,
            "points_memory_in_bytes": 42.0,
            "stored_fields_memory_in_bytes": 42.0,
            "terms_memory_in_bytes": 42.0,
            "term_vectors_memory_in_bytes": 42.0,
            "version_map_memory_in_bytes": 42.0
          },
          "seq_no": {
            "global_checkpoint": 42.0,
            "local_checkpoint": 42.0,
            "max_seq_no": 42.0
          },
          "store": {
            "size_in_bytes": 42.0,
            "reserved_in_bytes": 42.0,
            "total_data_set_size_in_bytes": 42.0
          },
          "translog": {
            "earliest_last_modified_age": 42.0,
            "operations": 42.0,
            "size": "string",
            "size_in_bytes": 42.0,
            "uncommitted_operations": 42.0,
            "uncommitted_size": "string",
            "uncommitted_size_in_bytes": 42.0
          },
          "warmer": {
            "current": 42.0,
            "total": 42.0,
            "total_time": "string"
          },
          "bulk": {
            "total_operations": 42.0,
            "total_time": "string",
            "total_size_in_bytes": 42.0,
            "avg_time": "string",
            "avg_size_in_bytes": 42.0
          },
          "shards": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "shard_stats": {
            "total_count": 42.0
          },
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      ]
    },
    "total": {
      "completion": {
        "size_in_bytes": 42.0,
        "": 42.0,
        "fields": {
          "additionalProperty1": {
            "size_in_bytes": 42.0
          },
          "additionalProperty2": {
            "size_in_bytes": 42.0
          }
        }
      },
      "docs": {
        "count": 42.0,
        "deleted": 42.0
      },
      "fielddata": {
        "evictions": 42.0,
        "": 42.0,
        "memory_size_in_bytes": 42.0,
        "fields": {
          "additionalProperty1": {
            "memory_size_in_bytes": 42.0
          },
          "additionalProperty2": {
            "memory_size_in_bytes": 42.0
          }
        }
      },
      "flush": {
        "periodic": 42.0,
        "total": 42.0,
        "total_time": "string",
        "": 42.0
      },
      "get": {
        "current": 42.0,
        "exists_time": "string",
        "": 42.0,
        "exists_total": 42.0,
        "missing_time": "string",
        "missing_total": 42.0,
        "time": "string",
        "total": 42.0
      },
      "indexing": {
        "index_current": 42.0,
        "delete_current": 42.0,
        "delete_time": "string",
        "": 42.0,
        "delete_total": 42.0,
        "is_throttled": true,
        "noop_update_total": 42.0,
        "throttle_time": "string",
        "index_time": "string",
        "index_total": 42.0,
        "index_failed": 42.0,
        "types": {
          "*": {}
        },
        "write_load": 42.0,
        "recent_write_load": 42.0,
        "peak_write_load": 42.0
      },
      "additionalProperty1": {},
      "additionalProperty2": {},
      "merges": {
        "current": 42.0,
        "current_docs": 42.0,
        "current_size": "string",
        "current_size_in_bytes": 42.0,
        "total": 42.0,
        "total_auto_throttle": "string",
        "total_auto_throttle_in_bytes": 42.0,
        "total_docs": 42.0,
        "total_size": "string",
        "total_size_in_bytes": 42.0,
        "total_stopped_time": "string",
        "": 42.0,
        "total_throttled_time": "string",
        "total_time": "string"
      },
      "query_cache": {
        "cache_count": 42.0,
        "cache_size": 42.0,
        "evictions": 42.0,
        "hit_count": 42.0,
        "": 42.0,
        "memory_size_in_bytes": 42.0,
        "miss_count": 42.0,
        "total_count": 42.0
      },
      "recovery": {
        "current_as_source": 42.0,
        "current_as_target": 42.0,
        "throttle_time": "string",
        "": 42.0
      },
      "refresh": {
        "external_total": 42.0,
        "": 42.0,
        "listeners": 42.0,
        "total": 42.0,
        "total_time": "string"
      },
      "request_cache": {
        "evictions": 42.0,
        "hit_count": 42.0,
        "memory_size": "string",
        "memory_size_in_bytes": 42.0,
        "miss_count": 42.0
      },
      "search": {
        "fetch_current": 42.0,
        "fetch_time": "string",
        "": 42.0,
        "fetch_total": 42.0,
        "open_contexts": 42.0,
        "query_current": 42.0,
        "query_time": "string",
        "query_total": 42.0,
        "scroll_current": 42.0,
        "scroll_time": "string",
        "scroll_total": 42.0,
        "suggest_current": 42.0,
        "suggest_time": "string",
        "suggest_total": 42.0,
        "groups": {
          "*": {}
        }
      },
      "segments": {
        "count": 42.0,
        "": 42.0,
        "doc_values_memory_in_bytes": 42.0,
        "file_sizes": {
          "additionalProperty1": {
            "description": "string",
            "size_in_bytes": 42.0,
            "min_size_in_bytes": 42.0,
            "max_size_in_bytes": 42.0,
            "average_size_in_bytes": 42.0,
            "count": 42.0
          },
          "additionalProperty2": {
            "description": "string",
            "size_in_bytes": 42.0,
            "min_size_in_bytes": 42.0,
            "max_size_in_bytes": 42.0,
            "average_size_in_bytes": 42.0,
            "count": 42.0
          }
        },
        "fixed_bit_set_memory_in_bytes": 42.0,
        "index_writer_max_memory_in_bytes": 42.0,
        "index_writer_memory_in_bytes": 42.0,
        "max_unsafe_auto_id_timestamp": 42.0,
        "memory_in_bytes": 42.0,
        "norms_memory_in_bytes": 42.0,
        "points_memory_in_bytes": 42.0,
        "stored_fields_memory_in_bytes": 42.0,
        "terms_memory_in_bytes": 42.0,
        "term_vectors_memory_in_bytes": 42.0,
        "version_map_memory_in_bytes": 42.0
      },
      "store": {
        "": 42.0,
        "size_in_bytes": 42.0,
        "reserved_in_bytes": 42.0,
        "total_data_set_size_in_bytes": 42.0
      },
      "translog": {
        "earliest_last_modified_age": 42.0,
        "operations": 42.0,
        "size": "string",
        "size_in_bytes": 42.0,
        "uncommitted_operations": 42.0,
        "uncommitted_size": "string",
        "uncommitted_size_in_bytes": 42.0
      },
      "warmer": {
        "current": 42.0,
        "total": 42.0,
        "total_time": "string",
        "": 42.0
      },
      "bulk": {
        "total_operations": 42.0,
        "total_time": "string",
        "": 42.0,
        "total_size_in_bytes": 42.0,
        "avg_time": "string",
        "avg_size_in_bytes": 42.0
      },
      "shard_stats": {
        "total_count": 42.0
      }
    },
    "uuid": "string",
    "health": "green",
    "status": "open"
  }
}

Delete anomaly jobs from a calendar Added in 6.2.0

DELETE /_ml/calendars/{calendar_id}/jobs/{job_id}

Api key auth Basic auth Bearer auth

Path parameters

calendar_id string Required

A string that uniquely identifies a calendar.
job_id string | array[string] Required

An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.

Responses

200 application/json
Hide response attributes Show response attributes object
- calendar_id string Required
- description string
  
  A description of the calendar.
- job_ids string | array[string] Required
  
  One of:
  Id string Ids array[string]

DELETE /_ml/calendars/{calendar_id}/jobs/{job_id}

curl \
 --request DELETE 'http://api.example.com/_ml/calendars/{calendar_id}/jobs/{job_id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response when deleting an anomaly detection job from a calendar.

{
  "calendar_id": "planned-outages",
  "job_ids": []
}

Evaluate data frame analytics Added in 7.3.0

POST /_ml/data_frame/_evaluate

Api key auth Basic auth Bearer auth

The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.

application/json

Body Required

evaluation object Required
Hide evaluation attributes Show evaluation attributes object
- classification object
  Hide classification attributes Show classification attributes object
  
  actual_field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  predicted_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  top_classes_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  metrics object
  
  Hide metrics attributes Show metrics attributes object
  
  auc_roc object
  
  Hide auc_roc attributes Show auc_roc attributes object
  
  class_name string
  
  include_curve boolean
  
  Whether or not the curve should be returned in addition to the score. Default value is false.
  
  precision object
  
  Precision of predictions (per-class and average).
  
  Hide precision attribute Show precision attribute object
  
  * object Additional properties
  
  recall object
  
  Recall of predictions (per-class and average).
  
  Hide recall attribute Show recall attribute object
  
  * object Additional properties
  
  accuracy object
  
  Accuracy of predictions (per-class and overall).
  
  Hide accuracy attribute Show accuracy attribute object
  
  * object Additional properties
  
  multiclass_confusion_matrix object
  
  Multiclass confusion matrix.
  
  Hide multiclass_confusion_matrix attribute Show multiclass_confusion_matrix attribute object
  
  * object Additional properties
- outlier_detection object
  Hide outlier_detection attributes Show outlier_detection attributes object
  
  actual_field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  predicted_probability_field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  metrics object
  
  Hide metrics attributes Show metrics attributes object
  
  auc_roc object
  
  Hide auc_roc attributes Show auc_roc attributes object
  
  class_name string
  
  include_curve boolean
  
  Whether or not the curve should be returned in addition to the score. Default value is false.
  
  precision object
  
  Precision of predictions (per-class and average).
  
  Hide precision attribute Show precision attribute object
  
  * object Additional properties
  
  recall object
  
  Recall of predictions (per-class and average).
  
  Hide recall attribute Show recall attribute object
  
  * object Additional properties
  
  confusion_matrix object
  
  Accuracy of predictions (per-class and overall).
  
  Hide confusion_matrix attribute Show confusion_matrix attribute object
  
  * object Additional properties
- regression object
  Hide regression attributes Show regression attributes object
  
  actual_field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  predicted_field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  metrics object
  
  Hide metrics attributes Show metrics attributes object
  
  mse object
  
  Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article.
  
  Hide mse attribute Show mse attribute object
  
  * object Additional properties
  
  msle object
  
  Hide msle attribute Show msle attribute object
  
  offset number
  
  Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1.
  
  huber object
  
  Hide huber attribute Show huber attribute object
  
  delta number
  
  Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0.
  
  r_squared object
  
  Proportion of the variance in the dependent variable that is predictable from the independent variables.
  
  Hide r_squared attribute Show r_squared attribute object
  
  * object Additional properties
index string Required
query object

An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

External documentation

Responses

200 application/json
Hide response attributes Show response attributes object
- classification object
  
  Hide classification attributes Show classification attributes object
  
  auc_roc object
  
  Hide auc_roc attributes Show auc_roc attributes object
  
  value number Required
  
  curve array[object]
  
  Hide curve attributes Show curve attributes object
  
  tpr number Required
  
  fpr number Required
  
  threshold number Required
  
  accuracy object
  
  Hide accuracy attributes Show accuracy attributes object
  
  classes array[object] Required
  
  Hide classes attributes Show classes attributes object
  
  value number Required
  
  class_name string Required
  
  overall_accuracy number Required
  
  multiclass_confusion_matrix object
  
  Hide multiclass_confusion_matrix attributes Show multiclass_confusion_matrix attributes object
  
  confusion_matrix array[object] Required
  
  Hide confusion_matrix attributes Show confusion_matrix attributes object
  
  actual_class string Required
  
  actual_class_doc_count number Required
  
  predicted_classes array[object] Required
  
  other_predicted_class_doc_count number Required
  
  other_actual_class_count number Required
  
  precision object
  
  Hide precision attributes Show precision attributes object
  
  classes array[object] Required
  
  Hide classes attributes Show classes attributes object
  
  value number Required
  
  class_name string Required
  
  avg_precision number Required
  
  recall object
  
  Hide recall attributes Show recall attributes object
  
  classes array[object] Required
  
  Hide classes attributes Show classes attributes object
  
  value number Required
  
  class_name string Required
  
  avg_recall number Required
- outlier_detection object
  
  Hide outlier_detection attributes Show outlier_detection attributes object
  
  auc_roc object
  
  Hide auc_roc attributes Show auc_roc attributes object
  
  value number Required
  
  curve array[object]
  
  Hide curve attributes Show curve attributes object
  
  tpr number Required
  
  fpr number Required
  
  threshold number Required
  
  precision object
  
  Set the different thresholds of the outlier score at where the metric is calculated.
  
  Hide precision attribute Show precision attribute object
  
  * number Additional properties
  
  recall object
  
  Set the different thresholds of the outlier score at where the metric is calculated.
  
  Hide recall attribute Show recall attribute object
  
  * number Additional properties
  
  confusion_matrix object
  
  Set the different thresholds of the outlier score at where the metrics (tp - true positive, fp - false positive, tn - true negative, fn - false negative) are calculated.
  
  Hide confusion_matrix attribute Show confusion_matrix attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  tp number Required
  
  True Positive
  
  fp number Required
  
  False Positive
  
  tn number Required
  
  True Negative
  
  fn number Required
  
  False Negative
- regression object
  
  Hide regression attributes Show regression attributes object
  
  huber object
  
  Hide huber attribute Show huber attribute object
  
  value number Required
  
  mse object
  
  Hide mse attribute Show mse attribute object
  
  value number Required
  
  msle object
  
  Hide msle attribute Show msle attribute object
  
  value number Required
  
  r_squared object
  
  Hide r_squared attribute Show r_squared attribute object
  
  value number Required

POST /_ml/data_frame/_evaluate

curl \
 --request POST 'http://api.example.com/_ml/data_frame/_evaluate' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"index\": \"animal_classification\",\n  \"evaluation\": {\n    \"classification\": {\n      \"actual_field\": \"animal_class\",\n      \"predicted_field\": \"ml.animal_class_prediction\",\n      \"metrics\": {\n        \"multiclass_confusion_matrix\": {}\n      }\n    }\n  }\n}"'

Request examples

Run `POST _ml/data_frame/_evaluate` to evaluate a a classification job for an annotated index. The `actual_field` contains the ground truth for classification. The `predicted_field` contains the predicted value calculated by the classification analysis.

{
  "index": "animal_classification",
  "evaluation": {
    "classification": {
      "actual_field": "animal_class",
      "predicted_field": "ml.animal_class_prediction",
      "metrics": {
        "multiclass_confusion_matrix": {}
      }
    }
  }
}

Run `POST _ml/data_frame/_evaluate` to evaluate a classification job with AUC ROC metrics for an annotated index. The `actual_field` contains the ground truth value for the actual animal classification. This is required in order to evaluate results. The `class_name` specifies the class name that is treated as positive during the evaluation, all the other classes are treated as negative.

{
  "index": "animal_classification",
  "evaluation": {
    "classification": {
      "actual_field": "animal_class",
      "metrics": {
        "auc_roc": {
          "class_name": "dog"
        }
      }
    }
  }
}

Run `POST _ml/data_frame/_evaluate` to evaluate an outlier detection job for an annotated index.

{
  "index": "my_analytics_dest_index",
  "evaluation": {
    "outlier_detection": {
      "actual_field": "is_outlier",
      "predicted_probability_field": "ml.outlier_score"
    }
  }
}

Run `POST _ml/data_frame/_evaluate` to evaluate the testing error of a regression job for an annotated index. The term query in the body limits evaluation to be performed on the test split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis.

{
  "index": "house_price_predictions",
  "query": {
    "bool": {
      "filter": [
        {
          "term": {
            "ml.is_training": false
          }
        }
      ]
    }
  },
  "evaluation": {
    "regression": {
      "actual_field": "price",
      "predicted_field": "ml.price_prediction",
      "metrics": {
        "r_squared": {},
        "mse": {},
        "msle": {
          "offset": 10
        },
        "huber": {
          "delta": 1.5
        }
      }
    }
  }
}

Run `POST _ml/data_frame/_evaluate` to evaluate the training error of a regression job for an annotated index. The term query in the body limits evaluation to be performed on the training split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis.

{
  "index": "house_price_predictions",
  "query": {
    "term": {
      "ml.is_training": {
        "value": true
      }
    }
  },
  "evaluation": {
    "regression": {
      "actual_field": "price",
      "predicted_field": "ml.price_prediction",
      "metrics": {
        "r_squared": {},
        "mse": {},
        "msle": {},
        "huber": {}
      }
    }
  }
}

Response examples (200)

A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job for an annotated index. The `actual_class` contains the name of the class the analysis tried to predict. The `actual_class_doc_count` is the number of documents in the index belonging to the `actual_class`. The `predicted_classes` object contains the list of the predicted classes and the number of predictions associated with the class.

{
  "classification": {
    "multiclass_confusion_matrix": {
      "confusion_matrix": [
        {
          "actual_class": "cat",
          "actual_class_doc_count": 12,
          "predicted_classes": [
            {
              "predicted_class": "cat",
              "count": 12
            },
            {
              "predicted_class": "dog",
              "count": 0
            }
          ],
          "other_predicted_class_doc_count": 0
        },
        {
          "actual_class": "dog",
          "actual_class_doc_count": 11,
          "predicted_classes": [
            {
              "predicted_class": "dog",
              "count": 7
            },
            {
              "predicted_class": "cat",
              "count": 4
            }
          ],
          "other_predicted_class_doc_count": 0
        }
      ],
      "other_actual_class_count": 0
    }
  }
}

A succesful response from `POST _ml/data_frame/_evaluate` to evaluate a classification analysis job with the AUC ROC metrics for an annotated index.

{
  "classification": {
    "auc_roc": {
      "value": 0.8941788639536681
    }
  }
}

A successful response from `POST _ml/data_frame/_evaluate` to evaluate an outlier detection job.

{
  "outlier_detection": {
    "auc_roc": {
      "value": 0.9258475774641445
    },
    "confusion_matrix": {
      "0.25": {
        "tp": 5,
        "fp": 9,
        "tn": 204,
        "fn": 5
      },
      "0.5": {
        "tp": 1,
        "fp": 5,
        "tn": 208,
        "fn": 9
      },
      "0.75": {
        "tp": 0,
        "fp": 4,
        "tn": 209,
        "fn": 10
      }
    },
    "precision": {
      "0.25": 0.35714285714285715,
      "0.5": 0.16666666666666666,
      "0.75": 0
    },
    "recall": {
      "0.25": 0.5,
      "0.5": 0.1,
      "0.75": 0
    }
  }
}

Create a trained model Added in 7.10.0

PUT /_ml/trained_models/{model_id}

Api key auth Basic auth Bearer auth

Enable you to supply a trained model that is not created by data frame analytics.

Path parameters

model_id string Required

The unique identifier of the trained model.

Query parameters

defer_definition_decompression boolean

If set to true and a compressed_definition is provided, the request defers definition decompression and skips relevant validations.
wait_for_completion boolean

Whether to wait for all child operations (e.g. model download) to complete.

application/json

Body Required

compressed_definition string

The compressed (GZipped and Base64 encoded) inference definition of the model. If compressed_definition is specified, then definition cannot be specified.
definition object
Hide definition attributes Show definition attributes object
- preprocessors array[object]
  
  Collection of preprocessors
  Hide preprocessors attributes Show preprocessors attributes object
  
  frequency_encoding object
  
  Hide frequency_encoding attributes Show frequency_encoding attributes object
  
  field string Required
  
  feature_name string Required
  
  frequency_map object Required
  
  Hide frequency_map attribute Show frequency_map attribute object
  
  * number Additional properties
  
  one_hot_encoding object
  
  Hide one_hot_encoding attributes Show one_hot_encoding attributes object
  
  field string Required
  
  hot_map object Required
  
  Hide hot_map attribute Show hot_map attribute object
  
  * string Additional properties
  
  target_mean_encoding object
  
  Hide target_mean_encoding attributes Show target_mean_encoding attributes object
  
  field string Required
  
  feature_name string Required
  
  target_map object Required
  
  Hide target_map attribute Show target_map attribute object
  
  * number Additional properties
  
  default_value number Required
- trained_model object Required
  Hide trained_model attributes Show trained_model attributes object
  
  tree object
  
  Hide tree attributes Show tree attributes object
  
  classification_labels array[string]
  
  feature_names array[string] Required
  
  target_type string
  
  tree_structure array[object] Required
  
  Hide tree_structure attributes Show tree_structure attributes object
  
  decision_type string
  
  default_left boolean
  
  leaf_value number
  
  left_child number
  
  node_index number Required
  
  right_child number
  
  split_feature number
  
  split_gain number
  
  threshold number
  
  tree_node object
  
  Hide tree_node attributes Show tree_node attributes object
  
  decision_type string
  
  default_left boolean
  
  leaf_value number
  
  left_child number
  
  node_index number Required
  
  right_child number
  
  split_feature number
  
  split_gain number
  
  threshold number
  
  ensemble object
  
  Hide ensemble attributes Show ensemble attributes object
  
  aggregate_output object
  
  Hide aggregate_output attributes Show aggregate_output attributes object
  
  logistic_regression object
  
  Hide logistic_regression attribute Show logistic_regression attribute object
  
  weights number Required
  
  weighted_sum object
  
  Hide weighted_sum attribute Show weighted_sum attribute object
  
  weights number Required
  
  weighted_mode object
  
  Hide weighted_mode attribute Show weighted_mode attribute object
  
  weights number Required
  
  exponent object
  
  Hide exponent attribute Show exponent attribute object
  
  weights number Required
  
  classification_labels array[string]
  
  feature_names array[string]
  
  target_type string
  
  trained_models array[object] Required
description string

A human-readable description of the inference trained model.
inference_config object

Inference configuration provided when storing the model config
Hide inference_config attributes Show inference_config attributes object
- regression object
  Hide regression attributes Show regression attributes object
  
  results_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  num_top_feature_importance_values number
  
  Specifies the maximum number of feature importance values per document.
- classification object
  Hide classification attributes Show classification attributes object
  
  num_top_classes number
  
  Specifies the number of top class predictions to return. Defaults to 0.
  
  num_top_feature_importance_values number
  
  Specifies the maximum number of feature importance values per document.
  
  prediction_field_type string
  
  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.
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  top_classes_results_field string
  
  Specifies the field to which the top classes are written. Defaults to top_classes.
- text_classification object
  Hide text_classification attributes Show text_classification attributes object
  
  num_top_classes number
  
  Specifies the number of top class predictions to return. Defaults to 0.
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  classification_labels array[string]
  
  Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels
  
  vocabulary object
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
- zero_shot_classification object
  Hide zero_shot_classification attributes Show zero_shot_classification attributes object
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  hypothesis_template string
  
  Hypothesis template used when tokenizing labels for prediction
  
  classification_labels array[string] Required
  
  The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  multi_label boolean
  
  Indicates if more than one true label exists.
  
  labels array[string]
  
  The labels to predict.
- fill_mask object
  Hide fill_mask attributes Show fill_mask attributes object
  
  mask_token string
  
  The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail.
  
  num_top_classes number
  
  Specifies the number of top class predictions to return. Defaults to 0.
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  vocabulary object Required
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
- learning_to_rank object
  Hide learning_to_rank attributes Show learning_to_rank attributes object
  
  default_params object
  
  Hide default_params attribute Show default_params attribute object
  
  * object Additional properties
  
  feature_extractors array[object]
  
  num_top_feature_importance_values number Required
- ner object
  Hide ner attributes Show ner attributes object
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  classification_labels array[string]
  
  The token classification labels. Must be IOB formatted tags
  
  vocabulary object
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
- pass_through object
  Hide pass_through attributes Show pass_through attributes object
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  vocabulary object
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
- text_embedding object
  Hide text_embedding attributes Show text_embedding attributes object
  
  embedding_size number
  
  The number of dimensions in the embedding output
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  vocabulary object Required
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
- text_expansion object
  Hide text_expansion attributes Show text_expansion attributes object
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  vocabulary object Required
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
- question_answering object
  Hide question_answering attributes Show question_answering attributes object
  
  num_top_classes number
  
  Specifies the number of top class predictions to return. Defaults to 0.
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  max_answer_length number
  
  The maximum answer length to consider
input object
Hide input attribute Show input attribute object
- field_names string | array[string] Required
metadata object

An object map that contains metadata about the model.
model_type string

Values are tree_ensemble, lang_ident, or pytorch.
model_size_bytes number

The estimated memory usage in bytes to keep the trained model in memory. This property is supported only if defer_definition_decompression is true or the model definition is not supplied.
platform_architecture string

The platform architecture (if applicable) of the trained mode. If the model only works on one platform, because it is heavily optimized for a particular processor architecture and OS combination, then this field specifies which. The format of the string must match the platform identifiers used by Elasticsearch, so one of, linux-x86_64, linux-aarch64, darwin-x86_64, darwin-aarch64, or windows-x86_64. For portable models (those that work independent of processor architecture or OS features), leave this field unset.
tags array[string]

An array of tags to organize the model.
prefix_strings object
Hide prefix_strings attributes Show prefix_strings attributes object
- ingest string
  
  String prepended to input at ingest
- search string
  
  String prepended to input at search

Responses

200 application/json
Hide response attributes Show response attributes object
- model_id string Required
- model_type string
  
  Values are tree_ensemble, lang_ident, or pytorch.
- tags array[string] Required
  
  A comma delimited string of tags. A trained model can have many tags, or none.
- version string
- compressed_definition string
- created_by string
  
  Information on the creator of the trained model.
- create_time string | number
  
  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.
  
  One of:
  DateTime string UnitMillis number
- default_field_map object
  
  Any field map described in the inference configuration takes precedence.
  
  Hide default_field_map attribute Show default_field_map attribute object
  
  * string Additional properties
- description string
  
  The free-text description of the trained model.
- estimated_heap_memory_usage_bytes number
  
  The estimated heap usage in bytes to keep the trained model in memory.
- estimated_operations number
  
  The estimated number of operations to use the trained model.
- fully_defined boolean
  
  True if the full model definition is present.
- inference_config object
  
  Inference configuration provided when storing the model config
  
  Hide inference_config attributes Show inference_config attributes object
  
  regression object
  
  Hide regression attributes Show regression attributes object
  
  results_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  num_top_feature_importance_values number
  
  Specifies the maximum number of feature importance values per document.
  
  classification object
  
  Hide classification attributes Show classification attributes object
  
  num_top_classes number
  
  Specifies the number of top class predictions to return. Defaults to 0.
  
  num_top_feature_importance_values number
  
  Specifies the maximum number of feature importance values per document.
  
  prediction_field_type string
  
  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.
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  top_classes_results_field string
  
  Specifies the field to which the top classes are written. Defaults to top_classes.
  
  text_classification object
  
  Hide text_classification attributes Show text_classification attributes object
  
  num_top_classes number
  
  Specifies the number of top class predictions to return. Defaults to 0.
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  classification_labels array[string]
  
  Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels
  
  vocabulary object
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
  
  zero_shot_classification object
  
  Hide zero_shot_classification attributes Show zero_shot_classification attributes object
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  hypothesis_template string
  
  Hypothesis template used when tokenizing labels for prediction
  
  classification_labels array[string] Required
  
  The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  multi_label boolean
  
  Indicates if more than one true label exists.
  
  labels array[string]
  
  The labels to predict.
  
  fill_mask object
  
  Hide fill_mask attributes Show fill_mask attributes object
  
  mask_token string
  
  The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail.
  
  num_top_classes number
  
  Specifies the number of top class predictions to return. Defaults to 0.
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  vocabulary object Required
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
  
  learning_to_rank object
  
  Hide learning_to_rank attributes Show learning_to_rank attributes object
  
  default_params object
  
  Hide default_params attribute Show default_params attribute object
  
  * object Additional properties
  
  feature_extractors array[object]
  
  num_top_feature_importance_values number Required
  
  ner object
  
  Hide ner attributes Show ner attributes object
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  classification_labels array[string]
  
  The token classification labels. Must be IOB formatted tags
  
  vocabulary object
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
  
  pass_through object
  
  Hide pass_through attributes Show pass_through attributes object
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  vocabulary object
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
  
  text_embedding object
  
  Hide text_embedding attributes Show text_embedding attributes object
  
  embedding_size number
  
  The number of dimensions in the embedding output
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  vocabulary object Required
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
  
  text_expansion object
  
  Hide text_expansion attributes Show text_expansion attributes object
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  vocabulary object Required
  
  Hide vocabulary attribute Show vocabulary attribute object
  
  index string Required
  
  question_answering object
  
  Hide question_answering attributes Show question_answering attributes object
  
  num_top_classes number
  
  Specifies the number of top class predictions to return. Defaults to 0.
  
  tokenization object
  
  Tokenization options stored in inference configuration
  
  Hide tokenization attributes Show tokenization attributes object
  
  bert object
  
  Hide bert attributes Show bert attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  bert_ja object
  
  Hide bert_ja attributes Show bert_ja attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  mpnet object
  
  Hide mpnet attributes Show mpnet attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  roberta object
  
  Hide roberta attributes Show roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  add_prefix_space boolean
  
  Should the tokenizer prefix input with a space character
  
  xlm_roberta object
  
  Hide xlm_roberta attributes Show xlm_roberta attributes object
  
  do_lower_case boolean
  
  Should the tokenizer lower case the text
  
  max_sequence_length number
  
  Maximum input sequence length for the model
  
  span number
  
  Tokenization spanning options. Special value of -1 indicates no spanning takes place
  
  truncate string
  
  Values are first, second, or none.
  
  with_special_tokens boolean
  
  Is tokenization completed with special tokens
  
  results_field string
  
  The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
  
  max_answer_length number
  
  The maximum answer length to consider
- input object Required
  
  Hide input attribute Show input attribute object
  
  field_names array[string] Required
  
  An array of input field names for the model.
- license_level string
  
  The license level of the trained model.
- metadata object
  
  Hide metadata attributes Show metadata attributes object
  
  model_aliases array[string]
  
  feature_importance_baseline object
  
  An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.
  
  Hide feature_importance_baseline attribute Show feature_importance_baseline attribute object
  
  * string Additional properties
  
  hyperparameters array[object]
  
  List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.
  
  Hide hyperparameters attributes Show hyperparameters attributes object
  
  absolute_importance number
  
  A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.
  
  name string Required
  
  relative_importance number
  
  A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.
  
  supplied boolean Required
  
  Indicates if the hyperparameter is specified by the user (true) or optimized (false).
  
  value number Required
  
  The value of the hyperparameter, either optimized or specified by the user.
  
  total_feature_importance array[object]
  
  An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.
  
  Hide total_feature_importance attributes Show total_feature_importance attributes object
  
  feature_name string Required
  
  importance array[object] Required
  
  A collection of feature importance statistics related to the training data set for this particular feature.
  
  Hide importance attributes Show importance attributes object
  
  mean_magnitude number Required
  
  The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.
  
  max number Required
  
  The maximum importance value across all the training data for this feature.
  
  min number Required
  
  The minimum importance value across all the training data for this feature.
  
  classes array[object] Required
  
  If the trained model is a classification model, feature importance statistics are gathered per target class value.
  
  Hide classes attributes Show classes attributes object
  
  class_name string Required
  
  importance array[object] Required
  
  A collection of feature importance statistics related to the training data set for this particular feature.
- model_size_bytes number | string
  
  One of:
  ByteSize number ByteSize string
- model_package object
  
  Hide model_package attributes Show model_package attributes object
  
  create_time number
  
  Time unit for milliseconds
  
  description string
  
  inference_config object
  
  Hide inference_config attribute Show inference_config attribute object
  
  * object Additional properties
  
  metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  * object Additional properties
  
  minimum_version string
  
  model_repository string
  
  model_type string
  
  packaged_model_id string Required
  
  platform_architecture string
  
  prefix_strings object
  
  Hide prefix_strings attributes Show prefix_strings attributes object
  
  ingest string
  
  String prepended to input at ingest
  
  search string
  
  String prepended to input at search
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  sha256 string
  
  tags array[string]
  
  vocabulary_file string
- location object
  
  Hide location attribute Show location attribute object
  
  index object Required
  
  Hide index attribute Show index attribute object
  
  name string Required
- platform_architecture string
- prefix_strings object
  
  Hide prefix_strings attributes Show prefix_strings attributes object
  
  ingest string
  
  String prepended to input at ingest
  
  search string
  
  String prepended to input at search

PUT /_ml/trained_models/{model_id}

curl \
 --request PUT 'http://api.example.com/_ml/trained_models/{model_id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"compressed_definition":"string","definition":{"preprocessors":[{"frequency_encoding":{"field":"string","feature_name":"string","frequency_map":{"additionalProperty1":42.0,"additionalProperty2":42.0}},"one_hot_encoding":{"field":"string","hot_map":{"additionalProperty1":"string","additionalProperty2":"string"}},"target_mean_encoding":{"field":"string","feature_name":"string","target_map":{"additionalProperty1":42.0,"additionalProperty2":42.0},"default_value":42.0}}],"trained_model":{"tree":{"classification_labels":["string"],"feature_names":["string"],"target_type":"string","tree_structure":[{"decision_type":"string","default_left":true,"leaf_value":42.0,"left_child":42.0,"node_index":42.0,"right_child":42.0,"split_feature":42.0,"split_gain":42.0,"threshold":42.0}]},"tree_node":{"decision_type":"string","default_left":true,"leaf_value":42.0,"left_child":42.0,"node_index":42.0,"right_child":42.0,"split_feature":42.0,"split_gain":42.0,"threshold":42.0},"ensemble":{"aggregate_output":{"logistic_regression":{"weights":42.0},"weighted_sum":{"weights":42.0},"weighted_mode":{"weights":42.0},"exponent":{"weights":42.0}},"classification_labels":["string"],"feature_names":["string"],"target_type":"string","trained_models":[{}]}}},"description":"string","inference_config":{"regression":{"results_field":"string","num_top_feature_importance_values":42.0},"classification":{"num_top_classes":42.0,"num_top_feature_importance_values":42.0,"prediction_field_type":"string","results_field":"string","top_classes_results_field":"string"},"text_classification":{"num_top_classes":42.0,"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","classification_labels":["string"],"vocabulary":{"index":"string"}},"zero_shot_classification":{"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"hypothesis_template":"string","classification_labels":["string"],"results_field":"string","multi_label":true,"labels":["string"]},"fill_mask":{"mask_token":"string","num_top_classes":42.0,"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","vocabulary":{"index":"string"}},"learning_to_rank":{"default_params":{"additionalProperty1":{},"additionalProperty2":{}},"feature_extractors":[{}],"num_top_feature_importance_values":42.0},"ner":{"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","classification_labels":["string"],"vocabulary":{"index":"string"}},"pass_through":{"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","vocabulary":{"index":"string"}},"text_embedding":{"embedding_size":42.0,"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","vocabulary":{"index":"string"}},"text_expansion":{"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","vocabulary":{"index":"string"}},"question_answering":{"num_top_classes":42.0,"tokenization":{"bert":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"bert_ja":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"mpnet":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true},"roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true,"add_prefix_space":true},"xlm_roberta":{"do_lower_case":true,"max_sequence_length":42.0,"span":42.0,"truncate":"first","with_special_tokens":true}},"results_field":"string","max_answer_length":42.0}},"input":{"field_names":"string"},"metadata":{},"model_type":"tree_ensemble","model_size_bytes":42.0,"platform_architecture":"string","tags":["string"],"prefix_strings":{"ingest":"string","search":"string"}}'

Request examples

{
  "compressed_definition": "string",
  "definition": {
    "preprocessors": [
      {
        "frequency_encoding": {
          "field": "string",
          "feature_name": "string",
          "frequency_map": {
            "additionalProperty1": 42.0,
            "additionalProperty2": 42.0
          }
        },
        "one_hot_encoding": {
          "field": "string",
          "hot_map": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          }
        },
        "target_mean_encoding": {
          "field": "string",
          "feature_name": "string",
          "target_map": {
            "additionalProperty1": 42.0,
            "additionalProperty2": 42.0
          },
          "default_value": 42.0
        }
      }
    ],
    "trained_model": {
      "tree": {
        "classification_labels": [
          "string"
        ],
        "feature_names": [
          "string"
        ],
        "target_type": "string",
        "tree_structure": [
          {
            "decision_type": "string",
            "default_left": true,
            "leaf_value": 42.0,
            "left_child": 42.0,
            "node_index": 42.0,
            "right_child": 42.0,
            "split_feature": 42.0,
            "split_gain": 42.0,
            "threshold": 42.0
          }
        ]
      },
      "tree_node": {
        "decision_type": "string",
        "default_left": true,
        "leaf_value": 42.0,
        "left_child": 42.0,
        "node_index": 42.0,
        "right_child": 42.0,
        "split_feature": 42.0,
        "split_gain": 42.0,
        "threshold": 42.0
      },
      "ensemble": {
        "aggregate_output": {
          "logistic_regression": {
            "weights": 42.0
          },
          "weighted_sum": {
            "weights": 42.0
          },
          "weighted_mode": {
            "weights": 42.0
          },
          "exponent": {
            "weights": 42.0
          }
        },
        "classification_labels": [
          "string"
        ],
        "feature_names": [
          "string"
        ],
        "target_type": "string",
        "trained_models": [
          {}
        ]
      }
    }
  },
  "description": "string",
  "inference_config": {
    "regression": {
      "results_field": "string",
      "num_top_feature_importance_values": 42.0
    },
    "classification": {
      "num_top_classes": 42.0,
      "num_top_feature_importance_values": 42.0,
      "prediction_field_type": "string",
      "results_field": "string",
      "top_classes_results_field": "string"
    },
    "text_classification": {
      "num_top_classes": 42.0,
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "classification_labels": [
        "string"
      ],
      "vocabulary": {
        "index": "string"
      }
    },
    "zero_shot_classification": {
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "hypothesis_template": "string",
      "classification_labels": [
        "string"
      ],
      "results_field": "string",
      "multi_label": true,
      "labels": [
        "string"
      ]
    },
    "fill_mask": {
      "mask_token": "string",
      "num_top_classes": 42.0,
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "vocabulary": {
        "index": "string"
      }
    },
    "learning_to_rank": {
      "default_params": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      },
      "feature_extractors": [
        {}
      ],
      "num_top_feature_importance_values": 42.0
    },
    "ner": {
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "classification_labels": [
        "string"
      ],
      "vocabulary": {
        "index": "string"
      }
    },
    "pass_through": {
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "vocabulary": {
        "index": "string"
      }
    },
    "text_embedding": {
      "embedding_size": 42.0,
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "vocabulary": {
        "index": "string"
      }
    },
    "text_expansion": {
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "vocabulary": {
        "index": "string"
      }
    },
    "question_answering": {
      "num_top_classes": 42.0,
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "max_answer_length": 42.0
    }
  },
  "input": {
    "field_names": "string"
  },
  "metadata": {},
  "model_type": "tree_ensemble",
  "model_size_bytes": 42.0,
  "platform_architecture": "string",
  "tags": [
    "string"
  ],
  "prefix_strings": {
    "ingest": "string",
    "search": "string"
  }
}

Response examples (200)

{
  "model_id": "string",
  "model_type": "tree_ensemble",
  "tags": [
    "string"
  ],
  "version": "string",
  "compressed_definition": "string",
  "created_by": "string",
  "": 42.0,
  "default_field_map": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "description": "string",
  "estimated_heap_memory_usage_bytes": 42.0,
  "estimated_operations": 42.0,
  "fully_defined": true,
  "inference_config": {
    "regression": {
      "results_field": "string",
      "num_top_feature_importance_values": 42.0
    },
    "classification": {
      "num_top_classes": 42.0,
      "num_top_feature_importance_values": 42.0,
      "prediction_field_type": "string",
      "results_field": "string",
      "top_classes_results_field": "string"
    },
    "text_classification": {
      "num_top_classes": 42.0,
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "classification_labels": [
        "string"
      ],
      "vocabulary": {
        "index": "string"
      }
    },
    "zero_shot_classification": {
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "hypothesis_template": "string",
      "classification_labels": [
        "string"
      ],
      "results_field": "string",
      "multi_label": true,
      "labels": [
        "string"
      ]
    },
    "fill_mask": {
      "mask_token": "string",
      "num_top_classes": 42.0,
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "vocabulary": {
        "index": "string"
      }
    },
    "learning_to_rank": {
      "default_params": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      },
      "feature_extractors": [
        {}
      ],
      "num_top_feature_importance_values": 42.0
    },
    "ner": {
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "classification_labels": [
        "string"
      ],
      "vocabulary": {
        "index": "string"
      }
    },
    "pass_through": {
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "vocabulary": {
        "index": "string"
      }
    },
    "text_embedding": {
      "embedding_size": 42.0,
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "vocabulary": {
        "index": "string"
      }
    },
    "text_expansion": {
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "vocabulary": {
        "index": "string"
      }
    },
    "question_answering": {
      "num_top_classes": 42.0,
      "tokenization": {
        "bert": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "bert_ja": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "mpnet": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        },
        "roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true,
          "add_prefix_space": true
        },
        "xlm_roberta": {
          "do_lower_case": true,
          "max_sequence_length": 42.0,
          "span": 42.0,
          "truncate": "first",
          "with_special_tokens": true
        }
      },
      "results_field": "string",
      "max_answer_length": 42.0
    }
  },
  "input": {
    "field_names": [
      "string"
    ]
  },
  "license_level": "string",
  "metadata": {
    "model_aliases": [
      "string"
    ],
    "feature_importance_baseline": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    },
    "hyperparameters": [
      {
        "absolute_importance": 42.0,
        "name": "string",
        "relative_importance": 42.0,
        "supplied": true,
        "value": 42.0
      }
    ],
    "total_feature_importance": [
      {
        "feature_name": "string",
        "importance": [
          {
            "mean_magnitude": 42.0,
            "max": 42.0,
            "min": 42.0
          }
        ],
        "classes": [
          {
            "class_name": "string",
            "importance": [
              {}
            ]
          }
        ]
      }
    ]
  },
  "model_package": {
    "": 42.0,
    "description": "string",
    "inference_config": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    },
    "metadata": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    },
    "minimum_version": "string",
    "model_repository": "string",
    "model_type": "string",
    "packaged_model_id": "string",
    "platform_architecture": "string",
    "prefix_strings": {
      "ingest": "string",
      "search": "string"
    },
    "sha256": "string",
    "tags": [
      "string"
    ],
    "vocabulary_file": "string"
  },
  "location": {
    "index": {
      "name": "string"
    }
  },
  "platform_architecture": "string",
  "prefix_strings": {
    "ingest": "string",
    "search": "string"
  }
}

Start a trained model deployment Added in 8.0.0

POST /_ml/trained_models/{model_id}/deployment/_start

Api key auth Basic auth Bearer auth

It allocates the model to every machine learning node.

Path parameters

model_id string Required

The unique identifier of the trained model. Currently, only PyTorch models are supported.

Query parameters

cache_size number | string

The inference cache size (in memory outside the JVM heap) per node for the model. The default value is the same size as the model_size_bytes. To disable the cache, 0b can be provided.
deployment_id string

A unique identifier for the deployment of the model.
number_of_allocations number

The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. If adaptive_allocations is enabled, do not set this value, because it’s automatically set.
priority string

The deployment priority.

Values are normal or low.
queue_capacity number

Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds this value, new requests are rejected with a 429 error.
threads_per_allocation number

Sets the number of threads used by each model allocation during inference. This generally increases the inference speed. The inference process is a compute-bound process; any number greater than the number of available hardware threads on the machine does not increase the inference speed. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads.
timeout string

Specifies the amount of time to wait for the model to deploy.
wait_for string

Specifies the allocation status to wait for before returning.

Values are started, starting, or fully_allocated.

application/json

Body

adaptive_allocations object
Hide adaptive_allocations attributes Show adaptive_allocations attributes object
- enabled boolean Required
  
  If true, adaptive_allocations is enabled
- min_number_of_allocations number
  
  Specifies the minimum number of allocations to scale to. If set, it must be greater than or equal to 0. If not defined, the deployment scales to 0.
- max_number_of_allocations number
  
  Specifies the maximum number of allocations to scale to. If set, it must be greater than or equal to min_number_of_allocations.

Responses

200 application/json
Hide response attribute Show response attribute object
- assignment object Required
  
  Hide assignment attributes Show assignment attributes object
  
  adaptive_allocations object | string | null
  
  One of:
  AdaptiveAllocationsSettings object string-2 string | null
  
  Hide attributes Show attributes
  
  enabled boolean Required
  
  If true, adaptive_allocations is enabled
  
  min_number_of_allocations number
  
  Specifies the minimum number of allocations to scale to. If set, it must be greater than or equal to 0. If not defined, the deployment scales to 0.
  
  max_number_of_allocations number
  
  Specifies the maximum number of allocations to scale to. If set, it must be greater than or equal to min_number_of_allocations.
  
  assignment_state string Required
  
  Values are started, starting, stopping, or failed.
  
  max_assigned_allocations number
  
  reason string
  
  routing_table object Required
  
  The allocation state for each node.
  
  Hide routing_table attribute Show routing_table attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  reason string
  
  The reason for the current state. It is usually populated only when the routing_state is failed.
  
  routing_state string Required
  
  Values are failed, started, starting, stopped, or stopping.
  
  current_allocations number Required
  
  Current number of allocations.
  
  target_allocations number Required
  
  Target number of allocations.
  
  start_time string | number Required
  
  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.
  
  One of:
  DateTime string UnitMillis number
  
  task_parameters object Required
  
  Hide task_parameters attributes Show task_parameters attributes object
  
  model_bytes number | string Required
  
  One of:
  ByteSize number ByteSize string
  
  model_id string Required
  
  deployment_id string Required
  
  cache_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  number_of_allocations number Required
  
  The total number of allocations this model is assigned across ML nodes.
  
  priority string Required
  
  Values are normal or low.
  
  per_deployment_memory_bytes number | string Required
  
  One of:
  ByteSize number ByteSize string
  
  per_allocation_memory_bytes number | string Required
  
  One of:
  ByteSize number ByteSize string
  
  queue_capacity number Required
  
  Number of inference requests are allowed in the queue at a time.
  
  threads_per_allocation number Required
  
  Number of threads per allocation.

POST /_ml/trained_models/{model_id}/deployment/_start

curl \
 --request POST 'http://api.example.com/_ml/trained_models/{model_id}/deployment/_start' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"adaptive_allocations":{"enabled":true,"min_number_of_allocations":42.0,"max_number_of_allocations":42.0}}'

Request examples

{
  "adaptive_allocations": {
    "enabled": true,
    "min_number_of_allocations": 42.0,
    "max_number_of_allocations": 42.0
  }
}

Response examples (200)

{
  "assignment": {
    "adaptive_allocations": {
      "enabled": true,
      "min_number_of_allocations": 42.0,
      "max_number_of_allocations": 42.0
    },
    "assignment_state": "started",
    "max_assigned_allocations": 42.0,
    "reason": "string",
    "routing_table": {
      "additionalProperty1": {
        "reason": "string",
        "routing_state": "failed",
        "current_allocations": 42.0,
        "target_allocations": 42.0
      },
      "additionalProperty2": {
        "reason": "string",
        "routing_state": "failed",
        "current_allocations": 42.0,
        "target_allocations": 42.0
      }
    },
    "": "string",
    "task_parameters": {
      "": 42.0,
      "model_id": "string",
      "deployment_id": "string",
      "number_of_allocations": 42.0,
      "priority": "normal",
      "queue_capacity": 42.0,
      "threads_per_allocation": 42.0
    }
  }
}

Run multiple templated searches Added in 5.0.0

GET /_msearch/template

Api key auth Basic auth Bearer auth

Run multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to preserve newlines. For example:

$ cat requests
{ "index": "my-index" }
{ "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }}
{ "index": "my-other-index" }
{ "id": "my-other-search-template", "params": { "query_type": "match_all" }}

$ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo

External documentation

Query parameters

ccs_minimize_roundtrips boolean

If true, network round-trips are minimized for cross-cluster search requests.
max_concurrent_searches number

The maximum number of concurrent searches the API can run.
search_type string

The type of the search operation.

Values are query_then_fetch or dfs_query_then_fetch.
rest_total_hits_as_int boolean

If true, the response returns hits.total as an integer. If false, it returns hits.total as an object.
typed_keys boolean

If true, the response prefixes aggregation and suggester names with their respective types.

application/json

Body object Required

allow_no_indices boolean
expand_wildcards string | array[string]
ignore_unavailable boolean
index string | array[string]
preference string
request_cache boolean
routing string
search_type string

Values are query_then_fetch or dfs_query_then_fetch.
ccs_minimize_roundtrips boolean
allow_partial_search_results boolean
ignore_throttled boolean

explain boolean

If true, returns detailed information about score calculation as part of each hit.
id string
params object

Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.
Hide params attribute Show params attribute object
- * object Additional properties
profile boolean

If true, the query execution is profiled.
source string | object

One of:
ScriptSource string ScriptSource object

Responses

200 application/json
Hide response attributes Show response attributes object
- took number Required
- responses array[object] Required
  
  One of:
  MultiSearchItem object ErrorResponseBase object
  
  Hide attributes Show attributes
  
  took number Required
  
  The number of milliseconds it took Elasticsearch to run the request. This value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response. It includes:
  
  Communication time between the coordinating node and data nodes
  
  Time the request spends in the search thread pool, queued for execution
  
  Actual run time
  
  It does not include:
  
  Time needed to send the request to Elasticsearch
  
  Time needed to serialize the JSON response
  
  Time needed to send the response to a client
  
  timed_out boolean Required
  
  If true, the request timed out before completion; returned results may be partial or empty.
  
  _shards object Required
  
  Hide _shards attributes Show _shards attributes object
  
  failed number Required
  
  successful number Required
  
  total number Required
  
  failures array[object]
  
  skipped number
  
  hits object Required
  
  Hide hits attributes Show hits attributes object
  
  total
  
  hits array[object] Required
  
  max_score
  
  aggregations object
  
  _clusters object
  
  Hide _clusters attributes Show _clusters attributes object
  
  skipped number Required
  
  successful number Required
  
  total number Required
  
  running number Required
  
  partial number Required
  
  failed number Required
  
  details object
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  max_score number
  
  num_reduce_phases number
  
  profile object
  
  Hide profile attribute Show profile attribute object
  
  shards array[object] Required
  
  pit_id string
  
  _scroll_id string
  
  suggest object
  
  Hide suggest attribute Show suggest attribute object
  
  * array[object] Additional properties
  
  terminated_early boolean
  
  status number
  
  Hide attributes Show attributes
  
  error object Required
  
  Hide error attributes Show error attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  status number Required

GET /_msearch/template

curl \
 --request GET 'http://api.example.com/_msearch/template' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{ }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}"'

Request example

Run `GET my-index/_msearch/template` to run multiple templated searches.

{ }
{ "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }}
{ }
{ "id": "my-other-search-template", "params": { "query_type": "match_all" }}

Response examples (200)

{
  "took": 42.0,
  "responses": [
    {
      "took": 42.0,
      "timed_out": true,
      "_shards": {
        "failed": 42.0,
        "successful": 42.0,
        "total": 42.0,
        "failures": [
          {}
        ],
        "skipped": 42.0
      },
      "hits": {
        "hits": [
          {}
        ]
      },
      "aggregations": {},
      "_clusters": {
        "skipped": 42.0,
        "successful": 42.0,
        "total": 42.0,
        "running": 42.0,
        "partial": 42.0,
        "failed": 42.0,
        "details": {}
      },
      "fields": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      },
      "max_score": 42.0,
      "num_reduce_phases": 42.0,
      "profile": {
        "shards": [
          {}
        ]
      },
      "pit_id": "string",
      "_scroll_id": "string",
      "suggest": {
        "additionalProperty1": [
          {}
        ],
        "additionalProperty2": [
          {}
        ]
      },
      "terminated_early": true,
      "status": 42.0
    }
  ]
}

epoch number | string

Get anomaly detection jobs Added in 7.7.0

data.input_bytes number | string

model.bytes number | string

model.bytes_exceeded number | string

Create or update a connector Beta

Set a connector sync job error Technical preview

Body Required

Activate the connector draft filter Technical preview

Create or update an index template Added in 7.9.0

Body Required

source string | object

lang string

routing_path string | array[string]

order string | array[string]

mode string | array[string]

missing string | array[string]

number_of_shards number | string

number_of_replicas number | string

routing_partition_size number | string

hidden boolean | string

auto_expand_replicas string | null

max_thread_count number | string

max_merge_count number | string

read_only boolean | string

read_only_allow_delete boolean | string

read boolean | string

write boolean | string

metadata boolean | string

max_token_count number | string

threshold_enabled boolean | string

indexing_complete boolean | string

prefer_ilm boolean | string

creation_date number | string

creation_date_string string | number

verified_before_close boolean | string

format string | number

flush_threshold_size number | string

size number | string

lenient boolean | string Required

priority number | string

end_time string | number

start_time string | number

limit number | string

ignore_dynamic_beyond_limit boolean | string

ignore_malformed boolean | string

type string Required

Get index statistics Added in 1.3.0

size number | string

memory_size number | string

memory_size number | string

doc_values_memory number | string

fixed_bit_set number | string

index_writer_memory number | string

memory number | string

norms_memory number | string

points_memory number | string

stored_memory number | string

terms_memory number | string

term_vectory_memory number | string

version_map_memory number | string

size number | string

reserved number | string

total_data_set_size number | string

total_size number | string

avg_size number | string

size number | string

memory_size number | string

memory_size number | string

doc_values_memory number | string

fixed_bit_set number | string

index_writer_memory number | string

memory number | string

norms_memory number | string

points_memory number | string

stored_memory number | string

terms_memory number | string

term_vectory_memory number | string

version_map_memory number | string

size number | string