predictive
List of the predictive search results.
Arguments
- Anchor to limitlimit•Int
Limits the number of results based on
. The value can range from 1 to 10, and the default is 10.- Anchor to limitScopelimit•Predictive
Scope Search Limit Scope Decides the distribution of results.
- Anchor to queryquery•String!required
The search query.
- Anchor to searchableFieldssearchable•[Searchable
Fields Field!] Specifies the list of resource fields to use for search. The default fields searched on are TITLE, PRODUCT_TYPE, VARIANT_TITLE, and VENDOR. For the best search experience, you should search on the default field set.
The input must not contain more than
250values.- Anchor to typestypes•[Predictive
Search Type!] The types of resources to search for.
The input must not contain more than
250values.- •Search
Unavailable Products Type Specifies how unavailable products are displayed in the search results.
Anchor to Possible returnsPossible returns
- Anchor to PredictiveSearchResultPredictive•Predictive
Search Result Search Result A predictive search result represents a list of products, collections, pages, articles, and query suggestions that matches the predictive search query.