OpenSearch Query DSL

https://docs.opensearch.org/latest/query-dsl
Admin
OpenSearch Query DSL documentation covering the flexible JSON query language for searching data,...
Tokens:154,280
Snippets:1,127
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Match Phrase Prefix Query Example

Source: https://docs.opensearch.org/latest/query-dsl/full-text/match-phrase-prefix

This section provides a concrete example of using the `match_phrase_prefix` query, including index setup and a query that demonstrates matching documents based on a phrase and a prefix.

```APIDOC
## PUT testindex/_doc/1

### Description
Indexes a document with a title.

### Method
PUT

### Endpoint
testindex/_doc/1

### Request Body
```json
{
  "title": "The wind rises"
}
```

## PUT testindex/_doc/2

### Description
Indexes another document with a title.

### Method
PUT

### Endpoint
testindex/_doc/2

### Request Body
```json
{
  "title": "Gone with the wind"
}
```

## GET testindex/_search

### Description
Searches for documents where the title contains 'wind' followed by a word starting with 'ri'.

### Method
GET

### Endpoint
testindex/_search

### Parameters
#### Query Parameters
- **query** (object) - Required - The query definition.
  - **match_phrase_prefix** (object) - Required - Defines the `match_phrase_prefix` query.
    - **title** (string) - Required - The field to search against and the phrase to match.

### Request Example
```json
{
  "query": {
    "match_phrase_prefix": {
      "title": "wind ri"
    }
  }
}
```

### Response
#### Success Response (200)
(See the 'Match Phrase Prefix Query' section for detailed response structure.)

#### Response Example
```json
{
  "took": 6,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 1,
      "relation": "eq"
    },
    "max_score": 0.92980814,
    "hits": [
      {
        "_index": "testindex",
        "_id": "1",
        "_score": 0.92980814,
        "_source": {
          "title": "The wind rises"
        }
      }
    ]
  }
}
```
```

--------------------------------

### Index Documents for Example

Source: https://docs.opensearch.org/latest/query-dsl/full-text/match-phrase-prefix

These examples show how to index documents into 'testindex'. These documents are used to demonstrate the behavior of the match_phrase_prefix query.

```json
PUT testindex/_doc/1
{
  "title": "The wind rises"
}
```

```json
PUT testindex/_doc/2
{
  "title": "Gone with the wind"
  
}
```

--------------------------------

### Index Sample Documents for Combined Fields Query

Source: https://docs.opensearch.org/latest/query-dsl/full-text/combined-fields

Use the _bulk API to index sample documents into the 'books' index. This setup is required to follow along with the combined_fields query examples.

```json
POST /books/_bulk
{"index":{"_id":"1"}}
{"title":"Database Systems","description":"A comprehensive guide to database design and implementation"}
{"index":{"_id":"2"}}
{"title":"Introduction to Systems","description":"This book covers database architectures and distributed systems"}

```

--------------------------------

### Index Example Documents

Source: https://docs.opensearch.org/latest/query-dsl/specialized/script

Indexes three example documents into the 'products' index using the bulk API. Each document includes a title, price, and rating.

```json
POST /products/_bulk
{
  "index": { "_id": 1 }
}
{ "title": "Wireless Earbuds", "price": 99.99, "rating": 4.5 }
{
  "index": { "_id": 2 }
}
{ "title": "Bluetooth Speaker", "price": 79.99, "rating": 4.8 }
{
  "index": { "_id": 3 }
}
{ "title": "Noise Cancelling Headphones", "price": 199.99, "rating": 4.7 }

```

--------------------------------

### OpenSearch Span or Query Example

Source: https://docs.opensearch.org/latest/query-dsl/span/span-or

Searches for either 'formal collar' or 'button collar' appearing within a specified slop distance. Requires setup steps to be completed before execution.

