coveo-search-ui

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>QueryBuilder | Coveo JavaScript Search Framework - Reference Documentation</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="https://use.typekit.net/bqa0xml.css"></link> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/all.min.css" /> <link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/overrides.css"> <link rel="stylesheet" href="../assets/css/coveo-connect-header.css"> <link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10122/css/CoveoFullSearch.min.css" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script> <script type="text/javascript" src="https://static.cloud.coveo.com/coveo.analytics.js/coveoua.js"></script> <script src="../assets/js/modernizr.js"></script> <script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10122/js/CoveoJsSearch.min.js"></script> <script src="../assets/js/coveo-connect-header.js"></script> <script src="../assets/gen/js/playground.js"></script> <script src="../assets/js/searchUIrefDoc.js"></script> <link href="../assets/favicon.ico" rel="shortcut icon" type="image/x-icon"> </head> <body> <header class="no-sticky"> <div class="content"> <div class="main-header"> <div class="logo"> <a class="logo-img-wrap" href="https://coveo.com"> <div class="logo-imgbg"> <svg width="124" height="32" viewBox="0 0 409 104" fill="none" xmlns="http://www.w3.org/2000/svg"> <g clip-path="url(#clip0)"> <path d="M164.7 36.2L159.8 41.4C156.4 38.1 152.8 36.2 147.9 36.2C139.4 36.2 133 42.9 133 52.3C133 61.7 139.4 68.4 147.9 68.4C152.5 68.4 156.9 66.5 160.1 63.2L164.7 68.4C160.7 73 155 75.4 148.3 75.4C134.3 75.4 125.2 65.4 125.2 52.3C125.2 38.9 134.3 28.9 148.3 28.9C154.6 28.8 160.6 31.5 164.7 36.2Z" fill="white"/> <path d="M219.4 52.3C219.4 65.4 209.4 75.4 196 75.4C182.3 75.4 172.3 65.4 172.3 52.3C172.3 38.9 182.3 28.9 196 28.9C209.4 28.9 219.4 38.9 219.4 52.3ZM180.2 52.3C180.2 61.7 186.9 68.4 196 68.4C204.8 68.4 211.5 61.7 211.5 52.3C211.5 42.9 204.8 36.2 196 36.2C186.9 36.2 180.2 42.9 180.2 52.3Z" fill="white"/> <path d="M252.3 74.5H243.1L224.3 30.1H232.8L247.7 66.9L262.6 30.1H270.8L252.3 74.5Z" fill="white"/> <path d="M318.8 52V55H283.8C284.7 64.1 291.1 68.7 298.7 68.7C303.8 68.8 308.8 66.9 312.7 63.5L316.7 68.7C311.2 73.9 305.1 75.5 298.4 75.5C285 75.5 275.6 66.4 275.6 52.4C275.6 38.7 285 29 297.8 29C310 28.9 318.8 38.6 318.8 52ZM283.9 48.6H311.3C310.4 41 305.2 35.8 297.9 35.8C290 35.9 285.1 41 283.9 48.6Z" fill="white"/> <path d="M376 52.3C376 65.4 366 75.4 352.6 75.4C338.9 75.4 328.9 65.4 328.9 52.3C328.9 38.9 338.9 28.9 352.6 28.9C365.9 28.9 376 38.9 376 52.3ZM336.8 52.3C336.8 61.7 343.5 68.4 352.6 68.4C361.4 68.4 368.1 61.7 368.1 52.3C368.1 42.9 361.4 36.2 352.6 36.2C343.4 36.2 336.8 42.9 336.8 52.3Z" fill="white"/> <path d="M88.1 14.9C79.5 6.4 68.3 1.2 56.2 0C55.3 0 54.6 0.8 54.6 1.8C54.6 2.2 54.7 2.5 55 2.8L73.8 21.3C73.8 21.6 73.8 21.6 73.5 21.6C68.3 17.8 62.2 15.5 55.9 14.9C55.3 14.8 54.8 15.2 54.7 15.8C54.7 16.1 54.8 16.4 55 16.7L67.8 29.5C67.8 29.5 67.8 29.8 67.5 29.5C64 27.3 60.1 25.9 55.9 25.5C55.3 25.5 55 26.1 55.3 26.7L76.9 48.3C77.5 48.9 78.4 48.3 78.1 47.7C77.8 43.6 76.4 39.6 74.1 36.1C73.8 36.1 74.1 35.8 74.1 36.1L86.6 48.3C87.2 48.9 88.4 48.3 88.4 47.4C87.7 41 85.4 34.8 81.7 29.5C81.4 29.5 81.7 29.2 81.7 29.5L100.6 48C101.1 48.6 101.9 48.7 102.5 48.3C103 48 103.2 47.4 103 46.8C101.9 34.7 96.6 23.4 88.1 14.9Z" fill="#00ADFF"/> <path d="M14.9 14.9C23.6 6.5 34.8 1.2 46.8 0C47.7 0 48.4 0.6 48.5 1.5C48.5 1.9 48.4 2.4 48 2.7L29.5 21.3C29.2 21.6 29.5 21.6 29.5 21.6C34.8 17.8 41 15.5 47.4 14.9C48.3 14.9 48.9 16.1 48.3 16.7L35.6 29.5C35.3 29.5 35.6 29.8 35.6 29.5C39.1 27.3 43 26 47.2 25.5C47.8 25.5 48.4 26.1 47.8 26.7L26.1 48.3C25.5 48.9 24.9 48.3 24.9 47.7C25.3 43.6 26.8 39.6 29.2 36.1C29.2 36.1 28.9 35.8 28.9 36.1L16.7 48.3C15.8 48.9 14.6 48.3 14.9 47.4C15.5 40.9 17.8 34.7 21.6 29.5C21.6 29.5 21.3 29.2 21.3 29.5L2.7 48C1.5 49.2 0 48.3 0 46.8C1.2 34.8 6.5 23.6 14.9 14.9Z" fill="#F05245"/> <path d="M14.9 88.8C23.4 97.4 34.7 102.7 46.8 103.7C47.6 103.8 48.3 103.3 48.4 102.5C48.5 102 48.3 101.6 48 101.2L29.5 82.4C29.2 82.4 29.5 82.1 29.5 82.4C34.8 86.2 41 88.5 47.4 89C48.3 89 48.9 87.8 48.3 87.2L35.6 74.5C35.3 74.2 35.6 74.2 35.6 74.2C39 76.5 43 78 47.1 78.4C47.7 78.4 48.3 77.5 47.7 77.2L26.1 55.6C25.5 55 24.9 55.3 24.9 56.2C25.3 60.3 26.8 64.3 29.2 67.8C29.2 67.8 28.9 68.1 28.9 67.8L16.7 55.6C15.8 55 14.6 55.3 14.9 56.5C15.5 62.9 17.8 69 21.6 74.1C21.6 74.3 21.5 74.4 21.3 74.4L2.7 55.6C2 55 0.9 55.2 0.4 55.9C0.2 56.2 0.1 56.5 0 56.9C1.1 68.9 6.4 80.2 14.9 88.8Z" fill="#1CEBCF"/> <path d="M88.1 88.8C79.6 97.5 68.3 102.8 56.2 103.7C55 104 54.1 102.2 55 101.3L73.8 82.5C73.8 82.5 73.8 82.2 73.5 82.5C68.3 86.3 62.2 88.6 55.9 89.2C55.3 89.3 54.8 88.8 54.7 88.2C54.7 87.9 54.8 87.6 55 87.3L67.8 74.5C67.8 74.2 67.8 74.2 67.5 74.2C64.1 76.6 60.1 78.1 56 78.4C55.5 78.3 55.2 77.9 55.3 77.5C55.3 77.4 55.3 77.3 55.4 77.2L77 55.6C77.6 55 78.5 55.3 78.2 56.2C77.9 60.3 76.5 64.3 74.2 67.8C73.9 67.8 74.2 68.1 74.2 67.8L86.7 55.6C87.1 55.2 87.8 55.2 88.2 55.6C88.4 55.8 88.5 56.2 88.5 56.5C87.8 62.8 85.5 68.9 81.8 74.1C81.5 74.4 81.8 74.4 81.8 74.4L100.6 55.6C101.5 54.7 103.3 55.6 103 56.8C102 68.9 96.7 80.2 88.1 88.8Z" fill="#FFE300"/> <path opacity="0.87" d="M390.8 31.9V43H388.9V31.9H385.4V30.1H394.4V31.9H390.8Z" fill="white"/> <path opacity="0.87" d="M407.7 43V34.4L404.7 40.5999H403.3L400.3 34.4V43H398.3V30.2H400.3L404 38.2L407.7 30.2H409.6V43H407.7Z" fill="white"/> </g> <defs> <clipPath id="clip0"> <rect width="409" height="104" fill="white"/> </clipPath> </defs> </svg> </div> </a> <a class="logo-text" href="https://docs.coveo.com"> <span class="logo-text-bar">|</span> <span class="logo-text-custom">docs</span> </a> </div> <div class="search"> <div id="coveoConnectHeaderStandaloneSearchbox" class="searchbox"> <div class="CoveoSearchbox" style="display: flex;" type="text" data-auto-focus="false" data-enable-omnibox="true" data-inline="false" data-enable-wildcards="true" data-enable-search-as-you-type="false" data-enable-reveal-query-suggest-addon="true" data-enable-query-syntax="true" data-enable-field-addon="true" data-placeholder="Search"></div> <div class="CoveoAnalytics"></div> </div> </div> <nav class="subnav"> <ul> <li><a href="https://connect.coveo.com/" target="_blank">Community</a></li> <li><a href="https://docs.google.com/forms/d/e/1FAIpQLSeyNL18g4JWIDR5xEyIMY48JIjyjwXRmlCveecjXBNSLh4Ygg/viewform?usp=sf_link" target="_blank">Feedback</a></li> <li><a href="https://docs.coveo.com/en/3378/">News</a></li> </ul> </nav> </div> </div> </header> <subHeader class="no-sticky"> <div class="content"> <nav class="navBar"> <ul> <li><button class="dropdownButton">Guides<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://docs.coveo.com/en/1724/">Searching With Coveo</a></li> <li><a href="https://docs.coveo.com/en/2648/">Project Guide</a></li> <li><a href="https://docs.coveo.com/en/1351/">Services</a></li> </li> </ul> </button> </li> <li> <button class="dropdownButton">API Reference<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://coveo.github.io/search-ui/" target="_blank">JavaScript Search Framework</a></li>  <li><a href="https://docs.coveo.com/en/headless/latest/reference/">Headless</a></li> <li><a href="https://docs.coveo.com/en/12/">Push API</a></li> <li><a href="https://docs.coveo.com/en/8/">Field API</a></li> <li><a href="https://docs.coveo.com/en/13/">Search API</a></li> <li><a href="https://docs.coveo.com/en/18/">Usage Analytics API</a></li> <li><a href="https://docs.coveo.com/en/4/">Other APIs</a></li> </ul> </button> </li> <li> <button class="dropdownButton">Extensions<i class="fas fa-chevron-down"></i> <ul class="dropdown"> <li><a href="https://docs.coveo.com/en/1499/">Coveo for Commerce</a></li> <li><a href="https://docs.coveo.com/en/1243/">Coveo for Salesforce</a></li> <li><a href="https://docs.coveo.com/en/1479/">Coveo for ServiceNow</a></li> <li><a href="https://docs.coveo.com/en/2709/">Coveo for Sitecore</a></li> </ul> </button> </li> </ul> </nav> </div> </subHeader> <div class="container container-main"> <div class="row"> <div id="toc-column" class="col-1 col-menu menu-sticky-wrap menu-highlight"> <div id="filter-box-container"> <div id="filter-box-header">Filter</div> <div id="filter-box-body"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <div class="ctr-box-filter"> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited" title="Display inherited methods and properties"> Inherited</label><br> </div> </div> </div> </div> </div> </div> <div id="filter-box-footer"></div> </div> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <a id="globals-toc-link" href=../globals.html><b>Globals</b></a> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="querybuilder.html" class="tsd-kind-icon">Query<wbr>Builder</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#addcontext" class="tsd-kind-icon">add<wbr>Context</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#addcontextvalue" class="tsd-kind-icon">add<wbr>Context<wbr>Value</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#addfieldstoexclude" class="tsd-kind-icon">add<wbr>Fields<wbr>ToExclude</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#addfieldstoinclude" class="tsd-kind-icon">add<wbr>Fields<wbr>ToInclude</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#build" class="tsd-kind-icon">build</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#computecompleteexpression" class="tsd-kind-icon">compute<wbr>Complete<wbr>Expression</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#computecompleteexpressionexcept" class="tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Except</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#computecompleteexpressionparts" class="tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Parts</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#computecompleteexpressionpartsexcept" class="tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Parts<wbr>Except</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="querybuilder.html#containsenduserkeywords" class="tsd-kind-icon">contains<wbr>End<wbr>User<wbr>Keywords</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#actionshistory" class="tsd-kind-icon">actions<wbr>History</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#advancedexpression" class="tsd-kind-icon">advanced<wbr>Expression</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#allowquerieswithoutkeywords" class="tsd-kind-icon">allow<wbr>Queries<wbr>Without<wbr>Keywords</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#categoryfacets" class="tsd-kind-icon">category<wbr>Facets</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#childfield" class="tsd-kind-icon">child<wbr>Field</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#commerce" class="tsd-kind-icon">commerce</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#constantexpression" class="tsd-kind-icon">constant<wbr>Expression</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#context" class="tsd-kind-icon">context</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#disjunctionexpression" class="tsd-kind-icon">disjunction<wbr>Expression</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#enablecollaborativerating" class="tsd-kind-icon">enable<wbr>Collaborative<wbr>Rating</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#enabledebug" class="tsd-kind-icon">enable<wbr>Debug</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#enabledidyoumean" class="tsd-kind-icon">enable<wbr>Did<wbr>You<wbr>Mean</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#enablelowercaseoperators" class="tsd-kind-icon">enable<wbr>Lowercase<wbr>Operators</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#enablepartialmatch" class="tsd-kind-icon">enable<wbr>Partial<wbr>Match</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#enablequerysyntax" class="tsd-kind-icon">enable<wbr>Query<wbr>Syntax</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#enablequestionmarks" class="tsd-kind-icon">enable<wbr>Question<wbr>Marks</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#enablewildcards" class="tsd-kind-icon">enable<wbr>Wildcards</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#excerptlength" class="tsd-kind-icon">excerpt<wbr>Length</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#expression" class="tsd-kind-icon">expression</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#facetoptions" class="tsd-kind-icon">facet<wbr>Options</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#facetrequests" class="tsd-kind-icon">facet<wbr>Requests</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#filterfield" class="tsd-kind-icon">filter<wbr>Field</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#filterfieldrange" class="tsd-kind-icon">filter<wbr>Field<wbr>Range</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#firstresult" class="tsd-kind-icon">first<wbr>Result</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#groupbyrequests" class="tsd-kind-icon">group<wbr>ByRequests</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#longqueryexpression" class="tsd-kind-icon">long<wbr>Query<wbr>Expression</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#maximumage" class="tsd-kind-icon">maximum<wbr>Age</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#numberofresults" class="tsd-kind-icon">number<wbr>OfResults</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#parentfield" class="tsd-kind-icon">parent<wbr>Field</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#partialmatchkeywords" class="tsd-kind-icon">partial<wbr>Match<wbr>Keywords</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#partialmatchthreshold" class="tsd-kind-icon">partial<wbr>Match<wbr>Threshold</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#pipeline" class="tsd-kind-icon">pipeline</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#queryfunctions" class="tsd-kind-icon">query<wbr>Functions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#rankingfunctions" class="tsd-kind-icon">ranking<wbr>Functions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#recommendation" class="tsd-kind-icon">recommendation</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#searchhub" class="tsd-kind-icon">search<wbr>Hub</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#sortcriteria" class="tsd-kind-icon">sort<wbr>Criteria</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#sortfield" class="tsd-kind-icon">sort<wbr>Field</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#tab" class="tsd-kind-icon">tab</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="querybuilder.html#useractions" class="tsd-kind-icon">user<wbr>Actions</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> <div id="separator"></div> <div class="col-2 col-content"> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <a id="home-menu-link" class="aui-nav-link" title="Go to the home page" href=..> <i class="fa fa-home" aria-hidden="true"></i> </a> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="querybuilder.html">QueryBuilder</a> </li> </ul> <h1>Class QueryBuilder</h1> </div> </div> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The QueryBuilder is used to build a <a href="../interfaces/iquery.html">IQuery</a> that will be able to be executed using the Search API.</p> </div> <p>The class exposes several members and methods that help components and external code to build up the final query that is sent to the Search API.</p> </div> </section> <div class="preview-container tsd-panel"> <div class="overlay"></div> </div> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#addcontext" class="tsd-kind-icon">add<wbr>Context</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#addcontextvalue" class="tsd-kind-icon">add<wbr>Context<wbr>Value</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#addfieldstoexclude" class="tsd-kind-icon">add<wbr>Fields<wbr>ToExclude</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#addfieldstoinclude" class="tsd-kind-icon">add<wbr>Fields<wbr>ToInclude</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#build" class="tsd-kind-icon">build</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#computecompleteexpression" class="tsd-kind-icon">compute<wbr>Complete<wbr>Expression</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#computecompleteexpressionexcept" class="tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Except</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#computecompleteexpressionparts" class="tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Parts</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#computecompleteexpressionpartsexcept" class="tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Parts<wbr>Except</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="querybuilder.html#containsenduserkeywords" class="tsd-kind-icon">contains<wbr>End<wbr>User<wbr>Keywords</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#actionshistory" class="tsd-kind-icon">actions<wbr>History</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#advancedexpression" class="tsd-kind-icon">advanced<wbr>Expression</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#allowquerieswithoutkeywords" class="tsd-kind-icon">allow<wbr>Queries<wbr>Without<wbr>Keywords</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#categoryfacets" class="tsd-kind-icon">category<wbr>Facets</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#childfield" class="tsd-kind-icon">child<wbr>Field</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#commerce" class="tsd-kind-icon">commerce</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#constantexpression" class="tsd-kind-icon">constant<wbr>Expression</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#context" class="tsd-kind-icon">context</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#disjunctionexpression" class="tsd-kind-icon">disjunction<wbr>Expression</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#enablecollaborativerating" class="tsd-kind-icon">enable<wbr>Collaborative<wbr>Rating</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#enabledebug" class="tsd-kind-icon">enable<wbr>Debug</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#enabledidyoumean" class="tsd-kind-icon">enable<wbr>Did<wbr>You<wbr>Mean</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#enablelowercaseoperators" class="tsd-kind-icon">enable<wbr>Lowercase<wbr>Operators</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#enablepartialmatch" class="tsd-kind-icon">enable<wbr>Partial<wbr>Match</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#enablequerysyntax" class="tsd-kind-icon">enable<wbr>Query<wbr>Syntax</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#enablequestionmarks" class="tsd-kind-icon">enable<wbr>Question<wbr>Marks</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#enablewildcards" class="tsd-kind-icon">enable<wbr>Wildcards</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#excerptlength" class="tsd-kind-icon">excerpt<wbr>Length</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#expression" class="tsd-kind-icon">expression</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#facetoptions" class="tsd-kind-icon">facet<wbr>Options</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#facetrequests" class="tsd-kind-icon">facet<wbr>Requests</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#filterfield" class="tsd-kind-icon">filter<wbr>Field</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#filterfieldrange" class="tsd-kind-icon">filter<wbr>Field<wbr>Range</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#firstresult" class="tsd-kind-icon">first<wbr>Result</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#groupbyrequests" class="tsd-kind-icon">group<wbr>ByRequests</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#longqueryexpression" class="tsd-kind-icon">long<wbr>Query<wbr>Expression</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#maximumage" class="tsd-kind-icon">maximum<wbr>Age</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#numberofresults" class="tsd-kind-icon">number<wbr>OfResults</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#parentfield" class="tsd-kind-icon">parent<wbr>Field</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#partialmatchkeywords" class="tsd-kind-icon">partial<wbr>Match<wbr>Keywords</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#partialmatchthreshold" class="tsd-kind-icon">partial<wbr>Match<wbr>Threshold</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#pipeline" class="tsd-kind-icon">pipeline</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#queryfunctions" class="tsd-kind-icon">query<wbr>Functions</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#rankingfunctions" class="tsd-kind-icon">ranking<wbr>Functions</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#recommendation" class="tsd-kind-icon">recommendation</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#searchhub" class="tsd-kind-icon">search<wbr>Hub</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#sortcriteria" class="tsd-kind-icon">sort<wbr>Criteria</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#sortfield" class="tsd-kind-icon">sort<wbr>Field</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#tab" class="tsd-kind-icon">tab</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="querybuilder.html#useractions" class="tsd-kind-icon">user<wbr>Actions</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="addcontext" class="tsd-anchor"></a> <h3>add<wbr>Context</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>Context<span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L511">ui/Base/QueryBuilder.ts :511</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Merges the specified <code>values</code> into the <code>context</code> object.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>values: <span class="tsd-signature-type">object</span></h5> <div class="tsd-comment tsd-typography"> <p>The object to merge into the <code>context</code> object. Can contain multiple key-value pairs, where each value should be a string or an array of strings. If some keys are already present in the <code>context</code> object, their values are updated.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="addcontextvalue" class="tsd-anchor"></a> <h3>add<wbr>Context<wbr>Value</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>Context<wbr>Value<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L499">ui/Base/QueryBuilder.ts :499</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Adds or updates a single context key-value pair in the <code>context</code> object.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The context key. If this key is already present in the <code>context</code> object, its value is updated.</p> </div> </li> <li> <h5>value: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>The context value. This should be a string or an array of strings.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="addfieldstoexclude" class="tsd-anchor"></a> <h3>add<wbr>Fields<wbr>ToExclude</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>Fields<wbr>ToExclude<span class="tsd-signature-symbol">(</span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L481">ui/Base/QueryBuilder.ts :481</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add fields to specifically exclude when the results return.</p> </div> <p>This can be used to accelerate the execution time of every query, as there is much less data to process if you blacklist specific fields.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fields: <span class="tsd-signature-type">string[]</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="addfieldstoinclude" class="tsd-anchor"></a> <h3>add<wbr>Fields<wbr>ToInclude</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>Fields<wbr>ToInclude<span class="tsd-signature-symbol">(</span>fields<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L467">ui/Base/QueryBuilder.ts :467</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add fields to specifically include when the results return.</p> </div> <p>This can be used to accelerate the execution time of every query, as there is much less data to process if you whitelist specific fields.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fields: <span class="tsd-signature-type">string[]</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="build" class="tsd-anchor"></a> <h3>build</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/iquery.html" class="tsd-signature-type">IQuery</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L337">ui/Base/QueryBuilder.ts :337</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Build the current content or state of the query builder and return a <a href="../interfaces/iquery.html">IQuery</a>.</p> </div> <p>build can be called multiple times on the same QueryBuilder.</p> </div> <h4 class="tsd-returns-title">Returns <a href="../interfaces/iquery.html" class="tsd-signature-type">IQuery</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="computecompleteexpression" class="tsd-anchor"></a> <h3>compute<wbr>Complete<wbr>Expression</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compute<wbr>Complete<wbr>Expression<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L398">ui/Base/QueryBuilder.ts :398</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return only the expression(s) part(s) of the query, as a string.</p> </div> <p>This means the basic, advanced and constant part in a complete expression <a href="../interfaces/iquery.html#q">IQuery.q</a>, <a href="../interfaces/iquery.html#aq">IQuery.aq</a>, <a href="../interfaces/iquery.html#cq">IQuery.cq</a>.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="computecompleteexpressionexcept" class="tsd-anchor"></a> <h3>compute<wbr>Complete<wbr>Expression<wbr>Except</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Except<span class="tsd-signature-symbol">(</span>except<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L422">ui/Base/QueryBuilder.ts :422</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return only the expression(s) part(s) of the query, as a string, except the given expression.</p> </div> <p>This is used by <a href="../components/facet.html">Facet</a>, to build their group by request with query override.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>except: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="computecompleteexpressionparts" class="tsd-anchor"></a> <h3>compute<wbr>Complete<wbr>Expression<wbr>Parts</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Parts<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">QueryBuilderExpression</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L406">ui/Base/QueryBuilder.ts :406</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return only the expression(s) part(s) of the query, as an object.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">QueryBuilderExpression</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="computecompleteexpressionpartsexcept" class="tsd-anchor"></a> <h3>compute<wbr>Complete<wbr>Expression<wbr>Parts<wbr>Except</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compute<wbr>Complete<wbr>Expression<wbr>Parts<wbr>Except<span class="tsd-signature-symbol">(</span>except<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">QueryBuilderExpression</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L433">ui/Base/QueryBuilder.ts :433</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return only the expression(s) part(s) of the query, as an object, except the given expression.</p> </div> <p>This is used by <a href="../components/facet.html">Facet</a>, to build their group by request with query override.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>except: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">QueryBuilderExpression</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="containsenduserkeywords" class="tsd-anchor"></a> <h3>contains<wbr>End<wbr>User<wbr>Keywords</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">contains<wbr>End<wbr>User<wbr>Keywords<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L523">ui/Base/QueryBuilder.ts :523</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns true if the current query contains any expression that are considered "end user input".</p> </div> <p>This usually means anything entered in the basic (see [q]{@link IQuery.options.q}) or long (see [lq]{@link IQuery.options.lq}) part of the query.</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="actionshistory" class="tsd-anchor"></a> <h3>actions<wbr>History</h3> <div class="tsd-signature tsd-kind-icon">actions<wbr>History<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L310">ui/Base/QueryBuilder.ts :310</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The actions history represents the past actions a user made and is used by the Coveo Machine Learning service to suggest recommendations. It is generated by the page view script (<a href="https://github.com/coveo/coveo.analytics.js)">https://github.com/coveo/coveo.analytics.js)</a>.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="advancedexpression" class="tsd-anchor"></a> <h3>advanced<wbr>Expression</h3> <div class="tsd-signature tsd-kind-icon">advanced<wbr>Expression<span class="tsd-signature-symbol">:</span> <a href="expressionbuilder.html" class="tsd-signature-type">ExpressionBuilder</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L32">ui/Base/QueryBuilder.ts :32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-deprecated"> </dl> <div class="lead"> <p>Used to build the advanced part of the query expression.</p> </div> <p>This part is typically formed of filter expressions generated by components such as facets, external code, etc.</p> <dl class="tsd-comment-tags"> <dt>type</dt> <dd><p>{Coveo.ExpressionBuilder}</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="allowquerieswithoutkeywords" class="tsd-anchor"></a> <h3>allow<wbr>Queries<wbr>Without<wbr>Keywords</h3> <div class="tsd-signature tsd-kind-icon">allow<wbr>Queries<wbr>Without<wbr>Keywords<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L322">ui/Base/QueryBuilder.ts :322</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies if the Search API should perform queries even when no keywords were entered by the end user.</p> </div> <p>End user keywords are present in either the <a href="../interfaces/iquery.html#q">IQuery.q</a> or <a href="../interfaces/iquery.html#lq">IQuery.lq</a> part of the query.</p> <p>This parameter is normally controlled by {@link SearchInterface.options.allowEmptyQuery} option.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="categoryfacets" class="tsd-anchor"></a> <h3>category<wbr>Facets</h3> <div class="tsd-signature tsd-kind-icon">category<wbr>Facets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ICategoryFacetRequest[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L298">ui/Base/QueryBuilder.ts :298</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies an array of request for the CategoryFacet component.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="childfield" class="tsd-anchor"></a> <h3>child<wbr>Field</h3> <div class="tsd-signature tsd-kind-icon">child<wbr>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L227">ui/Base/QueryBuilder.ts :227</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies the childField when doing parent-child loading (See: <a href="../components/folding.html">Folding</a>).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="commerce" class="tsd-anchor"></a> <h3>commerce</h3> <div class="tsd-signature tsd-kind-icon">commerce<span class="tsd-signature-symbol">:</span> <a href="../interfaces/icommercerequest.html" class="tsd-signature-type">ICommerceRequest</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/QueryBuilder.ts#L330">ui