Get role mappings | Elasticsearch API documentation (v9)

Get datafeeds Added in 7.7.0

GET /_cat/ml/datafeeds/{datafeed_id}

Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. 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 datafeed statistics API.

Path parameters

datafeed_id string Required

A numerical character string that uniquely identifies the datafeed.

Query parameters

allow_no_match boolean
Specifies what to do when the request:
- Contains wildcard expressions and there are no datafeeds 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 datafeeds 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.
h string | array[string]
Comma-separated list of column names to display.

Supported values include:
- ae (or assignment_explanation): For started datafeeds only, contains messages relating to the selection of a node.
- bc (or buckets.count, bucketsCount): The number of buckets processed.
- id: A numerical character string that uniquely identifies the datafeed.
- na (or node.address, nodeAddress): For started datafeeds only, the network address of the node where the datafeed is started.
- ne (or node.ephemeral_id, nodeEphemeralId): For started datafeeds only, the ephemeral ID of the node where the datafeed is started.
- ni (or node.id, nodeId): For started datafeeds only, the unique identifier of the node where the datafeed is started.
- nn (or node.name, nodeName): For started datafeeds only, the name of the node where the datafeed is started.
- sba (or search.bucket_avg, searchBucketAvg): The average search time per bucket, in milliseconds.
- sc (or search.count, searchCount): The number of searches run by the datafeed.
- seah (or search.exp_avg_hour, searchExpAvgHour): The exponential average search time per hour, in milliseconds.
- st (or search.time, searchTime): The total time the datafeed spent searching, in milliseconds.
- s (or state): The status of the datafeed: starting, started, stopping, or stopped. If starting, the datafeed has been requested to start but has not yet started. If started, the datafeed is actively receiving data. If stopping, the datafeed has been requested to stop gracefully and is completing its final action. If stopped, the datafeed is stopped and will not receive data until it is re-started.
s string | array[string]
Comma-separated list of column names or column aliases used to sort the response.

Supported values include:
- ae (or assignment_explanation): For started datafeeds only, contains messages relating to the selection of a node.
- bc (or buckets.count, bucketsCount): The number of buckets processed.
- id: A numerical character string that uniquely identifies the datafeed.
- na (or node.address, nodeAddress): For started datafeeds only, the network address of the node where the datafeed is started.
- ne (or node.ephemeral_id, nodeEphemeralId): For started datafeeds only, the ephemeral ID of the node where the datafeed is started.
- ni (or node.id, nodeId): For started datafeeds only, the unique identifier of the node where the datafeed is started.
- nn (or node.name, nodeName): For started datafeeds only, the name of the node where the datafeed is started.
- sba (or search.bucket_avg, searchBucketAvg): The average search time per bucket, in milliseconds.
- sc (or search.count, searchCount): The number of searches run by the datafeed.
- seah (or search.exp_avg_hour, searchExpAvgHour): The exponential average search time per hour, in milliseconds.
- st (or search.time, searchTime): The total time the datafeed spent searching, in milliseconds.
- s (or state): The status of the datafeed: starting, started, stopping, or stopped. If starting, the datafeed has been requested to start but has not yet started. If started, the datafeed is actively receiving data. If stopping, the datafeed has been requested to stop gracefully and is completing its final action. If stopped, the datafeed is stopped and will not receive data until it is re-started.
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
  
  The datafeed identifier.
- state string
  
  Values are started, stopped, starting, or stopping.
- assignment_explanation string
  
  For started datafeeds only, contains messages relating to the selection of a node.
- buckets.count string
  
  The number of buckets processed.
- search.count string
  
  The number of searches run by the datafeed.
- search.time string
  
  The total time the datafeed spent searching, in milliseconds.
- search.bucket_avg string
  
  The average search time per bucket, in milliseconds.
- search.exp_avg_hour string
  
  The exponential average search time per hour, in milliseconds.
- node.id string
  
  The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.name string
  
  The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.ephemeral_id string
  
  The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.address string
  
  The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

GET /_cat/ml/datafeeds/{datafeed_id}

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

Response examples (200)

A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.

[
  {
    "id": "datafeed-high_sum_total_sales",
    "state": "stopped",
    "buckets.count": "743",
    "search.count": "7"
  },
  {
    "id": "datafeed-low_request_rate",
    "state": "stopped",
    "buckets.count": "1457",
    "search.count": "3"
  },
  {
    "id": "datafeed-response_code_rates",
    "state": "stopped",
    "buckets.count": "1460",
    "search.count": "18"
  },
  {
    "id": "datafeed-url_scanning",
    "state": "stopped",
    "buckets.count": "1460",
    "search.count": "18"
  }
]

Get cluster repositories metering Technical preview

GET /_nodes/{node_id}/_repositories_metering

Api key auth Basic auth Bearer auth

Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.

Path parameters

node_id string | array[string] Required

Comma-separated list of node IDs or names used to limit returned information.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures 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]
  
  total number Required
  
  Total number of nodes selected by the request.
  
  successful number Required
  
  Number of nodes that responded successfully to the request.
  
  failed number Required
  
  Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
- cluster_name string Required
- nodes object Required
  
  Contains repositories metering information for the nodes selected by the request.
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  repository_name string Required
  
  repository_type string Required
  
  Repository type.
  
  repository_location object Required
  
  Hide repository_location attributes Show repository_location attributes object
  
  base_path string Required
  
  container string
  
  Container name (Azure)
  
  bucket string
  
  Bucket name (GCP, S3)
  
  repository_ephemeral_id string Required
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  archived boolean Required
  
  A flag that tells whether or not this object has been archived. When a repository is closed or updated the repository metering information is archived and kept for a certain period of time. This allows retrieving the repository metering information of previous repository instantiations.
  
  cluster_version number
  
  request_counts object Required
  
  Hide request_counts attributes Show request_counts attributes object
  
  GetBlobProperties number
  
  Number of Get Blob Properties requests (Azure)
  
  GetBlob number
  
  Number of Get Blob requests (Azure)
  
  ListBlobs number
  
  Number of List Blobs requests (Azure)
  
  PutBlob number
  
  Number of Put Blob requests (Azure)
  
  PutBlock number
  
  Number of Put Block (Azure)
  
  PutBlockList number
  
  Number of Put Block List requests
  
  GetObject number
  
  Number of get object requests (GCP, S3)
  
  ListObjects number
  
  Number of list objects requests (GCP, S3)
  
  InsertObject number
  
  Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads can perform multiple http requests to insert a single object but they are considered as a single request since they are billed as an individual operation. (GCP)
  
  PutObject number
  
  Number of PutObject requests (S3)
  
  PutMultipartObject number
  
  Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3)

GET /_nodes/{node_id}/_repositories_metering

curl \
 --request GET 'http://api.example.com/_nodes/{node_id}/_repositories_metering' \
 --header "Authorization: $API_KEY"

Get node information Added in 1.3.0

GET /_nodes

Api key auth Basic auth Bearer auth

By default, the API returns all attributes and core settings for cluster nodes.

Query parameters

flat_settings boolean

If true, returns settings in flat format.
timeout string

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

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures 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]
  
  total number Required
  
  Total number of nodes selected by the request.
  
  successful number Required
  
  Number of nodes that responded successfully to the request.
  
  failed number Required
  
  Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
- cluster_name string Required
- nodes object Required
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  attributes object Required
  
  Hide attributes attribute Show attributes attribute object
  
  * string Additional properties
  
  build_flavor string Required
  
  build_hash string Required
  
  Short hash of the last git commit in this release.
  
  build_type string Required
  
  host string Required
  
  http object
  
  Hide http attributes Show http attributes object
  
  bound_address array[string] Required
  
  max_content_length number | string
  
  One of:
  ByteSize number ByteSize string
  
  max_content_length_in_bytes number Required
  
  publish_address string Required
  
  ip string Required
  
  jvm object
  
  Hide jvm attributes Show jvm attributes object
  
  gc_collectors array[string] Required
  
  mem object Required
  
  Hide mem attributes Show mem attributes object
  
  direct_max
  
  direct_max_in_bytes number Required
  
  heap_init
  
  heap_init_in_bytes number Required
  
  heap_max
  
  heap_max_in_bytes number Required
  
  non_heap_init
  
  non_heap_init_in_bytes number Required
  
  non_heap_max
  
  non_heap_max_in_bytes number Required
  
  memory_pools array[string] Required
  
  pid number Required
  
  Time unit for milliseconds
  
  version string Required
  
  vm_name string Required
  
  vm_vendor string Required
  
  vm_version string Required
  
  using_bundled_jdk boolean Required
  
  using_compressed_ordinary_object_pointers boolean | string
  
  One of:
  boolean-1 boolean string-2 string
  
  input_arguments array[string] Required
  
  name string Required
  
  network object
  
  Hide network attributes Show network attributes object
  
  primary_interface object Required
  
  Hide primary_interface attributes Show primary_interface attributes object
  
  address string Required
  
  mac_address string Required
  
  name string Required
  
  refresh_interval number Required
  
  os object
  
  Hide os attributes Show os attributes object
  
  arch string Required
  
  Name of the JVM architecture (ex: amd64, x86)
  
  available_processors number Required
  
  Number of processors available to the Java virtual machine
  
  allocated_processors number
  
  The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS.
  
  name string Required
  
  pretty_name string Required
  
  Time unit for milliseconds
  
  version string Required
  
  cpu object
  
  Hide cpu attributes Show cpu attributes object
  
  cache_size string Required
  
  cache_size_in_bytes number Required
  
  cores_per_socket number Required
  
  mhz number Required
  
  model string Required
  
  total_cores number Required
  
  total_sockets number Required
  
  vendor string Required
  
  mem object
  
  Hide mem attributes Show mem attributes object
  
  total string Required
  
  total_in_bytes number Required
  
  swap object
  
  Hide swap attributes Show swap attributes object
  
  total string Required
  
  total_in_bytes number Required
  
  plugins array[object]
  
  Hide plugins attributes Show plugins attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  process object
  
  Hide process attributes Show process attributes object
  
  id number Required
  
  Process identifier (PID)
  
  mlockall boolean Required
  
  Indicates if the process address space has been successfully locked in memory
  
  Time unit for milliseconds
  
  roles array[string] Required
  
  @doc_id node-roles
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  settings object
  
  Hide settings attributes Show settings attributes object
  
  cluster object Required
  
  Hide cluster attributes Show cluster attributes object
  
  name string Required
  
  routing object
  
  election object Required
  
  initial_master_nodes array[string]
  
  deprecation_indexing object
  
  node object Required
  
  Hide node attributes Show node attributes object
  
  name string Required
  
  attr object Required
  
  max_local_storage_nodes string
  
  path object
  
  Hide path attributes Show path attributes object
  
  logs string
  
  home string
  
  repo array[string]
  
  data
  
  repositories object
  
  Hide repositories attribute Show repositories attribute object
  
  url object Required
  
  discovery object
  
  Hide discovery attributes Show discovery attributes object
  
  seed_hosts array[string]
  
  type string
  
  seed_providers array[string]
  
  action object
  
  Hide action attribute Show action attribute object
  
  destructive_requires_name string Required
  
  client object
  
  Hide client attribute Show client attribute object
  
  type string Required
  
  http object Required
  
  Hide http attributes Show http attributes object
  
  type object Required
  
  type.default string
  
  compression
  
  port
  
  bootstrap object
  
  Hide bootstrap attribute Show bootstrap attribute object
  
  memory_lock string Required
  
  transport object Required
  
  Hide transport attributes Show transport attributes object
  
  type object Required
  
  type.default string
  
  features object
  
  network object
  
  Hide network attribute Show network attribute object
  
  host
  
  xpack object
  
  Hide xpack attributes Show xpack attributes object
  
  license object
  
  security object Required
  
  notification object
  
  ml object
  
  script object
  
  Hide script attributes Show script attributes object
  
  allowed_types string Required
  
  disable_max_compilations_rate string
  
  search object
  
  Hide search attribute Show search attribute object
  
  remote object Required
  
  ingest object
  
  Hide ingest attributes Show ingest attributes object
  
  attachment object
  
  append object
  
  csv object
  
  convert object
  
  date object
  
  date_index_name object
  
  dot_expander object
  
  enrich object
  
  fail object
  
  foreach object
  
  json object
  
  user_agent object
  
  kv object
  
  geoip object
  
  grok object
  
  gsub object
  
  join object
  
  lowercase object
  
  remove object
  
  rename object
  
  script object
  
  set object
  
  sort object
  
  split object
  
  trim object
  
  uppercase object
  
  urldecode object
  
  bytes object
  
  dissect object
  
  set_security_user object
  
  pipeline object
  
  drop object
  
  circle object
  
  inference object
  
  thread_pool object
  
  Hide thread_pool attribute Show thread_pool attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  core number
  
  keep_alive 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 number
  
  queue_size number Required
  
  size number
  
  type string Required
  
  total_indexing_buffer number
  
  Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.
  
  total_indexing_buffer_in_bytes number | string
  
  One of:
  ByteSize number ByteSize string
  
  transport object
  
  Hide transport attributes Show transport attributes object
  
  bound_address array[string] Required
  
  publish_address string Required
  
  profiles object Required
  
  Hide profiles attribute Show profiles attribute object
  
  * string Additional properties
  
  transport_address string Required
  
  version string Required
  
  modules array[object]
  
  Hide modules attributes Show modules attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  ingest object
  
  Hide ingest attribute Show ingest attribute object
  
  processors array[object] Required
  
  aggregations object
  
  Hide aggregations attribute Show aggregations attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  types array[string] Required

GET /_nodes

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

Response examples (200)

An abbreviated response when requesting cluster nodes information.

{
    "_nodes": {},
    "cluster_name": "elasticsearch",
    "nodes": {
      "USpTGYaBSIKbgSUJR2Z9lg": {
        "name": "node-0",
        "transport_address": "192.168.17:9300",
        "host": "node-0.elastic.co",
        "ip": "192.168.17",
        "version": "{version}",
        "transport_version": 100000298,
        "index_version": 100000074,
        "component_versions": {
          "ml_config_version": 100000162,
          "transform_config_version": 100000096
        },
        "build_flavor": "default",
        "build_type": "{build_type}",
        "build_hash": "587409e",
        "roles": [
          "master",
          "data",
          "ingest"
        ],
        "attributes": {},
        "plugins": [
          {
            "name": "analysis-icu",
            "version": "{version}",
            "description": "The ICU Analysis plugin integrates Lucene ICU
  module into elasticsearch, adding ICU relates analysis components.",
            "classname":
  "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin",
            "has_native_controller": false
          }
        ],
        "modules": [
          {
            "name": "lang-painless",
            "version": "{version}",
            "description": "An easy, safe and fast scripting language for
  Elasticsearch",
            "classname": "org.elasticsearch.painless.PainlessPlugin",
            "has_native_controller": false
          }
        ]
      }
    }
}

Get data stream stats Added in 7.9.0

GET /_data_stream/{name}/_stats

Api key auth Basic auth Bearer auth

Get statistics for one or more data streams.

Path parameters

name string Required

Comma-separated list of data streams used to limit the request. Wildcard expressions (*) are supported. To target all data streams in a cluster, omit this parameter or use *.

Query parameters