```json
GET /clothing/_search
{
  "query": {
    "span_or": {
      "clauses": [
        {
          "span_near": {
            "clauses": [
              {
                "span_term": {
                  "description": "formal"
                }
              },
              {
                "span_term": {
                  "description": "collar"
                }
              }
            ],
            "slop": 0,
            "in_order": true
          }
        },
        {
          "span_near": {
            "clauses": [
              {
                "span_term": {
                  "description": "button"
                }
              },
              {
                "span_term": {
                  "description": "collar"
                }
              }
            ],
            "slop": 2,
            "in_order": true
          }
        }
      ]
    }
  }
}
```

--------------------------------

### Regexp Query Example

Source: https://docs.opensearch.org/latest/query-dsl/term/regexp

This example demonstrates how to use the regexp query to find terms starting with an uppercase or lowercase letter followed by 'amlet'.

```APIDOC
## GET shakespeare/_search

### Description
Searches for terms in the `play_name` field that match the regular expression `[a-zA-Z]amlet`.

### Method
GET

### Endpoint
`/shakespeare/_search`

### Query Parameters
- **query** (object) - Required - The query definition.
  - **regexp** (object) - Required - The regexp query definition.
    - **play_name** (object) - Required - The field to search within.
      - **value** (string) - Required - The regular expression pattern.
      - **boost** (float) - Optional - A floating-point value that specifies the weight of this field toward the relevance score. Default is 1.0.
      - **case_insensitive** (boolean) - Optional - If true, allows case-insensitive matching. Default is false.
      - **flags** (string) - Optional - Enables optional operators for Lucene’s regular expression engine.
      - **max_determinized_states** (integer) - Optional - Specifies the maximum number of automaton states the query requires. Default is 10,000.
      - **rewrite** (string) - Optional - Determines how OpenSearch rewrites and scores multi-term queries. Default is `constant_score`.

### Request Example
```json
{
  "query": {
    "regexp": {
      "play_name": "[a-zA-Z]amlet"
    }
  }
}
```

### Response
#### Success Response (200)
- **took** (integer) - Time in milliseconds for the search to execute.
- **timed_out** (boolean) - Indicates if the request timed out.
- **hits** (object) - Contains the search results.
  - **total** (object) - Information about the total number of hits.
    - **value** (integer) - The total number of hits.
    - **relation** (string) - The relation of the total value to the number of hits (e.g., 'eq' for equal).
  - **max_score** (float) - The maximum score for this query.
  - **hits** (array) - An array of search hit objects.
    - **_index** (string) - The name of the index.
    - **_id** (string) - The ID of the document.
    - **_score** (float) - The score of the document.
    - **_source** (object) - The source fields of the document.
      - **play_name** (string) - The name of the play.
      - **line_id** (integer) - The ID of the line.
      - **line_number** (integer) - The line number.
      - **speaker** (string) - The speaker of the line.
      - **text_entry** (string) - The text of the line.

#### Response Example
```json
{
  "took": 5,
  "timed_out": false,
  "hits": {
    "total": {
      "value": 1,
      "relation": "eq"
    },
    "max_score": 1.0,
    "hits": [
      {
        "_index": "shakespeare",
        "_id": "_aBcDeF",
        "_score": 1.0,
        "_source": {
          "play_name": "Hamlet",
          "line_id": 1,
          "line_number": 1,
          "speaker": "Enter Ghost",
          "text_entry": ""
        }
      }
    ]
  }
}
```
```

--------------------------------

### Example Search Results

Source: https://docs.opensearch.org/latest/query-dsl/query-dsl/minimum-should-match

These are example search results for the provided queries, illustrating the documents returned based on the query logic.

```json
{
  "took": 34,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 5,
      "relation": "eq"
    },
    "max_score": 2.494999,
    "hits": [
      {
        "_index": "testindex",
        "_id": "4",
        "_score": 2.494999,
        "_source": {
          "text": "one two three four OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "3",
        "_score": 1.5744598,
        "_source": {
          "text": "one two three OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "2",
        "_score": 0.91368985,
        "_source": {
          "text": "one two OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "1",
        "_score": 0.4338556,
        "_source": {
          "text": "one OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "5",
        "_score": 0.11964063,
        "_source": {
          "text": "OpenSearch"
        }
      }
    ]
  }
}
```

