Home > @yext/search-core > AutocompleteResult
An autocomplete suggestion.
Signature:
export interface AutocompleteResult | Property | Type | Description |
|---|---|---|
| filter? | FieldValueFilter | (Optional) A filter applied to the autocomplete response. |
| key? | string | (Optional) The fieldId which corresponds to the AutocompleteResult value. |
| matchedSubstrings? | { length: number; offset: number; }[] | (Optional) An array of substrings which overlap with the autocomplete input. |
| relatedItem? | Result | (Optional) An entity that corresponds to the autocomplete result. |
| value | string | The value of an autocomplete suggestion. |
| verticalKeys? | string[] | (Optional) Any vertical keys associated with a prompt. This only shows up on universal autocomplete requests. |