Skip to content

Latest commit

 

History

History
247 lines (107 loc) · 3.46 KB

search-core.verticalsearchresponse.md

File metadata and controls

247 lines (107 loc) · 3.46 KB

Home > @yext/search-core > VerticalSearchResponse

VerticalSearchResponse interface

A representation of a response from a vertical search.

Signature:

export interface VerticalSearchResponse 

Properties

Property

Modifiers

Type

Description

allResultsForVertical?

VerticalSearchResponse

(Optional) A representation of a response from a vertical search.

alternativeVerticals?

VerticalResults[]

(Optional) The VerticalResults for each search vertical.

directAnswer?

FeaturedSnippetDirectAnswer | FieldValueDirectAnswer

(Optional) A direct answer to a search.

facets?

DisplayableFacet[]

(Optional) An array of Facets associated with the search results.

locationBias?

LocationBias

(Optional) Information about the user's location.

queryId

string

The ID of the query.

queryRulesActionsData?

QueryRulesActionsData[]

(Optional) Data returned from the Search query rules system.

searchIntents?

SearchIntent[]

(Optional) An array of SearchIntents.

spellCheck?

SpellCheck

(Optional) A spellcheck response from a search query.

uuid

string

A unique id which corresponds to the request.

verticalResults

VerticalResults

Represents results from a search vertical.