From 20dafe077502f06de2901b4e72fd8e9c2d6c84fe Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 23 Mar 2023 20:35:34 +0000 Subject: [PATCH] Automated update to repo's documentation from github action --- docs/search-core.autocompleteresult.md | 1 + docs/search-core.autocompleteresult.queryintents.md | 13 +++++++++++++ etc/search-core.api.md | 1 + 3 files changed, 15 insertions(+) create mode 100644 docs/search-core.autocompleteresult.queryintents.md diff --git a/docs/search-core.autocompleteresult.md b/docs/search-core.autocompleteresult.md index a84dcaa8..1d29d019 100644 --- a/docs/search-core.autocompleteresult.md +++ b/docs/search-core.autocompleteresult.md @@ -19,6 +19,7 @@ export interface AutocompleteResult | [filter?](./search-core.autocompleteresult.filter.md) | [FieldValueFilter](./search-core.fieldvaluefilter.md) | (Optional) A filter applied to the autocomplete response. | | [key?](./search-core.autocompleteresult.key.md) | string | (Optional) The fieldId which corresponds to the AutocompleteResult value. | | [matchedSubstrings?](./search-core.autocompleteresult.matchedsubstrings.md) | { length: number; offset: number; }\[\] | (Optional) An array of substrings which overlap with the autocomplete input. | +| [queryIntents](./search-core.autocompleteresult.queryintents.md) | [SearchIntent](./search-core.searchintent.md)\[\] | [SearchIntent](./search-core.searchintent.md)s corresponding to the autocomplete result. | | [relatedItem?](./search-core.autocompleteresult.relateditem.md) | [Result](./search-core.result.md) | (Optional) An entity that corresponds to the autocomplete result. | | [value](./search-core.autocompleteresult.value.md) | string | The value of an autocomplete suggestion. | | [verticalKeys?](./search-core.autocompleteresult.verticalkeys.md) | string\[\] | (Optional) Any vertical keys associated with a prompt. This only shows up on universal autocomplete requests. | diff --git a/docs/search-core.autocompleteresult.queryintents.md b/docs/search-core.autocompleteresult.queryintents.md new file mode 100644 index 00000000..954218dd --- /dev/null +++ b/docs/search-core.autocompleteresult.queryintents.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [AutocompleteResult](./search-core.autocompleteresult.md) > [queryIntents](./search-core.autocompleteresult.queryintents.md) + +## AutocompleteResult.queryIntents property + +[SearchIntent](./search-core.searchintent.md)s corresponding to the autocomplete result. + +Signature: + +```typescript +queryIntents: SearchIntent[]; +``` diff --git a/etc/search-core.api.md b/etc/search-core.api.md index 1cbf0217..57d67663 100644 --- a/etc/search-core.api.md +++ b/etc/search-core.api.md @@ -75,6 +75,7 @@ export interface AutocompleteResult { length: number; offset: number; }[]; + queryIntents: SearchIntent[]; relatedItem?: Result; value: string; verticalKeys?: string[];