```json
{
  "took": 19,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 4,
      "relation": "eq"
    },
    "max_score": 2.426633,
    "hits": [
      {
        "_index": "testindex",
        "_id": "4",
        "_score": 2.426633,
        "_source": {
          "text": "one two three four OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "3",
        "_score": 1.4978898,
        "_source": {
          "text": "one two three OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "2",
        "_score": 0.8266785,
        "_source": {
          "text": "one two OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "1",
        "_score": 0.3331056,
        "_source": {
          "text": "one OpenSearch"
        }
      }
    ]
  }
}
```

--------------------------------

### Example Search Results

Source: https://docs.opensearch.org/latest/query-dsl/minimum-should-match

These are example results for a query containing both `must` and `should` clauses, demonstrating documents that match the required term and optionally match the `should` terms.

```json
{
  "took": 34,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 5,
      "relation": "eq"
    },
    "max_score": 2.494999,
    "hits": [
      {
        "_index": "testindex",
        "_id": "4",
        "_score": 2.494999,
        "_source": {
          "text": "one two three four OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "3",
        "_score": 1.5744598,
        "_source": {
          "text": "one two three OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "2",
        "_score": 0.91368985,
        "_source": {
          "text": "one two OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "1",
        "_score": 0.4338556,
        "_source": {
          "text": "one OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "5",
        "_score": 0.11964063,
        "_source": {
          "text": "OpenSearch"
        }
      }
    ]
  }
}
```

--------------------------------

### Index Example Documents

Source: https://docs.opensearch.org/latest/query-dsl/specialized/rank-feature

Example of indexing documents with varying 'popularity' values into the 'products' index.

```APIDOC
## Index Example Documents

### Description
Adds sample products with varying popularity values to the 'products' index.

### Method
POST

### Endpoint
`/products/_bulk`

### Request Body
```json
{
  "index": { "_id": 1 }
}
{
  "title": "Wireless Earbuds",
  "popularity": 1
}
{
  "index": { "_id": 2 }
}
{
  "title": "Bluetooth Speaker",
  "popularity": 10
}
{
  "index": { "_id": 3 }
}
{
  "title": "Portable Charger",
  "popularity": 25
}
{
  "index": { "_id": 4 }
}
{
  "title": "Smartwatch",
  "popularity": 50
}
{
  "index": { "_id": 5 }
}
{
  "title": "Noise Cancelling Headphones",
  "popularity": 100
}
{
  "index": { "_id": 6 }
}
{
  "title": "Gaming Laptop",
  "popularity": 250
}
{
  "index": { "_id": 7 }
}
{
  "title": "4K Monitor",
  "popularity": 500
}
```
```

--------------------------------

### Hybrid query response example

Source: https://docs.opensearch.org/latest/query-dsl/compound/hybrid

Example response showing scores after applying a rescore boost.

```json
{
  "took": 30,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 3,
      "relation": "eq"
    },
    "max_score": 0.95,
    "hits": [
      {
        "_index": "my-index",
        "_id": "1",
        "_score": 0.95,
        "_source": {
          "title": "Building a search engine",
          "description": "A guide to modern search engine architecture"
        }
      },
      {
        "_index": "my-index",
        "_id": "2",
        "_score": 0.67,
        "_source": {
          "title": "Introduction to search",
          "description": "Learn about search engine basics"
        }
      },
      {
        "_index": "my-index",
        "_id": "3",
        "_score": 0.42,
        "_source": {
          "title": "Database engine tuning",
          "description": "How to optimize your search queries"
        }
      }
    ]
  }
}
```

--------------------------------

### Search Response Example

Source: https://docs.opensearch.org/latest/query-dsl/span/span-multi-term

