Search Instruction Type | Yext Hitchhikers Platform
A search step uses a Yext Search experience to look up relevant information from the Yext Content. Yext Search can be used for a variety of different applications:
- Looking up documentation, help articles
- Looking up relevant products based on attributes or user preferences
- Looking up physical locations (stores, hospitals, bank branches, etc.)
- Looking up people (doctors, financial advisors, insurance agents, etc.)
Search steps are commonly used in conjunction with DIRECT_ANSWER reply steps to faithfully respond to users’ questions using data from Yext Content.
The search step also has additional configurable options:
included/excludedVerticals- allows you to restrict the verticals of the Yext Search experience that the chat bot will considers.included/excludedFields- allows you to restrict the fields of each entity returned from Search that the chat bot will consider in its response.
Example
{
"search": {
"searchExperienceKey": "my-search-experience",
"includedFields": ["title", "body", "question", "answer"],
"includedVerticals": ["helpArticles", "faqs"]
}
}
<% elem.innerText %>