loading

Answers Configuration

$schemaconst Required

$idstring Required

The ID that uniquely identifies the experience within the business

externalKeystring

namestring

Display name of the experience (eg in Storm)

supportedLocalesarray of string

Each item of this array must be:

Type: string

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:

Type: string

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 KNOWLEDGEMANAGER, GOOGLECSE, BINGCSE, ZENDESK, ALGOLIA, and CUSTOMSEARCHER

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:

Type: object

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:

Type: string

boolean

Only show this vertical if an intent is detected

number

Base ranking of the vertical

array of string

KNOWLEDGE_MANAGER only. API names of the entity ids allowed in this vertical

Each item of this array must be:

Type: string

string

KNOWLEDGE_MANAGER only. Saved search to restrict results to

object

Controls dynamic reranking of results based on user engagement. Only available for KNOWLEDGE_MANAGER verticals with FAQ entity type.

string

Which user action to optimize for. Options include “CLICKS”.

array of object

KNOWLEDGE_MANAGER only. Specification for how results should be ordered

Each item of this array must be:

Type: object

string

The type of sort

string

If the type is FIELD, the field to sort on

string

ASC or DESC

object

KNOWLEDGE_MANAGER 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

KNOWLEDGE_MANAGER only. Ordering for facets

Each item of this array must be:

Type: string

array of string

KNOWLEDGE_MANAGER only. Priority ordering of fields for NLP Filtering

Each item of this array must be:

Type: string

number

KNOWLEDGE_MANAGER 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

KNOWLEDGE_MANAGER 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

KNOWLEDGE_MANAGER 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:

Type: string

The api name of the display field to include. You can use dot notation to specify substructures.

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:

Type: string

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:

Type: object

string

array of string

Each item of this array must be:

Type: string

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:

Type: array of string

Each item of this array must be:

Type: string

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:

Type: object

array of string

Each item of this array must be:

Type: string

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:

Type: string

object

Synonyms used at query time.

Same definition as synonyms

rulesarray of object

Array of Query Rules

Each item of this array must be:

Type: object

Object of Query Rule

object

Map of criterion type to value

array of object

Array of actions

Each item of this array must be:

Type: object

Object of action

string

additionalStopWordsarray of string

Set additional configurable stop words for searches.

Each item of this array must be:

Type: string

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:

Type: string

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:

Type: object

array of string

Collection of prompts shown to the user on a universal search.

Each item of this array must be:

Type: string

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.

Each item of this array must be:

Type: string