This is an example response from an OpenSearch search query, showing the hits found and their scores.

```json
{
  "took": 5,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 1.7590723,
    "hits": [
      {
        "_index": "clothing",
        "_id": "1",
        "_score": 1.7590723,
        "_source": {
          "description": "Long-sleeved dress shirt with a formal collar and button cuffs. "
        }
      },
      {
        "_index": "clothing",
        "_id": "4",
        "_score": 0.84792376,
        "_source": {
          "description": "A set of two midi silk shirt dresses with long fluttered sleeves in black. "
        }
      }
    ]
  }
}
```

--------------------------------

### OpenSearch Response Example

Source: https://docs.opensearch.org/latest/query-dsl/span/span-field-masking

This is an example response from an OpenSearch search query, showing the documents that matched the query criteria.

```json
{
  "took": 7,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 0.7444251,
    "hits": [
      {
        "_index": "clothing",
        "_id": "1",
        "_score": 0.7444251,
        "_source": {
          "description": "Long-sleeved dress shirt with a formal collar and button cuffs. "
        }
      },
      {
        "_index": "clothing",
        "_id": "4",
        "_score": 0.4291246,
        "_source": {
          "description": "A set of two midi silk shirt dresses with long fluttered sleeves in black. "
        }
      }
    ]
  }
}
```

--------------------------------

### Search Response Example

Source: https://docs.opensearch.org/latest/query-dsl/compound/constant-score

This is an example of a search response, showing document hits, their scores, and source data.

```json
{
  "took": 8,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 96,
      "relation": "eq"
    },
    "max_score": 1.2,
    "hits": [
      {
        "_index": "shakespeare",
        "_id": "32535",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32536,
          "play_name": "Hamlet",
          "speech_number": 48,
          "line_number": "1.1.97",
          "speaker": "HORATIO",
          "text_entry": "Dared to the combat; in which our valiant Hamlet--"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32546",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32547,
          "play_name": "Hamlet",
          "speech_number": 48,
          "line_number": "1.1.108",
          "speaker": "HORATIO",
          "text_entry": "His fell to Hamlet. Now, sir, young Fortinbras,"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32625",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32626,
          "play_name": "Hamlet",
          "speech_number": 59,
          "line_number": "1.1.184",
          "speaker": "HORATIO",
          "text_entry": "Unto young Hamlet; for, upon my life,"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32633",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32634,
          "play_name": "Hamlet",
          "speech_number": 60,
          "line_number": "",
          "speaker": "MARCELLUS",
          "text_entry": "Enter KING CLAUDIUS, QUEEN GERTRUDE, HAMLET,  POLONIUS, LAERTES, VOLTIMAND, CORNELIUS, Lords, and Attendants"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32634",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32635,
          "play_name": "Hamlet",
          "speech_number": 1,
          "line_number": "1.2.1",
          "speaker": "KING CLAUDIUS",
          "text_entry": "Though yet of Hamlet our dear brothers death"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32699",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32700,
          "play_name": "Hamlet",
          "speech_number": 8,
          "line_number": "1.2.65",
          "speaker": "KING CLAUDIUS",
          "text_entry": "But now, my cousin Hamlet, and my son,--"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32703",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32704,
          "play_name": "Hamlet",
          "speech_number": 12,
          "line_number": "1.2.69",
          "speaker": "QUEEN GERTRUDE",
          "text_entry": "Good Hamlet, cast thy nighted colour off,"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32723",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32724,
          "play_name": "Hamlet",
          "speech_number": 16,
          "line_number": "1.2.89",
          "speaker": "KING CLAUDIUS",
          "text_entry": "Tis sweet and commendable in your nature, Hamlet,"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32754",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32755,
          "play_name": "Hamlet",
          "speech_number": 17,
          "line_number": "1.2.120",
          "speaker": "QUEEN GERTRUDE",
          "text_entry": "Let not thy mother lose her prayers, Hamlet:"
        }
      },
      {
        "_index": "shakespeare",
        "_id": "32759",
        "_score": 1.2,
        "_source": {
          "type": "line",
          "line_id": 32760,
          "play_name": "Hamlet",
          "speech_number": 19,
          "line_number": "1.2.125",
          "speaker": "KING CLAUDIUS",
          "text_entry": "This gentle and unforced accord of Hamlet"
        }
      }
    ]
  }
}
```

