| +Package + + + | + +Description + + + |
|---|---|
| + +[@yext/search-headless](./search-headless.md) + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +["Client-SDK"?](./search-headless.additionalhttpheaders._client-sdk_.md) + + + | + + + | + +[ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) + + + | + +_(Optional)_ Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[city?](./search-headless.address.city.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[countryCode](./search-headless.address.countrycode.md) + + + | + + + | + +string + + + | + + + |
| + +[extraDescription?](./search-headless.address.extradescription.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[line1?](./search-headless.address.line1.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[line2?](./search-headless.address.line2.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[line3?](./search-headless.address.line3.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[postalCode?](./search-headless.address.postalcode.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[region?](./search-headless.address.region.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[sublocality?](./search-headless.address.sublocality.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.addressdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.Address](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[facets](./search-headless.allresultsforvertical.facets.md) + + + | + + + | + +[DisplayableFacet](./search-headless.displayablefacet.md)\[\] + + + | + +The dynamic collection of facets that can be applied to filter the search results and whether each of them is currently selected. + + + |
| + +[results](./search-headless.allresultsforvertical.results.md) + + + | + + + | + +[Result](./search-headless.result.md)\[\] + + + | + +The array of all results for the vertical. + + + |
| + +[resultsCount](./search-headless.allresultsforvertical.resultscount.md) + + + | + + + | + +number + + + | + +The total number of results for the vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.androidappurldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.AndroidAppURL](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[details?](./search-headless.appliedqueryfilter.details.md) + + + | + + + | + +[LocationFilterDetails](./search-headless.locationfilterdetails.md) + + + | + +_(Optional)_ Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). + + + |
| + +[displayKey](./search-headless.appliedqueryfilter.displaykey.md) + + + | + + + | + +string + + + | + +The display name of the filter key. + + + |
| + +[displayValue](./search-headless.appliedqueryfilter.displayvalue.md) + + + | + + + | + +string + + + | + +The value used in the filter. + + + |
| + +[filter](./search-headless.appliedqueryfilter.filter.md) + + + | + + + | + +[FieldValueFilter](./search-headless.fieldvaluefilter.md) + + + | + +The filter applied to the query results. + + + |
| + +[type](./search-headless.appliedqueryfilter.type.md) + + + | + + + | + +[AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) + + + | + +Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. + + + |
"FIELD_VALUE" | Indicates that a field value filter is applied based on the query. |
-| Intent | "INTENT" | Indicates that a search intent filter is applied based on the query. |
-| Place | "PLACE" | Indicates that a location filter is applied based on the query. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +FieldValue + + + | + +`"FIELD_VALUE"` + + + | + +Indicates that a field value filter is applied based on the query. + + + |
| + +Intent + + + | + +`"INTENT"` + + + | + +Indicates that a search intent filter is applied based on the query. + + + |
| + +Place + + + | + +`"PLACE"` + + + | + +Indicates that a location filter is applied based on the query. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[inputIntents](./search-headless.autocompleteresponse.inputintents.md) + + + | + + + | + +[SearchIntent](./search-headless.searchintent.md)\[\] + + + | + +Represents intents from the Search API. + + + |
| + +[queryId?](./search-headless.autocompleteresponse.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The ID of the search query. + + + |
| + +[results](./search-headless.autocompleteresponse.results.md) + + + | + + + | + +[AutocompleteResult](./search-headless.autocompleteresult.md)\[\] + + + | + +An array of [AutocompleteResult](./search-headless.autocompleteresult.md)s. + + + |
| + +[uuid](./search-headless.autocompleteresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[filter?](./search-headless.autocompleteresult.filter.md) + + + | + + + | + +[FieldValueFilter](./search-headless.fieldvaluefilter.md) + + + | + +_(Optional)_ A filter applied to the autocomplete response. + + + |
| + +[inputIntents](./search-headless.autocompleteresult.inputintents.md) + + + | + + + | + +[SearchIntent](./search-headless.searchintent.md)\[\] + + + | + +[SearchIntent](./search-headless.searchintent.md)s corresponding to the autocomplete result. + + + |
| + +[key?](./search-headless.autocompleteresult.key.md) + + + | + + + | + +string + + + | + +_(Optional)_ The fieldId which corresponds to the AutocompleteResult value. + + + |
| + +[matchedSubstrings?](./search-headless.autocompleteresult.matchedsubstrings.md) + + + | + + + | + +{ length: number; offset: number; }\[\] + + + | + +_(Optional)_ An array of substrings which overlap with the autocomplete input. + + + |
| + +[relatedItem?](./search-headless.autocompleteresult.relateditem.md) + + + | + + + | + +[Result](./search-headless.result.md) + + + | + +_(Optional)_ An entity that corresponds to the autocomplete result. + + + |
| + +[value](./search-headless.autocompleteresult.value.md) + + + | + + + | + +string + + + | + +The value of an autocomplete suggestion. + + + |
| + +[verticalKeys?](./search-headless.autocompleteresult.verticalkeys.md) + + + | + + + | + +string\[\] + + + | + +_(Optional)_ Any vertical keys associated with a prompt. This only shows up on universal autocomplete requests. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +request + + + | + +[FilterSearchRequest](./search-headless.filtersearchrequest.md) + + + | + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[filterSearch(request)](./search-headless.autocompleteservice.filtersearch.md) + + + | + +Retrieves query suggestions for filter search. + + + |
| + +[universalAutocomplete(request)](./search-headless.autocompleteservice.universalautocomplete.md) + + + | + +Retrieves query suggestions for universal. + + + |
| + +[verticalAutocomplete(request)](./search-headless.autocompleteservice.verticalautocomplete.md) + + + | + +Retrieves query suggestions for a vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.basefeaturedsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.MultiLineText](./search-headless.builtinfieldtype.md) \| [BuiltInFieldType.RichText](./search-headless.builtinfieldtype.md) \| [BuiltInFieldType.RichText\_v2](./search-headless.builtinfieldtype.md) \| [BuiltInFieldType.Html](./search-headless.builtinfieldtype.md) \| [BuiltInFieldType.Markdown](./search-headless.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| + +[snippet](./search-headless.basefeaturedsnippetdirectanswer.snippet.md) + + + | + + + | + +[Snippet](./search-headless.snippet.md) + + + | + +The snippet where the direct answer was found. + + + |
| + +[type](./search-headless.basefeaturedsnippetdirectanswer.type.md) + + + | + + + | + +[DirectAnswerType.FeaturedSnippet](./search-headless.directanswertype.md) + + + | + +Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md). + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[entityName](./search-headless.basefieldvaluedirectanswer.entityname.md) + + + | + + + | + +string + + + | + +The name of the entity that direct answer came from. + + + |
| + +[fieldApiName](./search-headless.basefieldvaluedirectanswer.fieldapiname.md) + + + | + + + | + +string + + + | + +The field api name of the direct answer. + + + |
| + +[fieldName](./search-headless.basefieldvaluedirectanswer.fieldname.md) + + + | + + + | + +string + + + | + +The field name of the direct answer. + + + |
| + +[type](./search-headless.basefieldvaluedirectanswer.type.md) + + + | + + + | + +[DirectAnswerType.FieldValue](./search-headless.directanswertype.md) + + + | + +Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md). + + + |
| + +[value](./search-headless.basefieldvaluedirectanswer.value.md) + + + | + + + | + +T + + + | + +The result of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[additionalQueryParams?](./search-headless.basesearchconfig.additionalqueryparams.md) + + + | + + + | + +{ \[key: string\]: string \| number \| boolean; } + + + | + +_(Optional)_ Additional query params added on to every request. + + + |
| + +[cloudRegion?](./search-headless.basesearchconfig.cloudregion.md) + + + | + + + | + +[CloudRegion](./search-headless.cloudregion.md) + + + | + +_(Optional)_ Defines the cloud region of the API domains. + + + |
| + +[endpoints?](./search-headless.basesearchconfig.endpoints.md) + + + | + + + | + +[Endpoints](./search-headless.endpoints.md) + + + | + +_(Optional)_ Overrides for the URLs which are used when making requests to the Search API. + + + |
| + +[environment?](./search-headless.basesearchconfig.environment.md) + + + | + + + | + +[Environment](./search-headless.environment.md) + + + | + +_(Optional)_ Defines the environment of the API domains. + + + |
| + +[experienceKey](./search-headless.basesearchconfig.experiencekey.md) + + + | + + + | + +string + + + | + +The experience key of the search experience. + + + |
| + +[experienceVersion?](./search-headless.basesearchconfig.experienceversion.md) + + + | + + + | + +'STAGING' \| 'PRODUCTION' \| string \| number + + + | + +_(Optional)_ The version of the search experience configuration. + + + |
| + +[locale](./search-headless.basesearchconfig.locale.md) + + + | + + + | + +string + + + | + +The locale of the search experience. + + + |
| + +[visitor?](./search-headless.basesearchconfig.visitor.md) + + + | + + + | + +[Visitor](./search-headless.visitor.md) + + + | + +_(Optional)_ Information used to associate requests with a particular user. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[max?](./search-headless.boundedrange.max.md) + + + | + + + | + +[RangeBoundary](./search-headless.rangeboundary.md)<T> + + + | + +_(Optional)_ The maximum value bounding the range. + + + |
| + +[min?](./search-headless.boundedrange.min.md) + + + | + + + | + +[RangeBoundary](./search-headless.rangeboundary.md)<T> + + + | + +_(Optional)_ The minimum value bounding the range. + + + |
"address" | |
-| AndroidAppURL | "android_app_url" | |
-| ComplexURL | "complex_url" | |
-| Decimal | "decimal" | |
-| Email | "email" | |
-| FacebookURL | "facebook_url" | |
-| Hours | "hours" | |
-| Html | "html" | |
-| InstagramHandle | "instagram_handle" | |
-| Integer | "integer" | |
-| IOSAppURL | "ios_app_url" | |
-| Markdown | "markdown" | |
-| MultiLineText | "multi_line_text" | |
-| Phone | "phone" | |
-| RichText | "rich_text" | |
-| RichText\_v2 | "rich_text_v2" | |
-| SingleLineText | "single_line_text" | |
-| TwitterHandle | "twitter_handle" | |
-| URL | "url" | |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +Address + + + | + +`"address"` + + + | + + + |
| + +AndroidAppURL + + + | + +`"android_app_url"` + + + | + + + |
| + +ComplexURL + + + | + +`"complex_url"` + + + | + + + |
| + +Decimal + + + | + +`"decimal"` + + + | + + + |
| + +Email + + + | + +`"email"` + + + | + + + |
| + +FacebookURL + + + | + +`"facebook_url"` + + + | + + + |
| + +Hours + + + | + +`"hours"` + + + | + + + |
| + +Html + + + | + +`"html"` + + + | + + + |
| + +InstagramHandle + + + | + +`"instagram_handle"` + + + | + + + |
| + +Integer + + + | + +`"integer"` + + + | + + + |
| + +IOSAppURL + + + | + +`"ios_app_url"` + + + | + + + |
| + +Markdown + + + | + +`"markdown"` + + + | + + + |
| + +MultiLineText + + + | + +`"multi_line_text"` + + + | + + + |
| + +Phone + + + | + +`"phone"` + + + | + + + |
| + +RichText + + + | + +`"rich_text"` + + + | + + + |
| + +RichText\_v2 + + + | + +`"rich_text_v2"` + + + | + + + |
| + +SingleLineText + + + | + +`"single_line_text"` + + + | + + + |
| + +TwitterHandle + + + | + +`"twitter_handle"` + + + | + + + |
| + +URL + + + | + +`"url"` + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[ANSWERS\_CORE?](./search-headless.clientsdkheadervalues.answers_core.md) + + + | + + + | + +never + + + | + +_(Optional)_ The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Search Core being used. + + + |
"GLOBAL-GCP" | |
-| GLOBAL\_MULTI | "GLOBAL-MULTI" | |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +GLOBAL\_GCP + + + | + +`"GLOBAL-GCP"` + + + | + + + |
| + +GLOBAL\_MULTI + + + | + +`"GLOBAL-MULTI"` + + + | + + + |
"eu" | |
-| US | "us" | |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +EU + + + | + +`"eu"` + + + | + + + |
| + +US + + + | + +`"us"` + + + | + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +filterA + + + | + +[StaticFilter](./search-headless.staticfilter.md) + + + | + +The first static filter to be combined + + + |
| + +filterB + + + | + +[StaticFilter](./search-headless.staticfilter.md) + + + | + +The second static filter to be combined + + + |
| + +combinator + + + | + +[FilterCombinator](./search-headless.filtercombinator.md) + + + | + +Specifies how the two static filters should be joined + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[displayUrl?](./search-headless.complexurl.displayurl.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[preferDisplayUrl](./search-headless.complexurl.preferdisplayurl.md) + + + | + + + | + +boolean + + + | + + + |
| + +[url](./search-headless.complexurl.url.md) + + + | + + + | + +string + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.complexurldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.ComplexURL](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[combinator](./search-headless.conjunctionstaticfilter.combinator.md) + + + | + + + | + +[FilterCombinator.AND](./search-headless.filtercombinator.md) + + + | + +Indicates that filters should be combined with a logical AND. + + + |
| + +[filters](./search-headless.conjunctionstaticfilter.filters.md) + + + | + + + | + +[StaticFilter](./search-headless.staticfilter.md)\[\] + + + | + +The filters to combine together. + + + |
| + +[kind](./search-headless.conjunctionstaticfilter.kind.md) + + + | + + + | + +'conjunction' + + + | + +The kind of static filter. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +fieldId + + + | + +string + + + | + +The comparison field's identifier + + + |
| + +range + + + | + +[BoundedRange](./search-headless.boundedrange.md)<Date> + + + | + +The acceptable date range + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +fieldId + + + | + +string + + + | + +The comparison field's identifier + + + |
| + +value + + + | + +string \| number \| boolean + + + | + +The value to match + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +position + + + | + +[NearFilterValue](./search-headless.nearfiltervalue.md) + + + | + +The position and radius + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +fieldId + + + | + +string + + + | + +The comparison field's identifier + + + |
| + +range + + + | + +[BoundedRange](./search-headless.boundedrange.md)<number> + + + | + +The acceptable number range + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[isClosed?](./search-headless.dayhour.isclosed.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ + + + |
| + +[openIntervals?](./search-headless.dayhour.openintervals.md) + + + | + + + | + +[Interval](./search-headless.interval.md)\[\] + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.decimaldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.Decimal](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.directanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType](./search-headless.builtinfieldtype.md)> \| 'unknown' + + + | + +The field type of the direct answer. + + + |
| + +[relatedResult](./search-headless.directanswer.relatedresult.md) + + + | + + + | + +[Result](./search-headless.result.md) + + + | + +The entity associated with the direct answer. + + + |
| + +[type](./search-headless.directanswer.type.md) + + + | + + + | + +[DirectAnswerType](./search-headless.directanswertype.md) + + + | + +The [DirectAnswerType](./search-headless.directanswertype.md). + + + |
| + +[value?](./search-headless.directanswer.value.md) + + + | + + + | + +T + + + | + +_(Optional)_ The value of the direct answer. + + + |
| + +[verticalKey](./search-headless.directanswer.verticalkey.md) + + + | + + + | + +string + + + | + +The vertical key of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[result?](./search-headless.directanswerstate.result.md) + + + | + + + | + +[FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) + + + | + +_(Optional)_ The data for the direct answer. The type of the data is determined by the Search API based on whether the answer was found within a document or was a field value in the knowledge graph. + + + |
"FEATURED_SNIPPET" | Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md). |
-| FieldValue | "FIELD_VALUE" | Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md). |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +FeaturedSnippet + + + | + +`"FEATURED_SNIPPET"` + + + | + +Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md). + + + |
| + +FieldValue + + + | + +`"FIELD_VALUE"` + + + | + +Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md). + + + |
"ASC" | An ascending sort |
-| Descending | "DESC" | A descending soft |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +Ascending + + + | + +`"ASC"` + + + | + +An ascending sort + + + |
| + +Descending + + + | + +`"DESC"` + + + | + +A descending soft + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[combinator](./search-headless.disjunctionstaticfilter.combinator.md) + + + | + + + | + +[FilterCombinator.OR](./search-headless.filtercombinator.md) + + + | + +Indicates that filters should be combined with a logical OR. + + + |
| + +[filters](./search-headless.disjunctionstaticfilter.filters.md) + + + | + + + | + +([DisjunctionStaticFilter](./search-headless.disjunctionstaticfilter.md) \| [FieldValueStaticFilter](./search-headless.fieldvaluestaticfilter.md))\[\] + + + | + +The filters to combine together. + + + |
| + +[kind](./search-headless.disjunctionstaticfilter.kind.md) + + + | + + + | + +'disjunction' + + + | + +The kind of static filter. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[displayName](./search-headless.displayablefacet.displayname.md) + + + | + + + | + +string + + + | + +The name of the facet which is meant to be displayed to the user. + + + |
| + +[options](./search-headless.displayablefacet.options.md) + + + | + + + | + +[DisplayableFacetOption](./search-headless.displayablefacetoption.md)\[\] + + + | + +An array of [DisplayableFacetOption](./search-headless.displayablefacetoption.md) + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[count](./search-headless.displayablefacetoption.count.md) + + + | + + + | + +number + + + | + +The number of results associated with this facet option. + + + |
| + +[displayName](./search-headless.displayablefacetoption.displayname.md) + + + | + + + | + +string + + + | + +The name of the facet option which is meant to be displayed to the end user. + + + |
| + +[selected](./search-headless.displayablefacetoption.selected.md) + + + | + + + | + +boolean + + + | + +Whether or not the filter is selected in the search results. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[documentScore](./search-headless.documentresult.documentscore.md) + + + | + + + | + +number + + + | + +The score calculated from whatever document search strategy was used. + + + |
| + +[segments](./search-headless.documentresult.segments.md) + + + | + + + | + +[Segment](./search-headless.segment.md)\[\] + + + | + +All the relevant segments extracted from the document. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.emaildirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.Email](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[filterSearch?](./search-headless.endpoints.filtersearch.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[questionSubmission?](./search-headless.endpoints.questionsubmission.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[status?](./search-headless.endpoints.status.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[universalAutocomplete?](./search-headless.endpoints.universalautocomplete.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[universalSearch?](./search-headless.endpoints.universalsearch.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[verticalAutocomplete?](./search-headless.endpoints.verticalautocomplete.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[verticalSearch?](./search-headless.endpoints.verticalsearch.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
"prod" | |
-| SANDBOX | "sbx" | |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +PROD + + + | + +`"prod"` + + + | + + + |
| + +SANDBOX + + + | + +`"sbx"` + + + | + + + |
"BACKEND_ERROR" | An internal error from the API backend. |
-| InvalidConfig | "INVALID_CONFIG" | An invalid config from the request. |
-| InvalidQuery | "INVALID_QUERY" | An invalid query from the request. |
-| Timeout | "TIMEOUT" | A timeout error from the server. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +BackendError + + + | + +`"BACKEND_ERROR"` + + + | + +An internal error from the API backend. + + + |
| + +InvalidConfig + + + | + +`"INVALID_CONFIG"` + + + | + +An invalid config from the request. + + + |
| + +InvalidQuery + + + | + +`"INVALID_QUERY"` + + + | + +An invalid query from the request. + + + |
| + +Timeout + + + | + +`"TIMEOUT"` + + + | + +A timeout error from the server. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.facebookurldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.FacebookURL](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldId](./search-headless.facet.fieldid.md) + + + | + + + | + +string + + + | + +The associated fieldId. + + + |
| + +[options](./search-headless.facet.options.md) + + + | + + + | + +[FacetOption](./search-headless.facetoption.md)\[\] + + + | + +An array of [FacetOption](./search-headless.facetoption.md) + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[value](./search-headless.facetoption.value.md) + + + | + + + | + +Exclude<[FieldValueFilter](./search-headless.fieldvaluefilter.md)\['value'\], [NearFilterValue](./search-headless.nearfiltervalue.md)> + + + | + +The value to compare. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[details](./search-headless.failedvertical.details.md) + + + | + + + | + +{ responseCode: number; description: string; } + + + | + +Detailed information about the error. + + + |
| + +[errorType](./search-headless.failedvertical.errortype.md) + + + | + + + | + +[ErrorType](./search-headless.errortype.md) + + + | + +Identifier for the type of error causing the failure. + + + |
| + +[queryDurationMillis](./search-headless.failedvertical.querydurationmillis.md) + + + | + + + | + +number + + + | + +The duration of the query in milliseconds. + + + |
| + +[verticalKey](./search-headless.failedvertical.verticalkey.md) + + + | + + + | + +string + + + | + +The vertical key associated with the failed vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldId](./search-headless.fieldvaluefilter.fieldid.md) + + + | + + + | + +string + + + | + +The fieldId to apply the filter against. + + + |
| + +[matcher](./search-headless.fieldvaluefilter.matcher.md) + + + | + + + | + +[Matcher](./search-headless.matcher.md) + + + | + +A Matcher is a filtering operation. + + + |
| + +[value](./search-headless.fieldvaluefilter.value.md) + + + | + + + | + +string \| number \| boolean \| [NearFilterValue](./search-headless.nearfiltervalue.md) \| [NumberRangeValue](./search-headless.numberrangevalue.md) + + + | + +The value to compare. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[kind](./search-headless.fieldvaluestaticfilter.kind.md) + + + | + + + | + +'fieldValue' + + + | + +The kind of static filter. + + + |
"$and" | Indicates that filters should be combined with a logical AND. |
-| OR | "$or" | Indicates that filters should be combined with a logical OR. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +AND + + + | + +`"$and"` + + + | + +Indicates that filters should be combined with a logical AND. + + + |
| + +OR + + + | + +`"$or"` + + + | + +Indicates that filters should be combined with a logical OR. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[excluded?](./search-headless.filtersearchrequest.excluded.md) + + + | + + + | + +[FieldValueFilter](./search-headless.fieldvaluefilter.md)\[\] + + + | + +_(Optional)_ An array of field value filters that should be excluded from filter search results. + + + |
| + +[fields](./search-headless.filtersearchrequest.fields.md) + + + | + + + | + +[SearchParameterField](./search-headless.searchparameterfield.md)\[\] + + + | + +An array of [SearchParameterField](./search-headless.searchparameterfield.md). + + + |
| + +[input](./search-headless.filtersearchrequest.input.md) + + + | + + + | + +string + + + | + +The input string for autocomplete. + + + |
| + +[sectioned](./search-headless.filtersearchrequest.sectioned.md) + + + | + + + | + +boolean + + + | + +Determines whether or not the results of the [FilterSearchResponse](./search-headless.filtersearchresponse.md) are separated by field. + + + |
| + +[sessionTrackingEnabled?](./search-headless.filtersearchrequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| + +[verticalKey](./search-headless.filtersearchrequest.verticalkey.md) + + + | + + + | + +string + + + | + +The key for the vertical to get autocomplete suggestions from. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[businessId?](./search-headless.filtersearchresponse.businessid.md) + + + | + + + | + +string + + + | + +_(Optional)_ ID of the account associated with this Search experience. + + + |
| + +[queryId?](./search-headless.filtersearchresponse.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The ID of the search query. + + + |
| + +[sections](./search-headless.filtersearchresponse.sections.md) + + + | + + + | + +{ label?: string; results: [AutocompleteResult](./search-headless.autocompleteresult.md)\[\]; }\[\] + + + | + +Represents autocomplete results separated by field. + + + |
| + +[uuid](./search-headless.filtersearchresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[facets?](./search-headless.filtersstate.facets.md) + + + | + + + | + +[DisplayableFacet](./search-headless.displayablefacet.md)\[\] + + + | + +_(Optional)_ The dynamic collection of facets that can be applied to filter the search results and whether each of them is currently selected. + + + |
| + +[static?](./search-headless.filtersstate.static.md) + + + | + + + | + +[SelectableStaticFilter](./search-headless.selectablestaticfilter.md)\[\] + + + | + +_(Optional)_ The collection of possible static filters that can be applied to the search results and whether each of them is currently selected. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[matchedSubstrings](./search-headless.highlightedvalue.matchedsubstrings.md) + + + | + + + | + +{ length: number; offset: number; }\[\] + + + | + +An array of substring matches which correspond to the highlighting. + + + |
| + +[value](./search-headless.highlightedvalue.value.md) + + + | + + + | + +string + + + | + +The value of the field which should be highlighted. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[date](./search-headless.holidayhours.date.md) + + + | + + + | + +string + + + | + + + |
| + +[isClosed?](./search-headless.holidayhours.isclosed.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ + + + |
| + +[isRegularHours?](./search-headless.holidayhours.isregularhours.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ + + + |
| + +[openIntervals?](./search-headless.holidayhours.openintervals.md) + + + | + + + | + +[Interval](./search-headless.interval.md)\[\] + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[friday?](./search-headless.hours.friday.md) + + + | + + + | + +[DayHour](./search-headless.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[holidayHours?](./search-headless.hours.holidayhours.md) + + + | + + + | + +[HolidayHours](./search-headless.holidayhours.md)\[\] + + + | + +_(Optional)_ + + + |
| + +[monday?](./search-headless.hours.monday.md) + + + | + + + | + +[DayHour](./search-headless.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[reopenDate?](./search-headless.hours.reopendate.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[saturday?](./search-headless.hours.saturday.md) + + + | + + + | + +[DayHour](./search-headless.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[sunday?](./search-headless.hours.sunday.md) + + + | + + + | + +[DayHour](./search-headless.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[thursday?](./search-headless.hours.thursday.md) + + + | + + + | + +[DayHour](./search-headless.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[tuesday?](./search-headless.hours.tuesday.md) + + + | + + + | + +[DayHour](./search-headless.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[wednesday?](./search-headless.hours.wednesday.md) + + + | + + + | + +[DayHour](./search-headless.dayhour.md) + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.hoursdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.Hours](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.htmlsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.Html](./search-headless.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.instagramhandledirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.InstagramHandle](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.integerdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.Integer](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[end?](./search-headless.interval.end.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[start?](./search-headless.interval.start.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.iosappurldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.IOSAppURL](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[latitude](./search-headless.latlong.latitude.md) + + + | + + + | + +number + + + | + +Latitude formatted as a decimal degree number. + + + |
| + +[longitude](./search-headless.latlong.longitude.md) + + + | + + + | + +number + + + | + +Longitude formatted as a decimal degree number. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[displayName](./search-headless.locationbias.displayname.md) + + + | + + + | + +string + + + | + +The name of the location. + + + |
| + +[latitude](./search-headless.locationbias.latitude.md) + + + | + + + | + +number + + + | + +The location's latitude. + + + |
| + +[longitude](./search-headless.locationbias.longitude.md) + + + | + + + | + +number + + + | + +The location's longitude. + + + |
| + +[method](./search-headless.locationbias.method.md) + + + | + + + | + +[LocationBiasMethod](./search-headless.locationbiasmethod.md) + + + | + +The method used to determine the location. + + + |
"DEVICE" | Location was supplied by the user's device. |
-| Ip | "IP" | Location was determined by IP address. |
-| Unknown | "UNKNOWN" | Location is unknown. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +Device + + + | + +`"DEVICE"` + + + | + +Location was supplied by the user's device. + + + |
| + +Ip + + + | + +`"IP"` + + + | + +Location was determined by IP address. + + + |
| + +Unknown + + + | + +`"UNKNOWN"` + + + | + +Location is unknown. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[maxLatitude](./search-headless.locationboundingbox.maxlatitude.md) + + + | + + + | + +number + + + | + +The location's highest latitude degree. + + + |
| + +[maxLongitude](./search-headless.locationboundingbox.maxlongitude.md) + + + | + + + | + +number + + + | + +The location's highest longitude degree. + + + |
| + +[minLatitude](./search-headless.locationboundingbox.minlatitude.md) + + + | + + + | + +number + + + | + +The location's lowest latitude degree. + + + |
| + +[minLongitude](./search-headless.locationboundingbox.minlongitude.md) + + + | + + + | + +number + + + | + +The location's lowest longitude degree. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[boundingBox?](./search-headless.locationfilterdetails.boundingbox.md) + + + | + + + | + +[LocationBoundingBox](./search-headless.locationboundingbox.md) + + + | + +_(Optional)_ The location's coordinate boundaries. + + + |
| + +[featureTypes](./search-headless.locationfilterdetails.featuretypes.md) + + + | + + + | + +string\[\] + + + | + +The location's classification (e.g. locality, region, address). + + + |
| + +[latitude](./search-headless.locationfilterdetails.latitude.md) + + + | + + + | + +number + + + | + +The location's latitude. + + + |
| + +[longitude](./search-headless.locationfilterdetails.longitude.md) + + + | + + + | + +number + + + | + +The location's longitude. + + + |
| + +[placeName](./search-headless.locationfilterdetails.placename.md) + + + | + + + | + +string + + + | + +The location's name. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[locationBias?](./search-headless.locationstate.locationbias.md) + + + | + + + | + +[LocationBias](./search-headless.locationbias.md) + + + | + +_(Optional)_ The geographical location bias used in the search, returned from the Search API. + + + |
| + +[userLocation?](./search-headless.locationstate.userlocation.md) + + + | + + + | + +[LatLong](./search-headless.latlong.md) + + + | + +_(Optional)_ The latitude and longitude of the user making the request. Used to bias the results. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[matcher](./search-headless.lowernumberrangelimit.matcher.md) + + + | + + + | + +[Matcher.GreaterThan](./search-headless.matcher.md) \| [Matcher.GreaterThanOrEqualTo](./search-headless.matcher.md) + + + | + +[Matcher](./search-headless.matcher.md) for the start limit + + + |
| + +[value](./search-headless.lowernumberrangelimit.value.md) + + + | + + + | + +number + + + | + +Value of the limit. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.markdownsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.Markdown](./search-headless.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
"$between" | A limitation of the dataset to a range of values. |
-| Equals | "$eq" | An equals comparison. |
-| GreaterThan | "$gt" | A greater than comparison. |
-| GreaterThanOrEqualTo | "$ge" | A greater than or equal to comparison. |
-| LessThan | "$lt" | A less than comparison. |
-| LessThanOrEqualTo | "$le" | A less than or equal to comparison. |
-| Near | "$near" | A comparison of whether an entity is within a certain radius of a certain location. |
-| NotEquals | "!$eq" | A not equals comparison. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +Between + + + | + +`"$between"` + + + | + +A limitation of the dataset to a range of values. + + + |
| + +Equals + + + | + +`"$eq"` + + + | + +An equals comparison. + + + |
| + +GreaterThan + + + | + +`"$gt"` + + + | + +A greater than comparison. + + + |
| + +GreaterThanOrEqualTo + + + | + +`"$ge"` + + + | + +A greater than or equal to comparison. + + + |
| + +LessThan + + + | + +`"$lt"` + + + | + +A less than comparison. + + + |
| + +LessThanOrEqualTo + + + | + +`"$le"` + + + | + +A less than or equal to comparison. + + + |
| + +Near + + + | + +`"$near"` + + + | + +A comparison of whether an entity is within a certain radius of a certain location. + + + |
| + +NotEquals + + + | + +`"!$eq"` + + + | + +A not equals comparison. + + + |
| + +Class + + + | + +Description + + + |
|---|---|
| + +[SearchCore](./search-headless.searchcore.md) + + + | + +Provides methods for executing searches, submitting questions, and performing autocompletes. + + + |
| + +[SearchError](./search-headless.searcherror.md) + + + | + +Represents an error + + + |
| + +[SearchHeadless](./search-headless.searchheadless.md) + + + | + +Provides the functionality for interacting with a Search experience. + + + |
| + +Enumeration + + + | + +Description + + + |
|---|---|
| + +[AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) + + + | + +Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. + + + |
| + +[BuiltInFieldType](./search-headless.builtinfieldtype.md) + + + | + +Possible built-in field types for [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md). + + + |
| + +[CloudChoice](./search-headless.cloudchoice.md) + + + | + +Defines the cloud choice of the API domains. + + + |
| + +[CloudRegion](./search-headless.cloudregion.md) + + + | + +Defines the cloud region of the API domains. + + + |
| + +[DirectAnswerType](./search-headless.directanswertype.md) + + + | + +Represents the type of direct answer. + + + |
| + +[Direction](./search-headless.direction.md) + + + | + +The direction of a sort. + + + |
| + +[Environment](./search-headless.environment.md) + + + | + +Defines the environment of the API domains. + + + |
| + +[ErrorType](./search-headless.errortype.md) + + + | + +Identifier for the type of error causing the failure. + + + |
| + +[FilterCombinator](./search-headless.filtercombinator.md) + + + | + +Indicates how child filters in a [StaticFilter](./search-headless.staticfilter.md) should be combined. + + + |
| + +[LocationBiasMethod](./search-headless.locationbiasmethod.md) + + + | + +The method used to determine the location. + + + |
| + +[Matcher](./search-headless.matcher.md) + + + | + +A Matcher is a filtering operation. + + + |
| + +[QuerySource](./search-headless.querysource.md) + + + | + +The source of the search request. + + + |
| + +[QueryTrigger](./search-headless.querytrigger.md) + + + | + +Describes the ways a search can be executed besides user input. + + + |
| + +[SearchIntent](./search-headless.searchintent.md) + + + | + +Represents intents from the Search API. + + + |
| + +[SearchTypeEnum](./search-headless.searchtypeenum.md) + + + | + +An enum which indicates the type of search that Headless is managing. + + + |
| + +[SortType](./search-headless.sorttype.md) + + + | + +The method of sorting. + + + |
| + +[Source](./search-headless.source.md) + + + | + +Represents the source of a [Result](./search-headless.result.md). + + + |
| + +[SpellCheckType](./search-headless.spellchecktype.md) + + + | + +Represents the type of spell check performed. + + + |
| + +Function + + + | + +Description + + + |
|---|---|
| + +[combineStaticFilters(filterA, filterB, combinator)](./search-headless.combinestaticfilters.md) + + + | + +Creates a [StaticFilter](./search-headless.staticfilter.md) by applying the specified [FilterCombinator](./search-headless.filtercombinator.md) to the two static filters. Throws an error if an attempt is made to combine a conjunction static filter using [FilterCombinator.OR](./search-headless.filtercombinator.md). + + + |
| + +[createDateRangeStaticFilter(fieldId, range)](./search-headless.createdaterangestaticfilter.md) + + + | + +Creates a [StaticFilter](./search-headless.staticfilter.md) that matches all results where the given field value falls in a specific Date [BoundedRange](./search-headless.boundedrange.md). + + + |
| + +[createEqualsStaticFilter(fieldId, value)](./search-headless.createequalsstaticfilter.md) + + + | + +Creates a [FieldValueStaticFilter](./search-headless.fieldvaluestaticfilter.md) that ensures all results will match a specific field value. + + + |
| + +[createNearMeStaticFilter(position)](./search-headless.createnearmestaticfilter.md) + + + | + +Creates a [FieldValueStaticFilter](./search-headless.fieldvaluestaticfilter.md) that matches all results within a certain radius of the given position. + + + |
| + +[createNumberRangeStaticFilter(fieldId, range)](./search-headless.createnumberrangestaticfilter.md) + + + | + +Creates a [StaticFilter](./search-headless.staticfilter.md) that matches all results where the given field value falls in a specific number [BoundedRange](./search-headless.boundedrange.md). + + + |
| + +[provideHeadless(config)](./search-headless.provideheadless.md) + + + | + +Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. + + + |
| + +Interface + + + | + +Description + + + |
|---|---|
| + +[AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) + + + | + +AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. + + + |
| + +[Address](./search-headless.address.md) + + + | + +An interface with address fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). + + + |
| + +[AddressDirectAnswer](./search-headless.addressdirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'address' field type. + + + |
| + +[AllResultsForVertical](./search-headless.allresultsforvertical.md) + + + | + +Represents all results for the current vertical. + + + |
| + +[AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) + + + | + +A direct answer for an android app url field. + + + |
| + +[AppliedQueryFilter](./search-headless.appliedqueryfilter.md) + + + | + +A filter that the Search API applied to the search. + + + |
| + +[AutocompleteResponse](./search-headless.autocompleteresponse.md) + + + | + +The response of a universal or vertical autocomplete request. + + + |
| + +[AutocompleteResult](./search-headless.autocompleteresult.md) + + + | + +An autocomplete suggestion. + + + |
| + +[AutocompleteService](./search-headless.autocompleteservice.md) + + + | + +A service for autocomplete requests. + + + |
| + +[BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) + + + | + +A direct answer which was found within a document. + + + |
| + +[BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) + + + | + +A direct answer where the answer came from a field from the knowledge graph. + + + |
| + +[BaseSearchConfig](./search-headless.basesearchconfig.md) + + + | + +The base configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [ServingConfig](./search-headless.servingconfig.md). + + + |
| + +[BoundedRange](./search-headless.boundedrange.md) + + + | + +An interface representing a range of values of type T. + + + |
| + +[ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) + + + | + +Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. + + + |
| + +[ComplexURL](./search-headless.complexurl.md) + + + | + +The shape of a [BuiltInFieldType.ComplexURL](./search-headless.builtinfieldtype.md) DirectAnswer value + + + |
| + +[ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md) + + + | + +A direct answer for a complex url field. + + + |
| + +[ConjunctionStaticFilter](./search-headless.conjunctionstaticfilter.md) + + + | + +A static filter composed by combining other static filters with the logical AND operator. + + + |
| + +[DayHour](./search-headless.dayhour.md) + + + | + +An interface for a day's hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). + + + |
| + +[DecimalDirectAnswer](./search-headless.decimaldirectanswer.md) + + + | + +A direct answer for a decimal field, which is a number represented using a string. + + + |
| + +[DirectAnswer](./search-headless.directanswer.md) + + + | + +A direct answer to a search. + + + |
| + +[DirectAnswerState](./search-headless.directanswerstate.md) + + + | + +Maintains the direct answer associated with the latest search. + + + |
| + +[DisjunctionStaticFilter](./search-headless.disjunctionstaticfilter.md) + + + | + +A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters. + + + |
| + +[DisplayableFacet](./search-headless.displayablefacet.md) + + + | + +A [Facet](./search-headless.facet.md) which contains extra fields meant to be displayed to the end user. + + + |
| + +[DisplayableFacetOption](./search-headless.displayablefacetoption.md) + + + | + +A [FacetOption](./search-headless.facetoption.md) with extra data meant to be displayed to the end user. + + + |
| + +[DocumentResult](./search-headless.documentresult.md) + + + | + +Details about the document and the document search algorithm + + + |
| + +[EmailDirectAnswer](./search-headless.emaildirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'email' field type. + + + |
| + +[Endpoints](./search-headless.endpoints.md) + + + | + +Overrides for the URLs which are used when making requests to the Search API. + + + |
| + +[FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md) + + + | + +A direct answer for a facebook url field. + + + |
| + +[Facet](./search-headless.facet.md) + + + | + +Represents dynamic filter options for the Search API. + + + |
| + +[FacetOption](./search-headless.facetoption.md) + + + | + +A filter associated with the facet. + + + |
| + +[FailedVertical](./search-headless.failedvertical.md) + + + | + +Error information from when a vertical fails to return results. + + + |
| + +[FieldValueFilter](./search-headless.fieldvaluefilter.md) + + + | + +Represents a filter which compares values to a single field. + + + |
| + +[FieldValueStaticFilter](./search-headless.fieldvaluestaticfilter.md) + + + | + +A [FieldValueFilter](./search-headless.fieldvaluefilter.md) with the kind of filter specified to discriminate between static filter types. + + + |
| + +[FilterSearchRequest](./search-headless.filtersearchrequest.md) + + + | + +Options for a filtersearch request. + + + |
| + +[FilterSearchResponse](./search-headless.filtersearchresponse.md) + + + | + +The response of a filtersearch request. + + + |
| + +[FiltersState](./search-headless.filtersstate.md) + + + | + +Maintains the current state of facets and filters in the application. + + + |
| + +[HighlightedValue](./search-headless.highlightedvalue.md) + + + | + +A field value and its substring matches as emphasized by the Search API. + + + |
| + +[HolidayHours](./search-headless.holidayhours.md) + + + | + +An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). + + + |
| + +[Hours](./search-headless.hours.md) + + + | + +An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). + + + |
| + +[HoursDirectAnswer](./search-headless.hoursdirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'hours' field type. + + + |
| + +[HTMLSnippetDirectAnswer](./search-headless.htmlsnippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'html' field type. "value" field is omitted for featured snippet direct answer of this field type. + + + |
| + +[InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md) + + + | + +A direct answer for an instagram handle field. + + + |
| + +[IntegerDirectAnswer](./search-headless.integerdirectanswer.md) + + + | + +A direct answer for an integer field. + + + |
| + +[Interval](./search-headless.interval.md) + + + | + +An interface for a time interval to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). + + + |
| + +[IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md) + + + | + +A direct answer for an iOS app url field. + + + |
| + +[LatLong](./search-headless.latlong.md) + + + | + +The latitude and longitude of the user making the request. Used to bias the results. + + + |
| + +[LocationBias](./search-headless.locationbias.md) + + + | + +Information about the user's location. + + + |
| + +[LocationBoundingBox](./search-headless.locationboundingbox.md) + + + | + +Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) + + + |
| + +[LocationFilterDetails](./search-headless.locationfilterdetails.md) + + + | + +Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). + + + |
| + +[LocationState](./search-headless.locationstate.md) + + + | + +Maintains the user's location, if given, or the inferred location, that is used to bias search results. + + + |
| + +[LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) + + + | + +The start limit of [NumberRangeValue](./search-headless.numberrangevalue.md). + + + |
| + +[MarkdownSnippetDirectAnswer](./search-headless.markdownsnippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'markdown' field type. "value" field is omitted for featured snippet direct answer of this field type. + + + |
| + +[MetaState](./search-headless.metastate.md) + + + | + +Maintains the metadata for Search Headless. + + + |
| + +[MultiLineTextSnippetDirectAnswer](./search-headless.multilinetextsnippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. + + + |
| + +[NearFilterValue](./search-headless.nearfiltervalue.md) + + + | + +A filter value for a filter with a $near [Matcher](./search-headless.matcher.md). + + + |
| + +[NumberRangeValue](./search-headless.numberrangevalue.md) + + + | + +A filter value for a filter with a $between [Matcher](./search-headless.matcher.md). + + + |
| + +[ParentState](./search-headless.parentstate.md) + + + | + +The overall shape of the redux state tree, with each key value pair of headlessId to [State](./search-headless.state.md) representing a single SearchHeadless instance. + + + |
| + +[PhoneDirectAnswer](./search-headless.phonedirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with phone value. + + + |
| + +[QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) + + + | + +Data returned from the Search query rules system. + + + |
| + +[QueryRulesState](./search-headless.queryrulesstate.md) + + + | + +Maintains the data from the triggered query rules. + + + |
| + +[QueryState](./search-headless.querystate.md) + + + | + +Maintains the latest query and its associated data. + + + |
| + +[QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) + + + | + +Options for a QuestionSubmission request. + + + |
| + +[QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) + + + | + +A representation of a question submission response. + + + |
| + +[QuestionSubmissionService](./search-headless.questionsubmissionservice.md) + + + | + +Submits a custom question to the Search API. + + + |
| + +[RangeBoundary](./search-headless.rangeboundary.md) + + + | + +A boundary for a [BoundedRange](./search-headless.boundedrange.md) of type T. + + + |
| + +[Result](./search-headless.result.md) + + + | + +An individual search result. + + + |
| + +[RichTextDirectAnswer](./search-headless.richtextdirectanswer.md) + + + | + +A direct answer for a rich text field. + + + |
| + +[RichTextSnippetDirectAnswer](./search-headless.richtextsnippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. + + + |
| + +[RichTextV2SnippetDirectAnswer](./search-headless.richtextv2snippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'rich\_text\_v2' field type. "value" field is omitted for featured snippet direct answer of this field type. + + + |
| + +[SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) + + + | + +Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires apiKey. + + + |
| + +[SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) + + + | + +Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires token. + + + |
| + +[SearchParameterField](./search-headless.searchparameterfield.md) + + + | + +Indicates which entity field to perform the autocomplete request on. + + + |
| + +[SearchRequest](./search-headless.searchrequest.md) + + + | + +Options for a Search API request. + + + |
| + +[SearchService](./search-headless.searchservice.md) + + + | + +A service which performs Yext Search. -## Functions -| Function | Description | -| --- | --- | -| [combineStaticFilters(filterA, filterB, combinator)](./search-headless.combinestaticfilters.md) | Creates a [StaticFilter](./search-headless.staticfilter.md) by applying the specified [FilterCombinator](./search-headless.filtercombinator.md) to the two static filters. Throws an error if an attempt is made to combine a conjunction static filter using [FilterCombinator.OR](./search-headless.filtercombinator.md). | -| [createDateRangeStaticFilter(fieldId, range)](./search-headless.createdaterangestaticfilter.md) | Creates a [StaticFilter](./search-headless.staticfilter.md) that matches all results where the given field value falls in a specific Date [BoundedRange](./search-headless.boundedrange.md). | -| [createEqualsStaticFilter(fieldId, value)](./search-headless.createequalsstaticfilter.md) | Creates a [FieldValueStaticFilter](./search-headless.fieldvaluestaticfilter.md) that ensures all results will match a specific field value. | -| [createNearMeStaticFilter(position)](./search-headless.createnearmestaticfilter.md) | Creates a [FieldValueStaticFilter](./search-headless.fieldvaluestaticfilter.md) that matches all results within a certain radius of the given position. | -| [createNumberRangeStaticFilter(fieldId, range)](./search-headless.createnumberrangestaticfilter.md) | Creates a [StaticFilter](./search-headless.staticfilter.md) that matches all results where the given field value falls in a specific number [BoundedRange](./search-headless.boundedrange.md). | -| [provideHeadless(config)](./search-headless.provideheadless.md) | Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. | + |
| -## Interfaces +[SearchStatusState](./search-headless.searchstatusstate.md) + + + | + +Maintains the status of the latest search. + + + |
| + +[Segment](./search-headless.segment.md) + + + | + +A result produced by a document vertical. + + + |
| + +[SelectableStaticFilter](./search-headless.selectablestaticfilter.md) + + + | + +A [StaticFilter](./search-headless.staticfilter.md) with additional information, such as an optional display name and whether or not it is selected. + + + |
| + +[ServingConfig](./search-headless.servingconfig.md) + + + | + +The configuration options for getting the endpoints. + + + |
| + +[SessionTrackingState](./search-headless.sessiontrackingstate.md) + + + | + +Maintains whether the user session should be tracked and, if so, the session information. + + + |
| + +[Snippet](./search-headless.snippet.md) + + + | + +The section of text where a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) was found. + + + |
| + +[SortBy](./search-headless.sortby.md) + + + | + +Represents a criterion that can be used to sort results. + + + |
| + +[SpellCheck](./search-headless.spellcheck.md) + + + | + +A spellcheck response from a search query. + + + |
| + +[SpellCheckState](./search-headless.spellcheckstate.md) + + + | + +Maintains whether spellcheck is enabled and the spellcheck response from the latest search. + + + |
| + +[State](./search-headless.state.md) + + + | + +The state representing a SearchHeadless instance. + + + |
| + +[StateListener](./search-headless.statelistener.md) + + + | + +Represents a listener for a specific value of type T in the state. + + + |
| + +[StateManager](./search-headless.statemanager.md) + + + | + +Manages the information contained in the state for a SearchHeadless instance. + + + |
| + +[TextDirectAnswer](./search-headless.textdirectanswer.md) + + + | + +A direct answer whose source is a string or string list field in the knowledge graph. + + + |
| + +[TwitterHandleDirectAnswer](./search-headless.twitterhandledirectanswer.md) + + + | + +A direct answer for an twitter handle field. + + + |
| + +[UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) + + + | + +Options for a universal autocomplete request. + + + |
| + +[UniversalLimit](./search-headless.universallimit.md) + + + | + +The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. + + + |
| + +[UniversalSearchRequest](./search-headless.universalsearchrequest.md) + + + | + +Options which can be specified for a universal search. + + + |
| + +[UniversalSearchResponse](./search-headless.universalsearchresponse.md) + + + | + +A representation of a response from a universal search. + + + |
| + +[UniversalSearchState](./search-headless.universalsearchstate.md) + + + | + +Maintains the data for the latest universal search. + + + |
| + +[UnknownFieldValueDirectAnswer](./search-headless.unknownfieldvaluedirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) with a field type outside of [BuiltInFieldType](./search-headless.builtinfieldtype.md). + + + |
| + +[UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) + + + | + +The end limit of [NumberRangeValue](./search-headless.numberrangevalue.md). + + + |
| + +[UrlDirectAnswer](./search-headless.urldirectanswer.md) -| Interface | Description | -| --- | --- | -| [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | -| [Address](./search-headless.address.md) | An interface with address fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). | -| [AddressDirectAnswer](./search-headless.addressdirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'address' field type. | -| [AllResultsForVertical](./search-headless.allresultsforvertical.md) | Represents all results for the current vertical. | -| [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) | A direct answer for an android app url field. | -| [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) | A filter that the Search API applied to the search. | -| [AutocompleteResponse](./search-headless.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. | -| [AutocompleteResult](./search-headless.autocompleteresult.md) | An autocomplete suggestion. | -| [AutocompleteService](./search-headless.autocompleteservice.md) | A service for autocomplete requests. | -| [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) | A direct answer which was found within a document. | -| [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. | -| [BaseSearchConfig](./search-headless.basesearchconfig.md) | The base configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [ServingConfig](./search-headless.servingconfig.md). | -| [BoundedRange](./search-headless.boundedrange.md) | An interface representing a range of values of type T. | -| [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. | -| [ComplexURL](./search-headless.complexurl.md) | The shape of a [BuiltInFieldType.ComplexURL](./search-headless.builtinfieldtype.md) DirectAnswer value | -| [ComplexUrlDirectAnswer](./search-headless.complexurldirectanswer.md) | A direct answer for a complex url field. | -| [ConjunctionStaticFilter](./search-headless.conjunctionstaticfilter.md) | A static filter composed by combining other static filters with the logical AND operator. | -| [DayHour](./search-headless.dayhour.md) | An interface for a day's hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). | -| [DecimalDirectAnswer](./search-headless.decimaldirectanswer.md) | A direct answer for a decimal field, which is a number represented using a string. | -| [DirectAnswer](./search-headless.directanswer.md) | A direct answer to a search. | -| [DirectAnswerState](./search-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. | -| [DisjunctionStaticFilter](./search-headless.disjunctionstaticfilter.md) | A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters. | -| [DisplayableFacet](./search-headless.displayablefacet.md) | A [Facet](./search-headless.facet.md) which contains extra fields meant to be displayed to the end user. | -| [DisplayableFacetOption](./search-headless.displayablefacetoption.md) | A [FacetOption](./search-headless.facetoption.md) with extra data meant to be displayed to the end user. | -| [DocumentResult](./search-headless.documentresult.md) | Details about the document and the document search algorithm | -| [EmailDirectAnswer](./search-headless.emaildirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'email' field type. | -| [Endpoints](./search-headless.endpoints.md) | Overrides for the URLs which are used when making requests to the Search API. | -| [FacebookUrlDirectAnswer](./search-headless.facebookurldirectanswer.md) | A direct answer for a facebook url field. | -| [Facet](./search-headless.facet.md) | Represents dynamic filter options for the Search API. | -| [FacetOption](./search-headless.facetoption.md) | A filter associated with the facet. | -| [FailedVertical](./search-headless.failedvertical.md) | Error information from when a vertical fails to return results. | -| [FieldValueFilter](./search-headless.fieldvaluefilter.md) | Represents a filter which compares values to a single field. | -| [FieldValueStaticFilter](./search-headless.fieldvaluestaticfilter.md) | A [FieldValueFilter](./search-headless.fieldvaluefilter.md) with the kind of filter specified to discriminate between static filter types. | -| [FilterSearchRequest](./search-headless.filtersearchrequest.md) | Options for a filtersearch request. | -| [FilterSearchResponse](./search-headless.filtersearchresponse.md) | The response of a filtersearch request. | -| [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. | -| [HighlightedValue](./search-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. | -| [HolidayHours](./search-headless.holidayhours.md) | An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). | -| [Hours](./search-headless.hours.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). | -| [HoursDirectAnswer](./search-headless.hoursdirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'hours' field type. | -| [HTMLSnippetDirectAnswer](./search-headless.htmlsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'html' field type. "value" field is omitted for featured snippet direct answer of this field type. | -| [InstagramHandleDirectAnswer](./search-headless.instagramhandledirectanswer.md) | A direct answer for an instagram handle field. | -| [IntegerDirectAnswer](./search-headless.integerdirectanswer.md) | A direct answer for an integer field. | -| [Interval](./search-headless.interval.md) | An interface for a time interval to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md). | -| [IosAppUrlDirectAnswer](./search-headless.iosappurldirectanswer.md) | A direct answer for an iOS app url field. | -| [LatLong](./search-headless.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. | -| [LocationBias](./search-headless.locationbias.md) | Information about the user's location. | -| [LocationBoundingBox](./search-headless.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) | -| [LocationFilterDetails](./search-headless.locationfilterdetails.md) | Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). | -| [LocationState](./search-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. | -| [LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./search-headless.numberrangevalue.md). | -| [MarkdownSnippetDirectAnswer](./search-headless.markdownsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'markdown' field type. "value" field is omitted for featured snippet direct answer of this field type. | -| [MetaState](./search-headless.metastate.md) | Maintains the metadata for Search Headless. | -| [MultiLineTextSnippetDirectAnswer](./search-headless.multilinetextsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. | -| [NearFilterValue](./search-headless.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./search-headless.matcher.md). | -| [NumberRangeValue](./search-headless.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./search-headless.matcher.md). | -| [ParentState](./search-headless.parentstate.md) | The overall shape of the redux state tree, with each key value pair of headlessId to [State](./search-headless.state.md) representing a single SearchHeadless instance. | -| [PhoneDirectAnswer](./search-headless.phonedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with phone value. | -| [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) | Data returned from the Search query rules system. | -| [QueryRulesState](./search-headless.queryrulesstate.md) | Maintains the data from the triggered query rules. | -| [QueryState](./search-headless.querystate.md) | Maintains the latest query and its associated data. | -| [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) | Options for a QuestionSubmission request. | -| [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) | A representation of a question submission response. | -| [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) | Submits a custom question to the Search API. | -| [RangeBoundary](./search-headless.rangeboundary.md) | A boundary for a [BoundedRange](./search-headless.boundedrange.md) of type T. | -| [Result](./search-headless.result.md) | An individual search result. | -| [RichTextDirectAnswer](./search-headless.richtextdirectanswer.md) | A direct answer for a rich text field. | -| [RichTextSnippetDirectAnswer](./search-headless.richtextsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. | -| [RichTextV2SnippetDirectAnswer](./search-headless.richtextv2snippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) with 'rich\_text\_v2' field type. "value" field is omitted for featured snippet direct answer of this field type. | -| [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) | Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires apiKey. | -| [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) | Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires token. | -| [SearchParameterField](./search-headless.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. | -| [SearchRequest](./search-headless.searchrequest.md) | Options for a Search API request. | -| [SearchService](./search-headless.searchservice.md) | A service which performs Yext Search. | -| [SearchStatusState](./search-headless.searchstatusstate.md) | Maintains the status of the latest search. | -| [Segment](./search-headless.segment.md) | A result produced by a document vertical. | -| [SelectableStaticFilter](./search-headless.selectablestaticfilter.md) | A [StaticFilter](./search-headless.staticfilter.md) with additional information, such as an optional display name and whether or not it is selected. | -| [ServingConfig](./search-headless.servingconfig.md) | The configuration options for getting the endpoints. | -| [SessionTrackingState](./search-headless.sessiontrackingstate.md) | Maintains whether the user session should be tracked and, if so, the session information. | -| [Snippet](./search-headless.snippet.md) | The section of text where a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) was found. | -| [SortBy](./search-headless.sortby.md) | Represents a criterion that can be used to sort results. | -| [SpellCheck](./search-headless.spellcheck.md) | A spellcheck response from a search query. | -| [SpellCheckState](./search-headless.spellcheckstate.md) | Maintains whether spellcheck is enabled and the spellcheck response from the latest search. | -| [State](./search-headless.state.md) | The state representing a SearchHeadless instance. | -| [StateListener](./search-headless.statelistener.md) | Represents a listener for a specific value of type T in the state. | -| [StateManager](./search-headless.statemanager.md) | Manages the information contained in the state for a SearchHeadless instance. | -| [TextDirectAnswer](./search-headless.textdirectanswer.md) | A direct answer whose source is a string or string list field in the knowledge graph. | -| [TwitterHandleDirectAnswer](./search-headless.twitterhandledirectanswer.md) | A direct answer for an twitter handle field. | -| [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) | Options for a universal autocomplete request. | -| [UniversalLimit](./search-headless.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | -| [UniversalSearchRequest](./search-headless.universalsearchrequest.md) | Options which can be specified for a universal search. | -| [UniversalSearchResponse](./search-headless.universalsearchresponse.md) | A representation of a response from a universal search. | -| [UniversalSearchState](./search-headless.universalsearchstate.md) | Maintains the data for the latest universal search. | -| [UnknownFieldValueDirectAnswer](./search-headless.unknownfieldvaluedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) with a field type outside of [BuiltInFieldType](./search-headless.builtinfieldtype.md). | -| [UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) | The end limit of [NumberRangeValue](./search-headless.numberrangevalue.md). | -| [UrlDirectAnswer](./search-headless.urldirectanswer.md) | A direct answer for a simple url field. | -| [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) | Options for a vertial autocomplete request. | -| [VerticalResults](./search-headless.verticalresults.md) | Represents results from a search vertical. | -| [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) | Options which can be specified for a vertical search. | -| [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) | A representation of a response from a vertical search. | -| [VerticalSearchState](./search-headless.verticalsearchstate.md) | Maintains the data for the latest vertical search. | -| [Visitor](./search-headless.visitor.md) | Information used to associate requests with a particular user. | + + | + +A direct answer for a simple url field. + + + |
| + +[VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) + + + | + +Options for a vertial autocomplete request. + + + |
| + +[VerticalResults](./search-headless.verticalresults.md) + + + | + +Represents results from a search vertical. + + + |
| + +[VerticalSearchRequest](./search-headless.verticalsearchrequest.md) + + + | + +Options which can be specified for a vertical search. + + + |
| + +[VerticalSearchResponse](./search-headless.verticalsearchresponse.md) + + + | + +A representation of a response from a vertical search. + + + |
| + +[VerticalSearchState](./search-headless.verticalsearchstate.md) + + + | + +Maintains the data for the latest vertical search. + + + |
| + +[Visitor](./search-headless.visitor.md) + + + | + +Information used to associate requests with a particular user. + + + |
| + +Namespace + + + | + +Description + + + |
|---|---|
| + +[searchUtilities](./search-headless.searchutilities.md) + + + | + + + |
| + +Variable + + + | + +Description + + + |
|---|---|
| + +[DEFAULT\_HEADLESS\_ID](./search-headless.default_headless_id.md) + + + | + +The headlessId automatically given to the first SearchHeadless instance created. + + + |
| + +[SandboxEndpoints](./search-headless.sandboxendpoints.md) + + + | + +The endpoints to use for sandbox experiences. + + + |
| + +Type Alias + + + | + +Description + + + |
|---|---|
| + +[Context](./search-headless.context.md) + + + | + +Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + + + |
| + +[EnumOrLiteral](./search-headless.enumorliteral.md) + + + | + +Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum. + + + |
| + +[FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) + + + | + +All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-headless.basefeaturedsnippetdirectanswer.md) interfaces. + + + |
| + +[FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) + + + | + +Possible built-in and custom [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interfaces. + + + |
| + +[HeadlessConfig](./search-headless.headlessconfig.md) + + + | + +The configuration for a SearchHeadless instance. + + + |
| + +[HighlightedFields](./search-headless.highlightedfields.md) + + + | + +A mapping of fields to the values emphasized by the Search API. + + + |
| + +[SearchConfig](./search-headless.searchconfig.md) + + + | + +The main configuration options for [SearchCore](./search-headless.searchcore.md). For a full description of the options, see [BaseSearchConfig](./search-headless.basesearchconfig.md). The config requires either an apiKey or a token. + + + |
| + +[SearchType](./search-headless.searchtype.md) + + + | + +An enum and its corresponding string literals which indicate the type of search that Headless is managing. + + + |
| + +[StaticFilter](./search-headless.staticfilter.md) + + + | + +Represents a static filter that will be used to refine results. + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[context?](./search-headless.metastate.context.md) + + + | + + + | + +[Context](./search-headless.context.md) + + + | + +_(Optional)_ A JSON object used for passing data to and triggering Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + + + |
| + +[referrerPageUrl?](./search-headless.metastate.referrerpageurl.md) + + + | + + + | + +string + + + | + +_(Optional)_ The URL of the referring page (the page that directed to the current page from which the request was made). + + + |
| + +[searchType](./search-headless.metastate.searchtype.md) + + + | + + + | + +[SearchType](./search-headless.searchtype.md) + + + | + +Indicates the type of search that Search Headless is managing. + + + |
| + +[uuid?](./search-headless.metastate.uuid.md) + + + | + + + | + +string + + + | + +_(Optional)_ A unique id which corresponds to the latest request/response. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.multilinetextsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.MultiLineText](./search-headless.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| + +[value](./search-headless.multilinetextsnippetdirectanswer.value.md) + + + | + + + | + +string + + + | + +The value of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[lat](./search-headless.nearfiltervalue.lat.md) + + + | + + + | + +number + + + | + +The latitude of the location. + + + |
| + +[lng](./search-headless.nearfiltervalue.lng.md) + + + | + + + | + +number + + + | + +The longitude of the location. + + + |
| + +[radius](./search-headless.nearfiltervalue.radius.md) + + + | + + + | + +number + + + | + +The radius (in meters) around the latitude and longitude. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[end?](./search-headless.numberrangevalue.end.md) + + + | + + + | + +[UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) + + + | + +_(Optional)_ End limit of the number range value. + + + |
| + +[start?](./search-headless.numberrangevalue.start.md) + + + | + + + | + +[LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) + + + | + +_(Optional)_ Start limit of the number range value. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.phonedirectanswer.fieldtype.md) + + + | + + + | + +[BuiltInFieldType.Phone](./search-headless.builtinfieldtype.md) + + + | + + + |
| -Returns: +Parameter -SearchHeadless + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +config + + + | + +[HeadlessConfig](./search-headless.headlessconfig.md) + + + | + +The apiKey, experienceKey, etc. needed to set up a front-end Search experience. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[data?](./search-headless.queryrulesactionsdata.data.md) + + + | + + + | + +Record<string, unknown> + + + | + +_(Optional)_ The data returned from the query rule. + + + |
| + +[errors?](./search-headless.queryrulesactionsdata.errors.md) + + + | + + + | + +{ uuid: string; type: string; message?: string; }\[\] + + + | + +_(Optional)_ Any errors returned from the query rule. + + + |
| + +[key](./search-headless.queryrulesactionsdata.key.md) + + + | + + + | + +string + + + | + +The unique identifier for this query rule. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[actions](./search-headless.queryrulesstate.actions.md) + + + | + + + | + +[QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] + + + | + +Any actions triggered by meeting criteria for query rules. + + + |
"AUTOCOMPLETE" | Indicates that the query was initiated from visual autocomplete. |
-| Overlay | "OVERLAY" | Indicates that the query was initiated from a Search Overlay. |
-| Standard | "STANDARD" | Indicates that the query was initiated from a standard Search integration. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +Autocomplete + + + | + +`"AUTOCOMPLETE"` + + + | + +Indicates that the query was initiated from visual autocomplete. + + + |
| + +Overlay + + + | + +`"OVERLAY"` + + + | + +Indicates that the query was initiated from a Search Overlay. + + + |
| + +Standard + + + | + +`"STANDARD"` + + + | + +Indicates that the query was initiated from a standard Search integration. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[input?](./search-headless.querystate.input.md) + + + | + + + | + +string + + + | + +_(Optional)_ The user input used for the next search query. + + + |
| + +[isPagination?](./search-headless.querystate.ispagination.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Whether the next query represents a pagination - in which case queryId will be maintained + + + |
| + +[mostRecentSearch?](./search-headless.querystate.mostrecentsearch.md) + + + | + + + | + +string + + + | + +_(Optional)_ The query of the most recent search. + + + |
| + +[queryId?](./search-headless.querystate.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The ID of the query from the latest search. + + + |
| + +[querySource?](./search-headless.querystate.querysource.md) + + + | + + + | + +[QuerySource](./search-headless.querysource.md) + + + | + +_(Optional)_ The source of the query (from a standard Search integration, a Search overlay, or from visual autocomplete). + + + |
| + +[queryTrigger?](./search-headless.querystate.querytrigger.md) + + + | + + + | + +[QueryTrigger](./search-headless.querytrigger.md) + + + | + +_(Optional)_ How the query was triggered (besides user input). + + + |
| + +[searchIntents?](./search-headless.querystate.searchintents.md) + + + | + + + | + +[SearchIntent](./search-headless.searchintent.md)\[\] + + + | + +_(Optional)_ The computed intents of the mostRecentSearch, as returned by the Search API. + + + |
"initialize" | Indicates that the query was triggered by a default initial search. |
-| Suggest | "suggest" | Indicates that the query was suggested by a [SpellCheck](./search-headless.spellcheck.md) response. |
+| + +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +Initialize + + + | + +`"initialize"` + + + | + +Indicates that the query was triggered by a default initial search. + + + |
| + +Suggest + + + | + +`"suggest"` + + + | + +Indicates that the query was suggested by a [SpellCheck](./search-headless.spellcheck.md) response. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[email](./search-headless.questionsubmissionrequest.email.md) + + + | + + + | + +string + + + | + +The email of the user that is submitting the question. + + + |
| + +[entityId](./search-headless.questionsubmissionrequest.entityid.md) + + + | + + + | + +string + + + | + +The ID of the entity to associate with the question. + + + |
| + +[name](./search-headless.questionsubmissionrequest.name.md) + + + | + + + | + +string + + + | + +The name of the user. + + + |
| + +[questionDescription?](./search-headless.questionsubmissionrequest.questiondescription.md) + + + | + + + | + +string + + + | + +_(Optional)_ Additional information about the question. + + + |
| + +[questionText](./search-headless.questionsubmissionrequest.questiontext.md) + + + | + + + | + +string + + + | + +The question. + + + |
| + +[sessionTrackingEnabled?](./search-headless.questionsubmissionrequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[uuid](./search-headless.questionsubmissionresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[submitQuestion(request)](./search-headless.questionsubmissionservice.submitquestion.md) + + + | + +Submits a question to be answered. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[inclusive](./search-headless.rangeboundary.inclusive.md) + + + | + + + | + +boolean + + + | + +Whether or not the range includes the boundary value. + + + |
| + +[value](./search-headless.rangeboundary.value.md) + + + | + + + | + +T + + + | + +The value of the boundary. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[description?](./search-headless.result.description.md) + + + | + + + | + +string + + + | + +_(Optional)_ A description of the result. + + + |
| + +[distance?](./search-headless.result.distance.md) + + + | + + + | + +number + + + | + +_(Optional)_ The distance from the user to the result in meters. + + + |
| + +[distanceFromFilter?](./search-headless.result.distancefromfilter.md) + + + | + + + | + +number + + + | + +_(Optional)_ The distance from a [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) location to the result in meters. + + + |
| + +[document?](./search-headless.result.document.md) + + + | + + + | + +[DocumentResult](./search-headless.documentresult.md) + + + | + +_(Optional)_ A relevant document associated with the result. Present for document verticals grouped by Document. + + + |
| + +[documents?](./search-headless.result.documents.md) + + + | + + + | + +[DocumentResult](./search-headless.documentresult.md)\[\] + + + | + +_(Optional)_ All relevant documents associated with the result. Present for document verticals grouped by Entity. + + + |
| + +[entityType?](./search-headless.result.entitytype.md) + + + | + + + | + +string + + + | + +_(Optional)_ The entity type of the result. + + + |
| + +[highlightedFields?](./search-headless.result.highlightedfields.md) + + + | + + + | + +[HighlightedFields](./search-headless.highlightedfields.md) + + + | + +_(Optional)_ The [highlighted fields](./search-headless.highlightedfields.md) emphasized by the api. + + + |
| + +[id?](./search-headless.result.id.md) + + + | + + + | + +string + + + | + +_(Optional)_ The result ID which depends on the Result Source. + + + |
| + +[index?](./search-headless.result.index.md) + + + | + + + | + +number + + + | + +_(Optional)_ The index of the result among the other results in the search. + + + |
| + +[link?](./search-headless.result.link.md) + + + | + + + | + +string + + + | + +_(Optional)_ A hyperlink associated with the result. + + + |
| + +[name?](./search-headless.result.name.md) + + + | + + + | + +string + + + | + +_(Optional)_ The name of the result. + + + |
| + +[rawData](./search-headless.result.rawdata.md) + + + | + + + | + +T + + + | + +Raw entity profile data in the shape of key-value pairs, or as an array of key-value pairs. + + + |
| + +[segment?](./search-headless.result.segment.md) + + + | + + + | + +[Segment](./search-headless.segment.md) + + + | + +_(Optional)_ A relevant segment associated with the result. Present for document verticals grouped by Segment. + + + |
| + +[source](./search-headless.result.source.md) + + + | + + + | + +[Source](./search-headless.source.md) + + + | + +Represents the source of a [Result](./search-headless.result.md). + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.richtextdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.RichText](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.richtextsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.RichText](./search-headless.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.richtextv2snippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.RichText\_v2](./search-headless.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[apiKey](./search-headless.searchconfigwithapikey.apikey.md) + + + | + + + | + +string + + + | + +The api key of the search experience which will be sent as a query param. + + + |
| + +[token?](./search-headless.searchconfigwithapikey.token.md) + + + | + + + | + +never + + + | + +_(Optional)_ token should NOT be provided along with apiKey. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[apiKey?](./search-headless.searchconfigwithtoken.apikey.md) + + + | + + + | + +never + + + | + +_(Optional)_ apiKey should NOT be provided along with token. + + + |
| + +[token](./search-headless.searchconfigwithtoken.token.md) + + + | + + + | + +string + + + | + +The authentication token of the search experience which will be passed in the Auth header as a Bearer token. + + + |
| +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +searchService + + + | + +[SearchService](./search-headless.searchservice.md) + + + | + + + |
| + +questionSubmissionService + + + | + +[QuestionSubmissionService](./search-headless.questionsubmissionservice.md) + + + | + + + |
| + +autoCompleteService + + + | + +[AutocompleteService](./search-headless.autocompleteservice.md) + + + | + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +request + + + | + +[FilterSearchRequest](./search-headless.filtersearchrequest.md) + + + | + +filtersearch request options + + + |
SearchCore class |
+| + +Constructor + + + | + +Modifiers + + + | + +Description + + + |
|---|---|---|
| + +[(constructor)(searchService, questionSubmissionService, autoCompleteService)](./search-headless.searchcore._constructor_.md) + + + | + + + | + +Constructs a new instance of the `SearchCore` class + + + |
| + +Method + + + | + +Modifiers + + + | + +Description + + + |
|---|---|---|
| + +[filterSearch(request)](./search-headless.searchcore.filtersearch.md) + + + | + + + | + +Performs a filtersearch request against specified fields within a single vertical. + + + |
| + +[submitQuestion(request)](./search-headless.searchcore.submitquestion.md) + + + | + + + | + +Submits a custom question to the Search API. + + + |
| + +[universalAutocomplete(request)](./search-headless.searchcore.universalautocomplete.md) + + + | + + + | + +Performs an autocomplete request across all verticals. + + + |
| + +[universalSearch(request)](./search-headless.searchcore.universalsearch.md) + + + | + + + | + +Performs a search across all verticals. + + + |
| + +[verticalAutocomplete(request)](./search-headless.searchcore.verticalautocomplete.md) + + + | + + + | + +Performs an autocomplete request for a single vertical. + + + |
| + +[verticalSearch(request)](./search-headless.searchcore.verticalsearch.md) + + + | + + + | + +Performs a search for a single vertical. + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +request + + + | + +[VerticalSearchRequest](./search-headless.verticalsearchrequest.md) + + + | + +Vertical search request options + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[code?](./search-headless.searcherror.code.md) + + + | + + + | + +number + + + | + +_(Optional)_ Search API error code. + + + |
| + +[message](./search-headless.searcherror.message.md) + + + | + + + | + +string + + + | + +The error message. + + + |
| + +[type?](./search-headless.searcherror.type.md) + + + | + + + | + +string + + + | + +_(Optional)_ Search API error type. + + + |
| +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +core + + + | + +[SearchCore](./search-headless.searchcore.md) + + + | + + + |
| + +stateManager + + + | + +[StateManager](./search-headless.statemanager.md) + + + | + + + |
| + +httpManager + + + | + +HttpManager + + + | + + + |
| + +additionalHttpHeaders + + + | + +[AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) \| undefined + + + | + +_(Optional)_ + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +listener + + + | + +[StateListener](./search-headless.statelistener.md)<T> + + + | + +The listener to add + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +query + + + | + +string + + + | + +The query for which to search + + + |
| + +sectioned + + + | + +boolean + + + | + +Whether or not the results should be sectioned by field + + + |
| + +fields + + + | + +[SearchParameterField](./search-headless.searchparameterfield.md)\[\] + + + | + +The entity fields to search + + + |
SearchHeadless class |
+| + +Constructor + + + | + +Modifiers + + + | + +Description + + + |
|---|---|---|
| + +[(constructor)(core, stateManager, httpManager, additionalHttpHeaders)](./search-headless.searchheadless._constructor_.md) + + + | + + + | + +Constructs a new instance of the `SearchHeadless` class + + + |
| + +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[state](./search-headless.searchheadless.state.md) + + + | + +`readonly` + + + | + +[State](./search-headless.state.md) + + + | + +Gets the current state of the SearchHeadless instance. + + + |
| + +[utilities](./search-headless.searchheadless.utilities.md) + + + | + +`readonly` + + + | + +typeof searchUtilities + + + | + +Common utility functions for manipulating Search-related data. + + + |
| + +Method + + + | + +Modifiers + + + | + +Description + + + |
|---|---|---|
| + +[addListener(listener)](./search-headless.searchheadless.addlistener.md) + + + | + + + | + +Adds a listener for a specific state value of type T. + + + |
| + +[executeFilterSearch(query, sectioned, fields)](./search-headless.searchheadless.executefiltersearch.md) + + + | + + + | + +Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. + + + |
| + +[executeUniversalAutocomplete()](./search-headless.searchheadless.executeuniversalautocomplete.md) + + + | + + + | + +Performs an autocomplete request across all verticals using the query input stored in state. + + + |
| + +[executeUniversalQuery()](./search-headless.searchheadless.executeuniversalquery.md) + + + | + + + | + +Performs a Search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. + + + |
| + +[executeVerticalAutocomplete()](./search-headless.searchheadless.executeverticalautocomplete.md) + + + | + + + | + +Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. + + + |
| + +[executeVerticalQuery()](./search-headless.searchheadless.executeverticalquery.md) + + + | + + + | + +Perform a Search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. + + + |
| + +[resetFacets()](./search-headless.searchheadless.resetfacets.md) + + + | + + + | + +Unselects all [facets](./search-headless.filtersstate.facets.md). + + + |
| + +[setAlternativeVerticals(alternativeVerticals)](./search-headless.searchheadless.setalternativeverticals.md) + + + | + + + | + +Sets the alternativeVerticals for [VerticalSearchState.noResults](./search-headless.verticalsearchstate.noresults.md) to the specified verticals. + + + |
| + +[setContext(context)](./search-headless.searchheadless.setcontext.md) + + + | + + + | + +Sets [MetaState.context](./search-headless.metastate.context.md) to the specified context. + + + |
| + +[setFacetOption(fieldId, facetOption, selected)](./search-headless.searchheadless.setfacetoption.md) + + + | + + + | + +Sets a specified facet option to be selected or unselected. + + + |
| + +[setFacets(facets)](./search-headless.searchheadless.setfacets.md) + + + | + + + | + +Sets [FiltersState.facets](./search-headless.filtersstate.facets.md) to the specified facets. + + + |
| + +[setFilterOption(filter)](./search-headless.searchheadless.setfilteroption.md) + + + | + + + | + +Sets a static filter option and whether or not it is selected in state. + + + |
| + +[setIsPagination(input)](./search-headless.searchheadless.setispagination.md) + + + | + + + | + +Sets [QueryState.isPagination](./search-headless.querystate.ispagination.md) to the specified input. + + + |
| + +[setLocationRadius(locationRadius)](./search-headless.searchheadless.setlocationradius.md) + + + | + + + | + +Sets [VerticalSearchState.locationRadius](./search-headless.verticalsearchstate.locationradius.md) to the specified number of meters. + + + |
| + +[setOffset(offset)](./search-headless.searchheadless.setoffset.md) + + + | + + + | + +Sets [VerticalSearchState.offset](./search-headless.verticalsearchstate.offset.md) to the specified offset. + + + |
| + +[setQuery(input)](./search-headless.searchheadless.setquery.md) + + + | + + + | + +Sets [QueryState.input](./search-headless.querystate.input.md) to the specified input. + + + |
| + +[setQuerySource(source)](./search-headless.searchheadless.setquerysource.md) + + + | + + + | + +Sets [QueryState.querySource](./search-headless.querystate.querysource.md) to the specified source. + + + |
| + +[setQueryTrigger(trigger)](./search-headless.searchheadless.setquerytrigger.md) + + + | + + + | + +Sets [QueryState.queryTrigger](./search-headless.querystate.querytrigger.md) to the specified trigger. + + + |
| + +[setReferrerPageUrl(referrerPageUrl)](./search-headless.searchheadless.setreferrerpageurl.md) + + + | + + + | + +Sets [MetaState.referrerPageUrl](./search-headless.metastate.referrerpageurl.md) to the specified URL. + + + |
| + +[setRestrictVerticals(restrictVerticals)](./search-headless.searchheadless.setrestrictverticals.md) + + + | + + + | + +Sets [UniversalSearchState.restrictVerticals](./search-headless.universalsearchstate.restrictverticals.md) to the specified vertical keys. + + + |
| + +[setSessionId(sessionId)](./search-headless.searchheadless.setsessionid.md) + + + | + + + | + +Sets [SessionTrackingState.sessionId](./search-headless.sessiontrackingstate.sessionid.md) to the specified ID. + + + |
| + +[setSessionTrackingEnabled(enabled)](./search-headless.searchheadless.setsessiontrackingenabled.md) + + + | + + + | + +Sets [SessionTrackingState.enabled](./search-headless.sessiontrackingstate.enabled.md) to the specified boolean value. + + + |
| + +[setSortBys(sortBys)](./search-headless.searchheadless.setsortbys.md) + + + | + + + | + +Sets [VerticalSearchState.sortBys](./search-headless.verticalsearchstate.sortbys.md) to the specified sortBys. + + + |
| + +[setSpellCheckEnabled(enabled)](./search-headless.searchheadless.setspellcheckenabled.md) + + + | + + + | + +Sets [SpellCheckState.enabled](./search-headless.spellcheckstate.enabled.md) to the specified boolean value. + + + |
| + +[setState(state)](./search-headless.searchheadless.setstate.md) + + + | + + + | + +Sets the [State](./search-headless.state.md) to the specified state. + + + |
| + +[setStaticFilters(filters)](./search-headless.searchheadless.setstaticfilters.md) + + + | + + + | + +Sets [FiltersState.static](./search-headless.filtersstate.static.md) to the specified filters. + + + |
| + +[setUniversal()](./search-headless.searchheadless.setuniversal.md) + + + | + + + | + +Sets up Headless to manage universal searches. + + + |
| + +[setUniversalLimit(limit)](./search-headless.searchheadless.setuniversallimit.md) + + + | + + + | + +Sets [UniversalSearchState.limit](./search-headless.universalsearchstate.limit.md) to the specified limit. + + + |
| + +[setUserLocation(latLong)](./search-headless.searchheadless.setuserlocation.md) + + + | + + + | + +Sets [LocationState.userLocation](./search-headless.locationstate.userlocation.md) to the specified latitude and longitude. + + + |
| + +[setVertical(verticalKey)](./search-headless.searchheadless.setvertical.md) + + + | + + + | + +Sets up Headless to manage the vertical indicated by the verticalKey. + + + |
| + +[setVerticalLimit(limit)](./search-headless.searchheadless.setverticallimit.md) + + + | + + + | + +Sets [VerticalSearchState.limit](./search-headless.verticalsearchstate.limit.md) to the specified limit. + + + |
| + +[submitQuestion(request)](./search-headless.searchheadless.submitquestion.md) + + + | + + + | + +Submits a question to the Search API with the specified request data. + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +alternativeVerticals + + + | + +[VerticalResults](./search-headless.verticalresults.md)\[\] + + + | + +The alternative verticals to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +context + + + | + +[Context](./search-headless.context.md) + + + | + +The context to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +fieldId + + + | + +string + + + | + +The fieldId for the facet + + + |
| + +facetOption + + + | + +[FacetOption](./search-headless.facetoption.md) + + + | + +The option of the facet to select + + + |
| + +selected + + + | + +boolean + + + | + +Whether or not the facet option should be selected + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +facets + + + | + +[DisplayableFacet](./search-headless.displayablefacet.md)\[\] + + + | + +The facets to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +filter + + + | + +[SelectableStaticFilter](./search-headless.selectablestaticfilter.md) + + + | + +The static filter and whether it is selected + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +input + + + | + +boolean + + + | + +The input to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +locationRadius + + + | + +number \| undefined + + + | + +The radius (in meters) to filter vertical searches by. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +offset + + + | + +number + + + | + +The vertical offset to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +input + + + | + +string + + + | + +The input to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +source + + + | + +[QuerySource](./search-headless.querysource.md) + + + | + +The query source to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +trigger + + + | + +[QueryTrigger](./search-headless.querytrigger.md) + + + | + +The query trigger to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +referrerPageUrl + + + | + +string + + + | + +The referring page URL to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +restrictVerticals + + + | + +string\[\] + + + | + +The new verticals to restrict a universal search + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +sessionId + + + | + +string + + + | + +The session ID to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +enabled + + + | + +boolean + + + | + +Whether or not session tracking should be set to enabled + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +sortBys + + + | + +[SortBy](./search-headless.sortby.md)\[\] + + + | + +The sortBys to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +enabled + + + | + +boolean + + + | + +Whether or not spellcheck should be set to enabled + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +state + + + | + +[State](./search-headless.state.md) + + + | + +The state to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +filters + + + | + +[SelectableStaticFilter](./search-headless.selectablestaticfilter.md)\[\] + + + | + +The static filters to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +limit + + + | + +[UniversalLimit](./search-headless.universallimit.md) + + + | + +The universal limit to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +latLong + + + | + +[LatLong](./search-headless.latlong.md) + + + | + +The user location to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +verticalKey + + + | + +string + + + | + +The vertical key to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +limit + + + | + +number + + + | + +The vertical limit to set + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +request + + + | + +Omit<[QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md), 'additionalHttpHeaders'> + + + | + +The data for the network request + + + |
"NEAR_ME" | The Search API is requesting a prompt for the user's location. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +NearMe + + + | + +`"NEAR_ME"` + + + | + +The Search API is requesting a prompt for the user's location. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[entityType](./search-headless.searchparameterfield.entitytype.md) + + + | + + + | + +string + + + | + +The entityType to perform the autocomplete on. + + + |
| + +[fetchEntities](./search-headless.searchparameterfield.fetchentities.md) + + + | + + + | + +boolean + + + | + +Indicates whether or not to return the [AutocompleteResult.relatedItem](./search-headless.autocompleteresult.relateditem.md) associated with the autocomplete result. + + + |
| + +[fieldApiName](./search-headless.searchparameterfield.fieldapiname.md) + + + | + + + | + +string + + + | + +The fieldApiName to perform the autocomplete on. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[additionalHttpHeaders?](./search-headless.searchrequest.additionalhttpheaders.md) + + + | + + + | + +[AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) + + + | + +_(Optional)_ AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[universalSearch(request)](./search-headless.searchservice.universalsearch.md) + + + | + +Performs a Universal search across all verticals. + + + |
| + +[verticalSearch(request)](./search-headless.searchservice.verticalsearch.md) + + + | + +Performs a search across a particular Vertical. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +request + + + | + +[VerticalSearchRequest](./search-headless.verticalsearchrequest.md) + + + | + +The details of the Vertical search request. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[isLoading?](./search-headless.searchstatusstate.isloading.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Whether a search is currently loading or has finished loading. + + + |
"universal" | Indicates that headless is managing universal search. |
-| Vertical | "vertical" | Indicates that headless is managing vertical search. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +Universal + + + | + +`"universal"` + + + | + +Indicates that headless is managing universal search. + + + |
| + +Vertical + + + | + +`"vertical"` + + + | + +Indicates that headless is managing vertical search. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +value + + + | + +string + + + | + +The string to compare against + + + |
| + +searchTerm + + + | + +string + + + | + +The term being searched for + + + |
| +Function + + + | + +Description + + + |
|---|---|
| + +[isCloseMatch(value, searchTerm)](./search-headless.searchutilities.isclosematch.md) + + + | + +Checks if the searchTerm is a case-insensitive, Levenshtein match for the value. + + + |
| + +[searchThroughFacet(facet, searchTerm)](./search-headless.searchutilities.searchthroughfacet.md) + + + | + +Searches through the specified facet and filters out the options that aren't a close match for the given searchTerm. The comparison is case insensitive. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +facet + + + | + +[DisplayableFacet](./search-headless.displayablefacet.md) + + + | + +The facet whose options are searched through + + + |
| + +searchTerm + + + | + +string + + + | + +The search term to compare the facet options against + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[pageNumber?](./search-headless.segment.pagenumber.md) + + + | + + + | + +number + + + | + +_(Optional)_ The page number of the document that the segment came from. Populated only for pdf files. + + + |
| + +[score](./search-headless.segment.score.md) + + + | + + + | + +number + + + | + +The similarity score of the segment from 0 to 1 + + + |
| + +[text](./search-headless.segment.text.md) + + + | + + + | + +string + + + | + +The value of the segment as plain text. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[displayName?](./search-headless.selectablestaticfilter.displayname.md) + + + | + + + | + +string + + + | + +_(Optional)_ The filter's display name. + + + |
| + +[filter](./search-headless.selectablestaticfilter.filter.md) + + + | + + + | + +[StaticFilter](./search-headless.staticfilter.md) + + + | + +Represents a static filter that will be used to refine results. + + + |
| + +[selected](./search-headless.selectablestaticfilter.selected.md) + + + | + + + | + +boolean + + + | + +Whether or not the filter is selected. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[cloudChoice?](./search-headless.servingconfig.cloudchoice.md) + + + | + + + | + +[CloudChoice](./search-headless.cloudchoice.md) + + + | + +_(Optional)_ Defines the cloud choice of the API domains. + + + |
| + +[cloudRegion?](./search-headless.servingconfig.cloudregion.md) + + + | + + + | + +[CloudRegion](./search-headless.cloudregion.md) + + + | + +_(Optional)_ Defines the cloud region of the API domains. + + + |
| + +[environment?](./search-headless.servingconfig.environment.md) + + + | + + + | + +[Environment](./search-headless.environment.md) + + + | + +_(Optional)_ Defines the environment of the API domains. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[enabled?](./search-headless.sessiontrackingstate.enabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Whether or not session tracking is enabled. + + + |
| + +[sessionId?](./search-headless.sessiontrackingstate.sessionid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The ID of the current session. Used to track session state when cookies are blocked. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[matchedSubstrings](./search-headless.snippet.matchedsubstrings.md) + + + | + + + | + +{ offset: number; length: number; }\[\] + + + | + +The locations in the document text of the [DirectAnswer.value](./search-headless.directanswer.value.md) + + + |
| + +[value](./search-headless.snippet.value.md) + + + | + + + | + +string + + + | + +The raw snippet value, or HTML if - entity is of type HTML - the conversion to HTML is enabled in search configuration + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[direction?](./search-headless.sortby.direction.md) + + + | + + + | + +[Direction](./search-headless.direction.md) + + + | + +_(Optional)_ The direction of the sort. Required if the SortBy type is [SortType.Field](./search-headless.sorttype.md). + + + |
| + +[field?](./search-headless.sortby.field.md) + + + | + + + | + +string + + + | + +_(Optional)_ The field name to sort by. Required if the SortBy type is [SortType.Field](./search-headless.sorttype.md). + + + |
| + +[type](./search-headless.sortby.type.md) + + + | + + + | + +[SortType](./search-headless.sorttype.md) + + + | + +The method of sorting. + + + |
"ENTITY_DISTANCE" | Sorts based on entity distance alone. |
-| Field | "FIELD" | Sorts based on a field with the direction specified. |
-| Relevance | "RELEVANCE" | Sorts based on relevance according to the algorithm and, when relevant, location bias. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +EntityDistance + + + | + +`"ENTITY_DISTANCE"` + + + | + +Sorts based on entity distance alone. + + + |
| + +Field + + + | + +`"FIELD"` + + + | + +Sorts based on a field with the direction specified. + + + |
| + +Relevance + + + | + +`"RELEVANCE"` + + + | + +Sorts based on relevance according to the algorithm and, when relevant, location bias. + + + |
"CUSTOM_SEARCHER" | The result was from a custom source. |
-| DocumentVertical | "DOCUMENT_VERTICAL" | The result is from a document vertical. |
-| Google | "GOOGLE_CSE" | The result is from Google Custom Search Engine. |
-| KnowledgeManager | "KNOWLEDGE_MANAGER" | The result is from a Knowledge Graph. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +Custom + + + | + +`"CUSTOM_SEARCHER"` + + + | + +The result was from a custom source. + + + |
| + +DocumentVertical + + + | + +`"DOCUMENT_VERTICAL"` + + + | + +The result is from a document vertical. + + + |
| + +Google + + + | + +`"GOOGLE_CSE"` + + + | + +The result is from Google Custom Search Engine. + + + |
| + +KnowledgeManager + + + | + +`"KNOWLEDGE_MANAGER"` + + + | + +The result is from a Knowledge Graph. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[correctedQuery](./search-headless.spellcheck.correctedquery.md) + + + | + + + | + +string + + + | + +The corrected version of the originalQuery. + + + |
| + +[matchedSubstrings](./search-headless.spellcheck.matchedsubstrings.md) + + + | + + + | + +{ length: number; offset: number; }\[\] + + + | + +An array of substring matches which correspond to the highlighting. Offset indicates the index of the match, and the length indicates the number of characters of the match. + + + |
| + +[originalQuery](./search-headless.spellcheck.originalquery.md) + + + | + + + | + +string + + + | + +The query that was input into the spell checker. + + + |
| + +[type](./search-headless.spellcheck.type.md) + + + | + + + | + +[SpellCheckType](./search-headless.spellchecktype.md) + + + | + +The type of spell check. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[enabled](./search-headless.spellcheckstate.enabled.md) + + + | + + + | + +boolean + + + | + +Whether or not spellcheck is enabled. + + + |
"AUTOCORRECT" | The API is autocorrecting the original query. |
-| Combine | "COMBINE" | The API may be doing some combination of suggesting or autocorrecting. |
-| Suggest | "SUGGEST" | The API is suggesting an alternative query. |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +AutoCorrect + + + | + +`"AUTOCORRECT"` + + + | + +The API is autocorrecting the original query. + + + |
| + +Combine + + + | + +`"COMBINE"` + + + | + +The API may be doing some combination of suggesting or autocorrecting. + + + |
| + +Suggest + + + | + +`"SUGGEST"` + + + | + +The API is suggesting an alternative query. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[directAnswer](./search-headless.state.directanswer.md) + + + | + + + | + +[DirectAnswerState](./search-headless.directanswerstate.md) + + + | + +Maintains the direct answer associated with the latest search. + + + |
| + +[filters](./search-headless.state.filters.md) + + + | + + + | + +[FiltersState](./search-headless.filtersstate.md) + + + | + +Maintains the current state of facets and filters in the application. + + + |
| + +[location](./search-headless.state.location.md) + + + | + + + | + +[LocationState](./search-headless.locationstate.md) + + + | + +Maintains the user's location, if given, or the inferred location, that is used to bias search results. + + + |
| + +[meta](./search-headless.state.meta.md) + + + | + + + | + +[MetaState](./search-headless.metastate.md) + + + | + +Maintains the metadata for Search Headless. + + + |
| + +[query](./search-headless.state.query.md) + + + | + + + | + +[QueryState](./search-headless.querystate.md) + + + | + +Maintains the latest query and its associated data. + + + |
| + +[queryRules](./search-headless.state.queryrules.md) + + + | + + + | + +[QueryRulesState](./search-headless.queryrulesstate.md) + + + | + +Maintains the data from the triggered query rules. + + + |
| + +[searchStatus](./search-headless.state.searchstatus.md) + + + | + + + | + +[SearchStatusState](./search-headless.searchstatusstate.md) + + + | + +Maintains the status of the latest search. + + + |
| + +[sessionTracking](./search-headless.state.sessiontracking.md) + + + | + + + | + +[SessionTrackingState](./search-headless.sessiontrackingstate.md) + + + | + +Maintains whether the user session should be tracked and, if so, the session information. + + + |
| + +[spellCheck](./search-headless.state.spellcheck.md) + + + | + + + | + +[SpellCheckState](./search-headless.spellcheckstate.md) + + + | + +Maintains whether spellcheck is enabled and the spellcheck response from the latest search. + + + |
| + +[universal](./search-headless.state.universal.md) + + + | + + + | + +[UniversalSearchState](./search-headless.universalsearchstate.md) + + + | + +Maintains the data for the latest universal search. + + + |
| + +[vertical](./search-headless.state.vertical.md) + + + | + + + | + +[VerticalSearchState](./search-headless.verticalsearchstate.md) + + + | + +Maintains the data for the latest vertical search. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +currentValue + + + | + +T + + + | + +The current state value + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[callback(currentValue)](./search-headless.statelistener.callback.md) + + + | + +The function to call when the state value updates. + + + |
| + +[valueAccessor(state)](./search-headless.statelistener.valueaccessor.md) + + + | + +Accesses a value of type T in the state. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +state + + + | + +[State](./search-headless.state.md) + + + | + +The current state + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +listener + + + | + +[StateListener](./search-headless.statelistener.md)<T> + + + | + +The state listener to add + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +type + + + | + +string + + + | + +The type of action to dispatch + + + |
| + +payload + + + | + +unknown + + + | + +_(Optional)_ The payload of the action to dispatch + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[addListener(listener)](./search-headless.statemanager.addlistener.md) + + + | + +Adds a listener for a specific state value of type T. + + + |
| + +[dispatchEvent(type, payload)](./search-headless.statemanager.dispatchevent.md) + + + | + +Dispatches an event. This can update the [State](./search-headless.state.md). + + + |
| + +[getState()](./search-headless.statemanager.getstate.md) + + + | + +Returns the current state. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.textdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.SingleLineText](./search-headless.builtinfieldtype.md) \| [BuiltInFieldType.MultiLineText](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.twitterhandledirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.TwitterHandle](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[input](./search-headless.universalautocompleterequest.input.md) + + + | + + + | + +string + + + | + +The input string for autocomplete. + + + |
| + +[sessionTrackingEnabled?](./search-headless.universalautocompleterequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[context?](./search-headless.universalsearchrequest.context.md) + + + | + + + | + +[Context](./search-headless.context.md) + + + | + +_(Optional)_ Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + + + |
| + +[limit?](./search-headless.universalsearchrequest.limit.md) + + + | + + + | + +[UniversalLimit](./search-headless.universallimit.md) + + + | + +_(Optional)_ The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. + + + |
| + +[location?](./search-headless.universalsearchrequest.location.md) + + + | + + + | + +[LatLong](./search-headless.latlong.md) + + + | + +_(Optional)_ The latitude and longitude of the user making the request. Used to bias the results. + + + |
| + +[query](./search-headless.universalsearchrequest.query.md) + + + | + + + | + +string + + + | + +The search query. + + + |
| + +[querySource?](./search-headless.universalsearchrequest.querysource.md) + + + | + + + | + +[QuerySource](./search-headless.querysource.md) \| string + + + | + +_(Optional)_ The source of the search request. + + + |
| + +[queryTrigger?](./search-headless.universalsearchrequest.querytrigger.md) + + + | + + + | + +[QueryTrigger](./search-headless.querytrigger.md) + + + | + +_(Optional)_ Describes the ways a search can be executed besides user input. + + + |
| + +[referrerPageUrl?](./search-headless.universalsearchrequest.referrerpageurl.md) + + + | + + + | + +string + + + | + +_(Optional)_ The URl of the page which referred the user to the current page. + + + |
| + +[restrictVerticals?](./search-headless.universalsearchrequest.restrictverticals.md) + + + | + + + | + +string\[\] + + + | + +_(Optional)_ If included, the response will only include these verticals. + + + |
| + +[sessionId?](./search-headless.universalsearchrequest.sessionid.md) + + + | + + + | + +string + + + | + +_(Optional)_ Used to track session state when cookies are blocked. + + + |
| + +[sessionTrackingEnabled?](./search-headless.universalsearchrequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| + +[skipSpellCheck?](./search-headless.universalsearchrequest.skipspellcheck.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Disables spellcheck if true. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[directAnswer?](./search-headless.universalsearchresponse.directanswer.md) + + + | + + + | + +[FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) + + + | + +_(Optional)_ A direct answer to a search. + + + |
| + +[failedVerticals?](./search-headless.universalsearchresponse.failedverticals.md) + + + | + + + | + +[FailedVertical](./search-headless.failedvertical.md)\[\] + + + | + +_(Optional)_ Error information from when a vertical fails to return results. + + + |
| + +[locationBias?](./search-headless.universalsearchresponse.locationbias.md) + + + | + + + | + +[LocationBias](./search-headless.locationbias.md) + + + | + +_(Optional)_ Information about the user's location. + + + |
| + +[queryId?](./search-headless.universalsearchresponse.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The ID of the search query. + + + |
| + +[queryRulesActionsData?](./search-headless.universalsearchresponse.queryrulesactionsdata.md) + + + | + + + | + +[QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] + + + | + +_(Optional)_ Data returned from the Search query rules system. + + + |
| + +[searchIntents?](./search-headless.universalsearchresponse.searchintents.md) + + + | + + + | + +[SearchIntent](./search-headless.searchintent.md)\[\] + + + | + +_(Optional)_ An array of [SearchIntent](./search-headless.searchintent.md)s which represents requests from the API. + + + |
| + +[spellCheck?](./search-headless.universalsearchresponse.spellcheck.md) + + + | + + + | + +[SpellCheck](./search-headless.spellcheck.md) + + + | + +_(Optional)_ A spellcheck response from a search query. + + + |
| + +[uuid](./search-headless.universalsearchresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| + +[verticalResults](./search-headless.universalsearchresponse.verticalresults.md) + + + | + + + | + +[VerticalResults](./search-headless.verticalresults.md)\[\] + + + | + +An array of [VerticalResults](./search-headless.verticalresults.md) which represent the results for each vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[limit?](./search-headless.universalsearchstate.limit.md) + + + | + + + | + +[UniversalLimit](./search-headless.universallimit.md) + + + | + +_(Optional)_ An object defining the limit (up to how many results should be returned) for each vertical. + + + |
| + +[restrictVerticals?](./search-headless.universalsearchstate.restrictverticals.md) + + + | + + + | + +string\[\] + + + | + +_(Optional)_ If included, the verticals to which the universal search should be restricted. + + + |
| + +[verticals?](./search-headless.universalsearchstate.verticals.md) + + + | + + + | + +[VerticalResults](./search-headless.verticalresults.md)\[\] + + + | + +_(Optional)_ The results from each vertical included in the universal search. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.unknownfieldvaluedirectanswer.fieldtype.md) + + + | + + + | + +'unknown' + + + | + +The field type of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[matcher](./search-headless.uppernumberrangelimit.matcher.md) + + + | + + + | + +[Matcher.LessThan](./search-headless.matcher.md) \| [Matcher.LessThanOrEqualTo](./search-headless.matcher.md) + + + | + +[Matcher](./search-headless.matcher.md) for the end limit + + + |
| + +[value](./search-headless.uppernumberrangelimit.value.md) + + + | + + + | + +number + + + | + +Value of the limit. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-headless.urldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-headless.enumorliteral.md)<[BuiltInFieldType.URL](./search-headless.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[input](./search-headless.verticalautocompleterequest.input.md) + + + | + + + | + +string + + + | + +The input string for autocomplete. + + + |
| + +[sessionTrackingEnabled?](./search-headless.verticalautocompleterequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| + +[verticalKey](./search-headless.verticalautocompleterequest.verticalkey.md) + + + | + + + | + +string + + + | + +The key for the vertical to get autocomplete suggestions from. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[appliedQueryFilters](./search-headless.verticalresults.appliedqueryfilters.md) + + + | + + + | + +[AppliedQueryFilter](./search-headless.appliedqueryfilter.md)\[\] + + + | + +A array of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md)s which were applied to the vertical results. + + + |
| + +[queryDurationMillis](./search-headless.verticalresults.querydurationmillis.md) + + + | + + + | + +number + + + | + +The duration of the query in milliseconds. + + + |
| + +[results](./search-headless.verticalresults.results.md) + + + | + + + | + +[Result](./search-headless.result.md)\[\] + + + | + +An array of search [Result](./search-headless.result.md)s for the vertical. + + + |
| + +[resultsCount](./search-headless.verticalresults.resultscount.md) + + + | + + + | + +number + + + | + +The total number of results within the vertical. + + + |
| + +[source](./search-headless.verticalresults.source.md) + + + | + + + | + +[Source](./search-headless.source.md) + + + | + +Represents the source of a [Result](./search-headless.result.md). + + + |
| + +[verticalKey](./search-headless.verticalresults.verticalkey.md) + + + | + + + | + +string + + + | + +The vertical key associated with the vertical results. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[context?](./search-headless.verticalsearchrequest.context.md) + + + | + + + | + +[Context](./search-headless.context.md) + + + | + +_(Optional)_ Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + + + |
| + +[facets?](./search-headless.verticalsearchrequest.facets.md) + + + | + + + | + +[Facet](./search-headless.facet.md)\[\] + + + | + +_(Optional)_ The facet filters to apply to the search. + + + |
| + +[limit?](./search-headless.verticalsearchrequest.limit.md) + + + | + + + | + +number + + + | + +_(Optional)_ The maximum number of results to include with a max of 50. + + + |
| + +[location?](./search-headless.verticalsearchrequest.location.md) + + + | + + + | + +[LatLong](./search-headless.latlong.md) + + + | + +_(Optional)_ The latitude and longitude of the user making the request. Used to bias the results. + + + |
| + +[locationRadius?](./search-headless.verticalsearchrequest.locationradius.md) + + + | + + + | + +number + + + | + +_(Optional)_ The radius (in meters) to filter the vertical search by. + + + |
| + +[offset?](./search-headless.verticalsearchrequest.offset.md) + + + | + + + | + +number + + + | + +_(Optional)_ The result offset which allows for fetching more results with the same query. + + + |
| + +[query](./search-headless.verticalsearchrequest.query.md) + + + | + + + | + +string + + + | + +The search query. + + + |
| + +[queryId?](./search-headless.verticalsearchrequest.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The queryId for the query, if this is a repeat query. + + + |
| + +[querySource?](./search-headless.verticalsearchrequest.querysource.md) + + + | + + + | + +[QuerySource](./search-headless.querysource.md) \| string + + + | + +_(Optional)_ The source of the search request. + + + |
| + +[queryTrigger?](./search-headless.verticalsearchrequest.querytrigger.md) + + + | + + + | + +[QueryTrigger](./search-headless.querytrigger.md) + + + | + +_(Optional)_ Describes the ways a search can be executed besides user input. + + + |
| + +[referrerPageUrl?](./search-headless.verticalsearchrequest.referrerpageurl.md) + + + | + + + | + +string + + + | + +_(Optional)_ The URl of the page which referred the user to the current page. + + + |
| + +[retrieveFacets?](./search-headless.verticalsearchrequest.retrievefacets.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Indicates that facets should be retrieved. + + + |
| + +[sessionId?](./search-headless.verticalsearchrequest.sessionid.md) + + + | + + + | + +string + + + | + +_(Optional)_ Used to track session state when cookies are blocked. + + + |
| + +[sessionTrackingEnabled?](./search-headless.verticalsearchrequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| + +[skipSpellCheck?](./search-headless.verticalsearchrequest.skipspellcheck.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Skips spell checking if true. + + + |
| + +[sortBys?](./search-headless.verticalsearchrequest.sortbys.md) + + + | + + + | + +[SortBy](./search-headless.sortby.md)\[\] + + + | + +_(Optional)_ Determines how results are sorted. \* + + + |
| + +[staticFilter?](./search-headless.verticalsearchrequest.staticfilter.md) + + + | + + + | + +[StaticFilter](./search-headless.staticfilter.md) + + + | + +_(Optional)_ The static filter to apply to the search. + + + |
| + +[verticalKey](./search-headless.verticalsearchrequest.verticalkey.md) + + + | + + + | + +string + + + | + +The key associated with the vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[allResultsForVertical?](./search-headless.verticalsearchresponse.allresultsforvertical.md) + + + | + + + | + +[VerticalSearchResponse](./search-headless.verticalsearchresponse.md) + + + | + +_(Optional)_ A representation of a response from a vertical search. + + + |
| + +[alternativeVerticals?](./search-headless.verticalsearchresponse.alternativeverticals.md) + + + | + + + | + +[VerticalResults](./search-headless.verticalresults.md)\[\] + + + | + +_(Optional)_ The [VerticalResults](./search-headless.verticalresults.md) for each search vertical. + + + |
| + +[directAnswer?](./search-headless.verticalsearchresponse.directanswer.md) + + + | + + + | + +[FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) + + + | + +_(Optional)_ A direct answer to a search. + + + |
| + +[facets?](./search-headless.verticalsearchresponse.facets.md) + + + | + + + | + +[DisplayableFacet](./search-headless.displayablefacet.md)\[\] + + + | + +_(Optional)_ An array of [Facet](./search-headless.facet.md)s associated with the search results. + + + |
| + +[locationBias?](./search-headless.verticalsearchresponse.locationbias.md) + + + | + + + | + +[LocationBias](./search-headless.locationbias.md) + + + | + +_(Optional)_ Information about the user's location. + + + |
| + +[queryId](./search-headless.verticalsearchresponse.queryid.md) + + + | + + + | + +string + + + | + +The ID of the query. + + + |
| + +[queryRulesActionsData?](./search-headless.verticalsearchresponse.queryrulesactionsdata.md) + + + | + + + | + +[QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] + + + | + +_(Optional)_ Data returned from the Search query rules system. + + + |
| + +[searchIntents?](./search-headless.verticalsearchresponse.searchintents.md) + + + | + + + | + +[SearchIntent](./search-headless.searchintent.md)\[\] + + + | + +_(Optional)_ An array of [SearchIntent](./search-headless.searchintent.md)s. + + + |
| + +[spellCheck?](./search-headless.verticalsearchresponse.spellcheck.md) + + + | + + + | + +[SpellCheck](./search-headless.spellcheck.md) + + + | + +_(Optional)_ A spellcheck response from a search query. + + + |
| + +[uuid](./search-headless.verticalsearchresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| + +[verticalResults](./search-headless.verticalsearchresponse.verticalresults.md) + + + | + + + | + +[VerticalResults](./search-headless.verticalresults.md) + + + | + +Represents results from a search vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[appliedQueryFilters?](./search-headless.verticalsearchstate.appliedqueryfilters.md) + + + | + + + | + +[AppliedQueryFilter](./search-headless.appliedqueryfilter.md)\[\] + + + | + +_(Optional)_ The array of filters inferred from the query and applied to the search. + + + |
| + +[displayName?](./search-headless.verticalsearchstate.displayname.md) + + + | + + + | + +string + + + | + +_(Optional)_ Name to be displayed for the vertical. + + + |
| + +[limit?](./search-headless.verticalsearchstate.limit.md) + + + | + + + | + +number + + + | + +_(Optional)_ The maximum number of results to include for the vertical search. + + + |
| + +[locationRadius?](./search-headless.verticalsearchstate.locationradius.md) + + + | + + + | + +number + + + | + +_(Optional)_ The radius (in meters) to filter vertical searches by. + + + |
| + +[noResults?](./search-headless.verticalsearchstate.noresults.md) + + + | + + + | + +{ allResultsForVertical: [AllResultsForVertical](./search-headless.allresultsforvertical.md); alternativeVerticals: [VerticalResults](./search-headless.verticalresults.md)\[\]; } + + + | + +_(Optional)_ The data for when no results are returned in the vertical search. + + + |
| + +[offset?](./search-headless.verticalsearchstate.offset.md) + + + | + + + | + +number + + + | + +_(Optional)_ The number of results that should be skipped when fetching results for the response. Allows for fetching more results with the same query. + + + |
| + +[queryDurationMillis?](./search-headless.verticalsearchstate.querydurationmillis.md) + + + | + + + | + +number + + + | + +_(Optional)_ The duration of the query in milliseconds. + + + |
| + +[results?](./search-headless.verticalsearchstate.results.md) + + + | + + + | + +[Result](./search-headless.result.md)\[\] + + + | + +_(Optional)_ The results from the vertical search. + + + |
| + +[resultsCount?](./search-headless.verticalsearchstate.resultscount.md) + + + | + + + | + +number + + + | + +_(Optional)_ The number of results for the vertical search. + + + |
| + +[sortBys?](./search-headless.verticalsearchstate.sortbys.md) + + + | + + + | + +[SortBy](./search-headless.sortby.md)\[\] + + + | + +_(Optional)_ The criteria by which the results should be sorted, in the order in which they should be applied. + + + |
| + +[source?](./search-headless.verticalsearchstate.source.md) + + + | + + + | + +[Source](./search-headless.source.md) + + + | + +_(Optional)_ The source of the vertical search results. + + + |
| + +[verticalKey?](./search-headless.verticalsearchstate.verticalkey.md) + + + | + + + | + +string + + + | + +_(Optional)_ The key associated with the vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[id](./search-headless.visitor.id.md) + + + | + + + | + +string + + + | + +The ID associated with the user + + + |
| + +[idMethod?](./search-headless.visitor.idmethod.md) + + + | + + + | + +string + + + | + +_(Optional)_ The type of visitor + + + |