expand_wildcards string | array[string]
Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

Supported values include:
- all: Match any data stream or index, including hidden ones.
- open: Match open, non-hidden indices. Also matches any non-hidden data stream.
- closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
- hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.

Responses

200 application/json
Hide response attributes Show response attributes object
- _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
- backing_indices number Required
  
  Total number of backing indices for the selected data streams.
- data_stream_count number Required
  
  Total number of selected data streams.
- data_streams array[object] Required
  
  Contains statistics for the selected data streams.
  
  Hide data_streams attributes Show data_streams attributes object
  
  backing_indices number Required
  
  Current number of backing indices for the data stream.
  
  data_stream string Required
  
  maximum_timestamp number
  
  Time unit for milliseconds
  
  store_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  store_size_bytes number Required
  
  Total size, in bytes, of all shards for the data stream’s backing indices.
- total_store_sizes number | string
  
  One of:
  ByteSize number ByteSize string
- total_store_size_bytes number Required
  
  Total size, in bytes, of all shards for the selected data streams.

GET /_data_stream/{name}/_stats

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

Response examples (200)

A successful response for retrieving statistics for a data stream.

{
  "_shards": {
    "total": 10,
    "successful": 5,
    "failed": 0
  },
  "data_stream_count": 2,
  "backing_indices": 5,
  "total_store_size": "7kb",
  "total_store_size_bytes": 7268,
  "data_streams": [
    {
      "data_stream": "my-data-stream",
      "backing_indices": 3,
      "store_size": "3.7kb",
      "store_size_bytes": 3772,
      "maximum_timestamp": 1607512028000
    },
    {
      "data_stream": "my-data-stream-two",
      "backing_indices": 2,
      "store_size": "3.4kb",
      "store_size_bytes": 3496,
      "maximum_timestamp": 1607425567000
    }
  ]
}

Get tokens from text analysis

POST /{index}/_analyze

Api key auth Basic auth Bearer auth

The analyze API performs analysis on a text string and returns the resulting tokens.

Generating excessive amount of tokens may cause a node to run out of memory. The index.analyze.max_token_count setting enables you to limit the number of tokens that can be produced. If more than this limit of tokens gets generated, an error occurs. The _analyze endpoint without a specified index will always use 10000 as its limit.

External documentation

Path parameters

index string Required

Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.

Query parameters

index string

Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.

application/json

Body

analyzer string

The name of the analyzer that should be applied to the provided text. This could be a built-in analyzer, or an analyzer that’s been configured in the index.
attributes array[string]

Array of token attributes used to filter the output of the explain parameter.
char_filter array

Array of character filters used to preprocess characters before the tokenizer.

External documentation
explain boolean

If true, the response includes token attributes and additional details.
field string

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
filter array

Array of token filters used to apply after the tokenizer.

External documentation
normalizer string

Normalizer to use to convert text into a single token.
text string | array[string]

One of:
TextToAnalyze string TextToAnalyze array[string]

Responses

200 application/json
Hide response attributes Show response attributes object
- detail object
  
  Hide detail attributes Show detail attributes object
  
  analyzer object
  
  Hide analyzer attributes Show analyzer attributes object
  
  name string Required
  
  tokens array[object] Required
  
  Hide tokens attributes Show tokens attributes object
  
  bytes string Required
  
  end_offset number Required
  
  keyword boolean
  
  position number Required
  
  positionLength number Required
  
  start_offset number Required
  
  termFrequency number Required
  
  token string Required
  
  type string Required
  
  charfilters array[object]
  
  Hide charfilters attributes Show charfilters attributes object
  
  filtered_text array[string] Required
  
  name string Required
  
  custom_analyzer boolean Required
  
  tokenfilters array[object]
  
  Hide tokenfilters attributes Show tokenfilters attributes object
  
  name string Required
  
  tokens array[object] Required
  
  Hide tokens attributes Show tokens attributes object
  
  bytes string Required
  
  end_offset number Required
  
  keyword boolean
  
  position number Required
  
  positionLength number Required
  
  start_offset number Required
  
  termFrequency number Required
  
  token string Required
  
  type string Required
  
  tokenizer object
  
  Hide tokenizer attributes Show tokenizer attributes object
  
  name string Required
  
  tokens array[object] Required
  
  Hide tokens attributes Show tokens attributes object
  
  bytes string Required
  
  end_offset number Required
  
  keyword boolean
  
  position number Required
  
  positionLength number Required
  
  start_offset number Required
  
  termFrequency number Required
  
  token string Required
  
  type string Required
- tokens array[object]
  
  Hide tokens attributes Show tokens attributes object
  
  end_offset number Required
  
  position number Required
  
  positionLength number
  
  start_offset number Required
  
  token string Required
  
  type string Required

POST /{index}/_analyze

curl \
 --request POST 'http://api.example.com/{index}/_analyze' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"analyzer\": \"standard\",\n  \"text\": \"this is a test\"\n}"'

Request examples

You can apply any of the built-in analyzers to the text string without specifying an index.

{
  "analyzer": "standard",
  "text": "this is a test"
}

If the text parameter is provided as array of strings, it is analyzed as a multi-value field.

{
  "analyzer": "standard",
  "text": [
    "this is a test",
    "the second text"
  ]
}

You can test a custom transient analyzer built from tokenizers, token filters, and char filters. Token filters use the filter parameter.

{
  "tokenizer": "keyword",
  "filter": [
    "lowercase"
  ],
  "char_filter": [
    "html_strip"
  ],
  "text": "this is a <b>test</b>"
}

Custom tokenizers, token filters, and character filters can be specified in the request body.

{
  "tokenizer": "whitespace",
  "filter": [
    "lowercase",
    {
      "type": "stop",
      "stopwords": [
        "a",
        "is",
        "this"
      ]
    }
  ],
  "text": "this is a test"
}

Run `GET /analyze_sample/_analyze` to run an analysis on the text using the default index analyzer associated with the `analyze_sample` index. Alternatively, the analyzer can be derived based on a field mapping.

{
  "field": "obj1.field1",
  "text": "this is a test"
}

Run `GET /analyze_sample/_analyze` and supply a normalizer for a keyword field if there is a normalizer associated with the specified index.

{
  "normalizer": "my_normalizer",
  "text": "BaR"
}

If you want to get more advanced details, set `explain` to `true`. It will output all token attributes for each token. You can filter token attributes you want to output by setting the `attributes` option. NOTE: The format of the additional detail information is labelled as experimental in Lucene and it may change in the future.

{
  "tokenizer": "standard",
  "filter": [
    "snowball"
  ],
  "text": "detailed output",
  "explain": true,
  "attributes": [
    "keyword"
  ]
}

Response examples (200)

A successful response for an analysis with `explain` set to `true`.

{
  "detail": {
    "custom_analyzer": true,
    "charfilters": [],
    "tokenizer": {
      "name": "standard",
      "tokens": [
        {
          "token": "detailed",
          "start_offset": 0,
          "end_offset": 8,
          "type": "<ALPHANUM>",
          "position": 0
        },
        {
          "token": "output",
          "start_offset": 9,
          "end_offset": 15,
          "type": "<ALPHANUM>",
          "position": 1
        }
      ]
    },
    "tokenfilters": [
      {
        "name": "snowball",
        "tokens": [
          {
            "token": "detail",
            "start_offset": 0,
            "end_offset": 8,
            "type": "<ALPHANUM>",
            "position": 0,
            "keyword": false
          },
          {
            "token": "output",
            "start_offset": 9,
            "end_offset": 15,
            "type": "<ALPHANUM>",
            "position": 1,
            "keyword": false
          }
        ]
      }
    ]
  }
}

Delete an alias

DELETE /{index}/_aliases/{name}

Api key auth Basic auth Bearer auth

Removes a data stream or index from an alias.

Path parameters

index string | array[string] Required

Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*).
name string | array[string] Required

Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all.

Query parameters

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.
timeout string

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

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.

DELETE /{index}/_aliases/{name}

curl \
 --request DELETE 'http://api.example.com/{index}/_aliases/{name}' \
 --header "Authorization: $API_KEY"

Delete a legacy index template Deprecated

DELETE /_template/{name}

Api key auth Basic auth Bearer auth

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

Path parameters

name string Required

The name of the legacy index template to delete. Wildcard (*) expressions are supported.

Query parameters

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.
timeout string

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

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.

DELETE /_template/{name}

curl \
 --request DELETE 'http://api.example.com/_template/{name}' \
 --header "Authorization: $API_KEY"

Resolve the cluster Added in 8.13.0

GET /_resolve/cluster/{name}

Api key auth Basic auth Bearer auth

Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.

This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.

You use the same index expression with this endpoint as you would for cross-cluster search. Index and cluster exclusions are also supported with this endpoint.

For each cluster in the index expression, information is returned about:

Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the remote/info endpoint.
Whether each remote cluster is configured with skip_unavailable as true or false.
Whether there are any indices, aliases, or data streams on that cluster that match the index expression.
Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).
Cluster version information, including the Elasticsearch server version.

For example, GET /_resolve/cluster/my-index-*,cluster*:my-index-* returns information about the local cluster and all remotely configured clusters that start with the alias cluster*. Each cluster returns information about whether it has any indices, aliases or data streams that match my-index-*.

Note on backwards compatibility

The ability to query without an index expression was added in version 8.18, so when querying remote clusters older than that, the local cluster will send the index expression dummy* to those remote clusters. Thus, if an errors occur, you may see a reference to that index expression even though you didn't request it. If it causes a problem, you can instead include an index expression like *:* to bypass the issue.

Advantages of using this endpoint before a cross-cluster search

You may want to exclude a cluster or index from a search when:

A remote cluster is not currently connected and is configured with skip_unavailable=false. Running a cross-cluster search under those conditions will cause the entire search to fail.
A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is logs*,remote1:logs* and the remote1 cluster has no indices, aliases or data streams that match logs*. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the _resolve/cluster response will be present. (This is also where security/permission errors will be shown.)
A remote cluster is an older version that does not support the feature you want to use in your search.

Test availability of remote clusters

The remote/info endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not. The remote cluster may be available, while the local cluster is not currently connected to it.