--------------------------------

### Example Search Results (Only Should)

Source: https://docs.opensearch.org/latest/query-dsl/minimum-should-match

These are example results for a query containing only `should` clauses, demonstrating documents that match at least one of the optional terms.

```json
{
  "took": 19,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 4,
      "relation": "eq"
    },
    "max_score": 2.426633,
    "hits": [
      {
        "_index": "testindex",
        "_id": "4",
        "_score": 2.426633,
        "_source": {
          "text": "one two three four OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "3",
        "_score": 1.4978898,
        "_source": {
          "text": "one two three OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "2",
        "_score": 0.8266785,
        "_source": {
          "text": "one two OpenSearch"
        }
      },
      {
        "_index": "testindex",
        "_id": "1",
        "_score": 0.3331056,
        "_source": {
          "text": "one OpenSearch"
        }
      }
    ]
  }
}
```

--------------------------------

### Search Response Example

Source: https://docs.opensearch.org/latest/query-dsl/compound/bool

This is an example of a successful search response, showing the total time taken, shard status, and the matching documents with their scores and source data.

```json
{
  "took": 10,
  "timed_out": false,
  "_shards": {
    "total": 2,
    "successful": 2,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": 1,
    "max_score": 11.37006,
    "hits": [
      {
        "_index": "shakespeare",
        "_type": "doc",
        "_id": "88020",
        "_score": 11.37006,
        "_source": {
          "type": "line",
          "line_id": 88021,
          "play_name": "Romeo and Juliet",
          "speech_number": 19,
          "line_number": "4.5.61",
          "speaker": "PARIS",
          "text_entry": "O love! O life! not life, but love in death!"
        }
      }
    ]
  }
}
```

--------------------------------

### Search Results Example

Source: https://docs.opensearch.org/latest/query-dsl/full-text/multi-match

This is an example of the search results returned by the best_fields query, showing document scores and source data.

```json
{
  "took": 30,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 0.84407747,
    "hits": [
      {
        "_index": "articles",
        "_id": "1",
        "_score": 0.84407747,
        "_source": {
          "title": "Aurora borealis",
          "description": "Northern lights, or aurora borealis, explained"
        }
      },
      {
        "_index": "articles",
        "_id": "2",
        "_score": 0.6322521,
        "_source": {
          "title": "Sun deprivation in the Northern countries",
          "description": "Using fluorescent lights for therapy"
        }
      }
    ]
  }
}
```

--------------------------------

### Example Search Results for More Like This Query

Source: https://docs.opensearch.org/latest/query-dsl/specialized/more-like-this

This is an example of the search results returned by a more_like_this query, showing documents that are most similar to the provided sources.

```json
{
  "...",
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 2.140194,
    "hits": [
      {
        "_index": "articles-optimized",
        "_id": "a1",
        "_score": 2.140194,
        "_source": {
          "name": "Diana",
          "alias": "Wonder Woman",
          "quote": "Justice will come when it is deserved."
        }
      },
      {
        "_index": "articles-optimized",
        "_id": "a2",
        "_score": 1.1596459,
        "_source": {
          "name": "Clark",
          "alias": "Superman",
          "quote": "Even in the darkest times, hope cuts through."
        }
      }
    ]
  }
}
```

--------------------------------

### Regexp Query Parameters

Source: https://docs.opensearch.org/latest/query-dsl/term/regexp

This example shows the general structure for a regexp query and details its parameters.

