Module Assessment | Yext Hitchhikers Platform

You must include a first name and last name in your profile to create challenge environments.

Background

Based on the search terms you’re seeing and feedback from users, both internal and external, you’ve decided to add two new verticals to your Search experience: Help Articles and Menu Items. You’ll want to make sure the Content is set up appropriately and then add each vertical to the Search config.

You already have the data in the platform for both verticals. Remember you added Help Articles using the crawler and a data connector from the brand’s Help Site. Now we’ll want to add saved filters to ensure only complete and approved content is included in Search.

Before you start this challenge, make sure you’ve completed all of the modules in this track. The instructions are meant to challenge you and will provide less detail at each step than in the feature-specific modules. Don’t hesitate to reference past modules if you’re stuck or can’t remember!

Your Challenge

Step 1: Prep the Content

You added the Active on Search custom field after these entity types were added to the platform so you need to go back and add it.
1. Navigate to Content > Configuration and click on Fields, then on the Active On Search field.
2. Next to Entity Type Availability, click the dropdown and check off both Help Articles and Menu Items.
3. Then click Save.
Populate this field for all current Help Articles and Menu Items in the platform and mark Active on Search as Yes. You know all the current content should be on Search, but you may have new content you draft later. Check out the Edit Entities in Bulk help article if you need help.
Add a saved filter for Help Articles called “Help Articles on Search” with the following criteria. Check out the Apply a Filter help article if you need help.
- Entity Type is Help Articles
- Fields with Data includes Body (The Fields with Data filter allows you to filter to only those entities that have the specified field(s) filled out with content. This filter is making sure that only FAQs that have an answer will appear in search results.)
- Active on Search = Yes (This flag allows you to vet and select the entities you want to surface.)
Add a saved filter for Menu Items called “Menu Items on Search” with the following criteria.
- Entity Type is Menu Items
- Fields with Data includes Primary Photo (You don’t want menu items without a photo uploaded to appear in Search. It’ll look wonky in the frontend.)
- Active on Search = Yes

Step 2: Add Help Articles Vertical

You already have the data in the platform that you ingested using the crawler and a data connector from the brand’s Help Site. Navigate to Search > Brand Search > Verticals to add the Help Articles vertical to your search config. You will need to update this in JSON using the following information:
- Use “help_articles” as the verticalKey
- Use “Help Articles” as the name
- Make sure that you use the API name for the entity type (you can find this when you click into an Entity Type from Manage Entity Types).
Add the following as searchable fields and then save your changes:
- Inferred Filter includes Entity type (builtin.entityType)
- Semantic Search includes Name
- Document Search includes Body

Add the saved filter “Help Articles on Search” you just created to the vertical. Your JSON should look like this:

"help_articles": {
  "entityTypes": [
    "helpArticle"
  ],
  "name": "Help Articles",
  "savedSearchId": "[[YOUR_SAVED_FILTER_ID]]",
  "searchableFields": {
    "bodyV2": {
      "documentSearch": true
    },
    "builtin.entityType": {
      "nlpFilter": true
    },
    "name": {
      "semanticTextSearch": true
    }
  },
  "sortBys": [],
  "source": "YEXT"
},

Menu items are also already loaded into the platform. In the Verticals config screen, add the Menu Items vertical to your search config. If you are editing as JSON:
- Use “menu_items” as the verticalKey
- Use “Menu Items” as the name
- Make sure that you use the API name for the entity type (you can find this when you click into an Entity Type from Manage Entity Types).
Add the following as searchable fields and then save your changes:
- Inferred filter includes Entity type (builtin.entityType)
- Semantic Search includes Name
Add the saved filter “Menu Items on Search” you just created to the vertical.
Save the changes to your search configuration.

Step 4: Update Query Suggestions

Update the universal prompts to include a prompt for Help Articles like “where to redeem gift cards” and a prompt for Menu Items like “menu items”. You should now have six universal prompts.
In addition, add a vertical prompt using an embedded [[name]] field for both Help Articles and Menu Items, similar to your existing prompts for the Events and FAQs verticals.
Save the changes to your search configuration.
Run some test searches to view the new Help Articles and Menu Items verticals.

Module Assessment

+<% util.points %> points

Weekly Challenge Streak: <% util.streakWeekly %>

You must include a first name and last name in your profile to create challenge environments.

Challenge account expires in <% util.expirationHours > 24 ? Math.round((util.expirationHours * 1.0) / 24) : util.expirationHours %> <% util.expirationHours > 24 ? (Math.round((util.expirationHours * 1.0) / 24) == 1 ? 'day' : 'days') : (util.expirationHours == 1 ? 'hour' : 'hours') %>.

Challenge account has expired. Please create a new account.

Report Card

Add the Help Articles vertical to the search config

Add searchable fields to the Help Articles vertical

Add the Help Articles on Search saved filter to the Help Articles vertical

Add the Menu Items vertical to the search config

Add searchable fields to the Menu Items vertical

Add the Menu Items on Search saved filter to the Menu Items vertical

Add two universal prompts for the new verticals

Add vertical prompts for Help Articles and Menu Items

Previous Submissions

Attempt #<% submission.attemptNumber %>

<% submission.date %>

Score: <% submission.numericScore %>

Pending

Feedback