Search Configuration Overview | Yext Hitchhikers Platform

What You’ll Learn

In this section, you will learn:

  • Search Configuration Overview
  • Frontend vs. Backend
  • Editing Search Configuration: UI and JSON
  • Navigating to Search Configuration

Search Configuration Overview

As you learned in the Overview of Search Infrastructure module, there are three levers that control how search results are returned in Search. The first is the Knowledge Graph, which is where you will define the data model and manage the core entity data. The second is the Search algorithm itself, which is managed by Yext. The third is the Search Configuration, which you will learn about in this module.

The Search Configuration (“config” or “configuration” for short!) is a backend tool that allows an Administrator to define business rules and search logic, which feed into the overall Search algorithm. Within the Search Configuration, an Administrator will define verticals, control which entities flow into the experience, determine how entities are sorted and ranked, set up various filters, create synonyms, and much more.

search quality levers diagram

You will typically begin building your Search Configuration shortly after you kick off the project. The prerequisite to building the Search Configuration file is that you have an underlying Knowledge Graph set up – so entity types, entity relationships, and custom fields are activated and entity data is loaded in.

Once your Knowledge Graph is ready to be configured in a search experience, all you have to do is navigate to Search in the navigation bar of the platform (more to come on this in Unit 3!) and create and edit the Search Configuration.

When you are ready to begin building the Search Configuration, you can navigate to Search > All Experiences in the Yext platform. By clicking “Add Experience”, you will begin the process of setting up your configuration via the Yext platform. You will be prompted and guided through the set up process when you begin creating your Search Configuration.

Frontend vs. Backend

Because the Search Configuration is on the backend, you are setting up the underlying data and business logic for the search experience. It is not a frontend control. You will learn about the frontend in future modules, which will allows you to define the display, colors, branding, etc. of the data being surfaced in the experience.

diagram backend frontend

When you edit the configuration in the UI, you will be able to test various queries in real-time with Test Search. Test Search, is a platform tool we offer so you can test queries and review various changes you make to your configuration (i.e., the backend), without needing to go to your frontend or live preview. For example, if you add a synonym or Query Rule to the backend through your Search Configuration, you can quickly preview the logic change on the right side of your screen.

With Test Search, you’ll be able to preview changes to your config in real-time, including activating featured snippets, applying NLP filters, and more. You can learn more about Test Search features in the following unit .

Note that Test Search is not a preview of your actual Search frontend build. You will learn how to create a full Search frontend and add branding, styling, fonts, etc. in future tracks. You will ultimately apply your backend Search Configuration to your frontend thereby creating a full, consumer-facing search experience.

navigating to search configuration

Search Configuration UI and Search Configuration JSON

By default, you will set up your Search Configuration via the UI in the Yext platform. The UI will allow you to quickly set up a configuration that pulls in the relevant verticals, entities, searchable fields (more to come on this!), synonyms, hardcoded prompts, and more.

Within the platform, you can optionally edit the configuration in JSON. Simply click “Edit as JSON” within the configuration and begin making edits. Make sure to always save your configuration edits before toggling between UI and JSON formats. You can learn more about JSON syntax in the JSON Module .

navigating to search configuration

The UI and JSON editor will always mirror each other and be in sync. Ultimately, it will be your choice on how you want to edit the configuration, either through the UI or with JSON syntax. Throughout the training, we will provide guidance on how to edit the configuration with either method.

light bulb
Some Search configuration features might only be available via the JSON editor. We will make sure to list out JSON-only features in the Configuration: Additional Settings Unit .

As a reminder, the Search Configuration lives under Search > All Search Experiences in the platform. Once an experience is selected, the Home page will land you directly on a full screen Test Search.

navigating to search configuration

unit Quiz
+20 points
Daily Quiz Streak Daily Quiz Streak: 0
Quiz Accuracy Streak Quiz Accuracy Streak: 0
    Error Success Question 1 of 2

    True or False: The Search Configuration controls the frontend, so an Administrator can use it to maintain the display of search results.

    Error Success Question 2 of 2

    Which of the following is NOT controlled through the Search Configuration?

    You're out of this world! 🌎

    You've already completed this quiz, so you can't earn more points.You completed this quiz in 1 attempt and earned 0 points! Feel free to review your answers and move on when you're ready.
1st attempt
0 incorrect