```APIDOC
## GET _search

### Description
Allows specifying a regexp query with various parameters for fine-grained control over the search.

### Method
GET

### Endpoint
`/_search`

### Query Parameters
- **query** (object) - Required - The query definition.
  - **regexp** (object) - Required - The regexp query definition.
    - **`<field>`** (object) - Required - The name of the field to search within. This is a placeholder for the actual field name.
      - **value** (string) - Required - The regular expression used for matching terms in the field.
      - **boost** (float) - Optional - A floating-point value that specifies the weight of this field toward the relevance score. Values above 1.0 increase the field’s relevance. Values between 0.0 and 1.0 decrease the field’s relevance. Default is 1.0.
      - **case_insensitive** (boolean) - Optional - If `true`, allows case-insensitive matching of the regular expression value with the indexed field values. Default is `false` (case sensitivity is determined by the field’s mapping).
      - **flags** (string) - Optional - Enables optional operators for Lucene’s regular expression engine. For valid values, see Optional operators.
      - **max_determinized_states** (integer) - Optional - Lucene converts a regular expression to an automaton with a number of determinized states. This parameter specifies the maximum number of automaton states the query requires. Use this parameter to prevent high resource consumption. To run complex regular expressions, you may need to increase the value of this parameter. Default is 10,000.
      - **rewrite** (string) - Optional - Determines how OpenSearch rewrites and scores multi-term queries. Valid values are `constant_score`, `scoring_boolean`, `constant_score_boolean`, `top_terms_N`, `top_terms_boost_N`, and `top_terms_blended_freqs_N`. Default is `constant_score`.

### Request Example
```json
GET _search
{
  "query": {
    "regexp": {
      "<field>": {
        "value": "[Ss]ample",
        "case_insensitive": true,
        "flags": "COMMENTS"
      }
    }
  }
}
```

### Response
#### Success Response (200)
- **took** (integer) - Time in milliseconds for the search to execute.
- **timed_out** (boolean) - Indicates if the request timed out.
- **hits** (object) - Contains the search results.
  - **total** (object) - Information about the total number of hits.
    - **value** (integer) - The total number of hits.
    - **relation** (string) - The relation of the total value to the number of hits (e.g., 'eq' for equal).
  - **max_score** (float) - The maximum score for this query.
  - **hits** (array) - An array of search hit objects.
    - **_index** (string) - The name of the index.
    - **_id** (string) - The ID of the document.
    - **_score** (float) - The score of the document.
    - **_source** (object) - The source fields of the document.

#### Response Example
```json
{
  "took": 10,
  "timed_out": false,
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 1.5,
    "hits": [
      {
        "_index": "my-index",
        "_id": "doc1",
        "_score": 1.5,
        "_source": {
          "my_field": "Example"
        }
      },
      {
        "_index": "my-index",
        "_id": "doc2",
        "_score": 1.0,
        "_source": {
          "my_field": "sample"
        }
      }
    ]
  }
}
```
```

--------------------------------

### Example k-NN Explain Response

Source: https://docs.opensearch.org/latest/query-dsl/specialized/k-nn/k-nn-explain

This is an example of the detailed explanation provided by the k-NN explain API for an Approximate k-NN search, showing score calculation and normalization details.

