Enumeration: KlevuSearchPreference

@klevu/core / @klevu/core docid 7vdpes 8 0tv 43dya7ly / klevusearchpreference table of contents enumeration members enumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01benumeration klevusearchpreference docid 4csizq9eos8dhpk21r01b enumeration members debugquery • debugquery = "debugquery" use this flag to include additional information about the query execution this information is populated in the meta object of the response please note that it is not recommended to enable this flag in your production environment, as performance will be impacted defined in models/klevusearchpreference ts 133 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l133 disablefuzzymatch • disablefuzzymatch = "disablefuzzymatch" this flag can be used in conjunction with the typeofsearch 'default' to disable the fuzzy and and fuzzy or search types from being attempted defined in models/klevusearchpreference ts 39 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l39 disableorsearch • disableorsearch = "disableorsearch" this flag can be used in conjunction with the typeofsearch 'default' to disable the wildcard or and fuzzy or search types from being attempted defined in models/klevusearchpreference ts 50 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l50 disablestocksorting • disablestocksorting = "disablestocksorting" this can be used in conjunction with showoutofstockproducts if your store is configured to display out of stock products, they will be displayed at the very end of the search results after all in stock products have been displayed by using this flag you can disable this logic, and cause all products to be ranked in an order that disregards their stock status defined in models/klevusearchpreference ts 17 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l17 disablewildcard • disablewildcard = "disablewildcard" this flag can be used in conjunction with the typeofsearch 'default' to disable the wildcard and and wildcard or search types from being attempted defined in models/klevusearchpreference ts 45 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l45 disablewordshingles • disablewordshingles = "disablewordshingles" for a query longer than one word, all the possible bigrams and trigrams (i e formed out of query terms) are looked up in records and the ones having one or more of them are boosted higher up in the search results you can use this flag to disable such boosting defined in models/klevusearchpreference ts 78 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l78 enableboostingoriginaltermsinsynonyms • enableboostingoriginaltermsinsynonyms = "enableboostingoriginaltermsinsynonyms" by default, synonyms are treated equally to their query term should you wish to give higher priority to the actual terms your customer entered in the query over their synonyms, please include this flag in your search preferences defined in models/klevusearchpreference ts 100 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l100 enablescores • enablescores = "enablescores" include the score information with the response fields score, klevu manual boosting, klevu bulk boosting and klevu selflearning boosting defined in models/klevusearchpreference ts 125 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l125 excludeids • excludeids = "excludeids" use this flag to disable the searching of record ids defined in models/klevusearchpreference ts 27 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l27 hideoutofstockproducts • hideoutofstockproducts = "hideoutofstockproducts" whether or not your store should include 'out of stock' products in search results by default can be configured within the klevu merchant centre however, if you would like to override this for a particular query, please include one of these flags defined in models/klevusearchpreference ts 9 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l9 ignoremanualboosting • ignoremanualboosting = "ignoremanualboosting" @todo most probably ignores manual boostin needs proper documentation defined in models/klevusearchpreference ts 138 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l138 includecategoryfilterincatnav • includecategoryfilterincatnav = "includecategoryfilterincatnav" when the typeofrequest is 'catnav', the filter for 'category' is automatically excluded since you are already within the context of a category use this flag to override this logic and return the category filters even for catnav requests defined in models/klevusearchpreference ts 120 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l120 includedescription • includedescription = "includedescription" , excludedescription whether or not a record's 'description' is considered for search results can be configured by klevu support on a store by store basis, however if you would like to override this for a particular query, please include one of these flags defined in models/klevusearchpreference ts 34 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l34 includestopwords • includestopwords = "includestopwords" by default, functional words such as prepositions, pronouns, articles, etc are excluded from searches add this flag to include these stopwords in your search defined in models/klevusearchpreference ts 23 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l23 partialmatch • partialmatch = "partialmatch" enable partial match for the last word of a query, where the last word searched can be a substring of any other word found in a record this can be useful for non english languages for example let's say a product has the name "rödvinsglas" (red wine glass) if searching for "högt glas" (tall glass) it may not match since the record has no words starting with 'glas' by providing this flag, the search would become "högt glas " meaning it would match the record since it contains a word which ends with 'glas' defined in models/klevusearchpreference ts 63 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l63 partialmatchforallwords • partialmatchforallwords = "partialmatchforallwords" similar to partialmatch, but for all words rather than just the last in the same "rödvinsglas" example, a search for "högt glas" would become " högt glas ", so any records containing words containing 'högt' or 'glas' would result in a match defined in models/klevusearchpreference ts 71 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l71 searchcompoundsasandquery • searchcompoundsasandquery = "searchcompoundsasandquery" when a compound word is searched for, i e two or more individual words joined together as one word, klevu automatically disjoints them if the de compounding feature is enabled for your store for example, a search for "fairylights" would be treated as "fairy lights", but with the added condition that those words must appear within 5 words of each other in a matching record if you would prefer that the words "fairy" and "light" could be found anywhere within the record, not necessarily near one another, then please include this flag defined in models/klevusearchpreference ts 92 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l92 showdisabledfacets • showdisabledfacets = "showdisabledfacets" it is possible to configure which facets or filters should be enabled or disabled within the klevu merchant centre by including this flag, all facets will be returned regardless of whether they have been disabled in the kmc defined in models/klevusearchpreference ts 107 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l107 showfilterswithsmallcount • showfilterswithsmallcount = "showfilterswithsmallcount" by default some filters are excluded from the results if they only have a small number of results please use this flag to override this logic and include all filters in the response defined in models/klevusearchpreference ts 113 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l113 showoutofstockproducts • showoutofstockproducts = "showoutofstockproducts" defined in models/klevusearchpreference ts 2 https //github com/klevultd/frontend sdk/blob/492d3760/packages/klevu core/src/models/klevusearchpreference ts#l2