habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP better generated API reference docs

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/api/SearchFieldSuggester.md Normal file
View File

@ -0,0 +1,10 @@
## Interface `SearchFieldSuggester`
| Name | Type | Description |
| - | - | - |
| `completion` | [SearchCompletionSuggester](./SearchCompletionSuggester.md) | Provides auto-complete/search-as-you-type functionality. |
| `phrase` | [SearchPhraseSuggester](./SearchPhraseSuggester.md) | Provides access to word alternatives on a per token basis within a certain string distance. |
| `prefix` | string | Prefix used to search for suggestions. |
| `regex` | string | A prefix expressed as a regular expression. |
| `term` | [SearchTermSuggester](./SearchTermSuggester.md) | Suggests terms based on edit distance. |
| `text` | string | The text to use as input for the suggester. Needs to be set globally or per suggestion. |