```json
{
  "took": 216038,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 88.4,
    "hits": [
      {
        "_shard": "[my-knn-index-1][0]",
        "_node": "VHcyav6OTsmXdpsttX2Yug",
        "_index": "my-knn-index-1",
        "_id": "5",
        "_score": 88.4,
        "_source": {
          "my_vector1": [
            2.5,
            3.5,
            5.5,
            7.4
          ],
          "price": 8.9
        },
        "_explanation": {
          "value": 88.4,
          "description": "the type of knn search executed was Approximate-NN",
          "details": [
            {
              "value": 88.4,
              "description": "the type of knn search executed at leaf was Approximate-NN with vectorDataType = FLOAT, spaceType = innerproduct where score is computed as `-rawScore + 1` from:",
              "details": [
                {
                  "value": -87.4,
                  "description": "rawScore, returned from FAISS library",
                  "details": []
                }
              ]
            }
          ]
        }
      },
      {
        "_shard": "[my-knn-index-1][0]",
        "_node": "VHcyav6OTsmXdpsttX2Yug",
        "_index": "my-knn-index-1",
        "_id": "2",
        "_score": 84.7,
        "_source": {
          "my_vector1": [
            2.5,
            3.5,
            5.6,
            6.7
          ],
          "price": 5.5
        },
        "_explanation": {
          "value": 84.7,
          "description": "the type of knn search executed was Approximate-NN",
          "details": [
            {
              "value": 84.7,
              "description": "the type of knn search executed at leaf was Approximate-NN with vectorDataType = FLOAT, spaceType = innerproduct where score is computed as `-rawScore + 1` from:",
              "details": [
                {
                  "value": -83.7,
                  "description": "rawScore, returned from FAISS library",
                  "details": []
                }
              ]
            }
          ]
        }
      }
    ]
  }
}
```

--------------------------------

### Example Response for k-NN Search

Source: https://docs.opensearch.org/latest/query-dsl/specialized/k-nn/k-nn-explain

This is an example response structure for a k-NN search query that includes explanations for the scoring and matching process.

```json
{
  "took" : 51,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 2,
      "relation" : "eq"
    },
    "max_score" : 84.7,
    "hits" : [
      {
        "_shard" : "[my-knn-index-1][0]",
        "_node" : "c9b4aPe4QGO8eOtb8P5D3g",
        "_index" : "my-knn-index-1",
        "_id" : "7",
        "_score" : 84.7,
        "_source" : {
          "my_vector2" : [
            2.5,
            3.5,
            5.6,
            6.7
          ],
          "price" : 5.5
        },
        "_explanation" : {
          "value" : 84.7,
          "description" : "sum of:",
          "details" : [
            {
              "value" : 84.7,
              "description" : "the type of knn search executed was Approximate-NN",
              "details" : [
                {
                  "value" : 84.7,
                  "description" : "the type of knn search executed at leaf was Approximate-NN with vectorDataType = FLOAT, spaceType = innerproduct where score is computed as `-rawScore + 1` from:",
                  "details" : [
                    {
                      "value" : -83.7,
                      "description" : "rawScore, returned from FAISS library",
                      "details" : [ ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      },
      {
        "_shard" : "[my-knn-index-1][0]",
        "_node" : "c9b4aPe4QGO8eOtb8P5D3g",
        "_index" : "my-knn-index-1",
        "_id" : "8",
        "_score" : 83.2,
        "_source" : {
          "my_vector2" : [
            4.5,
            5.5,
            6.7,
            3.7
          ],
          "price" : 4.4
        },
        "_explanation" : {
          "value" : 83.2,
          "description" : "sum of:",
          "details" : [
            {
              "value" : 82.2,
              "description" : "the type of knn search executed was Approximate-NN",
              "details" : [
                {
                  "value" : 82.2,
                  "description" : "the type of knn search executed at leaf was Approximate-NN with vectorDataType = FLOAT, spaceType = innerproduct where score is computed as `-rawScore + 1` from:",
                  "details" : [
                    {
                      "value" : -81.2,
                      "description" : "rawScore, returned from FAISS library",
                      "details" : [ ]
                    }
                  ]
                }
              ]
            },
            {
              "value" : 1.0,
              "description" : "price:[1082969293 TO 1082969293]",
              "details" : [ ]
            }
          ]
        }
      }
    ]
  }
}
```

--------------------------------

### Example Search Results

Source: https://docs.opensearch.org/latest/query-dsl/regex-syntax

This is an example of the search results returned by the regexp query using the ANYSTRING and INTERSECTION flags. It shows documents that matched the specified patterns.

