Search API | Hitchhikers Platform
Yext Search is a natural language search engine that allows you to search over your Knowledge Graph using natural language. Using the Search API you can query for entities as well as implement modern search UIs that include: faceting, query suggest, spellcheck and more. The Search API is designed to be called directly from the client to minimize latency.
Note: The Search API is just for querying and searching data. For indexing content in the Knowledge Graph check out our Knowledge Graph API.
In order to use the Search API, you will first need to create a Search Experience. The Search API endpoint contains endpoints for both Universal and Vertical Search.
Universal search is a single API endpoint that searches across all verticals (content types) enabled in the Search Experience.
The Vertical Search endpoints require a
verticalKey and only search one specific vertical (e.g., location or FAQ). If you are creating a modern search UI, generally universal search maps to the “All” tab while the other tabs just search a single vertical.
Universal Autocomplete will retrieve a list of suggested queries across all verticals in the experience based on the characters entered by the user. This API is meant to be hit after each keystroke.
Vertical Autocomplete will retrieve a list of suggested queries for the selected vertical based on the characters entered by the user, or the most popular queries when no user input is given.
Filter Search retrieves a list of potential filters that match the user’s input up to that point. This differs from query suggest, as it only returns the names of filters that can be searched rather than the broader collection of suggested queries.
- Build a Google-like search engine
- Build a store locator
- Build help site search
- Integrate search into a chatbot