WIP better generated API reference docs

This commit is contained in:
Josh Mock
2025-05-27 15:30:21 -05:00
parent a1dc6f55ee
commit b627037af1
3745 changed files with 30211 additions and 15508 deletions

View File

@ -0,0 +1,17 @@
## Interface `QueryDslSimpleQueryStringQuery`
| Name | Type | Description |
| - | - | - |
| `analyze_wildcard` | boolean | If `true`, the query attempts to analyze wildcard terms in the query string. |
| `analyzer` | string | Analyzer used to convert text in the query string into tokens. |
| `auto_generate_synonyms_phrase_query` | boolean | If `true`, the parser creates a match_phrase query for each multi-position token. |
| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | Default boolean logic used to interpret text in the query string if no operators are specified. |
| `fields` | [Field](./Field.md)[] | Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret ( `^`) notation. Defaults to the `index.query.default_field index` setting, which has a default value of `*`. |
| `flags` | [QueryDslSimpleQueryStringFlags](./QueryDslSimpleQueryStringFlags.md) | List of enabled operators for the simple query string syntax. |
| `fuzzy_max_expansions` | [integer](./integer.md) | Maximum number of terms to which the query expands for fuzzy matching. |
| `fuzzy_prefix_length` | [integer](./integer.md) | Number of beginning characters left unchanged for fuzzy matching. |
| `fuzzy_transpositions` | boolean | If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). |
| `lenient` | boolean | If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. |
| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Minimum number of clauses that must match for a document to be returned. |
| `query` | string | Query string in the simple query string syntax you wish to parse and use for search. |
| `quote_field_suffix` | string | Suffix appended to quoted text in the query string. |