```json
{
  "took": 20,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 1,
    "hits": [
      {
        "_index": "logs",
        "_id": "1",
        "_score": 1,
        "_source": {
          "message": "error404"
        }
      },
      {
        "_index": "logs",
        "_id": "2",
        "_score": 1,
        "_source": {
          "message": "error500"
        }
      }
    ]
  }
}

```

--------------------------------

### Intervals Query Example

Source: https://docs.opensearch.org/latest/query-dsl/full-text/intervals

This example demonstrates how to use the intervals query to search for documents containing specific phrases with defined order and gap constraints.

```APIDOC
## GET /testindex/_search

### Description
Searches for documents containing the phrase `key-value pairs` (with no gap separating the terms) followed by either `hash table` or `hash map`.

### Method
GET

### Endpoint
/testindex/_search

### Request Body
```json
{
  "query": {
    "intervals": {
      "title": {
        "all_of": {
          "ordered": true,
          "intervals": [
            {
              "match": {
                "query": "key-value pairs",
                "max_gaps": 0,
                "ordered": true
              }
            },
            {
              "any_of": {
                "intervals": [
                  {
                    "match": {
                      "query": "hash table"
                    }
                  },
                  {
                    "match": {
                      "query": "hash map"
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}
```

### Response
#### Success Response (200)
- **took** (integer) - Time in milliseconds for the search to complete.
- **timed_out** (boolean) - Indicates if the search timed out.
- **_shards** (object) - Information about the shards processed.
  - **total** (integer) - Total number of shards.
  - **successful** (integer) - Number of successful shards.
  - **skipped** (integer) - Number of skipped shards.
  - **failed** (integer) - Number of failed shards.
- **hits** (object) - Contains the search results.
  - **total** (object) - Information about the total number of hits.
    - **value** (integer) - The total number of hits.
    - **relation** (string) - Relation of the total value to the number of hits (e.g., 'eq').
  - **max_score** (float) - The maximum score of the hits.
  - **hits** (array) - An array of hit objects.
    - **_index** (string) - The index the hit belongs to.
    - **_id** (string) - The ID of the hit document.
    - **_score** (float) - The score of the hit.
    - **_source** (object) - The source fields of the hit document.
      - **title** (string) - The title field of the document.

#### Response Example
```json
{
  "took": 1011,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 0.25,
    "hits": [
      {
        "_index": "testindex",
        "_id": "2",
        "_score": 0.25,
        "_source": {
          "title": "store key-value pairs in a hash map"
        }
      },
      {
        "_index": "testindex",
        "_id": "1",
        "_score": 0.14285713,
        "_source": {
          "title": "key-value pairs are efficiently stored in a hash table"
        }
      }
    ]
  }
}
```
```

--------------------------------

### Example Response for Has Parent Query

Source: https://docs.opensearch.org/latest/query-dsl/joining/has-parent

This is an example response when the has_parent query successfully finds matching child documents. It includes details about the search execution and the retrieved documents.

```json
{
  "took": 11,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 1,
    "hits": [
      {
        "_index": "testindex1",
        "_id": "4",
        "_score": 1,
        "_routing": "2",
        "_source": {
          "name": "Electronic watch",
          "sales_count": 300,
          "product_to_brand": {
            "name": "product",
            "parent": "2"
          }
        }
      },
      {
        "_index": "testindex1",
        "_id": "5",
        "_score": 1,
        "_routing": "2",
        "_source": {
          "name": "Digital watch",
          "sales_count": 100,
          "product_to_brand": {
            "name": "product",
            "parent": "2"
          }
        }
      }
    ]
  }
}

```

--------------------------------

### Index Document with Multiple Fields

Source: https://docs.opensearch.org/latest/query-dsl/term/exists

Example of indexing a document with 'title' and 'description' fields.

```json
PUT testindex/_doc/2
{
  "title": "Gone with the wind",
  "description": "A 1939 American epic historical film"
}
```
Tokens:
Raw