Search Configuration
$schemaconst Required
“https://schema.yext.com/config/answers/answers-config/v1" $idstring Required
The ID that uniquely identifies the experience within the business
externalKeystring
namestring
Display name of the experience (eg in Storm)
restrictedApiKeystring
Scope the experience to a specific API key
supportedLocalesarray of string
Each item of this array must be:
countryRestrictionsarray of string
Scope the set of countries for place search. Will default to United States if no values are provided.
Each item of this array must be:
Country code of in-scope country
boundingBoxobject
Scope all Place Searches to the specified area
number
number
number
number
verticalsobject
Map of field ids to vertical configurations
object Pattern Property
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^.$ string
Display name of the vertical (eg in Storm)
string
The data source for the backend. Options include YEXT, GOOGLECSE, BINGCSE, ZENDESK, ALGOLIA, and CUSTOM_SEARCHER
object
Configuration to boost relevance of a vertical
array of object
Intent phrases that, when present in the user’s query, provide a boost to the designated vertical
Each item of this array must be:
string
The phrase that triggers the boost when present anywhere in the user’s query
number
Positive or negative modifier
array of string
If found, prevent a vertical from showing up
Each item of this array must be:
boolean
Only show this vertical if an intent is detected
number
Base ranking of the vertical
array of string
YEXT only. API names of the entity ids allowed in this vertical
Each item of this array must be:
string
YEXT only. Saved search to restrict results to
object
Controls dynamic reranking of results based on user engagement. Only available for YEXT verticals with FAQ entity type.
string
Which user action to optimize for. Options include “CLICKS”.
array of object
YEXT only. Specification for how results should be ordered
Each item of this array must be:
string
The type of sort
string
If the type is FIELD, the field to sort on
string
ASC or DESC
string
If populated, the relevance algorithm to use
array of number
If the type is ENTITY_DISTANCE and buckets are being used, the buckets to use
Each item of this array must be:
object
YEXT only. Specification for facets
array of object
An array of facets for specific fields
Each item of this array must be:
string
The field being used for the facet
string
Which way to order. Either ‘ASC’ or ‘DESC’
An object describing generated ranges
string
The algorithm to use. Either ‘DYNAMIC’ or ‘STATIC’
number
The number of buckets to generate. Only valid for DYNAMIC algorithms.
number
The length of buckets to generate. Only valid for STATIC algorithms.
An array of ranges
Each item of this array must be:
number
The start of the range
number
The end of the range
string
The name of the range
object
YEXT only. Map of field api names to field configurations.
object Pattern Property
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^.$ boolean
Whether this field can be used in fulltext search
boolean
Whether this field can be used in document search
boolean
Whether this field can be used to facet
boolean
Whether this field can be used to statically filter
boolean
Whether this field can be used in filtersearch
boolean
Whether this field can be returned as a Direct Answer
boolean
Whether this field can be inferred as a filter
boolean
Whether this field can be used for sorting
string
The named entity recognition type for this field. Options include PERSONGENERIC, PERSONSPECIFIC, LOCATION, DATE, EVENTS, NUMBERRANGE, PRODUCT, HEALTHCAREPROCEDURE, HEALTHCARECONDITION, HEALTHCARESPECIALTY, INSTITUTIONBRAND, ROUTINEBUSINESSOPERATION, FEELIMIT_CHARGE, and PROBLEM
array of string
YEXT only. Ordering for facets
Each item of this array must be:
array of string
YEXT only. Priority ordering of fields for NLP Filtering
Each item of this array must be:
number
YEXT only. A minimum location radius override in meters.
string
Only valid when source is GOOGLE_CSE
string
Only valid when source is GOOGLE_CSE
string
Only valid when source is GOOGLE_CSE
object
YEXT only. Configuration for various types of direct answers.
object
Configuration for featured snippets from any field documentSearch enabled.
string
Whether featured snippets require explicit approval from experience training. Options include “APPROVEONLY” and “ALLOWALL”.
object
Configuration for field value direct answers from the knowledge graph.
array
Array of API names for fields that are eligible for field value direct answers.
string
Determines when a field value direct answer is extracted. Options include “CLASSIFIER”, “FIELDNAME”, and “ONEENTITY”.
array of string
YEXT only. Fields on the profile that are returned to the frontend. If ommitted or empty, all fields will be returned.
Each item of this array must be:
The api name of the display field to include. You can use dot notation to specify substructures.
object
YEXT only. Thresholds to be used for semantic search.
number
number
object
YEXT only. Indicates choice of authorization scheme.
boolean
boolean
number
YEXT only. A value that will always be added to the semantic vertical relevance score.
number
YEXT only. Verticals with semantic relevance scores less than the threshold will not show.
array of string
YEXT only. An array of strings that will contribute to semantic vertical ranking.
Each item of this array must be:
A string used to calculate the semantic vertical relevance.
array of string
YEXT only. An array of field IDs, used as a tiebreaker for ranking verticals when multiple have the same score. Verticals with semantic values associated with these fields will be prioritized.
Each item of this array must be:
A searchable field.
string
Only valid when source is YEXT. Either BASIC or ADVANCED.
autocompleteobject
boolean
Disables autocomplete prompts from popular queries
array of string
Collection of hardcoded autocomplete prompts shown to the user alongside popular query autocomplete prompts on universal search.
Each item of this array must be:
synonymsobject
Synonyms used at query time.
array of object
A phrase that, when detected, is expanded to include all of the synonyms associated with the phrase.
Each item of this array must be:
string
array of string
Each item of this array must be:
array of array
A collection of phrases that, whenever any is present in a user’s query, is expanded to include all other terms in the set.
Each item of this array must be:
Each item of this array must be:
array of object
A collection of phrases that, whenever any is present in a user’s query, is expanded to include one synonym associated with the phrases.
Each item of this array must be:
array of string
Each item of this array must be:
string
timeoutnumber
Timeout, in milliseconds, given for each vertical within a query. All verticals completed before the timeout will still be returned even if others haven’t.
localizationsobject
Map of locale codes to configurations that have i18nable strings overriden
object Pattern Property
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^.$ object
object Pattern Property
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^.$ object
array of string
Each item of this array must be:
object
Synonyms used at query time.
Same definition as synonymsrulesarray of object
Array of Query Rules
Each item of this array must be:
Object of Query Rule
object
Map of criterion type to value
array of object
Array of actions
Each item of this array must be:
Object of action
string
additionalStopWordsarray of string
Set additional configurable stop words for searches.
Each item of this array must be:
The word to be used as an additional stop word.
additionalSearchablePlacesarray of string
Add Additional Searchable Places to enable more fine-grained location search. E.g. Add ‘neighborhoods’ to search for neighborhoods
Each item of this array must be:
customPhrasesarray of string
Add custom phrases that should be treated as single entities (e.g., My Product Name).
Each item of this array must be:
richTextV2ToHTMLboolean
Defaults to false. Whether to convert rich text v2 to HTML. If false, rich text v2 fields will be formatted as a JSON Abstract Expression Tree (AST).
markdownToHTMLboolean
Defaults to false. Whether to convert markdown to HTML. If false, markdown fields will be formatted as their original markdown strings.
disableAutomaticPhraseDetectionboolean
Disables automatic phase detection
querySuggestionsobject
Settings for Query Suggestion
boolean
Disables autocomplete prompts from popular queries
boolean
Control whether or not prompts return for an empty string for all verticals
array
Terms that should be blacklisted from popular queries
Each item of this array must be:
array of string
Regex patterns that should be blacklisted from popular queries
Each item of this array must be:
array of string
Collection of prompts shown to the user on a universal search.
Each item of this array must be:
object
Map of vertical key to vertical prompts.
array of string Pattern Property
All property whose name matches the following regular expression must respect the following conditions
Property name regular expression:^.$ Collection of prompts shown to the user on a vertical search for a given vertical key.