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>IQuery | 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-interface"> <a href="iquery.html" class="tsd-kind-icon">IQuery</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#actionshistory" class="tsd-kind-icon">actions<wbr>History</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#allowquerieswithoutkeywords" class="tsd-kind-icon">allow<wbr>Queries<wbr>Without<wbr>Keywords</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#aq" class="tsd-kind-icon">aq</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#categoryfacets" class="tsd-kind-icon">category<wbr>Facets</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#childfield" class="tsd-kind-icon">child<wbr>Field</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#commerce" class="tsd-kind-icon">commerce</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#context" class="tsd-kind-icon">context</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#cq" class="tsd-kind-icon">cq</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#debug" class="tsd-kind-icon">debug</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#dq" class="tsd-kind-icon">dq</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#enablecollaborativerating" class="tsd-kind-icon">enable<wbr>Collaborative<wbr>Rating</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#enabledidyoumean" class="tsd-kind-icon">enable<wbr>Did<wbr>You<wbr>Mean</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#enablequerysyntax" class="tsd-kind-icon">enable<wbr>Query<wbr>Syntax</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#excerptlength" class="tsd-kind-icon">excerpt<wbr>Length</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#facetoptions" class="tsd-kind-icon">facet<wbr>Options</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#facets" class="tsd-kind-icon">facets</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#fieldstoexclude" class="tsd-kind-icon">fields<wbr>ToExclude</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#fieldstoinclude" class="tsd-kind-icon">fields<wbr>ToInclude</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#filterfield" class="tsd-kind-icon">filter<wbr>Field</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#filterfieldrange" class="tsd-kind-icon">filter<wbr>Field<wbr>Range</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#firstresult" class="tsd-kind-icon">first<wbr>Result</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#format" class="tsd-kind-icon">format</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#groupby" class="tsd-kind-icon">group<wbr>By</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#lowercaseoperators" class="tsd-kind-icon">lowercase<wbr>Operators</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#lq" class="tsd-kind-icon">lq</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#maximumage" class="tsd-kind-icon">maximum<wbr>Age</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#numberofresults" class="tsd-kind-icon">number<wbr>OfResults</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#parentfield" class="tsd-kind-icon">parent<wbr>Field</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#partialmatch" class="tsd-kind-icon">partial<wbr>Match</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#partialmatchkeywords" class="tsd-kind-icon">partial<wbr>Match<wbr>Keywords</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#partialmatchthreshold" class="tsd-kind-icon">partial<wbr>Match<wbr>Threshold</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#pipeline" class="tsd-kind-icon">pipeline</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#q" class="tsd-kind-icon">q</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#queryfunctions" class="tsd-kind-icon">query<wbr>Functions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#questionmark" class="tsd-kind-icon">question<wbr>Mark</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#rankingfunctions" class="tsd-kind-icon">ranking<wbr>Functions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#recommendation" class="tsd-kind-icon">recommendation</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#retrievefirstsentences" class="tsd-kind-icon">retrieve<wbr>First<wbr>Sentences</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#searchhub" class="tsd-kind-icon">search<wbr>Hub</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#sortcriteria" class="tsd-kind-icon">sort<wbr>Criteria</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#tab" class="tsd-kind-icon">tab</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#useractions" class="tsd-kind-icon">user<wbr>Actions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="iquery.html#wildcards" class="tsd-kind-icon">wildcards</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="iquery.html">IQuery</a> </li> </ul> <h1>Interface IQuery</h1> </div> </div> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The IQuery interface describes a query that can be performed on the Coveo REST Search API.</p> </div> <p>For basic usage, see the <a href="iquery.html#q">IQuery.q</a> and <a href="iquery.html#aq">IQuery.aq</a> properties.</p> <p>In a normal scenario, a query is built by the <a href="../classes/querybuilder.html">QueryBuilder</a> class.</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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#actionshistory" class="tsd-kind-icon">actions<wbr>History</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#allowquerieswithoutkeywords" class="tsd-kind-icon">allow<wbr>Queries<wbr>Without<wbr>Keywords</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#aq" class="tsd-kind-icon">aq</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#categoryfacets" class="tsd-kind-icon">category<wbr>Facets</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#childfield" class="tsd-kind-icon">child<wbr>Field</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#commerce" class="tsd-kind-icon">commerce</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#context" class="tsd-kind-icon">context</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#cq" class="tsd-kind-icon">cq</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#debug" class="tsd-kind-icon">debug</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#dq" class="tsd-kind-icon">dq</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#enablecollaborativerating" class="tsd-kind-icon">enable<wbr>Collaborative<wbr>Rating</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#enabledidyoumean" class="tsd-kind-icon">enable<wbr>Did<wbr>You<wbr>Mean</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#enablequerysyntax" class="tsd-kind-icon">enable<wbr>Query<wbr>Syntax</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#excerptlength" class="tsd-kind-icon">excerpt<wbr>Length</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#facetoptions" class="tsd-kind-icon">facet<wbr>Options</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#facets" class="tsd-kind-icon">facets</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#fieldstoexclude" class="tsd-kind-icon">fields<wbr>ToExclude</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#fieldstoinclude" class="tsd-kind-icon">fields<wbr>ToInclude</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#filterfield" class="tsd-kind-icon">filter<wbr>Field</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#filterfieldrange" class="tsd-kind-icon">filter<wbr>Field<wbr>Range</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#firstresult" class="tsd-kind-icon">first<wbr>Result</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#format" class="tsd-kind-icon">format</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#groupby" class="tsd-kind-icon">group<wbr>By</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#lowercaseoperators" class="tsd-kind-icon">lowercase<wbr>Operators</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#lq" class="tsd-kind-icon">lq</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#maximumage" class="tsd-kind-icon">maximum<wbr>Age</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#numberofresults" class="tsd-kind-icon">number<wbr>OfResults</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#parentfield" class="tsd-kind-icon">parent<wbr>Field</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#partialmatch" class="tsd-kind-icon">partial<wbr>Match</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#partialmatchkeywords" class="tsd-kind-icon">partial<wbr>Match<wbr>Keywords</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#partialmatchthreshold" class="tsd-kind-icon">partial<wbr>Match<wbr>Threshold</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#pipeline" class="tsd-kind-icon">pipeline</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#q" class="tsd-kind-icon">q</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#queryfunctions" class="tsd-kind-icon">query<wbr>Functions</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#questionmark" class="tsd-kind-icon">question<wbr>Mark</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#rankingfunctions" class="tsd-kind-icon">ranking<wbr>Functions</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#recommendation" class="tsd-kind-icon">recommendation</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#retrievefirstsentences" class="tsd-kind-icon">retrieve<wbr>First<wbr>Sentences</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#searchhub" class="tsd-kind-icon">search<wbr>Hub</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#sortcriteria" class="tsd-kind-icon">sort<wbr>Criteria</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#tab" class="tsd-kind-icon">tab</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#useractions" class="tsd-kind-icon">user<wbr>Actions</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iquery.html#wildcards" class="tsd-kind-icon">wildcards</a></li> </ul> </section> </div> </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-interface"> <a name="actionshistory" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> 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/rest/Query.ts#L268">rest/Query.ts :268</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-interface"> <a name="allowquerieswithoutkeywords" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> 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/rest/Query.ts#L282">rest/Query.ts :282</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="iquery.html#q">IQuery.q</a> or <a href="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-interface"> <a name="aq" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> aq</h3> <div class="tsd-signature tsd-kind-icon">aq<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/rest/Query.ts#L74">rest/Query.ts :74</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The advanced query expression.<br/> This is the part of the query expression generated by code based on various rules.<br/> eg: Selecting a facet value will cause an expression to be added to the advanced query expression.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="categoryfacets" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> 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/rest/Query.ts#L228">rest/Query.ts :228</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies an array of request to retrieve facet values for the CategoryFacet component</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="childfield" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> 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/rest/Query.ts#L254">rest/Query.ts :254</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-interface"> <a name="commerce" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> commerce</h3> <div class="tsd-signature tsd-kind-icon">commerce<span class="tsd-signature-symbol">:</span> <a href="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/rest/Query.ts#L306">rest/Query.ts :306</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The commerce request to execute.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="context" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> context</h3> <div class="tsd-signature tsd-kind-icon">context<span class="tsd-signature-symbol">:</span> <a href="../globals.html#context" class="tsd-signature-type">Context</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L262">rest/Query.ts :262</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The context is a map of key_value that can be used in the Query pipeline in the Coveo platform.<br/></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="cq" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> cq</h3> <div class="tsd-signature tsd-kind-icon">cq<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/rest/Query.ts#L82">rest/Query.ts :82</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The constant query expression.<br/> This part of the expression is much alike the advanced query expression, but it is meant to hold expressions that are constant for all users of a search interface/widget.<br/> The results of evaluating those expressions are kept in a special index cache, to avoid re-evaluating them on each query.<br/> You must be careful to not include dynamic parts in this expression, otherwise you risk filling up the cache with useless data and this might have a negative impact on performance.<br/> Expressions other than cq also benefit from caching in the index, but using cq allows to explicitly require that a part of the query be included in the cache.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="debug" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> debug</h3> <div class="tsd-signature tsd-kind-icon">debug<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/rest/Query.ts#L238">rest/Query.ts :238</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether to include debug information from the Search API in the query response.</p> </div> <p><strong>Note:</strong></p> <blockquote> <p>This debug information does not include ranking information.</p> </blockquote> <p>Setting this property to <code>true</code> can have an adverse effect on query performance, so it should always be left to <code>false</code> in a production environment.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="dq" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> dq</h3> <div class="tsd-signature tsd-kind-icon">dq<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/rest/Query.ts#L96">rest/Query.ts :96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The disjunction query expression.<br/> This is the disjunctive part of the query expression that is merged with the other expression parts using an OR boolean operator.<br/> When specified, the final expression evaluated by the index ends up being (q aq cq) OR (dq).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="enablecollaborativerating" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr>Collaborative<wbr>Rating</h3> <div class="tsd-signature tsd-kind-icon">enable<wbr>Collaborative<wbr>Rating<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/rest/Query.ts#L250">rest/Query.ts :250</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the index should take collaborative rating in account when ranking result. See: <a href="../components/resultrating.html">ResultRating</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="enabledidyoumean" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr>Did<wbr>You<wbr>Mean</h3> <div class="tsd-signature tsd-kind-icon">enable<wbr>Did<wbr>You<wbr>Mean<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/rest/Query.ts#L212">rest/Query.ts :212</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This enables the query correction feature of the index.<br/> By activating this, the index returns an array of {link IQueryCorrection} with suggested word corrections.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="enablequerysyntax" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr>Query<wbr>Syntax</h3> <div class="tsd-signature tsd-kind-icon">enable<wbr>Query<wbr>Syntax<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/rest/Query.ts#L245">rest/Query.ts :245</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether to enable the special query syntax such as field references for the basic query expression (parameter q). It is equivalent to a No syntax block applied to the basic query expression. If not specified, the parameter defaults to false</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="excerptlength" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> excerpt<wbr>Length</h3> <div class="tsd-signature tsd-kind-icon">excerpt<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L202">rest/Query.ts :202</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies the length (in number of characters) of the excerpts generated by the indexer based on the keywords present in the query.<br/> The index includes the top most interesting sentences (in the order they appear in the item) that fit in the specified number of characters.<br/> When not specified, the default value is 200.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="facetoptions" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> facet<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">facet<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="ifacetoptions.html" class="tsd-signature-type">IFacetOptions</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L292">rest/Query.ts :292</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The global configuration options to apply to the requests in the <a href="iquery.html#facets">facets</a> array.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="facets" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> facets</h3> <div class="tsd-signature tsd-kind-icon">facets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IFacetRequest[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L287">rest/Query.ts :287</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies an array of request to retrieve facet values for the DynamicFacet component.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="fieldstoexclude" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> fields<wbr>ToExclude</h3> <div class="tsd-signature tsd-kind-icon">fields<wbr>ToExclude<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/rest/Query.ts#L196">rest/Query.ts :196</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies an array of fields that should be excluded from the query results.<br/> eg: ['@foo','@bar']</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="fieldstoinclude" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> fields<wbr>ToInclude</h3> <div class="tsd-signature tsd-kind-icon">fields<wbr>ToInclude<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/rest/Query.ts#L190">rest/Query.ts :190</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies an array of fields that should be returned for each result.<br/> eg: ['@foo','@bar']</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="filterfield" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> filter<wbr>Field</h3> <div class="tsd-signature tsd-kind-icon">filter<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/rest/Query.ts#L180">rest/Query.ts :180</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies a field on which <a href="../components/folding.html">Folding</a> should be performed.<br/> Folding is a kind of duplicate filtering where only the first result with any given value of the field is included in the result set.<br/> It's typically used to return only one result in a conversation, for example when forum posts in a thread are indexed as separate items.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="filterfieldrange" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> filter<wbr>Field<wbr>Range</h3> <div class="tsd-signature tsd-kind-icon">filter<wbr>Field<wbr>Range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L184">rest/Query.ts :184</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Number of results that should be folded, using the <a href="iquery.html#filterfield">IQuery.filterField</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="firstresult" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> first<wbr>Result</h3> <div class="tsd-signature tsd-kind-icon">first<wbr>Result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L158">rest/Query.ts :158</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is the 0-based index of the first result to return.<br/> If not specified, this parameter defaults to 0.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="format" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> format</h3> <div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <a href="../globals.html#responseformat" class="tsd-signature-type">ResponseFormat</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L311">rest/Query.ts :311</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The format of a successful response. If not specified, this parameter defaults to 'json'.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="groupby" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> group<wbr>By</h3> <div class="tsd-signature tsd-kind-icon">group<wbr>By<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IGroupByRequest[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L224">rest/Query.ts :224</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies an array of Group By operations that can be performed on the query results to extract facets</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="lowercaseoperators" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> lowercase<wbr>Operators</h3> <div class="tsd-signature tsd-kind-icon">lowercase<wbr>Operators<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/rest/Query.ts#L133">rest/Query.ts :133</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether to enable the support for operator in lowercase (AND OR -> and or)</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="lq" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> lq</h3> <div class="tsd-signature tsd-kind-icon">lq<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/rest/Query.ts#L90">rest/Query.ts :90</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The contextual text.<br/> This is the contextual text part of the query. It uses the Coveo Machine Learning service to pick key keywords from the text and add them to the basic expression. This field is mainly used to pass context such a case description, long textual query or any other form of text that might help in refining the query.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="maximumage" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> maximum<wbr>Age</h3> <div class="tsd-signature tsd-kind-icon">maximum<wbr>Age<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui/tree/master/src/rest/Query.ts#L117">rest/Query.ts :117</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The maximum age for cached query results, in milliseconds.<br/> If results for the exact same request (including user identities) are available in the in-memory cache, they will be used if they are not older than the specified value.<br/> Otherwise, the query will be sent to the index.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="numberofresults" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr>OfResults</h3> <div class="tsd-signature tsd-kind-icon">number<wbr>OfResults<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/coveo/search-ui