predictive
Returns suggested results as customers type in a search field, enabling type-ahead search experiences. The query matches products, collections, pages, and articles based on partial search terms, and also provides search query suggestions to help customers refine their search.
You can filter results by resource type and limit the quantity. The argument controls whether limits apply across all result types or per type. Use to control how out-of-stock products appear in results.
Arguments
- limit (Int)
- limitScope (PredictiveSearchLimitScope)
- query (String!)
- searchableFields ([SearchableField!])
- types ([PredictiveSearchType!])
- unavailableProducts (SearchUnavailableProductsType)
- 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
- PredictiveSearchResult (PredictiveSearchResult)
- Anchor to PredictiveSearchResultPredictive•Predictive
Search Result Search Result Returned by the
query to power type-ahead search experiences. Includes matchingProduct,Collection,Page, andArticleobjects, along with query suggestions that help customers refine their search.- Anchor to articlesarticles•[Article!]!non-null
The articles that match the search query.
- Anchor to collectionscollections•[Collection!]!non-null
The articles that match the search query.
- Anchor to pagespages•[Page!]!non-null
The pages that match the search query.
- Anchor to productsproducts•[Product!]!non-null
The products that match the search query.
- Anchor to queriesqueries•[Search
Query Suggestion!]! non-null The query suggestions that are relevant to the search query.