You can use the _resolve/cluster API to attempt to reconnect to remote clusters. For example with GET _resolve/cluster or GET _resolve/cluster/*:*. The connected field in the response will indicate whether it was successful. If a connection was (re-)established, this will also cause the remote/info endpoint to now indicate a connected status.

Path parameters

name string | array[string] Required

A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax. Index and cluster exclusions (e.g., -cluster1:*) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching

Query parameters

allow_no_indices boolean

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.
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. Valid values are: all, open, closed, hidden, none. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

Supported values include:
- all: Match any data stream or index, including hidden ones.
- open: Match open, non-hidden indices. Also matches any non-hidden data stream.
- closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
- hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.
ignore_throttled boolean Deprecated

If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.
ignore_unavailable boolean

If false, the request returns an error if it targets a missing or closed index. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.
timeout string

The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out.

The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds).

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attributes Show * attributes object
  
  connected boolean Required
  
  Whether the remote cluster is connected to the local (querying) cluster.
  
  skip_unavailable boolean Required
  
  The skip_unavailable setting for a remote cluster.
  
  matching_indices boolean
  
  Whether the index expression provided in the request matches any indices, aliases or data streams on the cluster.
  
  error string
  
  Provides error messages that are likely to occur if you do a search with this index expression on the specified cluster (for example, lack of security privileges to query an index).
  
  version object
  
  Hide version attributes Show version attributes object
  
  build_flavor string Required
  
  minimum_index_compatibility_version string Required
  
  minimum_wire_compatibility_version string Required
  
  number string Required

GET /_resolve/cluster/{name}

curl \
 --request GET 'http://api.example.com/_resolve/cluster/{name}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_resolve/cluster/my-index*,clust*:my-index*`. Each cluster has its own response section. The cluster you sent the request to is labelled as "(local)".

{
  "(local)": {
    "connected": true,
    "skip_unavailable": false,
    "matching_indices": true,
    "version": {
      "number": "8.13.0",
      "build_flavor": "default",
      "minimum_wire_compatibility_version": "7.17.0",
      "minimum_index_compatibility_version": "7.0.0"
    }
  },
  "cluster_one": {
    "connected": true,
    "skip_unavailable": true,
    "matching_indices": true,
    "version": {
      "number": "8.13.0",
      "build_flavor": "default",
      "minimum_wire_compatibility_version": "7.17.0",
      "minimum_index_compatibility_version": "7.0.0"
    }
  },
  "cluster_two": {
    "connected": true,
    "skip_unavailable": false,
    "matching_indices": true,
    "version": {
      "number": "8.13.0",
      "build_flavor": "default",
      "minimum_wire_compatibility_version": "7.17.0",
      "minimum_index_compatibility_version": "7.0.0"
    }
  }
}

A successful response from `GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s`. This type of request can be used to identify potential problems with your cross-cluster search. Note also that a `timeout` of 5 seconds is sent, which sets the maximum time the query will wait for remote clusters to respond. The local cluster has no index called `not_present`. Searching with `ignore_unavailable=false` would return a "no such index" error. The `cluster_one` remote cluster has no indices that match the pattern `my-index*`. There may be no indices that match the pattern or the index could be closed. The `cluster_two` remote cluster is not connected (the attempt to connect failed). Since this cluster is marked as `skip_unavailable=false`, you should probably exclude this cluster from the search by adding `-cluster_two:*` to the search index expression. For `cluster_three`, the error message indicates that this remote cluster did not respond within the 5-second timeout window specified, so it is also marked as not connected. The `oldcluster` remote cluster shows that it has matching indices, but no version information is included. This indicates that the cluster version predates the introduction of the `_resolve/cluster` API, so you may want to exclude it from your cross-cluster search.

{
  "(local)": {
    "connected": true,
    "skip_unavailable": false,
    "error": "no such index [not_present]"
  },
  "cluster_one": {
    "connected": true,
    "skip_unavailable": true,
    "matching_indices": false,
    "version": {
      "number": "8.13.0",
      "build_flavor": "default",
      "minimum_wire_compatibility_version": "7.17.0",
      "minimum_index_compatibility_version": "7.0.0"
    }
  },
  "cluster_two": {
    "connected": false,
    "skip_unavailable": false
  },
  "cluster_three": {
    "connected": false,
    "skip_unavailable": false,
    "error": "Request timed out before receiving a response from the remote cluster"
  },
  "oldcluster": {
    "connected": true,
    "skip_unavailable": false,
    "matching_indices": true
  }
}

Roll over to a new index Added in 5.0.0

POST /{alias}/_rollover/{new_index}

Api key auth Basic auth Bearer auth

TIP: It is recommended to use the index lifecycle rollover action to automate rollovers.

The rollover API creates a new index for a data stream or index alias. The API behavior depends on the rollover target.

Roll over a data stream

If you roll over a data stream, the API creates a new write index for the stream. The stream's previous write index becomes a regular backing index. A rollover also increments the data stream's generation.

Roll over an index alias with a write index

TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.

If an index alias points to multiple indices, one of the indices must be a write index. The rollover API creates a new write index for the alias with is_write_index set to true. The API also sets is_write_index to false for the previous write index.

Roll over an index alias with one index

If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.

NOTE: A rollover creates a new index and is subject to the wait_for_active_shards setting.

Increment index names for an alias

When you roll over an index alias, you can specify a name for the new index. If you don't specify a name and the current index ends with - and a number, such as my-index-000001 or my-index-3, the new index name increments that number. For example, if you roll over an alias with a current index of my-index-000001, the rollover creates a new index named my-index-000002. This number is always six characters and zero-padded, regardless of the previous index's name.

If you use an index alias for time series data, you can use date math in the index name to track the rollover date. For example, you can create an alias that points to an index named <my-index-{now/d}-000001>. If you create the index on May 6, 2099, the index's name is my-index-2099.05.06-000001. If you roll over the alias on May 7, 2099, the new index's name is my-index-2099.05.07-000002.

Path parameters

alias string Required

Name of the data stream or index alias to roll over.
new_index string Required

Name of the index to create. Supports date math. Data streams do not support this parameter.

Query parameters

dry_run boolean

If true, checks whether the current index satisfies the specified conditions but does not perform a rollover.
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.
timeout string

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
wait_for_active_shards number | string

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).
lazy boolean

If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.

application/json

Body

aliases object

Aliases for the target index. Data streams do not support this parameter.
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
conditions object
Hide conditions attributes Show conditions attributes object
- min_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.
- max_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.
- max_age_millis number
  
  Time unit for milliseconds
- min_docs number
- max_docs number
- max_size number | string
  
  One of:
  ByteSize number ByteSize string
- max_size_bytes number
- min_size number | string
  
  One of:
  ByteSize number ByteSize string
- min_size_bytes number
- max_primary_shard_size number | string
  
  One of:
  ByteSize number ByteSize string
- max_primary_shard_size_bytes number
- min_primary_shard_size number | string
  
  One of:
  ByteSize number ByteSize string
- min_primary_shard_size_bytes number
- max_primary_shard_docs number
- min_primary_shard_docs number
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 SearchRequestBody object
  
  Hide attributes Show attributes
  
  aggregations object
  
  Defines the aggregations that are run as part of the search request.
  
  collapse object
  
  explain boolean
  
  If true, the request returns detailed information about score computation as part of a hit.
  
  ext object
  
  Configuration of search extensions defined by Elasticsearch plugins.
  
  from number
  
  The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
  
  highlight
  
  track_total_hits boolean | number
  
  Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.
  
  indices_boost array[object]
  
  Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.
  
  docvalue_fields array[object]
  
  An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
  
  knn
  
  rank object
  
  min_score number
  
  The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.
  
  post_filter object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  profile boolean
  
  Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
  
  query object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  rescore
  
  retriever object
  
  script_fields object
  
  Retrieve a script evaluation (based on different fields) for each hit.
  
  search_after array[number | string | boolean | null]
  
  A field value.
  
  size number
  
  The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.
  
  slice object
  
  sort
  
  _source
  
  fields array[object]
  
  An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
  
  suggest object
  
  terminate_after number
  
  The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.
  
  IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
  
  If set to 0 (default), the query does not terminate early.
  
  timeout string
  
  The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
  
  track_scores boolean
  
  If true, calculate and return document scores, even if the scores are not used for sorting.
  
  version boolean
  
  If true, the request returns the document version as part of a hit.
  
  seq_no_primary_term boolean
  
  If true, the request returns sequence number and primary term of the last modification of each hit.
  
  stored_fields string | array[string]
  
  pit object
  
  runtime_mappings object
  
  stats array[string]
  
  The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.
  
  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 or false.
- _data_stream_timestamp object
  Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object
  
  enabled boolean Required
settings object

Configuration options for the index. Data streams do not support this parameter.
Hide settings attribute Show settings attribute object
- * object Additional properties

Responses

200 application/json
Hide response attributes Show response attributes object
- acknowledged boolean Required
- conditions object Required
  
  Hide conditions attribute Show conditions attribute object
  
  * boolean Additional properties
- dry_run boolean Required
- new_index string Required
- old_index string Required
- rolled_over boolean Required
- shards_acknowledged boolean Required

POST /{alias}/_rollover/{new_index}

curl \
 --request POST 'http://api.example.com/{alias}/_rollover/{new_index}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"conditions\": {\n    \"max_age\": \"7d\",\n    \"max_docs\": 1000,\n    \"max_primary_shard_size\": \"50gb\",\n    \"max_primary_shard_docs\": \"2000\"\n  }\n}"'

Request example

{
  "conditions": {
    "max_age": "7d",
    "max_docs": 1000,
    "max_primary_shard_size": "50gb",
    "max_primary_shard_docs": "2000"
  }
}

Response examples (200)

An abbreviated response from `GET /_segments`.

{
  "_shards": {},
  "indices": {
    "test": {
      "shards": {
        "0": [
          {
            "routing": {
              "state": "STARTED",
              "primary": true,
              "node": "zDC_RorJQCao9xf9pg3Fvw"
            },
            "num_committed_segments": 0,
            "num_search_segments": 1,
            "segments": {
              "_0": {
                "generation": 0,
                "num_docs": 1,
                "deleted_docs": 0,
                "size_in_bytes": 3800,
                "committed": false,
                "search": true,
                "version": "7.0.0",
                "compound": true,
                "attributes": {}
              }
            }
          }
        ]
      }
    }
  }
}

Create or update an alias Added in 1.3.0

POST /_aliases

Api key auth Basic auth Bearer auth

Adds a data stream or index to an alias.

Query parameters

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.
timeout string

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

application/json

Body Required

actions array[object]

Actions to perform.
Hide actions attributes Show actions attributes object
- add object
  Hide add attributes Show add attributes object
  
  alias string
  
  aliases string | array[string]
  
  Aliases for the action. Index alias names support date math.
  
  One of:
  IndexAlias string array-2 array[string]
  
  filter object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  index string
  
  indices string | array[string]
  
  index_routing string
  
  is_hidden boolean
  
  If true, the alias is hidden.
  
  is_write_index boolean
  
  If true, sets the write index or data stream for the alias.
  
  routing string
  
  search_routing string
  
  must_exist boolean
  
  If true, the alias must exist to perform the action.
- remove object
  Hide remove attributes Show remove attributes object
  
  alias string
  
  aliases string | array[string]
  
  Aliases for the action. Index alias names support date math.
  
  One of:
  IndexAlias string array-2 array[string]
  
  index string
  
  indices string | array[string]
  
  must_exist boolean
  
  If true, the alias must exist to perform the action.
- remove_index object
  Hide remove_index attributes Show remove_index attributes object
  
  index string
  
  indices string | array[string]
  
  must_exist boolean
  
  If true, the alias must exist to perform the action.

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 /_aliases

curl \
 --request POST 'http://api.example.com/_aliases' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"actions":[{"add":{"alias":"string","aliases":"string","filter":{},"index":"string","indices":"string","index_routing":"string","is_hidden":true,"is_write_index":true,"routing":"string","search_routing":"string","must_exist":true},"remove":{"alias":"string","aliases":"string","index":"string","indices":"string","must_exist":true},"remove_index":{"index":"string","indices":"string","must_exist":true}}]}'

Get lifecycle policies Added in 6.6.0

GET /_ilm/policy

Api key auth Basic auth Bearer auth

Query parameters

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.
timeout string

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

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attributes Show * attributes object
  
  modified_date 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
  
  policy object Required
  
  Hide policy attributes Show policy attributes object
  
  phases object Required
  
  Hide phases attributes Show phases attributes object
  
  cold object
  
  Hide cold attributes Show cold attributes object
  
  actions object
  
  Hide actions attributes Show actions attributes object
  
  allocate object
  
  delete object
  
  downsample object
  
  freeze object
  
  forcemerge object
  
  migrate object
  
  readonly object
  
  rollover object
  
  set_priority object
  
  searchable_snapshot object
  
  shrink object
  
  unfollow object
  
  wait_for_snapshot object
  
  min_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.
  
  delete object
  
  Hide delete attributes Show delete attributes object
  
  actions object
  
  Hide actions attributes Show actions attributes object
  
  allocate object
  
  delete object
  
  downsample object
  
  freeze object
  
  forcemerge object
  
  migrate object
  
  readonly object
  
  rollover object
  
  set_priority object
  
  searchable_snapshot object
  
  shrink object
  
  unfollow object
  
  wait_for_snapshot object
  
  min_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.
  
  frozen object
  
  Hide frozen attributes Show frozen attributes object
  
  actions object
  
  Hide actions attributes Show actions attributes object
  
  allocate object
  
  delete object
  
  downsample object
  
  freeze object
  
  forcemerge object
  
  migrate object
  
  readonly object
  
  rollover object
  
  set_priority object
  
  searchable_snapshot object
  
  shrink object
  
  unfollow object
  
  wait_for_snapshot object
  
  min_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.
  
  hot object
  
  Hide hot attributes Show hot attributes object
  
  actions object
  
  Hide actions attributes Show actions attributes object
  
  allocate object
  
  delete object
  
  downsample object
  
  freeze object
  
  forcemerge object
  
  migrate object
  
  readonly object
  
  rollover object
  
  set_priority object
  
  searchable_snapshot object
  
  shrink object
  
  unfollow object
  
  wait_for_snapshot object
  
  min_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.
  
  warm object
  
  Hide warm attributes Show warm attributes object
  
  actions object
  
  Hide actions attributes Show actions attributes object
  
  allocate object
  
  delete object
  
  downsample object
  
  freeze object
  
  forcemerge object
  
  migrate object
  
  readonly object
  
  rollover object
  
  set_priority object
  
  searchable_snapshot object
  
  shrink object
  
  unfollow object
  
  wait_for_snapshot object
  
  min_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.
  
  _meta object
  
  Hide _meta attribute Show _meta attribute object
  
  * object Additional properties
  
  version number Required

GET /_ilm/policy

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

Response examples (200)

A successful response when retrieving a lifecycle policy.

{
  "my_policy": {
    "version": 1,
    "modified_date": 82392349,
    "policy": {
      "phases": {
        "warm": {
          "min_age": "10d",
          "actions": {
            "forcemerge": {
              "max_num_segments": 1
            }
          }
        },
        "delete": {
          "min_age": "30d",
          "actions": {
            "delete": {
              "delete_searchable_snapshot": true
            }
          }
        }
      }
    },
    "in_use_by" : {
      "indices" : [],
      "data_streams" : [],
      "composable_templates" : []
    }
  }
}

Stop the ILM plugin Added in 6.6.0

POST /_ilm/stop

Api key auth Basic auth Bearer auth

Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.

The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the get ILM status API to check whether ILM is running.

Query parameters

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.
timeout string

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

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 /_ilm/stop

curl \
 --request POST 'http://api.example.com/_ilm/stop' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response when stopping the ILM plugin.

{
  "acknowledged": true
}

Get pipelines Added in 5.0.0

GET /_ingest/pipeline/{id}

Api key auth Basic auth Bearer auth

Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.

External documentation

Path parameters

id string Required

Comma-separated list of pipeline IDs to retrieve. Wildcard (*) expressions are supported. To get all ingest pipelines, omit this parameter or use *.

Query parameters

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.
summary boolean

Return pipelines without their definitions (default: false)

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
 
 Hide * attributes Show * attributes object
 
 description string
 
 Description of the ingest pipeline.
 
 on_failure array[object]
 
 Processors to run immediately after a processor failure.
 
 Hide on_failure attributes Show on_failure attributes object
 
 append object
 
 Hide append attributes Show append attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 value
 
 allow_duplicates boolean
 
 If false, the processor does not append values already present in the field.
 
 attachment object
 
 Hide attachment attributes Show attachment attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 indexed_chars number
 
 The number of chars being used for extraction to prevent huge fields. Use -1 for no limit.
 
 indexed_chars_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 properties array[string]
 
 Array of properties to select to be stored. Can be content, title, name, author, keywords, date, content_type, content_length, language.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 remove_binary boolean
 
 If true, the binary field will be removed from the document
 
 resource_name string
 
 Field containing the name of the resource to decode. If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.
 
 bytes object
 
 Hide bytes attributes Show bytes attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 circle object
 
 Hide circle attributes Show circle attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 error_distance number Required
 
 The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape).
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 shape_type string Required
 
 Values are geo_shape or shape.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 community_id object
 
 Hide community_id attributes Show community_id attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 source_ip string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 source_port string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 destination_ip string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 destination_port string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 iana_number string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 icmp_type string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 icmp_code string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 transport 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.
 
 seed number
 
 Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
 
 ignore_missing boolean
 
 If true and any required fields are missing, the processor quietly exits without modifying the document.
 
 convert object
 
 Hide convert attributes Show convert attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 type string Required
 
 Values are integer, long, double, float, boolean, ip, string, or auto.
 
 csv object
 
 Hide csv attributes Show csv attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 empty_value object
 
 Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes ("").
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 quote string
 
 Quote used in CSV, has to be single character string.
 
 separator string
 
 Separator used in CSV, has to be single character string.
 
 target_fields string | array[string] Required
 
 trim boolean
 
 Trim whitespaces in unquoted fields.
 
 date object
 
 Hide date attributes Show date attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 formats array[string] Required
 
 An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
 
 locale string
 
 The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 timezone string
 
 The timezone to use when parsing the date. Supports template snippets.
 
 output_format string
 
 The format to use when writing the date to target_field. Must be a valid java time pattern.
 
 date_index_name object
 
 Hide date_index_name attributes Show date_index_name attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 date_formats array[string]
 
 An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
 
 date_rounding string Required
 
 How to round the date when formatting the date into the index name. Valid values are: y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). Supports template snippets.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 index_name_format string
 
 The format to be used when printing the parsed date into the index name. A valid java time pattern is expected here. Supports template snippets.
 
 index_name_prefix string
 
 A prefix of the index name to be prepended before the printed date. Supports template snippets.
 
 locale string
 
 The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.
 
 timezone string
 
 The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.
 
 dissect object
 
 Hide dissect attributes Show dissect attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 append_separator string
 
 The character(s) that separate the appended fields.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 pattern string Required
 
 The pattern to apply to the field.
 
 dot_expander object
 
 Hide dot_expander attributes Show dot_expander attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 override boolean
 
 Controls the behavior when there is already an existing nested object that conflicts with the expanded field. When false, the processor will merge conflicts by combining the old and the new values into an array. When true, the value from the expanded field will overwrite the existing value.
 
 path string
 
 The field that contains the field to expand. Only required if the field to expand is part another object field, because the field option can only understand leaf fields.
 
 drop object
 
 Hide drop attributes Show drop attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 enrich object
 
 Hide enrich attributes Show enrich attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 max_matches number
 
 The maximum number of matched documents to include under the configured target field. The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128.
 
 override boolean
 
 If processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.
 
 policy_name string Required
 
 The name of the enrich policy to use.
 
 shape_relation string
 
 Values are intersects, disjoint, within, or contains.
 
 target_field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 fail object
 
 Hide fail attributes Show fail attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 message string Required
 
 The error message thrown by the processor. Supports template snippets.
 
 fingerprint object
 
 Hide fingerprint attributes Show fingerprint attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 fields string | array[string] Required
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 salt string
 
 Salt value for the hash function.
 
 method string
 
 Values are MD5, SHA-1, SHA-256, SHA-512, or MurmurHash3.
 
 ignore_missing boolean
 
 If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
 
 foreach object
 
 Hide foreach attributes Show foreach attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true, the processor silently exits without changing the document if the field is null or missing.
 
 processor object Required
 
 ip_location object
 
 Hide ip_location attributes Show ip_location attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 database_file string
 
 The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 first_only boolean
 
 If true, only the first found IP location data will be returned, even if the field contains an array.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 properties array[string]
 
 Controls what properties are added to the target_field based on the IP location lookup.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 download_database_on_pipeline_creation boolean
 
 If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.
 
 geo_grid object
 
 Hide geo_grid attributes Show geo_grid attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 The field to interpret as a geo-tile.= The field format is determined by the tile_type.
 
 tile_type string Required
 
 Values are geotile, geohex, or geohash.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 parent_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 children_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 non_children_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 precision_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 target_format string
 
 Values are geojson or wkt.
 
 geoip object
 
 Hide geoip attributes Show geoip attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 database_file string
 
 The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 first_only boolean
 
 If true, only the first found geoip data will be returned, even if the field contains an array.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 properties array[string]
 
 Controls what properties are added to the target_field based on the geoip lookup.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 download_database_on_pipeline_creation boolean
 
 If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.
 
 grok object
 
 Hide grok attributes Show grok attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 ecs_compatibility string
 
 Must be disabled or v1. If v1, the processor uses patterns with Elastic Common Schema (ECS) field names.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 pattern_definitions object
 
 A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition.
 
 patterns array[string] Required
 
 An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.
 
 trace_match boolean
 
 When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched.
 
 gsub object
 
 Hide gsub attributes Show gsub attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 pattern string Required
 
 The pattern to be replaced.
 
 replacement string Required
 
 The string to replace the matching patterns with.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 html_strip object
 
 Hide html_strip attributes Show html_strip attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document,
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 inference object
 
 Hide inference attributes Show inference attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 model_id string Required
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 field_map object
 
 Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration.
 
 inference_config object
 
 input_output
 
 ignore_missing boolean
 
 If true and any of the input fields defined in input_ouput are missing then those missing fields are quietly ignored, otherwise a missing field causes a failure. Only applies when using input_output configurations to explicitly list the input fields.
 
 join object
 
 Hide join attributes Show join attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 separator string Required
 
 The separator character.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 json object
 
 Hide json attributes Show json attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 add_to_root boolean
 
 Flag that forces the parsed JSON to be added at the top level of the document. target_field must not be set when this option is chosen.
 
 add_to_root_conflict_strategy string
 
 Values are replace or merge.
 
 allow_duplicate_keys boolean
 
 When set to true, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins.
 
 field string Required
 
 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.
 
 kv object
 
 Hide kv attributes Show kv attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 exclude_keys array[string]
 
 List of keys to exclude from document.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 field_split string Required
 
 Regex pattern to use for splitting key-value pairs.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 include_keys array[string]
 
 List of keys to filter and insert into document. Defaults to including all keys.
 
 prefix string
 
 Prefix to be added to extracted keys.
 
 strip_brackets boolean
 
 If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 trim_key string
 
 String of characters to trim from extracted keys.
 
 trim_value string
 
 String of characters to trim from extracted values.
 
 value_split string Required
 
 Regex pattern to use for splitting the key from the value within a key-value pair.
 
 lowercase object
 
 Hide lowercase attributes Show lowercase attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 network_direction object
 
 Hide network_direction attributes Show network_direction attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 source_ip string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 destination_ip 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.
 
 internal_networks array[string]
 
 List of internal networks. Supports IPv4 and IPv6 addresses and ranges in CIDR notation. Also supports the named ranges listed below. These may be constructed with template snippets. Must specify only one of internal_networks or internal_networks_field.
 
 internal_networks_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and any required fields are missing, the processor quietly exits without modifying the document.
 
 pipeline object
 
 Hide pipeline attributes Show pipeline attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 name string Required
 
 ignore_missing_pipeline boolean
 
 Whether to ignore missing pipelines instead of failing.
 
 redact object
 
 Hide redact attributes Show redact attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 patterns array[string] Required
 
 A list of grok expressions to match and redact named captures with
 
 pattern_definitions object
 
 prefix string
 
 Start a redacted section with this token
 
 suffix string
 
 End a redacted section with this token
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 skip_if_unlicensed boolean
 
 If true and the current license does not support running redact processors, then the processor quietly exits without modifying the document
 
 trace_redact boolean
 
 If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted
 
 registered_domain object
 
 Hide registered_domain attributes Show registered_domain attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 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.
 
 ignore_missing boolean
 
 If true and any required fields are missing, the processor quietly exits without modifying the document.
 
 remove object
 
 Hide remove attributes Show remove attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string | array[string] Required
 
 keep string | array[string]
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 rename object
 
 Hide rename attributes Show rename attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 target_field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 reroute object
 
 Hide reroute attributes Show reroute attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 destination string
 
 A static value for the target. Can’t be set when the dataset or namespace option is set.
 
 dataset
 
 namespace
 
 script object
 
 Hide script attributes Show script attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 id string
 
 lang
 
 params object
 
 Object containing parameters for the script.
 
 source
 
 set object
 
 Hide set attributes Show set attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 copy_from string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_empty_value boolean
 
 If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document.
 
 media_type string
 
 The media type for encoding value. Applies only when value is a template snippet. Must be one of application/json, text/plain, or application/x-www-form-urlencoded.
 
 override boolean
 
 If true processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.
 
 value object
 
 The value to be set for the field. Supports template snippets. May specify only one of value or copy_from.
 
 set_security_user object
 
 Hide set_security_user attributes Show set_security_user attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 properties array[string]
 
 Controls what user related properties are added to the field.
 
 sort object
 
 Hide sort attributes Show sort attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 order string
 
 Values are asc or desc.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 split object
 
 Hide split attributes Show split attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 preserve_trailing boolean
 
 Preserves empty trailing fields, if any.
 
 separator string Required
 
 A regex which matches the separator, for example, , or \s+.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 terminate object
 
 Hide terminate attributes Show terminate attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 trim object
 
 Hide trim attributes Show trim attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 uppercase object
 
 Hide uppercase attributes Show uppercase attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 urldecode object
 
 Hide urldecode attributes Show urldecode attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 uri_parts object
 
 Hide uri_parts attributes Show uri_parts attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 keep_original boolean
 
 If true, the processor copies the unparsed URI to <target_field>.original.
 
 remove_if_successful boolean
 
 If true, the processor removes the field after parsing the URI string. If parsing fails, the processor does not remove the field.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 user_agent object
 
 Hide user_agent attributes Show user_agent attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 regex_file string
 
 The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 properties array[string]
 
 Controls what properties are added to target_field.
 
 Values are name, os, device, original, or version.
 
 extract_device_type boolean Beta
 
 Extracts device type from the user agent string on a best-effort basis.
 
 processors array[object]
 
 Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.
 
 Hide processors attributes Show processors attributes object
 
 append object
 
 Hide append attributes Show append attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 value
 
 allow_duplicates boolean
 
 If false, the processor does not append values already present in the field.
 
 attachment object
 
 Hide attachment attributes Show attachment attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 indexed_chars number
 
 The number of chars being used for extraction to prevent huge fields. Use -1 for no limit.
 
 indexed_chars_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 properties array[string]
 
 Array of properties to select to be stored. Can be content, title, name, author, keywords, date, content_type, content_length, language.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 remove_binary boolean
 
 If true, the binary field will be removed from the document
 
 resource_name string
 
 Field containing the name of the resource to decode. If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection.
 
 bytes object
 
 Hide bytes attributes Show bytes attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 circle object
 
 Hide circle attributes Show circle attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 error_distance number Required
 
 The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape).
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 shape_type string Required
 
 Values are geo_shape or shape.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 community_id object
 
 Hide community_id attributes Show community_id attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 source_ip string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 source_port string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 destination_ip string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 destination_port string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 iana_number string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 icmp_type string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 icmp_code string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 transport 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.
 
 seed number
 
 Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme.
 
 ignore_missing boolean
 
 If true and any required fields are missing, the processor quietly exits without modifying the document.
 
 convert object
 
 Hide convert attributes Show convert attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 type string Required
 
 Values are integer, long, double, float, boolean, ip, string, or auto.
 
 csv object
 
 Hide csv attributes Show csv attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 empty_value object
 
 Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes ("").
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 quote string
 
 Quote used in CSV, has to be single character string.
 
 separator string
 
 Separator used in CSV, has to be single character string.
 
 target_fields string | array[string] Required
 
 trim boolean
 
 Trim whitespaces in unquoted fields.
 
 date object
 
 Hide date attributes Show date attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 formats array[string] Required
 
 An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
 
 locale string
 
 The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 timezone string
 
 The timezone to use when parsing the date. Supports template snippets.
 
 output_format string
 
 The format to use when writing the date to target_field. Must be a valid java time pattern.
 
 date_index_name object
 
 Hide date_index_name attributes Show date_index_name attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 date_formats array[string]
 
 An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.
 
 date_rounding string Required
 
 How to round the date when formatting the date into the index name. Valid values are: y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). Supports template snippets.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 index_name_format string
 
 The format to be used when printing the parsed date into the index name. A valid java time pattern is expected here. Supports template snippets.
 
 index_name_prefix string
 
 A prefix of the index name to be prepended before the printed date. Supports template snippets.
 
 locale string
 
 The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.
 
 timezone string
 
 The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.
 
 dissect object
 
 Hide dissect attributes Show dissect attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 append_separator string
 
 The character(s) that separate the appended fields.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 pattern string Required
 
 The pattern to apply to the field.
 
 dot_expander object
 
 Hide dot_expander attributes Show dot_expander attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 override boolean
 
 Controls the behavior when there is already an existing nested object that conflicts with the expanded field. When false, the processor will merge conflicts by combining the old and the new values into an array. When true, the value from the expanded field will overwrite the existing value.
 
 path string
 
 The field that contains the field to expand. Only required if the field to expand is part another object field, because the field option can only understand leaf fields.
 
 drop object
 
 Hide drop attributes Show drop attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 enrich object
 
 Hide enrich attributes Show enrich attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 max_matches number
 
 The maximum number of matched documents to include under the configured target field. The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128.
 
 override boolean
 
 If processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.
 
 policy_name string Required
 
 The name of the enrich policy to use.
 
 shape_relation string
 
 Values are intersects, disjoint, within, or contains.
 
 target_field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 fail object
 
 Hide fail attributes Show fail attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 message string Required
 
 The error message thrown by the processor. Supports template snippets.
 
 fingerprint object
 
 Hide fingerprint attributes Show fingerprint attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 fields string | array[string] Required
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 salt string
 
 Salt value for the hash function.
 
 method string
 
 Values are MD5, SHA-1, SHA-256, SHA-512, or MurmurHash3.
 
 ignore_missing boolean
 
 If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
 
 foreach object
 
 Hide foreach attributes Show foreach attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true, the processor silently exits without changing the document if the field is null or missing.
 
 processor object Required
 
 ip_location object
 
 Hide ip_location attributes Show ip_location attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 database_file string
 
 The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 first_only boolean
 
 If true, only the first found IP location data will be returned, even if the field contains an array.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 properties array[string]
 
 Controls what properties are added to the target_field based on the IP location lookup.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 download_database_on_pipeline_creation boolean
 
 If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.
 
 geo_grid object
 
 Hide geo_grid attributes Show geo_grid attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 The field to interpret as a geo-tile.= The field format is determined by the tile_type.
 
 tile_type string Required
 
 Values are geotile, geohex, or geohash.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 parent_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 children_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 non_children_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 precision_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 target_format string
 
 Values are geojson or wkt.
 
 geoip object
 
 Hide geoip attributes Show geoip attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 database_file string
 
 The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 first_only boolean
 
 If true, only the first found geoip data will be returned, even if the field contains an array.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 properties array[string]
 
 Controls what properties are added to the target_field based on the geoip lookup.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 download_database_on_pipeline_creation boolean
 
 If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.
 
 grok object
 
 Hide grok attributes Show grok attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 ecs_compatibility string
 
 Must be disabled or v1. If v1, the processor uses patterns with Elastic Common Schema (ECS) field names.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 pattern_definitions object
 
 A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition.
 
 patterns array[string] Required
 
 An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.
 
 trace_match boolean
 
 When true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched.
 
 gsub object
 
 Hide gsub attributes Show gsub attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 pattern string Required
 
 The pattern to be replaced.
 
 replacement string Required
 
 The string to replace the matching patterns with.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 html_strip object
 
 Hide html_strip attributes Show html_strip attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document,
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 inference object
 
 Hide inference attributes Show inference attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 model_id string Required
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 field_map object
 
 Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration.
 
 inference_config object
 
 input_output
 
 ignore_missing boolean
 
 If true and any of the input fields defined in input_ouput are missing then those missing fields are quietly ignored, otherwise a missing field causes a failure. Only applies when using input_output configurations to explicitly list the input fields.
 
 join object
 
 Hide join attributes Show join attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 separator string Required
 
 The separator character.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 json object
 
 Hide json attributes Show json attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 add_to_root boolean
 
 Flag that forces the parsed JSON to be added at the top level of the document. target_field must not be set when this option is chosen.
 
 add_to_root_conflict_strategy string
 
 Values are replace or merge.
 
 allow_duplicate_keys boolean
 
 When set to true, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins.
 
 field string Required
 
 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.
 
 kv object
 
 Hide kv attributes Show kv attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 exclude_keys array[string]
 
 List of keys to exclude from document.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 field_split string Required
 
 Regex pattern to use for splitting key-value pairs.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 include_keys array[string]
 
 List of keys to filter and insert into document. Defaults to including all keys.
 
 prefix string
 
 Prefix to be added to extracted keys.
 
 strip_brackets boolean
 
 If true. strip brackets (), <>, [] as well as quotes ' and " from extracted values.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 trim_key string
 
 String of characters to trim from extracted keys.
 
 trim_value string
 
 String of characters to trim from extracted values.
 
 value_split string Required
 
 Regex pattern to use for splitting the key from the value within a key-value pair.
 
 lowercase object
 
 Hide lowercase attributes Show lowercase attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 network_direction object
 
 Hide network_direction attributes Show network_direction attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 source_ip string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 destination_ip 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.
 
 internal_networks array[string]
 
 List of internal networks. Supports IPv4 and IPv6 addresses and ranges in CIDR notation. Also supports the named ranges listed below. These may be constructed with template snippets. Must specify only one of internal_networks or internal_networks_field.
 
 internal_networks_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and any required fields are missing, the processor quietly exits without modifying the document.
 
 pipeline object
 
 Hide pipeline attributes Show pipeline attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 name string Required
 
 ignore_missing_pipeline boolean
 
 Whether to ignore missing pipelines instead of failing.
 
 redact object
 
 Hide redact attributes Show redact attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 patterns array[string] Required
 
 A list of grok expressions to match and redact named captures with
 
 pattern_definitions object
 
 prefix string
 
 Start a redacted section with this token
 
 suffix string
 
 End a redacted section with this token
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 skip_if_unlicensed boolean
 
 If true and the current license does not support running redact processors, then the processor quietly exits without modifying the document
 
 trace_redact boolean
 
 If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted
 
 registered_domain object
 
 Hide registered_domain attributes Show registered_domain attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 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.
 
 ignore_missing boolean
 
 If true and any required fields are missing, the processor quietly exits without modifying the document.
 
 remove object
 
 Hide remove attributes Show remove attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string | array[string] Required
 
 keep string | array[string]
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 rename object
 
 Hide rename attributes Show rename attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 target_field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 reroute object
 
 Hide reroute attributes Show reroute attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 destination string
 
 A static value for the target. Can’t be set when the dataset or namespace option is set.
 
 dataset
 
 namespace
 
 script object
 
 Hide script attributes Show script attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 id string
 
 lang
 
 params object
 
 Object containing parameters for the script.
 
 source
 
 set object
 
 Hide set attributes Show set attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 copy_from string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_empty_value boolean
 
 If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document.
 
 media_type string
 
 The media type for encoding value. Applies only when value is a template snippet. Must be one of application/json, text/plain, or application/x-www-form-urlencoded.
 
 override boolean
 
 If true processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.
 
 value object
 
 The value to be set for the field. Supports template snippets. May specify only one of value or copy_from.
 
 set_security_user object
 
 Hide set_security_user attributes Show set_security_user attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 properties array[string]
 
 Controls what user related properties are added to the field.
 
 sort object
 
 Hide sort attributes Show sort attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 order string
 
 Values are asc or desc.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 split object
 
 Hide split attributes Show split attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 preserve_trailing boolean
 
 Preserves empty trailing fields, if any.
 
 separator string Required
 
 A regex which matches the separator, for example, , or \s+.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 terminate object
 
 Hide terminate attributes Show terminate attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 trim object
 
 Hide trim attributes Show trim attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 uppercase object
 
 Hide uppercase attributes Show uppercase attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 urldecode object
 
 Hide urldecode attributes Show urldecode attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist or is null, the processor quietly exits without modifying the document.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 uri_parts object
 
 Hide uri_parts attributes Show uri_parts attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 keep_original boolean
 
 If true, the processor copies the unparsed URI to <target_field>.original.
 
 remove_if_successful boolean
 
 If true, the processor removes the field after parsing the URI string. If parsing fails, the processor does not remove the field.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 user_agent object
 
 Hide user_agent attributes Show user_agent attributes object
 
 description string
 
 Description of the processor. Useful for describing the purpose of the processor or its configuration.
 
 if object
 
 ignore_failure boolean
 
 Ignore failures for the processor.
 
 on_failure array[object]
 
 Handle failures for the processor.
 
 tag string
 
 Identifier for the processor. Useful for debugging and metrics.
 
 field string Required
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 ignore_missing boolean
 
 If true and field does not exist, the processor quietly exits without modifying the document.
 
 regex_file string
 
 The name of the file in the config/ingest-user-agent directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the regexes.yaml from uap-core it ships with.
 
 target_field string
 
 Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
 
 properties array[string]
 
 Controls what properties are added to target_field.
 
 Values are name, os, device, original, or version.
 
 extract_device_type boolean Beta
 
 Extracts device type from the user agent string on a best-effort basis.
 
 version number
 
 deprecated boolean
 
 Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.
 
 _meta object
 
 Hide _meta attribute Show _meta attribute object
 
 * object Additional properties

GET /_ingest/pipeline/{id}

curl \
 --request GET 'http://api.example.com/_ingest/pipeline/{id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response for retrieving information about an ingest pipeline.

{
  "my-pipeline-id" : {
    "description" : "describe pipeline",
    "version" : 123,
    "processors" : [
      {
        "set" : {
          "field" : "foo",
          "value" : "bar"
        }
      }
    ]
  }
}

Get data frame analytics job configuration info Added in 7.3.0

GET /_ml/data_frame/analytics/{id}

Api key auth Basic auth Bearer auth

You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.

Path parameters

id string Required

Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.

Query parameters

allow_no_match boolean
Specifies what to do when the request:
1. Contains wildcard expressions and there are no data frame analytics jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches.
The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.
from number

Skips the specified number of data frame analytics jobs.
size number

Specifies the maximum number of data frame analytics jobs to obtain.
exclude_generated boolean

Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

Responses

200 application/json
Hide response attributes Show response attributes object
- count number Required
- data_frame_analytics array[object] Required
  
  An array of data frame analytics job resources, which are sorted by the id value in ascending order.
  
  Hide data_frame_analytics attributes Show data_frame_analytics attributes object
  
  allow_lazy_start boolean
  
  analysis object Required
  
  Hide analysis attributes Show analysis attributes object
  
  classification object
  
  Hide classification attributes Show classification attributes object
  
  alpha number
  
  Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.
  
  dependent_variable string Required
  
  Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. For regression analysis, the data type of the field must be numeric.
  
  downsample_factor number
  
  Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.
  
  early_stopping_enabled boolean
  
  Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable.
  
  eta number
  
  Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1.
  
  eta_growth_rate_per_tree number
  
  Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2.
  
  feature_bag_fraction number
  
  Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.
  
  feature_processors array[object]
  
  Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields.
  
  gamma number
  
  Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
  
  lambda number
  
  Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
  
  max_optimization_rounds_per_hyperparameter number
  
  Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.
  
  max_trees number
  
  Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.
  
  num_top_feature_importance_values number
  
  Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs.
  
  prediction_field_name string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  randomize_seed number
  
  Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same).
  
  soft_tree_depth_limit number
  
  Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.
  
  soft_tree_depth_tolerance number
  
  Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01.
  
  training_percent
  
  class_assignment_objective string
  
  num_top_classes number
  
  Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, num_top_classes must be set to -1 or a value greater than or equal to the total number of categories.
  
  outlier_detection object
  
  Hide outlier_detection attributes Show outlier_detection attributes object
  
  compute_feature_influence boolean
  
  Specifies whether the feature influence calculation is enabled.
  
  feature_influence_threshold number
  
  The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1.
  
  method string
  
  The method that outlier detection uses. Available methods are lof, ldof, distance_kth_nn, distance_knn, and ensemble. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score.
  
  n_neighbors number
  
  Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.
  
  outlier_fraction number
  
  The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.
  
  standardization_enabled boolean
  
  If true, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i).
  
  regression object
  
  Hide regression attributes Show regression attributes object
  
  alpha number
  
  Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.
  
  dependent_variable string Required
  
  Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. For classification analysis, the data type of the field must be numeric (integer, short, long, byte), categorical (ip or keyword), or boolean. There must be no more than 30 different values in this field. For regression analysis, the data type of the field must be numeric.
  
  downsample_factor number
  
  Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.
  
  early_stopping_enabled boolean
  
  Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable.
  
  eta number
  
  Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1.
  
  eta_growth_rate_per_tree number
  
  Advanced configuration option. Specifies the rate at which eta increases for each new tree that is added to the forest. For example, a rate of 1.05 increases eta by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2.
  
  feature_bag_fraction number
  
  Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.
  
  feature_processors array[object]
  
  Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple feature_processors entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields.
  
  gamma number
  
  Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
  
  lambda number
  
  Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
  
  max_optimization_rounds_per_hyperparameter number
  
  Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.
  
  max_trees number
  
  Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.
  
  num_top_feature_importance_values number
  
  Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs.
  
  prediction_field_name string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  randomize_seed number
  
  Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as source and analyzed_fields are the same).
  
  soft_tree_depth_limit number
  
  Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the soft_tree_depth_tolerance to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.
  
  soft_tree_depth_tolerance number
  
  Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01.
  
  training_percent
  
  loss_function string
  
  The loss function used during regression. Available options are mse (mean squared error), msle (mean squared logarithmic error), huber (Pseudo-Huber loss).
  
  loss_function_parameter number
  
  A positive number that is used as a parameter to the loss_function.
  
  analyzed_fields object
  
  Hide analyzed_fields attributes Show analyzed_fields attributes object
  
  includes array[string]
  
  An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.
  
  excludes array[string]
  
  An array of strings that defines the fields that will be included in the analysis.
  
  authorization object
  
  Hide authorization attributes Show authorization attributes object
  
  api_key object
  
  Hide api_key attributes Show api_key attributes object
  
  id string Required
  
  The identifier for the API key.
  
  name string Required
  
  The name of the API key.
  
  roles array[string]
  
  If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response.
  
  service_account string
  
  If a service account was used for the most recent update to the job, the account name is listed in the response.
  
  create_time number
  
  Time unit for milliseconds
  
  description string
  
  dest object Required
  
  Hide dest attributes Show dest attributes object
  
  index string Required
  
  results_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  id string Required
  
  max_num_threads number
  
  model_memory_limit string
  
  source object Required
  
  Hide source attributes Show source attributes object
  
  index string | array[string] Required
  
  runtime_mappings object
  
  Hide runtime_mappings attribute Show runtime_mappings attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  fields object
  
  For type composite
  
  fetch_fields array[object]
  
  For type lookup
  
  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
  
  type string Required
  
  Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
  
  _source object
  
  Hide _source attributes Show _source attributes object
  
  includes array[string]
  
  An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically.
  
  excludes array[string]
  
  An array of strings that defines the fields that will be included in the analysis.
  
  query object
  
  The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {}}.
  
  Query DSL
  
  version string
  
  _meta object
  
  Hide _meta attribute Show _meta attribute object
  
  * object Additional properties

GET /_ml/data_frame/analytics/{id}

curl \
 --request GET 'http://api.example.com/_ml/data_frame/analytics/{id}' \
 --header "Authorization: $API_KEY"

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"}}'

Get feature migration information Added in 7.16.0

GET /_migration/system_features

Api key auth Basic auth Bearer auth

Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress.

TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

Responses

200 application/json
Hide response attributes Show response attributes object
- features array[object] Required
  
  Hide features attributes Show features attributes object
  
  feature_name string Required
  
  minimum_index_version string Required
  
  migration_status string Required
  
  Values are NO_MIGRATION_NEEDED, MIGRATION_NEEDED, IN_PROGRESS, or ERROR.
  
  indices array[object] Required
  
  Hide indices attributes Show indices attributes object
  
  index string Required
  
  version string Required
  
  failure_cause object
  
  Hide failure_cause attributes Show failure_cause 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]
- migration_status string Required
  
  Values are NO_MIGRATION_NEEDED, MIGRATION_NEEDED, IN_PROGRESS, or ERROR.

GET /_migration/system_features

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

Response examples (200)

A successful response from `GET /_migration/system_features`.

{
  "features" : [
    {
      "feature_name" : "async_search",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "enrich",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "ent_search",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "fleet",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "geoip",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "kibana",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "logstash_management",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "machine_learning",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "searchable_snapshots",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "security",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "synonyms",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "tasks",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "transform",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    },
    {
      "feature_name" : "watcher",
      "minimum_index_version" : "8100099",
      "migration_status" : "NO_MIGRATION_NEEDED",
      "indices" : [ ]
    }
  ],
  "migration_status" : "NO_MIGRATION_NEEDED"
}

Run a scrolling search

POST /_search/scroll/{scroll_id}

Api key auth Basic auth Bearer auth

IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT).

The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. The scroll parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the _scroll_id response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.

You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.

IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.

External documentation

Path parameters

scroll_id string Required Deprecated

The scroll ID

Query parameters

scroll string

The period to retain the search context for scrolling.
scroll_id string Deprecated

The scroll ID for scrolled search
rest_total_hits_as_int boolean

If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.

application/json

Body

scroll 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_id string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- 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]
  
  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
- hits object Required
  
  Hide hits attributes Show hits attributes object
  
  total object | number
  
  Total hit count information, present only if track_total_hits wasn't false in the search request.
  
  One of:
  TotalHits object number-2 number
  
  Hide attributes Show attributes
  
  relation string Required
  
  Values are eq or gte.
  
  value number Required
  
  hits array[object] Required
  
  Hide hits attributes Show hits attributes object
  
  _index string Required
  
  _id string
  
  _score number | string | null
  
  One of:
  number-1 number string-2 string | null
  
  _explanation object
  
  Hide _explanation attributes Show _explanation attributes object
  
  description string Required
  
  details array[object] Required
  
  value number Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  highlight object
  
  Hide highlight attribute Show highlight attribute object
  
  * array[string] Additional properties
  
  inner_hits object
  
  Hide inner_hits attribute Show inner_hits attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  hits object Required
  
  matched_queries array[string] | object
  
  One of:
  array-1 array[string] object-2 object
  
  _nested object
  
  Hide _nested attributes Show _nested attributes object
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  offset number Required
  
  _nested object
  
  _ignored array[string]
  
  ignored_field_values object
  
  Hide ignored_field_values attribute Show ignored_field_values attribute object
  
  * array[object] Additional properties
  
  _shard string
  
  _node string
  
  _routing string
  
  _source object
  
  _rank number
  
  _seq_no number
  
  _primary_term number
  
  _version number
  
  sort array[number | string | boolean | null]
  
  A field value.
  
  max_score number | string | null
  
  One of:
  number-1 number string-2 string | null
- 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
  
  Hide details attribute Show details attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  status string Required
  
  Values are running, successful, partial, skipped, or failed.
  
  indices string Required
  
  took number
  
  Time unit for milliseconds
  
  timed_out boolean Required
  
  _shards object
  
  Hide _shards attributes Show _shards attributes object
  
  failed number Required
  
  successful number Required
  
  total number Required
  
  failures array[object]
  
  skipped number
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  index string
  
  node string
  
  reason object Required
  
  shard number Required
  
  status string
- 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
  
  Hide shards attributes Show shards attributes object
  
  aggregations array[object] Required
  
  Hide aggregations attributes Show aggregations attributes object
  
  breakdown object Required
  
  description string Required
  
  time_in_nanos
  
  type string Required
  
  debug object
  
  children array[object]
  
  cluster string Required
  
  dfs object
  
  Hide dfs attributes Show dfs attributes object
  
  statistics object
  
  Hide statistics attributes Show statistics attributes object
  
  type string Required
  
  description string 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_nanos
  
  breakdown object Required
  
  debug object
  
  children array[object]
  
  knn array[object]
  
  fetch object
  
  Hide fetch attributes Show fetch attributes object
  
  type string Required
  
  description string Required
  
  time_in_nanos number
  
  Time unit for nanoseconds
  
  breakdown object Required
  
  Hide breakdown attributes Show breakdown attributes object
  
  load_source number
  
  load_source_count number
  
  load_stored_fields number
  
  load_stored_fields_count number
  
  next_reader number
  
  next_reader_count number
  
  process_count number
  
  process number
  
  debug object
  
  Hide debug attributes Show debug attributes object
  
  stored_fields array[string]
  
  fast_path number
  
  children array[object]
  
  id string Required
  
  index string Required
  
  node_id string Required
  
  searches array[object] Required
  
  Hide searches attributes Show searches attributes object
  
  collector array[object] Required
  
  query array[object] Required
  
  rewrite_time number Required
  
  shard_id number Required
- pit_id string
- _scroll_id string
- suggest object
  
  Hide suggest attribute Show suggest attribute object
  
  * array[object] Additional properties
  
  One of:
  CompletionSuggest object PhraseSuggest object TermSuggest object
  
  Hide attributes Show attributes
  
  length number Required
  
  offset number Required
  
  text string Required
  
  options
- terminated_early boolean

POST /_search/scroll/{scroll_id}

curl \
 --request POST 'http://api.example.com/_search/scroll/{scroll_id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}"'

Request example

Run `GET /_search/scroll` to get the next batch of results for a scrolling search.

{
  "scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}

Explain a document match result

POST /{index}/_explain/{id}

Api key auth Basic auth Bearer auth

Get information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document.

Path parameters

index string Required

Index names that are used to limit the request. Only a single index name can be provided to this parameter.
id string Required

The document identifier.

Query parameters

analyzer string

The analyzer to use for the query string. This parameter can be used only when the q query string parameter is specified.
analyze_wildcard boolean

If true, wildcard and prefix queries are analyzed. This parameter can be used only when the q query string parameter is specified.
default_operator string

The default operator for query string query: AND or OR. This parameter can be used only when the q query string parameter is specified.

Values are and, AND, or, or OR.
df string

The field to use as default where no field prefix is given in the query string. This parameter can be used only when the q query string parameter is specified.
lenient boolean

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the q query string parameter is specified.
preference string

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

A custom value used to route operations to a specific shard.
_source boolean | string | array[string]

True or false to return the _source field or not or a list of fields to return.
_source_excludes string | array[string]

A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.
_source_includes string | array[string]

A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.
stored_fields string | array[string]

A comma-separated list of stored fields to return in the response.
q string

The query in the Lucene query string syntax.

application/json

Body

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
- _index string Required
- _id string Required
- matched boolean Required
- explanation object
  
  Hide explanation attributes Show explanation attributes object
  
  description string Required
  
  details array[object]
  
  value number Required
- get object
  
  Hide get attributes Show get attributes object
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  found boolean Required
  
  _seq_no number
  
  _primary_term number
  
  _routing string
  
  _source object

POST /{index}/_explain/{id}

curl \
 --request POST 'http://api.example.com/{index}/_explain/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"query\" : {\n    \"match\" : { \"message\" : \"elasticsearch\" }\n  }\n}"'

Request example

Run `GET /my-index-000001/_explain/0` with the request body. Alternatively, run `GET /my-index-000001/_explain/0?q=message:elasticsearch`

{
  "query" : {
    "match" : { "message" : "elasticsearch" }
  }
}

Response examples (200)

A successful response from `GET /my-index-000001/_explain/0`.

{
  "_index":"my-index-000001",
  "_id":"0",
  "matched":true,
  "explanation":{
      "value":1.6943598,
      "description":"weight(message:elasticsearch in 0) [PerFieldSimilarity], result of:",
      "details":[
        {
            "value":1.6943598,
            "description":"score(freq=1.0), computed as boost * idf * tf from:",
            "details":[
              {
                  "value":2.2,
                  "description":"boost",
                  "details":[]
              },
              {
                  "value":1.3862944,
                  "description":"idf, computed as log(1 + (N - n + 0.5) / (n + 0.5)) from:",
                  "details":[
                    {
                        "value":1,
                        "description":"n, number of documents containing term",
                        "details":[]
                    },
                    {
                        "value":5,
                        "description":"N, total number of documents with field",
                        "details":[]
                    }
                  ]
              },
              {
                  "value":0.5555556,
                  "description":"tf, computed as freq / (freq + k1 * (1 - b + b * dl / avgdl)) from:",
                  "details":[
                    {
                        "value":1.0,
                        "description":"freq, occurrences of term within document",
                        "details":[]
                    },
                    {
                        "value":1.2,
                        "description":"k1, term saturation parameter",
                        "details":[]
                    },
                    {
                        "value":0.75,
                        "description":"b, length normalization parameter",
                        "details":[]
                    },
                    {
                        "value":3.0,
                        "description":"dl, length of field",
                        "details":[]
                    },
                    {
                        "value":5.4,
                        "description":"avgdl, average length of field",
                        "details":[]
                    }
                  ]
              }
            ]
        }
      ]
  }
}

Open a point in time Added in 7.10.0

POST /{index}/_pit

Api key auth Basic auth Bearer auth

A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between search_after requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time.

A point in time must be opened explicitly before being used in search requests.

A subsequent search request with the pit parameter must not specify index, routing, or preference values as these parameters are copied from the point in time.

Just like regular searches, you can use from and size to page through point in time search results, up to the first 10,000 hits. If you want to retrieve more hits, use PIT with search_after.

IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.

When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a NoShardAvailableActionException exception. To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.

Keeping point in time alive

The keep_alive parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time. The value does not need to be long enough to process all data — it just needs to be long enough for the next request.

Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments. Once the smaller segments are no longer needed they are deleted. However, open point-in-times prevent the old segments from being deleted since they are still in use.

TIP: Keeping older segments alive means that more disk space and file handles are needed. Ensure that you have configured your nodes to have ample free file handles.

Additionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request. Ensure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates. Note that a point-in-time doesn't prevent its associated indices from being deleted. You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.

Path parameters

index string | array[string] Required

A comma-separated list of index names to open point in time; use _all or empty string to perform the operation on all indices

Query parameters

keep_alive string Required

Extend the length of time that the point in time persists.
ignore_unavailable boolean

If false, the request returns an error if it targets a missing or closed index.
preference string

The node or shard the operation should be performed on. By default, it is random.
routing string

A custom value that is used to route operations to a specific shard.
expand_wildcards string | array[string]
The 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. It supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

Supported values include:
- all: Match any data stream or index, including hidden ones.
- open: Match open, non-hidden indices. Also matches any non-hidden data stream.
- closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
- hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.
allow_partial_search_results boolean

Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If false, creating a point in time request when a shard is missing or unavailable will throw an exception. If true, the point in time will contain all the shards that are available at the time of the request.
max_concurrent_shard_requests number

Maximum number of concurrent shard requests that each sub-search request executes per node.

application/json

Body

index_filter 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
- _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
- id string Required

POST /{index}/_pit

curl \
 --request POST 'http://api.example.com/{index}/_pit?keep_alive=string' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"index_filter":{}}'

Response examples (200)

A successful response from `POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true`. It includes a summary of the total number of shards, as well as the number of successful shards when creating the PIT.

{
  "id": "46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA=",
  "_shards": {
    "total": 10,
    "successful": 10,
    "skipped": 0,
    "failed": 0
  }
}

Evaluate ranked search results Added in 6.2.0

GET /_rank_eval

Api key auth Basic auth Bearer auth

Evaluate the quality of ranked search results over a set of typical search queries.

Query parameters

allow_no_indices boolean

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
expand_wildcards string | array[string]
Whether to expand wildcard expression to concrete indices that are open, closed or both.

Supported values include:
- all: Match any data stream or index, including hidden ones.
- open: Match open, non-hidden indices. Also matches any non-hidden data stream.
- closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
- hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.
ignore_unavailable boolean

If true, missing or closed indices are not included in the response.
search_type string

Search operation type

application/json

Body Required

requests array[object] Required

A set of typical search requests, together with their provided ratings.
Hide requests attributes Show requests attributes object
- id string Required
- request object
  Hide request attributes Show request attributes object
  
  query object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  size number
- ratings array[object] Required
  
  List of document ratings
  Hide ratings attributes Show ratings attributes object
  
  _id string Required
  
  _index string Required
  
  rating number Required
  
  The document’s relevance with regard to this search request.
- template_id string
- params object
  
  The search template parameters.
  Hide params attribute Show params attribute object
  
  * object Additional properties
metric object
Hide metric attributes Show metric attributes object
- precision object
  Hide precision attributes Show precision attributes object
  
  k number
  
  Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.
  
  relevant_rating_threshold number
  
  Sets the rating threshold above which documents are considered to be "relevant".
  
  ignore_unlabeled boolean
  
  Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant.
- recall object
  Hide recall attributes Show recall attributes object
  
  k number
  
  Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.
  
  relevant_rating_threshold number
  
  Sets the rating threshold above which documents are considered to be "relevant".
- mean_reciprocal_rank object
  Hide mean_reciprocal_rank attributes Show mean_reciprocal_rank attributes object
  
  k number
  
  Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.
  
  relevant_rating_threshold number
  
  Sets the rating threshold above which documents are considered to be "relevant".
- dcg object
  Hide dcg attributes Show dcg attributes object
  
  k number
  
  Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.
  
  normalize boolean
  
  If set to true, this metric will calculate the Normalized DCG.
- expected_reciprocal_rank object
  Hide expected_reciprocal_rank attributes Show expected_reciprocal_rank attributes object
  
  k number
  
  Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query.
  
  maximum_relevance number Required
  
  The highest relevance grade used in the user-supplied relevance judgments.

Responses

200 application/json
Hide response attributes Show response attributes object
- metric_score number Required
  
  The overall evaluation quality calculated by the defined metric
- details object Required
  
  The details section contains one entry for every query in the original requests section, keyed by the search request id
  
  Hide details attribute Show details attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  metric_score number Required
  
  The metric_score in the details section shows the contribution of this query to the global quality metric score
  
  unrated_docs array[object] Required
  
  The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents
  
  Hide unrated_docs attributes Show unrated_docs attributes object
  
  _id string Required
  
  _index string Required
  
  hits array[object] Required
  
  The hits section shows a grouping of the search results with their supplied ratings
  
  Hide hits attributes Show hits attributes object
  
  hit object Required
  
  Hide hit attributes Show hit attributes object
  
  _id string Required
  
  _index string Required
  
  _score number Required
  
  rating number | string | null
  
  One of:
  number-1 number string-2 string | null
  
  metric_details object Required
  
  The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results
  
  Hide metric_details attribute Show metric_details attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  * object Additional properties
- failures object Required
  
  Hide failures attribute Show failures attribute object
  
  * object Additional properties

GET /_rank_eval

curl \
 --request GET 'http://api.example.com/_rank_eval' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"requests":[{"id":"string","request":{"query":{},"size":42.0},"ratings":[{"_id":"string","_index":"string","rating":42.0}],"template_id":"string","params":{"additionalProperty1":{},"additionalProperty2":{}}}],"metric":{"precision":{"k":42.0,"relevant_rating_threshold":42.0,"ignore_unlabeled":true},"recall":{"k":42.0,"relevant_rating_threshold":42.0},"mean_reciprocal_rank":{"k":42.0,"relevant_rating_threshold":42.0},"dcg":{"k":42.0,"normalize":true},"expected_reciprocal_rank":{"k":42.0,"maximum_relevance":42.0}}}'

Run a search

GET /_search

Api key auth Basic auth Bearer auth

Get search hits that match the query defined in the request. You can provide search queries using the q query string parameter or the request body. If both are specified, only the query parameter is used.

If the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges. To search a point in time (PIT) for an alias, you must have the read index privilege for the alias's data streams or indices.

Search slicing

When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the slice and pit properties. By default the splitting is done first on the shards, then locally on each shard. The local splitting partitions the shard into contiguous ranges based on Lucene document IDs.

For instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.

IMPORTANT: The same point-in-time ID should be used for all slices. If different PIT IDs are used, slices can overlap and miss documents. This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.

External documentation

Query parameters

allow_no_indices boolean

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
allow_partial_search_results boolean

If true and there are shard request timeouts or shard failures, the request returns partial results. If false, it returns an error with no partial results.

To override the default behavior, you can set the search.default_allow_partial_results cluster setting to false.
analyzer string

The analyzer to use for the query string. This parameter can be used only when the q query string parameter is specified.
analyze_wildcard boolean

If true, wildcard and prefix queries are analyzed. This parameter can be used only when the q query string parameter is specified.
batched_reduce_size number

The number of shard results that should be reduced at once on the coordinating node. If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request.
ccs_minimize_roundtrips boolean

If true, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.
default_operator string

The default operator for the query string query: AND or OR. This parameter can be used only when the q query string parameter is specified.

Values are and, AND, or, or OR.
df string

The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the q query string parameter is specified.
docvalue_fields string | array[string]

A comma-separated list of fields to return as the docvalue representation of a field for each hit.
expand_wildcards string | array[string]
The 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. It supports comma-separated values such as open,hidden.

Supported values include:
- all: Match any data stream or index, including hidden ones.
- open: Match open, non-hidden indices. Also matches any non-hidden data stream.
- closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
- hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.
explain boolean

If true, the request returns detailed information about score computation as part of a hit.
ignore_throttled boolean Deprecated

If true, concrete, expanded or aliased indices will be ignored when frozen.
ignore_unavailable boolean

If false, the request returns an error if it targets a missing or closed index.
include_named_queries_score boolean

If true, the response includes the score contribution from any named queries.

This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead.
lenient boolean

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the q query string parameter is specified.
max_concurrent_shard_requests number

The number of concurrent shard requests per node that the search runs concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.
preference string
The nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
- _only_local to run the search only on shards on the local node.
- _local to, if possible, run the search on shards on the local node, or if not, select shards using the default method.
- _only_nodes:<node-id>,<node-id> to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.
- _prefer_nodes:<node-id>,<node-id> to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.
- _shards:<shard>,<shard> to run the search only on the specified shards. You can combine this value with other preference values. However, the _shards value must come first. For example: _shards:2,3|_local.
- <custom-string> (any string that does not start with _) to route searches with the same <custom-string> to the same shards in the same order.
pre_filter_shard_size number
A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met:
- The request targets more than 128 shards.
- The request targets one or more read-only index.
- The primary sort of the query targets an indexed field.
request_cache boolean

If true, the caching of search results is enabled for requests where size is 0. It defaults to index level settings.
routing string

A custom value that is used to route operations to a specific shard.
scroll string

The period to retain the search context for scrolling. By default, this value cannot exceed 1d (24 hours). You can change this limit by using the search.max_keep_alive cluster-level setting.
search_type string
Indicates how distributed term frequencies are calculated for relevance scoring.

Supported values include:
- query_then_fetch: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.
- dfs_query_then_fetch: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.
Values are query_then_fetch or dfs_query_then_fetch.
stats array[string]

Specific tag of the request for logging and statistical purposes.
stored_fields string | array[string]

A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.
suggest_field string

The field to use for suggestions.
suggest_mode string
The suggest mode. This parameter can be used only when the suggest_field and suggest_text query string parameters are specified.

Supported values include:
- missing: Only generate suggestions for terms that are not in the shard.
- popular: Only suggest terms that occur in more docs on the shard than the original term.
- always: Suggest any matching suggestions based on terms in the suggest text.
Values are missing, popular, or always.
suggest_size number

The number of suggestions to return. This parameter can be used only when the suggest_field and suggest_text query string parameters are specified.
suggest_text string

The source text for which the suggestions should be returned. This parameter can be used only when the suggest_field and suggest_text query string parameters are specified.
terminate_after number

The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. If set to 0 (default), the query does not terminate early.
timeout string

The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. It defaults to no timeout.
track_total_hits boolean | number

The number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query.
track_scores boolean

If true, the request calculates and returns document scores, even if the scores are not used for sorting.
typed_keys boolean

If true, aggregation and suggester names are be prefixed by their respective types in the response.
rest_total_hits_as_int boolean

Indicates whether hits.total should be rendered as an integer or an object in the rest search response.
version boolean

If true, the request returns the document version as part of a hit.
_source boolean | string | array[string]
The source fields that are returned for matching documents. These fields are returned in the hits._source property of the search response. Valid values are:
- true to return the entire document source.
- false to not return the document source.
- <string> to return the source fields that are specified as a comma-separated list that supports wildcard (*) patterns.
_source_excludes string | array[string]

A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.
_source_includes string | array[string]

A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.
seq_no_primary_term boolean

If true, the request returns the sequence number and primary term of the last modification of each hit.
q string

A query in the Lucene query string syntax. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.

IMPORTANT: This parameter overrides the query parameter in the request body. If both parameters are specified, documents matching the query request body parameter are not returned.
size number

The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
from number

The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
sort string | array[string]

A comma-separated list of <field>:<direction> pairs.

application/json

Body

aggregations object

Defines the aggregations that are run as part of the search request.

External documentation
collapse object
External documentation
explain boolean

If true, the request returns detailed information about score computation as part of a hit.
ext object

Configuration of search extensions defined by Elasticsearch plugins.
Hide ext attribute Show ext attribute object
- * object Additional properties
from number

The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
highlight object
Hide highlight attributes Show highlight attributes object
- type string
 
 Any of:
 HighlighterType string HighlighterType string
 
 Values are plain, fvh, or unified.
- boundary_chars string
 
 A string that contains each boundary character.
- boundary_max_scan number
 
 How far to scan for boundary characters.
- boundary_scanner string
 
 Values are chars, sentence, or word.
- boundary_scanner_locale string
 
 Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".
- force_source boolean Deprecated
- fragmenter string
 
 Values are simple or span.
- fragment_size number
 
 The size of the highlighted fragment in characters.
- highlight_filter boolean
- highlight_query object
 
 An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
 
 External documentation
- max_fragment_length number
- max_analyzed_offset number
 
 If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.
- no_match_size number
 
 The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.
- number_of_fragments number
 
 The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.
- options object
 Hide options attribute Show options attribute object
 
 * object Additional properties
- order string
 
 Value is score.
- phrase_limit number
 
 Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.
- post_tags array[string]
 
 Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in  and  tags.
- pre_tags array[string]
 
 Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in  and  tags.
- require_field_match boolean
 
 By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.
- tags_schema string
 
 Value is styled.
- encoder string
 
 Values are default or html.
- fields object Required
track_total_hits boolean | number

Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.
indices_boost array[object]

Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.

External documentation
Hide indices_boost attribute Show indices_boost attribute object
- * number Additional properties
docvalue_fields array[object]

An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

External documentation
Hide docvalue_fields attributes Show docvalue_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
  
  The format in which the values are returned.
- include_unmapped boolean
knn object | array[object]

The approximate kNN search to run.
One of:
KnnSearch object array-2 array[object]
Hide attributes Show attributes

field string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

query_vector array[number]

query_vector_builder object

Hide query_vector_builder attribute Show query_vector_builder attribute object

text_embedding object

Hide text_embedding attributes Show text_embedding attributes object

model_id string Required

model_text string Required

k number

The final number of nearest neighbors to return as top hits

num_candidates number

The number of nearest neighbor candidates to consider per shard

boost number

Boost value to apply to kNN scores

filter object | array[object]

Filters for the kNN search query

One of:
QueryContainer object array-2 array[object]

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

External documentation

similarity number

The minimum similarity for a vector to be considered a match

inner_hits object

Hide inner_hits attributes Show inner_hits attributes object

name string

size number

The maximum number of hits to return per inner_hits.

from number

Inner hit starting document offset.

collapse object
External documentation

docvalue_fields array[object]

Hide docvalue_fields attributes Show docvalue_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

The format in which the values are returned.

include_unmapped boolean

explain boolean

highlight object

Hide highlight attributes Show highlight attributes object

type string

Any of:
HighlighterType string HighlighterType string

Values are plain, fvh, or unified.

boundary_chars string

A string that contains each boundary character.

boundary_max_scan number

How far to scan for boundary characters.

boundary_scanner string

Values are chars, sentence, or word.

boundary_scanner_locale string

Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

force_source boolean Deprecated

fragmenter string

Values are simple or span.

fragment_size number

The size of the highlighted fragment in characters.

highlight_filter boolean

highlight_query object

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

External documentation

max_fragment_length number

max_analyzed_offset number

If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

no_match_size number

The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

number_of_fragments number

The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

options object

Hide options attribute Show options attribute object

* object Additional properties

order string

Value is score.

phrase_limit number

Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

post_tags array[string]

Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in  and  tags.

pre_tags array[string]

Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in  and  tags.

require_field_match boolean

By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

tags_schema string

Value is styled.

encoder string

Values are default or html.

fields object Required

ignore_unmapped boolean

script_fields object

Hide script_fields attribute Show script_fields attribute object

* object Additional properties

Hide * attributes Show * attributes object

script object Required

Hide script attributes Show script attributes object

source

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.

lang

options object

ignore_failure boolean

seq_no_primary_term boolean

fields array[string]

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

sort string | object | array[string | object]

One of:
Field string SortOptions object Sort array[string | object]

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

_source boolean | object

Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

One of:
SourceConfig boolean SourceFilter object

stored_fields string | array[string]

track_scores boolean

version boolean

rescore_vector object

Hide rescore_vector attribute Show rescore_vector attribute object

oversample number Required

Applies the specified oversample factor to k on the approximate kNN search
External documentation
Hide attributes Show attributes object

field string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

query_vector array[number]

query_vector_builder object

Hide query_vector_builder attribute Show query_vector_builder attribute object

text_embedding object

Hide text_embedding attributes Show text_embedding attributes object

model_id string Required

model_text string Required

k number

The final number of nearest neighbors to return as top hits

num_candidates number

The number of nearest neighbor candidates to consider per shard

boost number

Boost value to apply to kNN scores

filter object | array[object]

Filters for the kNN search query

One of:
QueryContainer object array-2 array[object]

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

External documentation

similarity number

The minimum similarity for a vector to be considered a match

inner_hits object

Hide inner_hits attributes Show inner_hits attributes object

name string

size number

The maximum number of hits to return per inner_hits.

from number

Inner hit starting document offset.

collapse object
External documentation

docvalue_fields array[object]

Hide docvalue_fields attributes Show docvalue_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

The format in which the values are returned.

include_unmapped boolean

explain boolean

highlight object

Hide highlight attributes Show highlight attributes object

type

boundary_chars string

A string that contains each boundary character.

boundary_max_scan number

How far to scan for boundary characters.

boundary_scanner string

Values are chars, sentence, or word.

boundary_scanner_locale string

Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: "en-US", "fr-FR", "ja-JP".

force_source boolean Deprecated

fragmenter string

Values are simple or span.

fragment_size number

The size of the highlighted fragment in characters.

highlight_filter boolean

highlight_query object

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

max_fragment_length number

max_analyzed_offset number

If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The max_analyzed_offset query setting does not override the index.highlight.max_analyzed_offset setting, which prevails when it’s set to lower value than the query setting.

no_match_size number

The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.

number_of_fragments number

The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored.

options object

order string

Value is score.

phrase_limit number

Controls the number of matching phrases in a document that are considered. Prevents the fvh highlighter from analyzing too many phrases and consuming too much memory. When using matched_fields, phrase_limit phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the fvh highlighter.

post_tags array[string]

Use in conjunction with pre_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in  and  tags.

pre_tags array[string]

Use in conjunction with post_tags to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in  and  tags.

require_field_match boolean

By default, only fields that contains a query match are highlighted. Set to false to highlight all fields.

tags_schema string

Value is styled.

encoder string

Values are default or html.

fields object Required

ignore_unmapped boolean

script_fields object

Hide script_fields attribute Show script_fields attribute object

* object Additional properties

Hide * attributes Show * attributes object

script object Required

ignore_failure boolean

seq_no_primary_term boolean

fields array[string]

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

sort string | object | array[string | object]

One of:
Field string SortOptions object Sort array[string | object]

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

_source boolean | object

Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.

One of:
SourceConfig boolean SourceFilter object

stored_fields string | array[string]

track_scores boolean

version boolean

rescore_vector object

Hide rescore_vector attribute Show rescore_vector attribute object

oversample number Required

Applies the specified oversample factor to k on the approximate kNN search
rank object
Hide rank attribute Show rank attribute object
- rrf object
  Hide rrf attributes Show rrf attributes object
  
  rank_constant number
  
  How much influence documents in individual result sets per query have over the final ranked result set
  
  rank_window_size number
  
  Size of the individual result sets per query
min_score number

The minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations.
post_filter object

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

External documentation
profile boolean

Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
query object

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

External documentation
rescore object | array[object]

Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the query and post_filter phases.
One of:
Rescore object array-2 array[object]
Hide attributes Show attributes

window_size number

query object

Hide query attributes Show query attributes object

rescore_query object Required

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

External documentation

query_weight number

Relative importance of the original query versus the rescore query.

rescore_query_weight number

Relative importance of the rescore query versus the original query.

score_mode string

Values are avg, max, min, multiply, or total.

learning_to_rank object

Hide learning_to_rank attributes Show learning_to_rank attributes object

model_id string Required

The unique identifier of the trained model uploaded to Elasticsearch

params object

Named parameters to be passed to the query templates used for feature

Hide params attribute Show params attribute object

* object Additional properties
Hide attributes Show attributes object

window_size number

query object

Hide query attributes Show query attributes object

rescore_query object Required

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

External documentation

query_weight number

Relative importance of the original query versus the rescore query.

rescore_query_weight number

Relative importance of the rescore query versus the original query.

score_mode string

Values are avg, max, min, multiply, or total.

learning_to_rank object

Hide learning_to_rank attributes Show learning_to_rank attributes object

model_id string Required

The unique identifier of the trained model uploaded to Elasticsearch

params object

Named parameters to be passed to the query templates used for feature

Hide params attribute Show params attribute object

* object Additional properties
retriever object
Hide retriever attributes Show retriever attributes object
- standard object
  Hide standard attributes Show standard attributes object
  
  filter object | array[object]
  
  Query to filter the documents that can match.
  
  One of:
  QueryContainer object array-2 array[object]
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  min_score number
  
  Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
  
  query object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  search_after array[number | string | boolean | null]
  
  A field value.
  
  terminate_after number
  
  Maximum number of documents to collect for each shard.
  
  sort string | object | array[string | object]
  
  One of:
  Field string SortOptions object Sort array[string | object]
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  collapse object
  External documentation
- knn object
  Hide knn attributes Show knn attributes object
  
  filter object | array[object]
  
  Query to filter the documents that can match.
  
  One of:
  QueryContainer object array-2 array[object]
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  min_score number
  
  Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
  
  field string Required
  
  The name of the vector field to search against.
  
  query_vector array[number]
  
  query_vector_builder object
  
  Hide query_vector_builder attribute Show query_vector_builder attribute object
  
  text_embedding object
  
  Hide text_embedding attributes Show text_embedding attributes object
  
  model_id string Required
  
  model_text string Required
  
  k number Required
  
  Number of nearest neighbors to return as top hits.
  
  num_candidates number Required
  
  Number of nearest neighbor candidates to consider per shard.
  
  similarity number
  
  The minimum similarity required for a document to be considered a match.
  
  rescore_vector object
  
  Hide rescore_vector attribute Show rescore_vector attribute object
  
  oversample number Required
  
  Applies the specified oversample factor to k on the approximate kNN search
- rrf object
  Hide rrf attributes Show rrf attributes object
  
  filter object | array[object]
  
  Query to filter the documents that can match.
  
  One of:
  QueryContainer object array-2 array[object]
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  min_score number
  
  Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
  
  retrievers array[object] Required
  
  A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them.
  
  rank_constant number
  
  This value determines how much influence documents in individual result sets per query have over the final ranked result set.
  
  rank_window_size number
  
  This value determines the size of the individual result sets per query.
- text_similarity_reranker object
  Hide text_similarity_reranker attributes Show text_similarity_reranker attributes object
  
  filter object | array[object]
  
  Query to filter the documents that can match.
  
  One of:
  QueryContainer object array-2 array[object]
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  min_score number
  
  Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
  
  retriever object Required
  
  rank_window_size number
  
  This value determines how many documents we will consider from the nested retriever.
  
  inference_id string
  
  Unique identifier of the inference endpoint created using the inference API.
  
  inference_text string
  
  The text snippet used as the basis for similarity comparison
  
  field string
  
  The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text
- rule object
  Hide rule attributes Show rule attributes object
  
  filter object | array[object]
  
  Query to filter the documents that can match.
  
  One of:
  QueryContainer object array-2 array[object]
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  min_score number
  
  Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
  
  ruleset_ids array[string] Required
  
  The ruleset IDs containing the rules this retriever is evaluating against.
  
  match_criteria object Required
  
  The match criteria that will determine if a rule in the provided rulesets should be applied.
  
  retriever object Required
  
  rank_window_size number
  
  This value determines the size of the individual result set.
script_fields object

Retrieve a script evaluation (based on different fields) for each hit.
Hide script_fields attribute Show script_fields attribute object
- * object Additional properties
  Hide * attributes Show * attributes object
  
  script object Required
  
  Hide script attributes Show script attributes object
  
  source string | object
  
  One of:
  ScriptSource string SearchRequestBody object
  
  Hide attributes Show attributes
  
  aggregations object
  
  Defines the aggregations that are run as part of the search request.
  
  External documentation
  
  collapse object
  External documentation
  
  explain boolean
  
  If true, the request returns detailed information about score computation as part of a hit.
  
  ext object
  
  Configuration of search extensions defined by Elasticsearch plugins.
  
  Hide ext attribute Show ext attribute object
  
  * object Additional properties
  
  from number
  
  The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
  
  highlight object
  
  track_total_hits boolean | number
  
  Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.
  
  indices_boost array[object]
  
  Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.
  
  External documentation
  
  docvalue_fields array[object]
  
  An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
  
  External documentation
  
  knn object | array[object]
  
  The approximate kNN search to run.
  
  One of:
  KnnSearch object array-2 array[object]
  
  rank object
  
  Hide rank attribute Show rank attribute object
  
  rrf
  
  min_score number
  
  The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.
  
  post_filter object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  profile boolean
  
  Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
  
  query object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  rescore array[object]
  
  retriever object
  
  Hide retriever attributes Show retriever attributes object
  
  standard
  
  knn
  
  rrf
  
  text_similarity_reranker
  
  rule
  
  script_fields object
  
  Retrieve a script evaluation (based on different fields) for each hit.
  
  Hide script_fields attribute Show script_fields attribute object
  
  * object Additional properties
  
  search_after array[number | string | boolean | null]
  
  A field value.
  
  size number
  
  The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.
  
  slice object
  
  Hide slice attributes Show slice attributes object
  
  field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  id string Required
  
  max number Required
  
  sort array[string | object]
  
  _source boolean | object
  
  Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
  
  One of:
  SourceConfig boolean SourceFilter object
  
  fields array[object]
  
  An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
  
  suggest object
  
  Hide suggest attribute Show suggest attribute object
  
  text string
  
  Global suggest text, to avoid repetition when the same text is used in several suggesters
  
  terminate_after number
  
  The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.
  
  IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
  
  If set to 0 (default), the query does not terminate early.
  
  timeout string
  
  The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
  
  track_scores boolean
  
  If true, calculate and return document scores, even if the scores are not used for sorting.
  
  version boolean
  
  If true, the request returns the document version as part of a hit.
  
  seq_no_primary_term boolean
  
  If true, the request returns sequence number and primary term of the last modification of each hit.
  
  External documentation
  
  stored_fields string | array[string]
  
  pit object
  
  Hide pit attributes Show pit attributes object
  
  id string Required
  
  keep_alive 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.
  
  runtime_mappings object
  
  Hide runtime_mappings attribute Show runtime_mappings attribute object
  
  * object Additional properties
  
  stats array[string]
  
  The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.
  
  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
  
  ignore_failure boolean
search_after array[number | string | boolean | null]

A field value.
size number

The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.
slice object
Hide slice attributes Show slice attributes object
- field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
- id string Required
- max number Required
sort string | object | array[string | object]
One of:
Field string SortOptions object Sort array[string | object]

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Hide attributes Show attributes

_score object

Hide _score attribute Show _score attribute object

order string

Values are asc or desc.

_doc object

Hide _doc attribute Show _doc attribute object

order string

Values are asc or desc.

_geo_distance object

Hide _geo_distance attributes Show _geo_distance attributes object

mode string

Values are min, max, sum, avg, or median.

distance_type string

Values are arc or plane.

ignore_unmapped boolean

order string

Values are asc or desc.

unit string

Values are in, ft, yd, mi, nmi, km, m, cm, or mm.

nested object

Hide nested attributes Show nested attributes object

filter object

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

External documentation

max_children number

nested object

path string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

_script object

Hide _script attributes Show _script attributes object

order string

Values are asc or desc.

script object Required

Hide script attributes Show script attributes object

source string | object

One of:
ScriptSource string SearchRequestBody 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

Values are string, number, or version.

mode string

Values are min, max, sum, avg, or median.

nested object

Hide nested attributes Show nested attributes object

filter object

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

External documentation

max_children number

nested object

path string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
One of:
Field string SortOptions object

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

Hide attributes Show attributes

_score object

Hide _score attribute Show _score attribute object

order string

Values are asc or desc.

_doc object

Hide _doc attribute Show _doc attribute object

order string

Values are asc or desc.

_geo_distance object

Hide _geo_distance attributes Show _geo_distance attributes object

mode string

Values are min, max, sum, avg, or median.

distance_type string

Values are arc or plane.

ignore_unmapped boolean

order string

Values are asc or desc.

unit string

Values are in, ft, yd, mi, nmi, km, m, cm, or mm.

nested object

Hide nested attributes Show nested attributes object

filter object

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

max_children number

nested object

path string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

_script object

Hide _script attributes Show _script attributes object

order string

Values are asc or desc.

script object Required

Hide script attributes Show script attributes object

source

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.

lang

options object

type string

Values are string, number, or version.

mode string

Values are min, max, sum, avg, or median.

nested object

Hide nested attributes Show nested attributes object

filter object

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

max_children number

nested object

path string Required

Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
_source boolean | object

Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
One of:
SourceConfig boolean SourceFilter object
Hide attributes Show attributes

excludes string | array[string]

includes string | array[string]
fields array[object]

An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
Hide fields attributes Show 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
  
  The format in which the values are returned.
- include_unmapped boolean
suggest object
Hide suggest attribute Show suggest attribute object
- text string
  
  Global suggest text, to avoid repetition when the same text is used in several suggesters
terminate_after number

The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.

If set to 0 (default), the query does not terminate early.
timeout string

The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
track_scores boolean

If true, calculate and return document scores, even if the scores are not used for sorting.
version boolean

If true, the request returns the document version as part of a hit.
seq_no_primary_term boolean

If true, the request returns sequence number and primary term of the last modification of each hit.

External documentation
stored_fields string | array[string]
pit object
Hide pit attributes Show pit attributes object
- id string Required
- keep_alive 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.
runtime_mappings object
Hide runtime_mappings attribute Show runtime_mappings 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 SearchRequestBody object
  
  Hide attributes Show attributes
  
  aggregations object
  
  Defines the aggregations that are run as part of the search request.
  
  External documentation
  
  collapse object
  External documentation
  
  explain boolean
  
  If true, the request returns detailed information about score computation as part of a hit.
  
  ext object
  
  Configuration of search extensions defined by Elasticsearch plugins.
  
  Hide ext attribute Show ext attribute object
  
  * object Additional properties
  
  from number
  
  The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
  
  highlight object
  
  track_total_hits boolean | number
  
  Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.
  
  indices_boost array[object]
  
  Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.
  
  External documentation
  
  docvalue_fields array[object]
  
  An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
  
  External documentation
  
  knn object | array[object]
  
  The approximate kNN search to run.
  
  One of:
  KnnSearch object array-2 array[object]
  
  rank object
  
  Hide rank attribute Show rank attribute object
  
  rrf
  
  min_score number
  
  The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.
  
  post_filter object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  profile boolean
  
  Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
  
  query object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  External documentation
  
  rescore array[object]
  
  retriever object
  
  Hide retriever attributes Show retriever attributes object
  
  standard
  
  knn
  
  rrf
  
  text_similarity_reranker
  
  rule
  
  script_fields object
  
  Retrieve a script evaluation (based on different fields) for each hit.
  
  Hide script_fields attribute Show script_fields attribute object
  
  * object Additional properties
  
  search_after array[number | string | boolean | null]
  
  A field value.
  
  size number
  
  The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.
  
  slice object
  
  Hide slice attributes Show slice attributes object
  
  field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  id string Required
  
  max number Required
  
  sort array[string | object]
  
  _source boolean | object
  
  Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
  
  One of:
  SourceConfig boolean SourceFilter object
  
  fields array[object]
  
  An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
  
  suggest object
  
  Hide suggest attribute Show suggest attribute object
  
  text string
  
  Global suggest text, to avoid repetition when the same text is used in several suggesters
  
  terminate_after number
  
  The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.
  
  IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
  
  If set to 0 (default), the query does not terminate early.
  
  timeout string
  
  The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
  
  track_scores boolean
  
  If true, calculate and return document scores, even if the scores are not used for sorting.
  
  version boolean
  
  If true, the request returns the document version as part of a hit.
  
  seq_no_primary_term boolean
  
  If true, the request returns sequence number and primary term of the last modification of each hit.
  
  External documentation
  
  stored_fields string | array[string]
  
  pit object
  
  Hide pit attributes Show pit attributes object
  
  id string Required
  
  keep_alive 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.
  
  runtime_mappings object
  
  stats array[string]
  
  The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.
  
  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.
stats array[string]

The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.

Responses

200 application/json
Hide response attributes Show response attributes object
- 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]
  
  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
- hits object Required
  
  Hide hits attributes Show hits attributes object
  
  total object | number
  
  Total hit count information, present only if track_total_hits wasn't false in the search request.
  
  One of:
  TotalHits object number-2 number
  
  Hide attributes Show attributes
  
  relation string Required
  
  Values are eq or gte.
  
  value number Required
  
  hits array[object] Required
  
  Hide hits attributes Show hits attributes object
  
  _index string Required
  
  _id string
  
  _score number | string | null
  
  One of:
  number-1 number string-2 string | null
  
  _explanation object
  
  Hide _explanation attributes Show _explanation attributes object
  
  description string Required
  
  details array[object] Required
  
  value number Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  highlight object
  
  Hide highlight attribute Show highlight attribute object
  
  * array[string] Additional properties
  
  inner_hits object
  
  Hide inner_hits attribute Show inner_hits attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  hits object Required
  
  matched_queries array[string] | object
  
  One of:
  array-1 array[string] object-2 object
  
  _nested object
  
  Hide _nested attributes Show _nested attributes object
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  offset number Required
  
  _nested object
  
  _ignored array[string]
  
  ignored_field_values object
  
  Hide ignored_field_values attribute Show ignored_field_values attribute object
  
  * array[object] Additional properties
  
  _shard string
  
  _node string
  
  _routing string
  
  _source object
  
  _rank number
  
  _seq_no number
  
  _primary_term number
  
  _version number
  
  sort array[number | string | boolean | null]
  
  A field value.
  
  max_score number | string | null
  
  One of:
  number-1 number string-2 string | null
- 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
  
  Hide details attribute Show details attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  status string Required
  
  Values are running, successful, partial, skipped, or failed.
  
  indices string Required
  
  took number
  
  Time unit for milliseconds
  
  timed_out boolean Required
  
  _shards object
  
  Hide _shards attributes Show _shards attributes object
  
  failed number Required
  
  successful number Required
  
  total number Required
  
  failures array[object]
  
  skipped number
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  index string
  
  node string
  
  reason object Required
  
  shard number Required
  
  status string
- 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
  
  Hide shards attributes Show shards attributes object
  
  aggregations array[object] Required
  
  Hide aggregations attributes Show aggregations attributes object
  
  breakdown object Required
  
  description string Required
  
  time_in_nanos
  
  type string Required
  
  debug object
  
  children array[object]
  
  cluster string Required
  
  dfs object
  
  Hide dfs attributes Show dfs attributes object
  
  statistics object
  
  Hide statistics attributes Show statistics attributes object
  
  type string Required
  
  description string 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_nanos
  
  breakdown object Required
  
  debug object
  
  children array[object]
  
  knn array[object]
  
  fetch object
  
  Hide fetch attributes Show fetch attributes object
  
  type string Required
  
  description string Required
  
  time_in_nanos number
  
  Time unit for nanoseconds
  
  breakdown object Required
  
  Hide breakdown attributes Show breakdown attributes object
  
  load_source number
  
  load_source_count number
  
  load_stored_fields number
  
  load_stored_fields_count number
  
  next_reader number
  
  next_reader_count number
  
  process_count number
  
  process number
  
  debug object
  
  Hide debug attributes Show debug attributes object
  
  stored_fields array[string]
  
  fast_path number
  
  children array[object]
  
  id string Required
  
  index string Required
  
  node_id string Required
  
  searches array[object] Required
  
  Hide searches attributes Show searches attributes object
  
  collector array[object] Required
  
  query array[object] Required
  
  rewrite_time number Required
  
  shard_id number Required
- pit_id string
- _scroll_id string
- suggest object
  
  Hide suggest attribute Show suggest attribute object
  
  * array[object] Additional properties
  
  One of:
  CompletionSuggest object PhraseSuggest object TermSuggest object
  
  Hide attributes Show attributes
  
  length number Required
  
  offset number Required
  
  text string Required
  
  options
- terminated_early boolean

GET /_search

curl \
 --request GET 'http://api.example.com/_search' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"query\": {\n    \"term\": {\n      \"user.id\": \"kimchy\"\n    }\n  }\n}"'

Request examples

Run `GET /my-index-000001/_search?from=40&size=20` to run a search.

{
  "query": {
    "term": {
      "user.id": "kimchy"
    }
  }
}

Run `POST /_search` to run a point in time search. The `id` parameter tells Elasticsearch to run the request using contexts from this open point in time. The `keep_alive` parameter tells Elasticsearch how long it should extend the time to live of the point in time.

{
    "size": 100,  
    "query": {
        "match" : {
            "title" : "elasticsearch"
        }
    },
    "pit": {
      "id":  "46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA==", 
      "keep_alive": "1m"  
    }
}

When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently. The result from running the first `GET /_search` request returns documents belonging to the first slice (`id: 0`). If you run a second request with `id` set to `1', it returns documents in the second slice. Since the maximum number of slices is set to `2`, the union of the results is equivalent to the results of a point-in-time search without slicing.

{
  "slice": {
    "id": 0,                      
    "max": 2                      
  },
  "query": {
    "match": {
      "message": "foo"
    }
  },
  "pit": {
    "id": "46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA=="
  }
}

Response examples (200)

An abbreviated response from `GET /my-index-000001/_search?from=40&size=20` with a simple term query.

{
  "took": 5,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 20,
      "relation": "eq"
    },
    "max_score": 1.3862942,
    "hits": [
      {
        "_index": "my-index-000001",
        "_id": "0",
        "_score": 1.3862942,
        "_source": {
          "@timestamp": "2099-11-15T14:12:12",
          "http": {
            "request": {
              "method": "get"
            },
            "response": {
              "status_code": 200,
              "bytes": 1070000
            },
            "version": "1.1"
          },
          "source": {
            "ip": "127.0.0.1"
          },
          "message": "GET /search HTTP/1.1 200 1070000",
          "user": {
            "id": "kimchy"
          }
        }
      }
    ]
  }
}

Get role mappings Added in 5.5.0

GET /_security/role_mapping

Api key auth Basic auth Bearer auth

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

External documentation

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attributes Show * attributes object
  
  enabled boolean Required
  
  metadata object Required
  
  Hide metadata attribute Show metadata attribute object
  
  * object Additional properties
  
  roles array[string]
  
  role_templates array[object]
  
  Hide role_templates attributes Show role_templates attributes object
  
  format string
  
  Values are string or json.
  
  template object Required
  
  Hide template attributes Show template attributes object
  
  source string | object
  
  One of:
  ScriptSource string SearchRequestBody 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
  
  rules object Required
  
  Hide rules attributes Show rules attributes object
  
  any array[object]
  
  all array[object]
  
  field object
  
  except object

GET /_security/role_mapping

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

Response examples (200)

A successful response from `GET /_security/role_mapping/mapping1`.

{
  "mapping1": {
    "enabled": true,
    "roles": [
      "user"
    ],
    "rules": {
      "field": {
        "username": "*"
      }
    },
    "metadata": {}
  }
}

Get datafeeds Added in 7.7.0

Get cluster repositories metering Technical preview

Get node information Added in 1.3.0

max_content_length number | string

using_compressed_ordinary_object_pointers boolean | string

total_indexing_buffer_in_bytes number | string

Get data stream stats Added in 7.9.0

store_size number | string

total_store_sizes number | string

text string | array[string]

Delete a legacy index template Deprecated

Resolve the cluster Added in 8.13.0

Roll over to a new index Added in 5.0.0

max_size number | string

min_size number | string

max_primary_shard_size number | string

min_primary_shard_size number | string

source string | object

lang string

Create or update an alias Added in 1.3.0

Body Required

aliases string | array[string]

aliases string | array[string]

Get lifecycle policies Added in 6.6.0

modified_date string | number Required

Stop the ILM plugin Added in 6.6.0

Get pipelines Added in 5.0.0

Get data frame analytics job configuration info Added in 7.3.0

Create a trained model Added in 7.10.0

Body Required

create_time string | number

model_size_bytes number | string

size number | string

Get feature migration information Added in 7.16.0

total object | number

_score number | string | null

matched_queries array[string] | object

max_score number | string | null

Open a point in time Added in 7.10.0

Evaluate ranked search results Added in 6.2.0

Body Required

rating number | string | null

type string

knn object | array[object]

filter object | array[object]

type string

sort string | object | array[string | object]

_source boolean | object

rescore object | array[object]

filter object | array[object]

sort string | object | array[string | object]

filter object | array[object]

filter object | array[object]

filter object | array[object]

filter object | array[object]

source string | object

lang string

sort string | object | array[string | object]

source string | object

lang string

_source boolean | object

source string | object

lang string

total object | number

_score number | string | null

matched_queries array[string] | object

max_score number | string | null

Get role mappings Added in 5.5.0

source string | object

lang string