| +Package + + + | + +Description + + + |
|---|---|
| + +[@yext/search-core](./search-core.md) + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +["Client-SDK"?](./search-core.additionalhttpheaders._client-sdk_.md) + + + | + + + | + +[ClientSDKHeaderValues](./search-core.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-core.address.city.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[countryCode](./search-core.address.countrycode.md) + + + | + + + | + +string + + + | + + + |
| + +[extraDescription?](./search-core.address.extradescription.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[line1?](./search-core.address.line1.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[line2?](./search-core.address.line2.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[line3?](./search-core.address.line3.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[postalCode?](./search-core.address.postalcode.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[region?](./search-core.address.region.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[sublocality?](./search-core.address.sublocality.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.addressdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.Address](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.androidappurldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.AndroidAppURL](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[details?](./search-core.appliedqueryfilter.details.md) + + + | + + + | + +[LocationFilterDetails](./search-core.locationfilterdetails.md) + + + | + +_(Optional)_ Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). + + + |
| + +[displayKey](./search-core.appliedqueryfilter.displaykey.md) + + + | + + + | + +string + + + | + +The display name of the filter key. + + + |
| + +[displayValue](./search-core.appliedqueryfilter.displayvalue.md) + + + | + + + | + +string + + + | + +The value used in the filter. + + + |
| + +[filter](./search-core.appliedqueryfilter.filter.md) + + + | + + + | + +[FieldValueFilter](./search-core.fieldvaluefilter.md) + + + | + +The filter applied to the query results. + + + |
| + +[type](./search-core.appliedqueryfilter.type.md) + + + | + + + | + +[AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md) + + + | + +Represents the type of [AppliedQueryFilter](./search-core.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-core.autocompleteresponse.inputintents.md) + + + | + + + | + +[SearchIntent](./search-core.searchintent.md)\[\] + + + | + +Represents intents from the Search API. + + + |
| + +[queryId?](./search-core.autocompleteresponse.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The ID of the search query. + + + |
| + +[results](./search-core.autocompleteresponse.results.md) + + + | + + + | + +[AutocompleteResult](./search-core.autocompleteresult.md)\[\] + + + | + +An array of [AutocompleteResult](./search-core.autocompleteresult.md)s. + + + |
| + +[uuid](./search-core.autocompleteresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[filter?](./search-core.autocompleteresult.filter.md) + + + | + + + | + +[FieldValueFilter](./search-core.fieldvaluefilter.md) + + + | + +_(Optional)_ A filter applied to the autocomplete response. + + + |
| + +[inputIntents](./search-core.autocompleteresult.inputintents.md) + + + | + + + | + +[SearchIntent](./search-core.searchintent.md)\[\] + + + | + +[SearchIntent](./search-core.searchintent.md)s corresponding to the autocomplete result. + + + |
| + +[key?](./search-core.autocompleteresult.key.md) + + + | + + + | + +string + + + | + +_(Optional)_ The fieldId which corresponds to the AutocompleteResult value. + + + |
| + +[matchedSubstrings?](./search-core.autocompleteresult.matchedsubstrings.md) + + + | + + + | + +{ length: number; offset: number; }\[\] + + + | + +_(Optional)_ An array of substrings which overlap with the autocomplete input. + + + |
| + +[relatedItem?](./search-core.autocompleteresult.relateditem.md) + + + | + + + | + +[Result](./search-core.result.md) + + + | + +_(Optional)_ An entity that corresponds to the autocomplete result. + + + |
| + +[value](./search-core.autocompleteresult.value.md) + + + | + + + | + +string + + + | + +The value of an autocomplete suggestion. + + + |
| + +[verticalKeys?](./search-core.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-core.filtersearchrequest.md) + + + | + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[filterSearch(request)](./search-core.autocompleteservice.filtersearch.md) + + + | + +Retrieves query suggestions for filter search. + + + |
| + +[universalAutocomplete(request)](./search-core.autocompleteservice.universalautocomplete.md) + + + | + +Retrieves query suggestions for universal. + + + |
| + +[verticalAutocomplete(request)](./search-core.autocompleteservice.verticalautocomplete.md) + + + | + +Retrieves query suggestions for a vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.basefeaturedsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.RichText](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.RichText\_v2](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.Html](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.Markdown](./search-core.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| + +[snippet](./search-core.basefeaturedsnippetdirectanswer.snippet.md) + + + | + + + | + +[Snippet](./search-core.snippet.md) + + + | + +The snippet where the direct answer was found. + + + |
| + +[type](./search-core.basefeaturedsnippetdirectanswer.type.md) + + + | + + + | + +[DirectAnswerType.FeaturedSnippet](./search-core.directanswertype.md) + + + | + +Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md). + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[entityName](./search-core.basefieldvaluedirectanswer.entityname.md) + + + | + + + | + +string + + + | + +The name of the entity that direct answer came from. + + + |
| + +[fieldApiName](./search-core.basefieldvaluedirectanswer.fieldapiname.md) + + + | + + + | + +string + + + | + +The field api name of the direct answer. + + + |
| + +[fieldName](./search-core.basefieldvaluedirectanswer.fieldname.md) + + + | + + + | + +string + + + | + +The field name of the direct answer. + + + |
| + +[type](./search-core.basefieldvaluedirectanswer.type.md) + + + | + + + | + +[DirectAnswerType.FieldValue](./search-core.directanswertype.md) + + + | + +Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md). + + + |
| + +[value](./search-core.basefieldvaluedirectanswer.value.md) + + + | + + + | + +T + + + | + +The result of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[additionalQueryParams?](./search-core.basesearchconfig.additionalqueryparams.md) + + + | + + + | + +{ \[key: string\]: string \| number \| boolean; } + + + | + +_(Optional)_ Additional query params added on to every request. + + + |
| + +[cloudRegion?](./search-core.basesearchconfig.cloudregion.md) + + + | + + + | + +[CloudRegion](./search-core.cloudregion.md) + + + | + +_(Optional)_ Defines the cloud region of the API domains. + + + |
| + +[endpoints?](./search-core.basesearchconfig.endpoints.md) + + + | + + + | + +[Endpoints](./search-core.endpoints.md) + + + | + +_(Optional)_ Overrides for the URLs which are used when making requests to the Search API. + + + |
| + +[environment?](./search-core.basesearchconfig.environment.md) + + + | + + + | + +[Environment](./search-core.environment.md) + + + | + +_(Optional)_ Defines the environment of the API domains. + + + |
| + +[experienceKey](./search-core.basesearchconfig.experiencekey.md) + + + | + + + | + +string + + + | + +The experience key of the search experience. + + + |
| + +[experienceVersion?](./search-core.basesearchconfig.experienceversion.md) + + + | + + + | + +'STAGING' \| 'PRODUCTION' \| string \| number + + + | + +_(Optional)_ The version of the search experience configuration. + + + |
| + +[locale](./search-core.basesearchconfig.locale.md) + + + | + + + | + +string + + + | + +The locale of the search experience. + + + |
| + +[visitor?](./search-core.basesearchconfig.visitor.md) + + + | + + + | + +[Visitor](./search-core.visitor.md) + + + | + +_(Optional)_ Information used to associate requests with a particular user. + + + |
"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-core.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. + + + |
| + +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +GLOBAL\_GCP + + + | + +`"GLOBAL-GCP"` + + + | + + + |
| + +GLOBAL\_MULTI + + + | + +`"GLOBAL-MULTI"` + + + | + + + |
"eu" | |
-| US | "us" | |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +EU + + + | + +`"eu"` + + + | + + + |
| + +US + + + | + +`"us"` + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[displayUrl?](./search-core.complexurl.displayurl.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[preferDisplayUrl](./search-core.complexurl.preferdisplayurl.md) + + + | + + + | + +boolean + + + | + + + |
| + +[url](./search-core.complexurl.url.md) + + + | + + + | + +string + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.complexurldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.ComplexURL](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[combinator](./search-core.conjunctionstaticfilter.combinator.md) + + + | + + + | + +[FilterCombinator.AND](./search-core.filtercombinator.md) + + + | + +Indicates that filters should be combined with a logical AND. + + + |
| + +[filters](./search-core.conjunctionstaticfilter.filters.md) + + + | + + + | + +[StaticFilter](./search-core.staticfilter.md)\[\] + + + | + +The filters to combine together. + + + |
| + +[kind](./search-core.conjunctionstaticfilter.kind.md) + + + | + + + | + +'conjunction' + + + | + +The kind of static filter. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[isClosed?](./search-core.dayhour.isclosed.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ + + + |
| + +[openIntervals?](./search-core.dayhour.openintervals.md) + + + | + + + | + +[Interval](./search-core.interval.md)\[\] + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.decimaldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.Decimal](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.directanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType](./search-core.builtinfieldtype.md)> \| 'unknown' + + + | + +The field type of the direct answer. + + + |
| + +[relatedResult](./search-core.directanswer.relatedresult.md) + + + | + + + | + +[Result](./search-core.result.md) + + + | + +The entity associated with the direct answer. + + + |
| + +[type](./search-core.directanswer.type.md) + + + | + + + | + +[DirectAnswerType](./search-core.directanswertype.md) + + + | + +The [DirectAnswerType](./search-core.directanswertype.md). + + + |
| + +[value?](./search-core.directanswer.value.md) + + + | + + + | + +T + + + | + +_(Optional)_ The value of the direct answer. + + + |
| + +[verticalKey](./search-core.directanswer.verticalkey.md) + + + | + + + | + +string + + + | + +The vertical key of the direct answer. + + + |
"FEATURED_SNIPPET" | Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md). |
-| FieldValue | "FIELD_VALUE" | Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md). |
+| +Member + + + | + +Value + + + | + +Description + + + |
|---|---|---|
| + +FeaturedSnippet + + + | + +`"FEATURED_SNIPPET"` + + + | + +Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md). + + + |
| + +FieldValue + + + | + +`"FIELD_VALUE"` + + + | + +Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-core.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-core.disjunctionstaticfilter.combinator.md) + + + | + + + | + +[FilterCombinator.OR](./search-core.filtercombinator.md) + + + | + +Indicates that filters should be combined with a logical OR. + + + |
| + +[filters](./search-core.disjunctionstaticfilter.filters.md) + + + | + + + | + +([DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) \| [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md))\[\] + + + | + +The filters to combine together. + + + |
| + +[kind](./search-core.disjunctionstaticfilter.kind.md) + + + | + + + | + +'disjunction' + + + | + +The kind of static filter. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[displayName](./search-core.displayablefacet.displayname.md) + + + | + + + | + +string + + + | + +The name of the facet which is meant to be displayed to the user. + + + |
| + +[options](./search-core.displayablefacet.options.md) + + + | + + + | + +[DisplayableFacetOption](./search-core.displayablefacetoption.md)\[\] + + + | + +An array of [DisplayableFacetOption](./search-core.displayablefacetoption.md) + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[count](./search-core.displayablefacetoption.count.md) + + + | + + + | + +number + + + | + +The number of results associated with this facet option. + + + |
| + +[displayName](./search-core.displayablefacetoption.displayname.md) + + + | + + + | + +string + + + | + +The name of the facet option which is meant to be displayed to the end user. + + + |
| + +[selected](./search-core.displayablefacetoption.selected.md) + + + | + + + | + +boolean + + + | + +Whether or not the filter is selected in the search results. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[documentScore](./search-core.documentresult.documentscore.md) + + + | + + + | + +number + + + | + +The score calculated from whatever document search strategy was used. + + + |
| + +[segments](./search-core.documentresult.segments.md) + + + | + + + | + +[Segment](./search-core.segment.md)\[\] + + + | + +All the relevant segments extracted from the document. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.emaildirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.Email](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[filterSearch?](./search-core.endpoints.filtersearch.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[generativeDirectAnswer?](./search-core.endpoints.generativedirectanswer.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[questionSubmission?](./search-core.endpoints.questionsubmission.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[status?](./search-core.endpoints.status.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[universalAutocomplete?](./search-core.endpoints.universalautocomplete.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[universalSearch?](./search-core.endpoints.universalsearch.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[verticalAutocomplete?](./search-core.endpoints.verticalautocomplete.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[verticalSearch?](./search-core.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-core.facebookurldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.FacebookURL](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldId](./search-core.facet.fieldid.md) + + + | + + + | + +string + + + | + +The associated fieldId. + + + |
| + +[options](./search-core.facet.options.md) + + + | + + + | + +[FacetOption](./search-core.facetoption.md)\[\] + + + | + +An array of [FacetOption](./search-core.facetoption.md) + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[value](./search-core.facetoption.value.md) + + + | + + + | + +Exclude<[FieldValueFilter](./search-core.fieldvaluefilter.md)\['value'\], [NearFilterValue](./search-core.nearfiltervalue.md)> + + + | + +The value to compare. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[details](./search-core.failedvertical.details.md) + + + | + + + | + +{ responseCode: number; description: string; } + + + | + +Detailed information about the error. + + + |
| + +[errorType](./search-core.failedvertical.errortype.md) + + + | + + + | + +[ErrorType](./search-core.errortype.md) + + + | + +Identifier for the type of error causing the failure. + + + |
| + +[queryDurationMillis](./search-core.failedvertical.querydurationmillis.md) + + + | + + + | + +number + + + | + +The duration of the query in milliseconds. + + + |
| + +[verticalKey](./search-core.failedvertical.verticalkey.md) + + + | + + + | + +string + + + | + +The vertical key associated with the failed vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldId](./search-core.fieldvaluefilter.fieldid.md) + + + | + + + | + +string + + + | + +The fieldId to apply the filter against. + + + |
| + +[matcher](./search-core.fieldvaluefilter.matcher.md) + + + | + + + | + +[Matcher](./search-core.matcher.md) + + + | + +A Matcher is a filtering operation. + + + |
| + +[value](./search-core.fieldvaluefilter.value.md) + + + | + + + | + +string \| number \| boolean \| [NearFilterValue](./search-core.nearfiltervalue.md) \| [NumberRangeValue](./search-core.numberrangevalue.md) + + + | + +The value to compare. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[kind](./search-core.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-core.filtersearchrequest.excluded.md) + + + | + + + | + +[FieldValueFilter](./search-core.fieldvaluefilter.md)\[\] + + + | + +_(Optional)_ An array of field value filters that should be excluded from filter search results. + + + |
| + +[fields](./search-core.filtersearchrequest.fields.md) + + + | + + + | + +[SearchParameterField](./search-core.searchparameterfield.md)\[\] + + + | + +An array of [SearchParameterField](./search-core.searchparameterfield.md). + + + |
| + +[input](./search-core.filtersearchrequest.input.md) + + + | + + + | + +string + + + | + +The input string for autocomplete. + + + |
| + +[sectioned](./search-core.filtersearchrequest.sectioned.md) + + + | + + + | + +boolean + + + | + +Determines whether or not the results of the [FilterSearchResponse](./search-core.filtersearchresponse.md) are separated by field. + + + |
| + +[sessionTrackingEnabled?](./search-core.filtersearchrequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| + +[verticalKey](./search-core.filtersearchrequest.verticalkey.md) + + + | + + + | + +string + + + | + +The key for the vertical to get autocomplete suggestions from. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[businessId?](./search-core.filtersearchresponse.businessid.md) + + + | + + + | + +string + + + | + +_(Optional)_ ID of the account associated with this Search experience. + + + |
| + +[queryId?](./search-core.filtersearchresponse.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The ID of the search query. + + + |
| + +[sections](./search-core.filtersearchresponse.sections.md) + + + | + + + | + +{ label?: string; results: [AutocompleteResult](./search-core.autocompleteresult.md)\[\]; }\[\] + + + | + +Represents autocomplete results separated by field. + + + |
| + +[uuid](./search-core.filtersearchresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[results](./search-core.generativedirectanswerrequest.results.md) + + + | + + + | + +[VerticalResults](./search-core.verticalresults.md)\[\] + + + | + +The complete set of Search Results + + + |
| + +[searchId](./search-core.generativedirectanswerrequest.searchid.md) + + + | + + + | + +string + + + | + +The ID of the search request. + + + |
| + +[searchTerm](./search-core.generativedirectanswerrequest.searchterm.md) + + + | + + + | + +string + + + | + +The text of the user-written query that prompted Search results. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[citations](./search-core.generativedirectanswerresponse.citations.md) + + + | + + + | + +string\[\] + + + | + +An array of uids from the relevant [Result.rawData](./search-core.result.rawdata.md) that were used to form the directAnswer. + + + |
| + +[directAnswer](./search-core.generativedirectanswerresponse.directanswer.md) + + + | + + + | + +string + + + | + +The text of the final generated response. + + + |
| + +[resultStatus](./search-core.generativedirectanswerresponse.resultstatus.md) + + + | + + + | + +string + + + | + +A string representing whether there was a result found within the given invocation. + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[generateAnswer(request)](./search-core.generativedirectanswerservice.generateanswer.md) + + + | + +Generates an answer to a search query. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[matchedSubstrings](./search-core.highlightedvalue.matchedsubstrings.md) + + + | + + + | + +{ length: number; offset: number; }\[\] + + + | + +An array of substring matches which correspond to the highlighting. + + + |
| + +[value](./search-core.highlightedvalue.value.md) + + + | + + + | + +string + + + | + +The value of the field which should be highlighted. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[date](./search-core.holidayhours.date.md) + + + | + + + | + +string + + + | + + + |
| + +[isClosed?](./search-core.holidayhours.isclosed.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ + + + |
| + +[isRegularHours?](./search-core.holidayhours.isregularhours.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ + + + |
| + +[openIntervals?](./search-core.holidayhours.openintervals.md) + + + | + + + | + +[Interval](./search-core.interval.md)\[\] + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[friday?](./search-core.hours.friday.md) + + + | + + + | + +[DayHour](./search-core.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[holidayHours?](./search-core.hours.holidayhours.md) + + + | + + + | + +[HolidayHours](./search-core.holidayhours.md)\[\] + + + | + +_(Optional)_ + + + |
| + +[monday?](./search-core.hours.monday.md) + + + | + + + | + +[DayHour](./search-core.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[reopenDate?](./search-core.hours.reopendate.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[saturday?](./search-core.hours.saturday.md) + + + | + + + | + +[DayHour](./search-core.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[sunday?](./search-core.hours.sunday.md) + + + | + + + | + +[DayHour](./search-core.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[thursday?](./search-core.hours.thursday.md) + + + | + + + | + +[DayHour](./search-core.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[tuesday?](./search-core.hours.tuesday.md) + + + | + + + | + +[DayHour](./search-core.dayhour.md) + + + | + +_(Optional)_ + + + |
| + +[wednesday?](./search-core.hours.wednesday.md) + + + | + + + | + +[DayHour](./search-core.dayhour.md) + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.hoursdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.Hours](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.htmlsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.Html](./search-core.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.instagramhandledirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.InstagramHandle](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.integerdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.Integer](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[end?](./search-core.interval.end.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| + +[start?](./search-core.interval.start.md) + + + | + + + | + +string + + + | + +_(Optional)_ + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.iosappurldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.IOSAppURL](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[latitude](./search-core.latlong.latitude.md) + + + | + + + | + +number + + + | + +Latitude formatted as a decimal degree number. + + + |
| + +[longitude](./search-core.latlong.longitude.md) + + + | + + + | + +number + + + | + +Longitude formatted as a decimal degree number. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[displayName](./search-core.locationbias.displayname.md) + + + | + + + | + +string + + + | + +The name of the location. + + + |
| + +[latitude](./search-core.locationbias.latitude.md) + + + | + + + | + +number + + + | + +The location's latitude. + + + |
| + +[longitude](./search-core.locationbias.longitude.md) + + + | + + + | + +number + + + | + +The location's longitude. + + + |
| + +[method](./search-core.locationbias.method.md) + + + | + + + | + +[LocationBiasMethod](./search-core.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-core.locationboundingbox.maxlatitude.md) + + + | + + + | + +number + + + | + +The location's highest latitude degree. + + + |
| + +[maxLongitude](./search-core.locationboundingbox.maxlongitude.md) + + + | + + + | + +number + + + | + +The location's highest longitude degree. + + + |
| + +[minLatitude](./search-core.locationboundingbox.minlatitude.md) + + + | + + + | + +number + + + | + +The location's lowest latitude degree. + + + |
| + +[minLongitude](./search-core.locationboundingbox.minlongitude.md) + + + | + + + | + +number + + + | + +The location's lowest longitude degree. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[boundingBox?](./search-core.locationfilterdetails.boundingbox.md) + + + | + + + | + +[LocationBoundingBox](./search-core.locationboundingbox.md) + + + | + +_(Optional)_ The location's coordinate boundaries. + + + |
| + +[featureTypes](./search-core.locationfilterdetails.featuretypes.md) + + + | + + + | + +string\[\] + + + | + +The location's classification (e.g. locality, region, address). + + + |
| + +[latitude](./search-core.locationfilterdetails.latitude.md) + + + | + + + | + +number + + + | + +The location's latitude. + + + |
| + +[longitude](./search-core.locationfilterdetails.longitude.md) + + + | + + + | + +number + + + | + +The location's longitude. + + + |
| + +[placeName](./search-core.locationfilterdetails.placename.md) + + + | + + + | + +string + + + | + +The location's name. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[matcher](./search-core.lowernumberrangelimit.matcher.md) + + + | + + + | + +[Matcher.GreaterThan](./search-core.matcher.md) \| [Matcher.GreaterThanOrEqualTo](./search-core.matcher.md) + + + | + +[Matcher](./search-core.matcher.md) for the start limit + + + |
| + +[value](./search-core.lowernumberrangelimit.value.md) + + + | + + + | + +number + + + | + +Value of the limit. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.markdownsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.Markdown](./search-core.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-core.searchcore.md) + + + | + +Provides methods for executing searches, submitting questions, and performing autocompletes. + + + |
| + +[SearchError](./search-core.searcherror.md) + + + | + +Represents an error + + + |
| + +Enumeration + + + | + +Description + + + |
|---|---|
| + +[AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md) + + + | + +Represents the type of [AppliedQueryFilter](./search-core.appliedqueryfilter.md) applied to a search. + + + |
| + +[BuiltInFieldType](./search-core.builtinfieldtype.md) + + + | + +Possible built-in field types for [DirectAnswer.fieldType](./search-core.directanswer.fieldtype.md). + + + |
| + +[CloudChoice](./search-core.cloudchoice.md) + + + | + +Defines the cloud choice of the API domains. + + + |
| + +[CloudRegion](./search-core.cloudregion.md) + + + | + +Defines the cloud region of the API domains. + + + |
| + +[DirectAnswerType](./search-core.directanswertype.md) + + + | + +Represents the type of direct answer. + + + |
| + +[Direction](./search-core.direction.md) + + + | + +The direction of a sort. + + + |
| + +[Environment](./search-core.environment.md) + + + | + +Defines the environment of the API domains. + + + |
| + +[ErrorType](./search-core.errortype.md) + + + | + +Identifier for the type of error causing the failure. + + + |
| + +[FilterCombinator](./search-core.filtercombinator.md) + + + | + +Indicates how child filters in a [StaticFilter](./search-core.staticfilter.md) should be combined. + + + |
| + +[LocationBiasMethod](./search-core.locationbiasmethod.md) + + + | + +The method used to determine the location. + + + |
| + +[Matcher](./search-core.matcher.md) + + + | + +A Matcher is a filtering operation. + + + |
| + +[QuerySource](./search-core.querysource.md) + + + | + +The source of the search request. + + + |
| + +[QueryTrigger](./search-core.querytrigger.md) + + + | + +Describes the ways a search can be executed besides user input. + + + |
| + +[SearchIntent](./search-core.searchintent.md) + + + | + +Represents intents from the Search API. + + + |
| + +[SortType](./search-core.sorttype.md) + + + | + +The method of sorting. + + + |
| + +[Source](./search-core.source.md) + + + | + +Represents the source of a [Result](./search-core.result.md). + + + |
| + +[SpellCheckType](./search-core.spellchecktype.md) + + + | + +Represents the type of spell check performed. + + + |
| + +Function + + + | + +Description + + + |
|---|---|
| + +[provideCore(config)](./search-core.providecore.md) + + + | + +The entrypoint to the search-core library. + + + |
| -## Variables +Interface -| Variable | Description | -| --- | --- | -| [SandboxEndpoints](./search-core.sandboxendpoints.md) | The endpoints to use for sandbox experiences. | -## Type Aliases + | + +Description + + + |
|---|---|
| + +[AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) + + + | + +AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. + + + |
| + +[Address](./search-core.address.md) + + + | + +An interface with address fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md). + + + |
| + +[AddressDirectAnswer](./search-core.addressdirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with 'address' field type. + + + |
| + +[AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md) + + + | + +A direct answer for an android app url field. + + + |
| + +[AppliedQueryFilter](./search-core.appliedqueryfilter.md) + + + | + +A filter that the Search API applied to the search. + + + |
| + +[AutocompleteResponse](./search-core.autocompleteresponse.md) + + + | + +The response of a universal or vertical autocomplete request. + + + |
| + +[AutocompleteResult](./search-core.autocompleteresult.md) + + + | + +An autocomplete suggestion. + + + |
| + +[AutocompleteService](./search-core.autocompleteservice.md) + + + | + +A service for autocomplete requests. + + + |
| + +[BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) + + + | + +A direct answer which was found within a document. + + + |
| + +[BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) + + + | + +A direct answer where the answer came from a field from the knowledge graph. + + + |
| + +[BaseSearchConfig](./search-core.basesearchconfig.md) + + + | + +The base configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [ServingConfig](./search-core.servingconfig.md). + + + |
| + +[ClientSDKHeaderValues](./search-core.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-core.complexurl.md) + + + | + +The shape of a [BuiltInFieldType.ComplexURL](./search-core.builtinfieldtype.md) DirectAnswer value + + + |
| + +[ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md) + + + | + +A direct answer for a complex url field. + + + |
| + +[ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) + + + | + +A static filter composed by combining other static filters with the logical AND operator. + + + |
| + +[DayHour](./search-core.dayhour.md) + + + | + +An interface for a day's hours to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md). + + + |
| + +[DecimalDirectAnswer](./search-core.decimaldirectanswer.md) + + + | + +A direct answer for a decimal field, which is a number represented using a string. + + + |
| + +[DirectAnswer](./search-core.directanswer.md) + + + | + +A direct answer to a search. + + + |
| + +[DisjunctionStaticFilter](./search-core.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-core.displayablefacet.md) + + + | + +A [Facet](./search-core.facet.md) which contains extra fields meant to be displayed to the end user. + + + |
| + +[DisplayableFacetOption](./search-core.displayablefacetoption.md) + + + | + +A [FacetOption](./search-core.facetoption.md) with extra data meant to be displayed to the end user. + + + |
| + +[DocumentResult](./search-core.documentresult.md) + + + | + +Details about the document and the document search algorithm + + + |
| + +[EmailDirectAnswer](./search-core.emaildirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with 'email' field type. + + + |
| + +[Endpoints](./search-core.endpoints.md) + + + | + +Overrides for the URLs which are used when making requests to the Search API. + + + |
| + +[FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md) + + + | + +A direct answer for a facebook url field. + + + |
| + +[Facet](./search-core.facet.md) + + + | + +Represents dynamic filter options for the Search API. + + + |
| + +[FacetOption](./search-core.facetoption.md) + + + | + +A filter associated with the facet. + + + |
| + +[FailedVertical](./search-core.failedvertical.md) + + + | + +Error information from when a vertical fails to return results. + + + |
| + +[FieldValueFilter](./search-core.fieldvaluefilter.md) + + + | + +Represents a filter which compares values to a single field. + + + |
| + +[FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md) + + + | + +A [FieldValueFilter](./search-core.fieldvaluefilter.md) with the kind of filter specified to discriminate between static filter types. + + + |
| + +[FilterSearchRequest](./search-core.filtersearchrequest.md) + + + | + +Options for a filtersearch request. + + + |
| + +[FilterSearchResponse](./search-core.filtersearchresponse.md) + + + | + +The response of a filtersearch request. + + + |
| + +[GenerativeDirectAnswerRequest](./search-core.generativedirectanswerrequest.md) + + + | + +Options which can be specified for a generative direct answer request. + + + |
| + +[GenerativeDirectAnswerResponse](./search-core.generativedirectanswerresponse.md) + + + | + +A representation of a generative direct answer response. + + + |
| + +[GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md) + + + | + +A service for generative direct answer requests. + + + |
| + +[HighlightedValue](./search-core.highlightedvalue.md) + + + | + +A field value and its substring matches as emphasized by the Search API. + + + |
| + +[HolidayHours](./search-core.holidayhours.md) + + + | + +An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md). + + + |
| + +[Hours](./search-core.hours.md) + + + | + +An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md). + + + |
| + +[HoursDirectAnswer](./search-core.hoursdirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with 'hours' field type. + + + |
| + +[HTMLSnippetDirectAnswer](./search-core.htmlsnippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'html' field type. "value" field is omitted for featured snippet direct answer of this field type. + + + |
| + +[InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md) + + + | + +A direct answer for an instagram handle field. + + + |
| + +[IntegerDirectAnswer](./search-core.integerdirectanswer.md) + + + | + +A direct answer for an integer field. + + + |
| + +[Interval](./search-core.interval.md) + + + | + +An interface for a time interval to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md). + + + |
| + +[IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md) + + + | + +A direct answer for an iOS app url field. + + + |
| + +[LatLong](./search-core.latlong.md) + + + | + +The latitude and longitude of the user making the request. Used to bias the results. + + + |
| + +[LocationBias](./search-core.locationbias.md) + + + | + +Information about the user's location. + + + |
| + +[LocationBoundingBox](./search-core.locationboundingbox.md) + + + | + +Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) + + + |
| + +[LocationFilterDetails](./search-core.locationfilterdetails.md) + + + | + +Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md). + + + |
| + +[LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) + + + | + +The start limit of [NumberRangeValue](./search-core.numberrangevalue.md). + + + |
| + +[MarkdownSnippetDirectAnswer](./search-core.markdownsnippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'markdown' field type. "value" field is omitted for featured snippet direct answer of this field type. + + + |
| + +[MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. + + + |
| + +[NearFilterValue](./search-core.nearfiltervalue.md) + + + | + +A filter value for a filter with a $near [Matcher](./search-core.matcher.md). + + + |
| + +[NumberRangeValue](./search-core.numberrangevalue.md) + + + | + +A filter value for a filter with a $between [Matcher](./search-core.matcher.md). + + + |
| + +[PhoneDirectAnswer](./search-core.phonedirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with phone value. + + + |
| + +[QueryRulesActionsData](./search-core.queryrulesactionsdata.md) + + + | + +Data returned from the Search query rules system. + + + |
| + +[QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) + + + | + +Options for a QuestionSubmission request. + + + |
| + +[QuestionSubmissionResponse](./search-core.questionsubmissionresponse.md) + + + | + +A representation of a question submission response. + + + |
| + +[QuestionSubmissionService](./search-core.questionsubmissionservice.md) + + + | + +Submits a custom question to the Search API. + + + |
| + +[Result](./search-core.result.md) + + + | + +An individual search result. + + + |
| + +[RichTextDirectAnswer](./search-core.richtextdirectanswer.md) + + + | + +A direct answer for a rich text field. + + + |
| + +[RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. + + + |
| + +[RichTextV2SnippetDirectAnswer](./search-core.richtextv2snippetdirectanswer.md) + + + | + +A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text\_v2' field type. "value" field is omitted for featured snippet direct answer of this field type. + + + |
| + +[SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) + + + | + +Configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md), but requires apiKey. + + + |
| + +[SearchConfigWithToken](./search-core.searchconfigwithtoken.md) + + + | + +Configuration options for [SearchCore](./search-core.searchcore.md), which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md), but requires token. + + + |
| + +[SearchParameterField](./search-core.searchparameterfield.md) + + + | + +Indicates which entity field to perform the autocomplete request on. + + + |
| + +[SearchRequest](./search-core.searchrequest.md) + + + | + +Options for a Search API request. + + + |
| + +[SearchService](./search-core.searchservice.md) + + + | + +A service which performs Yext Search. + + + |
| + +[Segment](./search-core.segment.md) + + + | + +A result produced by a document vertical. + + + |
| + +[ServingConfig](./search-core.servingconfig.md) + + + | + +The configuration options for getting the endpoints. + + + |
| + +[Snippet](./search-core.snippet.md) + + + | + +The section of text where a [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) was found. + + + |
| + +[SortBy](./search-core.sortby.md) + + + | + +Represents a criterion that can be used to sort results. + + + |
| + +[SpellCheck](./search-core.spellcheck.md) + + + | + +A spellcheck response from a search query. + + + |
| + +[TextDirectAnswer](./search-core.textdirectanswer.md) + + + | + +A direct answer whose source is a string or string list field in the knowledge graph. + + + |
| + +[TwitterHandleDirectAnswer](./search-core.twitterhandledirectanswer.md) + + + | + +A direct answer for an twitter handle field. + + + |
| + +[UniversalAutocompleteRequest](./search-core.universalautocompleterequest.md) + + + | + +Options for a universal autocomplete request. + + + |
| + +[UniversalLimit](./search-core.universallimit.md) + + + | + +The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. + + + |
| + +[UniversalSearchRequest](./search-core.universalsearchrequest.md) + + + | + +Options which can be specified for a universal search. + + + |
| + +[UniversalSearchResponse](./search-core.universalsearchresponse.md) + + + | + +A representation of a response from a universal search. + + + |
| + +[UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md) + + + | + +A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) with a field type outside of [BuiltInFieldType](./search-core.builtinfieldtype.md). + + + |
| + +[UpperNumberRangeLimit](./search-core.uppernumberrangelimit.md) + + + | + +The end limit of [NumberRangeValue](./search-core.numberrangevalue.md). + + + |
| + +[UrlDirectAnswer](./search-core.urldirectanswer.md) + + + | + +A direct answer for a simple url field. + + + |
| + +[VerticalAutocompleteRequest](./search-core.verticalautocompleterequest.md) + + + | + +Options for a vertial autocomplete request. + + + |
| + +[VerticalResults](./search-core.verticalresults.md) + + + | + +Represents results from a search vertical. + + + |
| + +[VerticalSearchRequest](./search-core.verticalsearchrequest.md) + + + | + +Options which can be specified for a vertical search. + + + |
| + +[VerticalSearchResponse](./search-core.verticalsearchresponse.md) + + + | + +A representation of a response from a vertical search. + + + |
| + +[Visitor](./search-core.visitor.md) + + + | + +Information used to associate requests with a particular user. + + + |
| + +Variable + + + | + +Description + + + |
|---|---|
| + +[SandboxEndpoints](./search-core.sandboxendpoints.md) + + + | + +The endpoints to use for sandbox experiences. + + + |
| + +Type Alias + + + | + +Description + + + |
|---|---|
| + +[Context](./search-core.context.md) + + + | + +Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + + + |
| + +[EnumOrLiteral](./search-core.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-core.featuredsnippetdirectanswer.md) + + + | + +All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) interfaces. + + + |
| + +[FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) + + + | + +Possible built-in and custom [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interfaces. + + + |
| + +[HighlightedFields](./search-core.highlightedfields.md) + + + | + +A mapping of fields to the values emphasized by the Search API. + + + |
| + +[SearchConfig](./search-core.searchconfig.md) + + + | + +The main configuration options for [SearchCore](./search-core.searchcore.md). For a full description of the options, see [BaseSearchConfig](./search-core.basesearchconfig.md). The config requires either an apiKey or a token. + + + |
| + +[StaticFilter](./search-core.staticfilter.md) + + + | + +Represents a static filter that will be used to refine results. -| Type Alias | Description | -| --- | --- | -| [Context](./search-core.context.md) | Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | -| [EnumOrLiteral](./search-core.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-core.featuredsnippetdirectanswer.md) | All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) interfaces. | -| [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) | Possible built-in and custom [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interfaces. | -| [HighlightedFields](./search-core.highlightedfields.md) | A mapping of fields to the values emphasized by the Search API. | -| [SearchConfig](./search-core.searchconfig.md) | The main configuration options for [SearchCore](./search-core.searchcore.md). For a full description of the options, see [BaseSearchConfig](./search-core.basesearchconfig.md). The config requires either an apiKey or a token. | -| [StaticFilter](./search-core.staticfilter.md) | Represents a static filter that will be used to refine results. | + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.multilinetextsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| + +[value](./search-core.multilinetextsnippetdirectanswer.value.md) + + + | + + + | + +string + + + | + +The value of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[lat](./search-core.nearfiltervalue.lat.md) + + + | + + + | + +number + + + | + +The latitude of the location. + + + |
| + +[lng](./search-core.nearfiltervalue.lng.md) + + + | + + + | + +number + + + | + +The longitude of the location. + + + |
| + +[radius](./search-core.nearfiltervalue.radius.md) + + + | + + + | + +number + + + | + +The radius (in meters) around the latitude and longitude. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[end?](./search-core.numberrangevalue.end.md) + + + | + + + | + +[UpperNumberRangeLimit](./search-core.uppernumberrangelimit.md) + + + | + +_(Optional)_ End limit of the number range value. + + + |
| + +[start?](./search-core.numberrangevalue.start.md) + + + | + + + | + +[LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) + + + | + +_(Optional)_ Start limit of the number range value. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.phonedirectanswer.fieldtype.md) + + + | + + + | + +[BuiltInFieldType.Phone](./search-core.builtinfieldtype.md) + + + | + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +config + + + | + +[SearchConfig](./search-core.searchconfig.md) + + + | + +The search-core config + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[data?](./search-core.queryrulesactionsdata.data.md) + + + | + + + | + +Record<string, unknown> + + + | + +_(Optional)_ The data returned from the query rule. + + + |
| + +[errors?](./search-core.queryrulesactionsdata.errors.md) + + + | + + + | + +{ uuid: string; type: string; message?: string; }\[\] + + + | + +_(Optional)_ Any errors returned from the query rule. + + + |
| + +[key](./search-core.queryrulesactionsdata.key.md) + + + | + + + | + +string + + + | + +The unique identifier for this query rule. + + + |
"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. + + + |
"initialize" | Indicates that the query was triggered by a default initial search. |
-| Suggest | "suggest" | Indicates that the query was suggested by a [SpellCheck](./search-core.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-core.spellcheck.md) response. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[email](./search-core.questionsubmissionrequest.email.md) + + + | + + + | + +string + + + | + +The email of the user that is submitting the question. + + + |
| + +[entityId](./search-core.questionsubmissionrequest.entityid.md) + + + | + + + | + +string + + + | + +The ID of the entity to associate with the question. + + + |
| + +[name](./search-core.questionsubmissionrequest.name.md) + + + | + + + | + +string + + + | + +The name of the user. + + + |
| + +[questionDescription?](./search-core.questionsubmissionrequest.questiondescription.md) + + + | + + + | + +string + + + | + +_(Optional)_ Additional information about the question. + + + |
| + +[questionText](./search-core.questionsubmissionrequest.questiontext.md) + + + | + + + | + +string + + + | + +The question. + + + |
| + +[sessionTrackingEnabled?](./search-core.questionsubmissionrequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[uuid](./search-core.questionsubmissionresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[submitQuestion(request)](./search-core.questionsubmissionservice.submitquestion.md) + + + | + +Submits a question to be answered. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[description?](./search-core.result.description.md) + + + | + + + | + +string + + + | + +_(Optional)_ A description of the result. + + + |
| + +[distance?](./search-core.result.distance.md) + + + | + + + | + +number + + + | + +_(Optional)_ The distance from the user to the result in meters. + + + |
| + +[distanceFromFilter?](./search-core.result.distancefromfilter.md) + + + | + + + | + +number + + + | + +_(Optional)_ The distance from a [AppliedQueryFilter](./search-core.appliedqueryfilter.md) location to the result in meters. + + + |
| + +[document?](./search-core.result.document.md) + + + | + + + | + +[DocumentResult](./search-core.documentresult.md) + + + | + +_(Optional)_ A relevant document associated with the result. Present for document verticals grouped by Document. + + + |
| + +[documents?](./search-core.result.documents.md) + + + | + + + | + +[DocumentResult](./search-core.documentresult.md)\[\] + + + | + +_(Optional)_ All relevant documents associated with the result. Present for document verticals grouped by Entity. + + + |
| + +[entityType?](./search-core.result.entitytype.md) + + + | + + + | + +string + + + | + +_(Optional)_ The entity type of the result. + + + |
| + +[highlightedFields?](./search-core.result.highlightedfields.md) + + + | + + + | + +[HighlightedFields](./search-core.highlightedfields.md) + + + | + +_(Optional)_ The [highlighted fields](./search-core.highlightedfields.md) emphasized by the api. + + + |
| + +[id?](./search-core.result.id.md) + + + | + + + | + +string + + + | + +_(Optional)_ The result ID which depends on the Result Source. + + + |
| + +[index?](./search-core.result.index.md) + + + | + + + | + +number + + + | + +_(Optional)_ The index of the result among the other results in the search. + + + |
| + +[link?](./search-core.result.link.md) + + + | + + + | + +string + + + | + +_(Optional)_ A hyperlink associated with the result. + + + |
| + +[name?](./search-core.result.name.md) + + + | + + + | + +string + + + | + +_(Optional)_ The name of the result. + + + |
| + +[rawData](./search-core.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-core.result.segment.md) + + + | + + + | + +[Segment](./search-core.segment.md) + + + | + +_(Optional)_ A relevant segment associated with the result. Present for document verticals grouped by Segment. + + + |
| + +[source](./search-core.result.source.md) + + + | + + + | + +[Source](./search-core.source.md) + + + | + +Represents the source of a [Result](./search-core.result.md). + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.richtextdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.richtextsnippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.richtextv2snippetdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.RichText\_v2](./search-core.builtinfieldtype.md)> + + + | + +The field type of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[apiKey](./search-core.searchconfigwithapikey.apikey.md) + + + | + + + | + +string + + + | + +The api key of the search experience which will be sent as a query param. + + + |
| + +[token?](./search-core.searchconfigwithapikey.token.md) + + + | + + + | + +never + + + | + +_(Optional)_ token should NOT be provided along with apiKey. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[apiKey?](./search-core.searchconfigwithtoken.apikey.md) + + + | + + + | + +never + + + | + +_(Optional)_ apiKey should NOT be provided along with token. + + + |
| + +[token](./search-core.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-core.searchservice.md) + + + | + + + |
| + +questionSubmissionService + + + | + +[QuestionSubmissionService](./search-core.questionsubmissionservice.md) + + + | + + + |
| + +autoCompleteService + + + | + +[AutocompleteService](./search-core.autocompleteservice.md) + + + | + + + |
| + +generativeDirectAnswerService + + + | + +[GenerativeDirectAnswerService](./search-core.generativedirectanswerservice.md) + + + | + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +request + + + | + +[FilterSearchRequest](./search-core.filtersearchrequest.md) + + + | + +filtersearch request options + + + |
SearchCore class |
+| + +Constructor + + + | + +Modifiers + + + | + +Description + + + |
|---|---|---|
| + +[(constructor)(searchService, questionSubmissionService, autoCompleteService, generativeDirectAnswerService)](./search-core.searchcore._constructor_.md) + + + | + + + | + +Constructs a new instance of the `SearchCore` class + + + |
| + +Method + + + | + +Modifiers + + + | + +Description + + + |
|---|---|---|
| + +[filterSearch(request)](./search-core.searchcore.filtersearch.md) + + + | + + + | + +Performs a filtersearch request against specified fields within a single vertical. + + + |
| + +[generativeDirectAnswer(request)](./search-core.searchcore.generativedirectanswer.md) + + + | + + + | + +Performs a generative direct answer request. + + + |
| + +[submitQuestion(request)](./search-core.searchcore.submitquestion.md) + + + | + + + | + +Submits a custom question to the Search API. + + + |
| + +[universalAutocomplete(request)](./search-core.searchcore.universalautocomplete.md) + + + | + + + | + +Performs an autocomplete request across all verticals. + + + |
| + +[universalSearch(request)](./search-core.searchcore.universalsearch.md) + + + | + + + | + +Performs a search across all verticals. + + + |
| + +[verticalAutocomplete(request)](./search-core.searchcore.verticalautocomplete.md) + + + | + + + | + +Performs an autocomplete request for a single vertical. + + + |
| + +[verticalSearch(request)](./search-core.searchcore.verticalsearch.md) + + + | + + + | + +Performs a search for a single vertical. + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +request + + + | + +[VerticalSearchRequest](./search-core.verticalsearchrequest.md) + + + | + +Vertical search request options + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[code?](./search-core.searcherror.code.md) + + + | + + + | + +number + + + | + +_(Optional)_ Search API error code. + + + |
| + +[message](./search-core.searcherror.message.md) + + + | + + + | + +string + + + | + +The error message. + + + |
| + +[type?](./search-core.searcherror.type.md) + + + | + + + | + +string + + + | + +_(Optional)_ Search API error type. + + + |
"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-core.searchparameterfield.entitytype.md) + + + | + + + | + +string + + + | + +The entityType to perform the autocomplete on. + + + |
| + +[fetchEntities](./search-core.searchparameterfield.fetchentities.md) + + + | + + + | + +boolean + + + | + +Indicates whether or not to return the [AutocompleteResult.relatedItem](./search-core.autocompleteresult.relateditem.md) associated with the autocomplete result. + + + |
| + +[fieldApiName](./search-core.searchparameterfield.fieldapiname.md) + + + | + + + | + +string + + + | + +The fieldApiName to perform the autocomplete on. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[additionalHttpHeaders?](./search-core.searchrequest.additionalhttpheaders.md) + + + | + + + | + +[AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) + + + | + +_(Optional)_ AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. + + + |
| +Method + + + | + +Description + + + |
|---|---|
| + +[universalSearch(request)](./search-core.searchservice.universalsearch.md) + + + | + +Performs a Universal search across all verticals. + + + |
| + +[verticalSearch(request)](./search-core.searchservice.verticalsearch.md) + + + | + +Performs a search across a particular Vertical. + + + |
| -Returns: +Parameter + + + | + +Type + + + | + +Description + + + |
|---|---|---|
| + +request + + + | + +[VerticalSearchRequest](./search-core.verticalsearchrequest.md) + + + | + +The details of the Vertical search request. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[pageNumber?](./search-core.segment.pagenumber.md) + + + | + + + | + +number + + + | + +_(Optional)_ The page number of the document that the segment came from. Populated only for pdf files. + + + |
| + +[score](./search-core.segment.score.md) + + + | + + + | + +number + + + | + +The similarity score of the segment from 0 to 1 + + + |
| + +[text](./search-core.segment.text.md) + + + | + + + | + +string + + + | + +The value of the segment as plain text. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[cloudChoice?](./search-core.servingconfig.cloudchoice.md) + + + | + + + | + +[CloudChoice](./search-core.cloudchoice.md) + + + | + +_(Optional)_ Defines the cloud choice of the API domains. + + + |
| + +[cloudRegion?](./search-core.servingconfig.cloudregion.md) + + + | + + + | + +[CloudRegion](./search-core.cloudregion.md) + + + | + +_(Optional)_ Defines the cloud region of the API domains. + + + |
| + +[environment?](./search-core.servingconfig.environment.md) + + + | + + + | + +[Environment](./search-core.environment.md) + + + | + +_(Optional)_ Defines the environment of the API domains. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[matchedSubstrings](./search-core.snippet.matchedsubstrings.md) + + + | + + + | + +{ offset: number; length: number; }\[\] + + + | + +The locations in the document text of the [DirectAnswer.value](./search-core.directanswer.value.md) + + + |
| + +[value](./search-core.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-core.sortby.direction.md) + + + | + + + | + +[Direction](./search-core.direction.md) + + + | + +_(Optional)_ The direction of the sort. Required if the SortBy type is [SortType.Field](./search-core.sorttype.md). + + + |
| + +[field?](./search-core.sortby.field.md) + + + | + + + | + +string + + + | + +_(Optional)_ The field name to sort by. Required if the SortBy type is [SortType.Field](./search-core.sorttype.md). + + + |
| + +[type](./search-core.sortby.type.md) + + + | + + + | + +[SortType](./search-core.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. |
-| FunctionVertical | "FUNCTION_VERTICAL" | The result is from a function 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. + + + |
| + +FunctionVertical + + + | + +`"FUNCTION_VERTICAL"` + + + | + +The result is from a function 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-core.spellcheck.correctedquery.md) + + + | + + + | + +string + + + | + +The corrected version of the originalQuery. + + + |
| + +[matchedSubstrings](./search-core.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-core.spellcheck.originalquery.md) + + + | + + + | + +string + + + | + +The query that was input into the spell checker. + + + |
| + +[type](./search-core.spellcheck.type.md) + + + | + + + | + +[SpellCheckType](./search-core.spellchecktype.md) + + + | + +The type of spell check. + + + |
"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 + + + |
|---|---|---|---|
| + +[fieldType](./search-core.textdirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.SingleLineText](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.twitterhandledirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.TwitterHandle](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[input](./search-core.universalautocompleterequest.input.md) + + + | + + + | + +string + + + | + +The input string for autocomplete. + + + |
| + +[sessionTrackingEnabled?](./search-core.universalautocompleterequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[context?](./search-core.universalsearchrequest.context.md) + + + | + + + | + +[Context](./search-core.context.md) + + + | + +_(Optional)_ Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + + + |
| + +[limit?](./search-core.universalsearchrequest.limit.md) + + + | + + + | + +[UniversalLimit](./search-core.universallimit.md) + + + | + +_(Optional)_ The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. + + + |
| + +[location?](./search-core.universalsearchrequest.location.md) + + + | + + + | + +[LatLong](./search-core.latlong.md) + + + | + +_(Optional)_ The latitude and longitude of the user making the request. Used to bias the results. + + + |
| + +[query](./search-core.universalsearchrequest.query.md) + + + | + + + | + +string + + + | + +The search query. + + + |
| + +[querySource?](./search-core.universalsearchrequest.querysource.md) + + + | + + + | + +[QuerySource](./search-core.querysource.md) \| string + + + | + +_(Optional)_ The source of the search request. + + + |
| + +[queryTrigger?](./search-core.universalsearchrequest.querytrigger.md) + + + | + + + | + +[QueryTrigger](./search-core.querytrigger.md) + + + | + +_(Optional)_ Describes the ways a search can be executed besides user input. + + + |
| + +[referrerPageUrl?](./search-core.universalsearchrequest.referrerpageurl.md) + + + | + + + | + +string + + + | + +_(Optional)_ The URl of the page which referred the user to the current page. + + + |
| + +[restrictVerticals?](./search-core.universalsearchrequest.restrictverticals.md) + + + | + + + | + +string\[\] + + + | + +_(Optional)_ If included, the response will only include these verticals. + + + |
| + +[sessionId?](./search-core.universalsearchrequest.sessionid.md) + + + | + + + | + +string + + + | + +_(Optional)_ Used to track session state when cookies are blocked. + + + |
| + +[sessionTrackingEnabled?](./search-core.universalsearchrequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| + +[skipSpellCheck?](./search-core.universalsearchrequest.skipspellcheck.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Disables spellcheck if true. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[directAnswer?](./search-core.universalsearchresponse.directanswer.md) + + + | + + + | + +[FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) + + + | + +_(Optional)_ A direct answer to a search. + + + |
| + +[failedVerticals?](./search-core.universalsearchresponse.failedverticals.md) + + + | + + + | + +[FailedVertical](./search-core.failedvertical.md)\[\] + + + | + +_(Optional)_ Error information from when a vertical fails to return results. + + + |
| + +[locationBias?](./search-core.universalsearchresponse.locationbias.md) + + + | + + + | + +[LocationBias](./search-core.locationbias.md) + + + | + +_(Optional)_ Information about the user's location. + + + |
| + +[queryId?](./search-core.universalsearchresponse.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The ID of the search query. + + + |
| + +[queryRulesActionsData?](./search-core.universalsearchresponse.queryrulesactionsdata.md) + + + | + + + | + +[QueryRulesActionsData](./search-core.queryrulesactionsdata.md)\[\] + + + | + +_(Optional)_ Data returned from the Search query rules system. + + + |
| + +[searchIntents?](./search-core.universalsearchresponse.searchintents.md) + + + | + + + | + +[SearchIntent](./search-core.searchintent.md)\[\] + + + | + +_(Optional)_ An array of [SearchIntent](./search-core.searchintent.md)s which represents requests from the API. + + + |
| + +[spellCheck?](./search-core.universalsearchresponse.spellcheck.md) + + + | + + + | + +[SpellCheck](./search-core.spellcheck.md) + + + | + +_(Optional)_ A spellcheck response from a search query. + + + |
| + +[uuid](./search-core.universalsearchresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| + +[verticalResults](./search-core.universalsearchresponse.verticalresults.md) + + + | + + + | + +[VerticalResults](./search-core.verticalresults.md)\[\] + + + | + +An array of [VerticalResults](./search-core.verticalresults.md) which represent the results for each vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.unknownfieldvaluedirectanswer.fieldtype.md) + + + | + + + | + +'unknown' + + + | + +The field type of the direct answer. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[matcher](./search-core.uppernumberrangelimit.matcher.md) + + + | + + + | + +[Matcher.LessThan](./search-core.matcher.md) \| [Matcher.LessThanOrEqualTo](./search-core.matcher.md) + + + | + +[Matcher](./search-core.matcher.md) for the end limit + + + |
| + +[value](./search-core.uppernumberrangelimit.value.md) + + + | + + + | + +number + + + | + +Value of the limit. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[fieldType](./search-core.urldirectanswer.fieldtype.md) + + + | + + + | + +[EnumOrLiteral](./search-core.enumorliteral.md)<[BuiltInFieldType.URL](./search-core.builtinfieldtype.md)> + + + | + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[input](./search-core.verticalautocompleterequest.input.md) + + + | + + + | + +string + + + | + +The input string for autocomplete. + + + |
| + +[sessionTrackingEnabled?](./search-core.verticalautocompleterequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| + +[verticalKey](./search-core.verticalautocompleterequest.verticalkey.md) + + + | + + + | + +string + + + | + +The key for the vertical to get autocomplete suggestions from. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[appliedQueryFilters](./search-core.verticalresults.appliedqueryfilters.md) + + + | + + + | + +[AppliedQueryFilter](./search-core.appliedqueryfilter.md)\[\] + + + | + +A array of [AppliedQueryFilter](./search-core.appliedqueryfilter.md)s which were applied to the vertical results. + + + |
| + +[queryDurationMillis?](./search-core.verticalresults.querydurationmillis.md) + + + | + + + | + +number + + + | + +_(Optional)_ The duration of the query in milliseconds + + + |
| + +[results](./search-core.verticalresults.results.md) + + + | + + + | + +[Result](./search-core.result.md)\[\] + + + | + +An array of search [Result](./search-core.result.md)s for the vertical. + + + |
| + +[resultsCount](./search-core.verticalresults.resultscount.md) + + + | + + + | + +number + + + | + +The total number of results within the vertical. + + + |
| + +[source](./search-core.verticalresults.source.md) + + + | + + + | + +[Source](./search-core.source.md) + + + | + +Represents the source of a [Result](./search-core.result.md). + + + |
| + +[verticalKey](./search-core.verticalresults.verticalkey.md) + + + | + + + | + +string + + + | + +The vertical key associated with the vertical results. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[context?](./search-core.verticalsearchrequest.context.md) + + + | + + + | + +[Context](./search-core.context.md) + + + | + +_(Optional)_ Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). + + + |
| + +[facets?](./search-core.verticalsearchrequest.facets.md) + + + | + + + | + +[Facet](./search-core.facet.md)\[\] + + + | + +_(Optional)_ The facet filters to apply to the search. + + + |
| + +[limit?](./search-core.verticalsearchrequest.limit.md) + + + | + + + | + +number + + + | + +_(Optional)_ The maximum number of results to include with a max of 50. + + + |
| + +[location?](./search-core.verticalsearchrequest.location.md) + + + | + + + | + +[LatLong](./search-core.latlong.md) + + + | + +_(Optional)_ The latitude and longitude of the user making the request. Used to bias the results. + + + |
| + +[locationRadius?](./search-core.verticalsearchrequest.locationradius.md) + + + | + + + | + +number + + + | + +_(Optional)_ The radius (in meters) to filter the vertical search by. + + + |
| + +[offset?](./search-core.verticalsearchrequest.offset.md) + + + | + + + | + +number + + + | + +_(Optional)_ The result offset which allows for fetching more results with the same query. + + + |
| + +[query](./search-core.verticalsearchrequest.query.md) + + + | + + + | + +string + + + | + +The search query. + + + |
| + +[queryId?](./search-core.verticalsearchrequest.queryid.md) + + + | + + + | + +string + + + | + +_(Optional)_ The queryId for the query, if this is a repeat query. + + + |
| + +[querySource?](./search-core.verticalsearchrequest.querysource.md) + + + | + + + | + +[QuerySource](./search-core.querysource.md) \| string + + + | + +_(Optional)_ The source of the search request. + + + |
| + +[queryTrigger?](./search-core.verticalsearchrequest.querytrigger.md) + + + | + + + | + +[QueryTrigger](./search-core.querytrigger.md) + + + | + +_(Optional)_ Describes the ways a search can be executed besides user input. + + + |
| + +[referrerPageUrl?](./search-core.verticalsearchrequest.referrerpageurl.md) + + + | + + + | + +string + + + | + +_(Optional)_ The URl of the page which referred the user to the current page. + + + |
| + +[retrieveFacets?](./search-core.verticalsearchrequest.retrievefacets.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Indicates that facets should be retrieved. + + + |
| + +[sessionId?](./search-core.verticalsearchrequest.sessionid.md) + + + | + + + | + +string + + + | + +_(Optional)_ Used to track session state when cookies are blocked. + + + |
| + +[sessionTrackingEnabled?](./search-core.verticalsearchrequest.sessiontrackingenabled.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Enables session tracking. + + + |
| + +[skipSpellCheck?](./search-core.verticalsearchrequest.skipspellcheck.md) + + + | + + + | + +boolean + + + | + +_(Optional)_ Skips spell checking if true. + + + |
| + +[sortBys?](./search-core.verticalsearchrequest.sortbys.md) + + + | + + + | + +[SortBy](./search-core.sortby.md)\[\] + + + | + +_(Optional)_ Determines how results are sorted. \* + + + |
| + +[staticFilter?](./search-core.verticalsearchrequest.staticfilter.md) + + + | + + + | + +[StaticFilter](./search-core.staticfilter.md) + + + | + +_(Optional)_ The static filter to apply to the search. + + + |
| + +[verticalKey](./search-core.verticalsearchrequest.verticalkey.md) + + + | + + + | + +string + + + | + +The key associated with the vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[allResultsForVertical?](./search-core.verticalsearchresponse.allresultsforvertical.md) + + + | + + + | + +[VerticalSearchResponse](./search-core.verticalsearchresponse.md) + + + | + +_(Optional)_ A representation of a response from a vertical search. + + + |
| + +[alternativeVerticals?](./search-core.verticalsearchresponse.alternativeverticals.md) + + + | + + + | + +[VerticalResults](./search-core.verticalresults.md)\[\] + + + | + +_(Optional)_ The [VerticalResults](./search-core.verticalresults.md) for each search vertical. + + + |
| + +[directAnswer?](./search-core.verticalsearchresponse.directanswer.md) + + + | + + + | + +[FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) + + + | + +_(Optional)_ A direct answer to a search. + + + |
| + +[facets?](./search-core.verticalsearchresponse.facets.md) + + + | + + + | + +[DisplayableFacet](./search-core.displayablefacet.md)\[\] + + + | + +_(Optional)_ An array of [Facet](./search-core.facet.md)s associated with the search results. + + + |
| + +[locationBias?](./search-core.verticalsearchresponse.locationbias.md) + + + | + + + | + +[LocationBias](./search-core.locationbias.md) + + + | + +_(Optional)_ Information about the user's location. + + + |
| + +[queryId](./search-core.verticalsearchresponse.queryid.md) + + + | + + + | + +string + + + | + +The ID of the query. + + + |
| + +[queryRulesActionsData?](./search-core.verticalsearchresponse.queryrulesactionsdata.md) + + + | + + + | + +[QueryRulesActionsData](./search-core.queryrulesactionsdata.md)\[\] + + + | + +_(Optional)_ Data returned from the Search query rules system. + + + |
| + +[searchIntents?](./search-core.verticalsearchresponse.searchintents.md) + + + | + + + | + +[SearchIntent](./search-core.searchintent.md)\[\] + + + | + +_(Optional)_ An array of [SearchIntent](./search-core.searchintent.md)s. + + + |
| + +[spellCheck?](./search-core.verticalsearchresponse.spellcheck.md) + + + | + + + | + +[SpellCheck](./search-core.spellcheck.md) + + + | + +_(Optional)_ A spellcheck response from a search query. + + + |
| + +[uuid](./search-core.verticalsearchresponse.uuid.md) + + + | + + + | + +string + + + | + +A unique id which corresponds to the request. + + + |
| + +[verticalResults](./search-core.verticalsearchresponse.verticalresults.md) + + + | + + + | + +[VerticalResults](./search-core.verticalresults.md) + + + | + +Represents results from a search vertical. + + + |
| +Property + + + | + +Modifiers + + + | + +Type + + + | + +Description + + + |
|---|---|---|---|
| + +[id](./search-core.visitor.id.md) + + + | + + + | + +string + + + | + +The ID associated with the user + + + |
| + +[idMethod?](./search-core.visitor.idmethod.md) + + + | + + + | + +string + + + | + +_(Optional)_ The type of visitor + + + |