diff options
author | Kristian Aune <kraune@verizonmedia.com> | 2022-06-03 12:46:50 +0200 |
---|---|---|
committer | Kristian Aune <kraune@verizonmedia.com> | 2022-06-03 12:46:50 +0200 |
commit | 11d836dad46f1b6786bdd6231bf7811f7a197ea2 (patch) | |
tree | e8eaffeffbbd0a2200c119b357935caf2c6c3d7d /container-search-gui | |
parent | b80465475e192bf4f66cea058755168f68f098a3 (diff) |
Icons, no query-api ref lookup, warnings
Diffstat (limited to 'container-search-gui')
21 files changed, 106 insertions, 2133 deletions
diff --git a/container-search-gui/src/main/resources/gui/_includes/css/vespa.css b/container-search-gui/src/main/resources/gui/_includes/css/vespa.css index a09364cefd4..110c52b6822 100644 --- a/container-search-gui/src/main/resources/gui/_includes/css/vespa.css +++ b/container-search-gui/src/main/resources/gui/_includes/css/vespa.css @@ -10,7 +10,7 @@ --fontprimary: HelveticaNeue,Helvetica,Arial,sans-serif; --fontsecondary: HelveticaNeue-Thin,Helvetica,Arial,sans-serif; - }; + } .bg-light-blue { background-image: linear-gradient(-1deg, rgba(63,157,216,0.08) 0%, rgba(163, 195, 215, 0.08) 97%); @@ -39,7 +39,7 @@ /*** Tooltips! ***/ .tip { visibility: visible; - border-bottom: 1px dotted [#FFFFFF]; + border-bottom: 1px dotted; position: relative; cursor: help; text-decoration: none; @@ -146,7 +146,7 @@ header .help-title { } .navbar-default .navbar-brand { - background: transparent url("../../img/Vespa-V2.png") no-repeat; + background: transparent url("https://vespa.ai/assets/vespa-logo.png") no-repeat; background-size: contain; direction: ltr; text-indent: -9000px; @@ -310,7 +310,7 @@ header .propvalue { margin-bottom: 3px; } -header .propvalue:-webkit-input-placeholder { /* Safari, Chrome(, Opera?) */ +header .propvalue::-webkit-input-placeholder { /* Safari, Chrome(, Opera?) */ color:gray; font-style:italic; } @@ -396,7 +396,7 @@ header .copyJSON{ height: 25px; border-width: 0px; border-radius: 5px; - padding: 0px + padding: 0px; padding-left: 1px; margin-top: 10px; margin-bottom: 20px; @@ -412,7 +412,7 @@ header .showJSON{ height: 25px; border-width: 0px; border-radius: 5px; - padding: 0px + padding: 0px; padding-left: 1px; margin-top: 5px; margin-bottom: 10px; @@ -431,8 +431,6 @@ header .pasteJSON{ padding-bottom: 2px; margin-top: 35px; margin-bottom: 10px; - - align-content: 30%; } @@ -444,7 +442,7 @@ header .copyURL{ height: 25px; border-width: 0px; border-radius: 5px; - padding: 0px + padding: 0px; padding-left: 1px; margin-top: 25px; margin-bottom: 10px; @@ -481,7 +479,7 @@ header .intro .btn-xl { header .intro-copy { - display:inline-block + display:inline-block; position: inherit; margin-top: 10px; padding-left: 50px; diff --git a/container-search-gui/src/main/resources/gui/_includes/index.html b/container-search-gui/src/main/resources/gui/_includes/index.html index 3faf3f09243..8537609478f 100644 --- a/container-search-gui/src/main/resources/gui/_includes/index.html +++ b/container-search-gui/src/main/resources/gui/_includes/index.html @@ -1,15 +1,12 @@ <!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. --> <!DOCTYPE html> -<html> +<html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <title>Vespa. Big data. Real time.</title> + <title>Vespa Querybuilder</title> <meta name="viewport" content="width=device-width"> - <meta name="description" content=" Your big data processing and serving system - deep learning, - search applications, ad selection system, personalized - recommendation systems, and more..."> - + <meta name="description" content="Vespa Querybuilder - use to generate Vespa Query API requests"> <!-- Site icons - generated using http://realfavicongenerator.net/ --> <link rel="apple-touch-icon" sizes="180x180" href="/querybuilder/icons/apple-touch-icon.png"> @@ -28,160 +25,90 @@ <link href='https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic,700italic' rel='stylesheet' type='text/css'> <link href='https://fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700' rel='stylesheet' type='text/css'> - <title>Vespa - Big Data. Real time.</title> - - <meta http-equiv="content-type" content="text/html; charset=utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <meta name="description" content=""> + <meta http-equiv="content-type" content="text/html; charset=utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> - - </head> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> +</head> <body id="page-top" class="index"> - -<style type="text/css"></style> - - <link href="/querybuilder/_includes/css/agency.css" rel="stylesheet" type="text/css"> <link href="/querybuilder/_includes/css/bootstrap.min.css" rel="stylesheet" type="text/css"> <link href="/querybuilder/_includes/css/vespa.css" rel="stylesheet" type="text/css"> <nav class="navbar navbar-default navbar-fixed-top"> - <div class="container"> - <!-- Brand and toggle get grouped for better mobile display --> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="https://vespa.ai">Vespa. Big data. Real time.</a> - </div> + <div class="container"> + <!-- Brand and toggle get grouped for better mobile display --> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="https://vespa.ai">Vespa.ai</a> + </div> - <!-- Collect the nav links, forms, and other content for toggling --> - <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> - <ul class="nav navbar-nav navbar-right"> - <li class="hidden"><a href="#page-top"></a> - <li><a href="https://blog.vespa.ai/">Blog</a> - <li><a href="https://twitter.com/vespaengine">Twitter</a> - <li><a href="https://docs.vespa.ai">Docs</a> - <li><a href="https://github.com/vespa-engine">GitHub</a> - <li><a href="https://docs.vespa.ai/en/getting-started.html">Get Started Now</a> - </ul> - </div> + <!-- Collect the nav links, forms, and other content for toggling --> + <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="https://docs.vespa.ai/en/query-api.html">Documentation</a></li> + <li><a href="https://github.com/vespa-engine/vespa/issues">Report issue</a></li> + </ul> </div> - </nav> + </div> +</nav> <!-- Header --> - <header> - <div class="layer"> - <div class="intro container"> - <div class="intro-lead-in">Vespa Search Engine</div> - <div class="intro-long">Select the method for sending requests and construct a query.</div> - <select class="methodselector" onchange="chooseMethod();" id="method"> - <option class="options" value="POST">POST</option> - <option class="options" value="GET">GET</option> - </select> - <input type="text" class="textbox" name="value" value="http://localhost:8080/search/" id="url" size="30"> - <button class="button" onclick="startSending();" id="send">Send</button> +<header> + <div class="layer"> + <div class="intro container"> + <div class="intro-lead-in">Vespa Querybuilder</div> + <div class="intro-long">Select the method for sending requests and construct a query:</div> + <select class="methodselector" onchange="chooseMethod();" id="method"> + <option class="options" value="POST">POST</option> + <option class="options" value="GET">GET</option> + </select> + <input type="text" class="textbox" name="value" value="http://localhost:8080/search/" id="url" size="30" /> + <button class="button" onclick="startSending();" id="send">Send</button> + + <br/><br/> - <br/> - <div id="request"> - </br> - <div class="intro-param">Construct a query by adding parameters or pasting a JSON.</div> - </div> - <br/> - <button class="addRow"onclick="addNewRow()" id="addRow">+</button> - <br/> - <button class="pasteJSON"onclick="pasteJSON();" id="pasteJSON"><img src="/querybuilder/img/paste.svg" height="16" width="16" style="margin-top:-2px; margin-right: 3px;"/> Paste JSON</button> - </br> - <button class="showJSON"onclick="showJSON();" id="showJSON">Show query JSON</button> - </br> - <textarea class="responsebox" id="jsonquery" cols=70 rows=15 style="display:none;"readonly></textarea> - </br> - <button class="copyJSON"onclick="copyToClipboard(jsonquery);" id="copyJSON"><img src="/querybuilder/img/copy.svg" height="17" width="17" /> Copy as JSON</button> - <button class="copyURL"onclick="copyURL();" id="copyURL"><img src="/querybuilder/img/copy.svg" height="17" width="17" /> Copy as URL</button> - <br/> + <div id="request"> + <div class="intro-param">Construct a query by adding parameters or pasting a JSON:</div> + </div> + <br/> + <button class="addRow" onclick="addNewRow()" id="addRow">+</button> + <br/> + <button class="pasteJSON" onclick="pasteJSON();" id="pasteJSON"> + <img src="/querybuilder/img/paste.svg" + height="16" width="16" style="margin-top:-2px; margin-right: 3px;" alt="paste"/> + Paste JSON + </button> + <button class="showJSON" onclick="showJSON();" id="showJSON">Show query JSON</button> + <textarea class="responsebox" id="jsonquery" cols=70 rows=15 style="display:none;"readonly></textarea> + <button class="copyJSON" onclick="copyToClipboard(jsonquery);" id="copyJSON"> + <img src="/querybuilder/img/copy.svg" height="17" width="17" alt="Copy as JSON"/> Copy as JSON + </button> + <button class="copyURL" onclick="copyURL();" id="copyURL"> + <img src="/querybuilder/img/copy.svg" height="17" width="17" alt="Copy as URL"/> Copy as URL + </button> + <br/> - <div class="response">Response</div> - <input class="responseinfo" id="reponsestatus" value="" readonly></input></br> - <textarea class="responsebox" id="response" cols=70 rows=25 readonly></textarea> - <div id="div" > - <div > + <div class="response">Response:</div> + <input class="responseinfo" id="reponsestatus" value="" readonly /> + <textarea class="responsebox" id="response" cols=70 rows=25 readonly></textarea> + <div id="div" > + <div> <div class="intro-copy" onclick="copyToClipboard(response);" style="cursor:pointer;"> - <img src="/querybuilder/img/copy.svg" height="30" width="30" /> - </div> - <div class="intro-refresh" onclick="refresh();" style="cursor:pointer;"> - <img src="/querybuilder/img/reload.svg" height="30" width="30" /> - </div> - </br> - </br> - <div id="helpbutton" class="intro-help" onclick="toggleHelp();" style="cursor:pointer;"> - <img src="/querybuilder/img/features-help.png" height="47" width="138" style="margin-left: -1px;"/> + <img src="/querybuilder/img/copy.svg" height="30" width="30" alt="Copy to clipboard"/> </div> - <div id="help" style="display: none;"> - <div class="intro-param" id="help"> - </br> - <div class="help-title">Features</div> - <span> ○ Autocompletion of YQL-syntax</span> </br> - <span> ○ Drop-down lists of all valid parameters</span> </br> - <span> ○ Sending both POST and GET-requests to <i>Vespa</i></span> </br> - <span> ○ Easy access to the <a href="https://docs.vespa.ai/en/reference/query-api-reference.html">documentation</a> of each parameter</span> </br> - <span> ○ Conversion of POST- to GET-query</span> </br> - <span> ○ Pasting already built JSON-query</span> </br> - <span> ○ View and copy the response of queries</span> </br> - <span> ○ View the finished JSON-query as you build </span> </br> - </div> - </br> - <div class="intro-param" id="help"> - <div class="help-title">Help</div> - <span>Please submit a pull request or create an <a href="https://github.com/vespa-engine/vespa/issues">issue</a> for fixes to the querybuilder.</span> </br> - </div> - </div> - </div> - </div> + </div> </div> </div> - </header> - <footer> - <div class="container"> - <div class="row"> - <div class="col-xs-2 quicklink-section"> - <div class="footer-title">Resources</div> - <ul class="quicklinks"> - <li><a href="https://docs.vespa.ai/en/vespa-quick-start.html">Getting Started</a> - <li><a href="https://docs.vespa.ai">Documentation</a> - <li><a href="https://github.com/vespa-engine/vespa">Open source</a> - </ul> - </div> - <div class="col-xs-2 quicklink-section"> - <div class="footer-title">Contact</div> - <ul class="quicklinks"> - <li><a href="https://twitter.com/vespaengine">Twitter</a> - <li><a href="mailto:info@vespa.ai">info@vespa.ai</a> - <li><a href="https://github.com/vespa-engine/vespa/issues">Issues</a> - </ul> - </div> - <div class="col-xs-2 quicklink-section"> - <div class="footer-title">Community</div> - <ul class="quicklinks"> - <li><a href="https://github.com/vespa-engine/vespa/blob/master/CONTRIBUTING.md">Contributing</a> - <li><a href="https://stackoverflow.com/questions/tagged/vespa">Stack Overflow</a> - <li><a href="https://gitter.im/vespa-engine/Lobby">Gitter</a> - </ul> - </div> - <div class="col-xs-6 quicklink-section"> - <div class="credits"> - <span>Copyright Yahoo</span> - Licensed under <a href="https://github.com/vespa-engine/vespa/blob/master/LICENSE">Apache License 2.0</a> - , <a href="https://github.com/y7kim/agency-jekyll-theme">Theme</a> by Rick K. - </div> - </div> - </div> - </div> - </footer> + </div> +</header> <!-- jQuery Version 1.11.0 --> <script src="/querybuilder/js/jquery-1.11.0.js"></script> @@ -229,7 +156,6 @@ childrenProps["ranking.properties"] = window.CONFIG.ranking_properties; } addNewRow(); - getSearchApiReference(); }, 250); }; var stringType = ["yql", "queryProfile", "searchChain", "model.defaultIndex", "model.encoding", "model.language", @@ -247,19 +173,6 @@ var yqlID = "v1"; - - function toggleHelp(){ - var div = document.getElementById("help"); - var buttonDiv = document.getElementById("helpbutton"); - if (div.style.display === "none") { - div.style.display = "block"; - buttonDiv.style.backgroundColor = '#4EA2D6'; - } else { - div.style.display = "none"; - buttonDiv.style.backgroundColor = 'transparent'; - } - } - function updateFields(){ var temp = number; while (temp > 0){ @@ -449,6 +362,7 @@ newButton.classList.add("removeRow"); var br = document.createElement("br"); br.id = "br"+temp + /* var img = document.createElement("img"); img.src = "/querybuilder/img/information.svg"; img.height = "15"; @@ -463,11 +377,12 @@ a.id = "inf"+temp a.appendChild(img); a.appendChild(span); + */ var div = document.createElement("div"); div.id = number; div.appendChild(newInput); div.appendChild(newDatalist); - div.appendChild(a); + //div.appendChild(a); div.appendChild(newInputVal); div.appendChild(newDatalist2); div.appendChild(newButton); @@ -490,6 +405,7 @@ generateJSON(); return temp; } + /* ToDo: remove completely function showInformation(no, key){ var a = document.getElementById("inf"+no); if(validKey(no, key)){ @@ -504,6 +420,7 @@ a.style = "visibility: hidden;" } } + */ function validKey(no, possibleKey){ if (contains(possible, possibleKey)){return true;} for (var key in childrenProps){ @@ -528,7 +445,7 @@ } function keySelected(no, value){ var key = document.getElementById("i"+no).value; - showInformation(no, key); + //showInformation(no, key); ToDo: remove completely findUsedProps(); var fullKey = getFullName(no, key); if(fullKey in childrenProps){ @@ -728,6 +645,7 @@ b.innerHTML = ' ↳ '; var margin = 20*(temp).length; b.style = "padding-left:"+margin+"px;"; + /* var img = document.createElement("img"); img.src = "/querybuilder/img/information.svg"; img.height = "15"; @@ -742,10 +660,11 @@ a.id = "inf"+temp a.appendChild(img); a.appendChild(span); + */ div.appendChild(b); div.appendChild(newInput); div.appendChild(newDatalist); - div.append(a); + //div.append(a); div.appendChild(newInputVal); div.appendChild(newDatalist2); div.appendChild(newButton); @@ -789,9 +708,7 @@ } return false; } - function refresh(){ - document.location.reload(true); - } + function generateJSON(){ json = JSON.parse("{}"); buildJSON(json, number, 0); @@ -940,20 +857,6 @@ copyURL.style.display = "none"; } } - function getSearchApiReference(){ - var div = document.getElementById("div"); - var object = document.createElement("object"); - object.data = "/querybuilder/_includes/search-api-reference.html"; - object.type ="text/html"; - object.style = "visibility: hidden; height: 1px; width: 200px;" - div.appendChild(object); - setTimeout(function(){ - searchApiReference = object.contentDocument; - setTimeout(function(){ - div.removeChild(object); - }, 20); - }, 150); - } function changeInformation(no,key){ if (key===""){return "Choose a parameter for information"} if (getFullName(no,key) in childrenProps){return "Add parameters under the parent ''" + getFullName(no,key) + "'"} diff --git a/container-search-gui/src/main/resources/gui/_includes/search-api-reference.html b/container-search-gui/src/main/resources/gui/_includes/search-api-reference.html deleted file mode 100644 index e7d9004e109..00000000000 --- a/container-search-gui/src/main/resources/gui/_includes/search-api-reference.html +++ /dev/null @@ -1,1914 +0,0 @@ - -<!DOCTYPE html> -<!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. --> -<html lang="en"> - -<head> - <!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. --> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <!-- <meta name="viewport" content="width=device-width, initial-scale=1"> --> - <meta name="description" content="Serve big data with ease - dynamic responses at any scale in milliseconds with any traffic volume."> - <meta name="author" content="Vespa team"> - - <title>Search API Reference</title> - - <!-- Bootstrap --> - <link href="/css/bootstrap.min.css" rel="stylesheet"> - - <!-- Font Awesome --> - <link rel="stylesheet" href="/css/font-awesome.min.css"> - - <!-- Docs layout --> - <link rel="stylesheet" href="/css/docs.css"> - - <!-- Favicons --> - <link rel="icon" href="/icons/favicon.ico" type="image/x-icon" /> - <link rel="shortcut icon" href="/icons/favicon.ico" type="image/x-icon" /> - - <!-- Bootstrap and other JavaScript --> - <script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML"></script> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script> - <script src="/js/bootstrap.min.js"></script> - - <!-- Global Site Tag (gtag.js) - Google Analytics --> - <script async src="https://www.googletagmanager.com/gtag/js?id=UA-107187180-3"></script> - <script> - window.dataLayer = window.dataLayer || []; - function gtag(){dataLayer.push(arguments)}; - gtag('js', new Date()); - gtag('config', 'UA-107187180-3'); -</script> - -</head> - -<body> - -<!-- Fixed navbar --> -<!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. --> -<nav class="navbar navbar-default navbar-fixed-top"> - <div class="container-fluid"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="http://vespa.ai"> - <img src="/img/vespa-logo.png" width="100" height="28"> - </a> - </div> - <div id="navbar" class="navbar-collapse collapse"> - <ul class="nav navbar-nav navbar-right"> - <li><a href="http://blog.vespa.ai/">Blog</a> - <li><a href="https://twitter.com/vespaengine">Twitter</a> - <li><a href="/documentation/">Docs</a> - <li><a href="https://github.com/vespa-engine" target="_blank">GitHub</a> - <li><a href="https://github.com/vespa-engine/vespa/issues" target="_blank">Issues</a> - </ul> - <div class="col-sm-offset-2 col-md-offset-2"> - <div class="row"> - <form class="search" action="/search.html" method="get" id="search-form"> - <div class="col-xs-4"> - <input type="text" class="form-control" placeholder="Search Documentation" id="search" name="q"> - </div> - <button type="submit" id="submit" class="btn btn-search"><i class="fa fa-search" aria-hidden="true"></i></button> - </form> - </div> - </div> - </div> - </div> -</nav> - - -<div id="main-content" class="container-fluid"> - <div class="row"> - - <!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. --> - - <div class="col-sm-3 col-md-2 sidebar"> - <ul class="nav nav-sidebar"> - <li class="collapse-all" onclick="expand_all();">[+] expand all</li> - </ul> - - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">WELCOME</li> - - - - <li class="collapseable"><a href="/">Welcome to Vespa</a></li> - - - - - <li class="collapseable"><a href="/documentation/overview.html">Vespa Overview</a></li> - - - - - <li class="collapseable"><a href="/documentation/features.html">Features</a></li> - - - - - <li class="collapseable"><a href="/documentation/elastic-search-comparison.html">Comparison to Elasticsearch</a></li> - - - - - <li class="collapseable"><a href="/documentation/contributing.html">Contributing to Vespa</a></li> - - - - - <li class="collapseable"><a href="/documentation/introduction-to-documentation.html">Documentation Conventions</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">GETTING STARTED</li> - - - - <li class="collapseable"><a href="/documentation/vespa-quick-start.html">Quick Start</a></li> - - - - - <li class="collapseable"><a href="/documentation/tutorials/blog-search.html">Blog Search Tutorial</a></li> - - - - - <li class="collapseable"><a href="/documentation/build-install-vespa.html">Build Vespa</a></li> - - - - - <li class="collapseable"><a href="/documentation/api.html">Vespa API and Interfaces</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">DOCUMENTS AND SEARCH DEFINITIONS</li> - - - - <li class="collapseable"><a href="/documentation/documents.html">Documents</a></li> - - - - - <li class="collapseable"><a href="/documentation/search-definitions.html">Search Definitions</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">WRITING TO VESPA</li> - - - - <li class="collapseable"><a href="/documentation/writing-to-vespa.html">Writing to Vespa</a></li> - - - - - <li class="collapseable"><a href="/documentation/vespa-http-client.html">Vespa Feeding Client API</a></li> - - - - - <li class="collapseable"><a href="/documentation/feed-using-hadoop-pig-oozie.html">Feed using Hadoop, Pig, Oozie</a></li> - - - - - <li class="collapseable"><a href="/documentation/document-api-guide.html">Document API</a></li> - - - - - <li class="collapseable"><a href="/documentation/document-processing-overview.html">Document Processing</a></li> - - - - - <li class="collapseable"><a href="/documentation/annotations.html">Annotations API</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">QUERYING VESPA</li> - - - - <li class="collapseable"><a href="/documentation/querying-vespa.html">Querying Vespa</a></li> - - - - - <li class="collapseable"><a href="/documentation/search-api.html">Search API</a></li> - - - - - <li class="collapseable"><a href="/documentation/query-language.html">Vespa Query Language</a></li> - - - - - <li class="collapseable"><a href="/documentation/grouping.html">Grouping Information in Results</a></li> - - - - - <li class="collapseable"><a href="/documentation/federation.html">Federation</a></li> - - - - - <li class="collapseable"><a href="/documentation/query-profiles.html">Query Profiles</a></li> - - - - - <li class="collapseable"><a href="/documentation/geo-search.html">Geo Search</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">RANKING AND ML MODELS</li> - - - - <li class="collapseable"><a href="/documentation/ranking.html">Ranking Introduction</a></li> - - - - - <li class="collapseable"><a href="/documentation/nativerank.html">Ranking With nativeRank</a></li> - - - - - <li class="collapseable"><a href="/documentation/tensor-intro.html">Tensor Introduction</a></li> - - - - - <li class="collapseable"><a href="/documentation/tensor-user-guide.html">Tensor User Guide</a></li> - - - - - <li class="collapseable"><a href="/documentation/tensorflow.html">Ranking With TensorFlow Models</a></li> - - - - - <li class="collapseable"><a href="/documentation/onnx.html">Ranking With ONNX Models</a></li> - - - - - <li class="collapseable"><a href="/documentation/xgboost.html">Ranking With XGBoost Models</a></li> - - - - - <li class="collapseable"><a href="/documentation/stateless-model-evaluation.html">Stateless model evaluation</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">LINGUISTICS AND TEXT PROCESSING</li> - - - - <li class="collapseable"><a href="/documentation/linguistics.html">Linguistics in Vespa</a></li> - - - - - <li class="collapseable"><a href="/documentation/stemming.html">Stemming</a></li> - - - - - <li class="collapseable"><a href="/documentation/text-processing.html">Special Tokens</a></li> - - - - - <li class="collapseable"><a href="/documentation/query-rewriting.html">Query Rewriting</a></li> - - - - - <li class="collapseable"><a href="/documentation/query-phrasing.html">Query Phrasing With PhrasingSearcher</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">DEVELOPING APPLICATIONS AND PLUGINS</li> - - - - <li class="collapseable"><a href="/documentation/cloudconfig/application-packages.html">Application Packages</a></li> - - - - - <li class="collapseable"><a href="/documentation/container-intro.html">The Vespa Container</a></li> - - - - - <li class="collapseable"><a href="/documentation/jdisc/">Java Data Intensive Serving Container - JDisc</a></li> - - - - - <li class="collapseable"><a href="/documentation/jdisc/container-components.html">JDisc Container Components</a></li> - - - - - <li class="collapseable"><a href="/documentation/component-types.html">Container Component Types</a></li> - - - - - <li class="collapseable"><a href="/documentation/jdisc/developing-applications.html">Application Development Basics</a></li> - - - - - <li class="collapseable"><a href="/documentation/jdisc/processing.html">Request-Response Processing</a></li> - - - - - <li class="collapseable"><a href="/documentation/searcher-development.html">Searcher Development</a></li> - - - - - <li class="collapseable"><a href="/documentation/docproc-development.html">Document Processor Development</a></li> - - - - - <li class="collapseable"><a href="/documentation/developing-web-services.html">Developing Web Service Applications</a></li> - - - - - <li class="collapseable"><a href="/documentation/handler-tutorial.html">HTTP API Use Case Tutorial</a></li> - - - - - <li class="collapseable"><a href="/documentation/jdisc/injecting-components.html">Component Injection</a></li> - - - - - <li class="collapseable"><a href="/documentation/chained-components.html">Chained Components</a></li> - - - - - <li class="collapseable"><a href="/documentation/jdisc/developing-osgi-bundles.html">Building OSGi Bundles</a></li> - - - - - <li class="collapseable"><a href="/documentation/bundle-plugin.html">OSGi Bundle Maven Plugin</a></li> - - - - - <li class="collapseable"><a href="/documentation/jdisc/component-versioning.html">Versioning in the Container</a></li> - - - - - <li class="collapseable"><a href="/documentation/jdisc/metrics.html">Container Metrics</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">CONFIGURATION</li> - - - - <li class="collapseable"><a href="/documentation/cloudconfig/config-introduction.html">The Cloud Configuration System</a></li> - - - - - <li class="collapseable"><a href="/documentation/cloudconfig/configapi-dev.html">Cloud Config API</a></li> - - - - - <li class="collapseable"><a href="/documentation/cloudconfig/cloudconfig-model-plugins.html">Developing Cloud Config Model Plugins</a></li> - - - - - <li class="collapseable"><a href="/documentation/cloudconfig/deploy-rest-api-v2.html">Deploy API</a></li> - - - - - <li class="collapseable"><a href="/documentation/cloudconfig/config-rest-api-v2.html">Config API</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">RESULT FORMATS</li> - - - - <li class="collapseable"><a href="/documentation/document-summaries.html">Document Summaries</a></li> - - - - - <li class="collapseable"><a href="/documentation/result-rendering.html">Search Result Renderers</a></li> - - - - - <li class="collapseable"><a href="/documentation/page-templates.html">Page Templates</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">PREDICATE SEARCH</li> - - - - <li class="collapseable"><a href="/documentation/predicate-fields.html">Predicate Fields</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">USER AND GROUP ORIENTED SEARCH</li> - - - - <li class="collapseable"><a href="/documentation/streaming-search.html">Streaming Search</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">THE CONTENT LAYER</li> - - - - <li class="collapseable"><a href="/documentation/elastic-vespa.html">Elastic Vespa</a></li> - - - - - <li class="collapseable"><a href="/documentation/proton.html">Proton</a></li> - - - - - <li class="collapseable"><a href="/documentation/content/consistency.html">Vespa Consistency Model</a></li> - - - - - <li class="collapseable"><a href="/documentation/content/idealstate.html">Distribution Algorithm</a></li> - - - - - <li class="collapseable"><a href="/documentation/content/data-placement.html">Document Distribution</a></li> - - - - - <li class="collapseable"><a href="/documentation/content/buckets.html">Buckets</a></li> - - - - - <li class="collapseable"><a href="/documentation/content/admin-states.html">Cluster and Node States</a></li> - - - - - <li class="collapseable"><a href="/documentation/content/api-state-rest-api.html">State API</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">PERFORMANCE AND TUNING</li> - - - - <li class="collapseable"><a href="/documentation/performance/sizing-search.html">Vespa Search Sizing Guide</a></li> - - - - - <li class="collapseable"><a href="/documentation/attributes.html">Document Attributes</a></li> - - - - - <li class="collapseable"><a href="/documentation/performance/attribute-memory-usage.html">Attribute Memory Usage</a></li> - - - - - <li class="collapseable"><a href="/documentation/performance/vespa-benchmarking.html">Vespa Benchmarking</a></li> - - - - - <li class="collapseable"><a href="/documentation/performance/profiling-search-container.html">Profiling the Search Container</a></li> - - - - - <li class="collapseable"><a href="/documentation/performance/container-tuning.html">Container Tuning</a></li> - - - - - <li class="collapseable"><a href="/documentation/performance/rate-limiting-searcher.html">Rate-Limiting Search Requests</a></li> - - - - - <li class="collapseable"><a href="/documentation/performance/fbench.html">Vespa HTTP Benchmark Tool - vespa-fbench</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">OPERATIONS AND PROCEDURES</li> - - - - <li class="collapseable"><a href="/documentation/operations/admin-procedures.html">Administrative Procedures</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/vespa-cmdline-tools.html">Vespa Command-line Tools</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/metrics-health-format.html">Gathering Metrics from Vespa</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/logs.html">Log Files</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/files-processes-and-ports.html">Files, Processes and Ports</a></li> - - - - - <li class="collapseable"><a href="/documentation/inspecting-java-services.html">Inspecting Vespa Java Services</a></li> - - - - - <li class="collapseable"><a href="/documentation/docker-containers-in-production.html">Docker Containers in Production</a></li> - - - - - <li class="collapseable"><a href="/documentation/securing-your-vespa-installation.html">Securing a Vespa installation</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">MIGRATING FROM ELASTICSEARCH TO VESPA</li> - - - - <li class="collapseable"><a href="/documentation/migrating-from-elastic-search-to-vespa.html">Migrating from Elasticsearch to Vespa</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">CONFIGURATION REFERENCE</li> - - - - <li class="collapseable"><a href="/documentation/reference/application-packages-reference.html">Application Package Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/search-definitions-reference.html">Search Definition Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/services.html">Services Configuration (services.xml)</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/advanced-indexing-language.html">Indexing Language</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/config-files.html">Custom Configuration File Reference</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">RANKING REFERENCE</li> - - - - <li class="collapseable"><a href="/documentation/reference/ranking-expressions.html">Ranking Expressions</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/tensor.html">Tensor Evaluation Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/nativerank.html">nativeRank Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/rank-features.html">Rank Feature Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/string-segment-match.html">String Segment Match</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/rank-feature-configuration.html">Rank Feature Configuration</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/rank-types.html">Rank Types</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">QUERIES AND RESULTS REFERENCE</li> - - - - <li class="active collapseable"><a href="/documentation/reference/search-api-reference.html">Search API Reference <span class="sr-only">(current)</span></a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/simple-query-language-reference.html">Simple Query Language Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/select-reference.html">Select Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/grouping-syntax.html">Grouping Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/sorting.html">Sorting Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/query-profile-reference.html">Query Profile Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/semantic-rules.html">Semantic Rule Language Reference</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/advanced-search-operators.html">Advanced Search Operators</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/equiv.html">The EQUIV Operator</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/wand-operator.html">The WAND Operator</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/weighted-set-term.html">The WeightedSetItem Operator</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/dot-product-search-operator.html">The Dot Product Search Operator</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/default-result-format.html">Default JSON Result Format</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/page-templates-syntax.html">Page Templates Syntax</a></li> - - - - - </ul> - - <ul class="nav nav-sidebar"> - <li class="collapse-parent" onclick="on_collapse(this);">DOCUMENT FORMAT AND LANGUAGES REFERENCE</li> - - - - <li class="collapseable"><a href="/documentation/reference/document-json-format.html">Document JSON Format</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/document-field-path.html">Document Field Path Syntax</a></li> - - - - - <li class="collapseable"><a href="/documentation/reference/document-select-language.html">Document Selector Language</a></li> - - - - - </ul> - - - </div> - - <script type="application/javascript"> - - $(document).ready (function() { - $(".collapseable").each(function() { - $(this).addClass("collapsed"); - }); - $(".active").each(function() { - $(this).removeClass("collapsed"); - $(this).siblings().each(function() { - if (!$(this).hasClass("collapse-parent")) { - $(this).removeClass("collapsed"); - } - }); - }); - }); - - function on_collapse(e) { - $(e).siblings().each(function() { - $(this).toggleClass("collapsed"); - }); - } - - function expand_all() { - $(".collapseable").each(function() { - $(this).removeClass("collapsed"); - }); - } - -</script> - - - <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> - - <h1> - Search API Reference - <div class="pull-right"><a href="https://github.com/vespa-engine/documentation/blob/master/documentation/reference/search-api-reference.html" class="btn btn-link"><i class="fa fa-github"></i> edit page</a></div> - </h1> - - <p> - All the search request parameters listed below can be set in query - profiles. The first four blocks of properties are also modeled as - query profile types. These types can be referred from query profiles - (and inheriting types) to provide type checking on the parameters. - </p><p> - These parameters often have both a full name - which includes the - path from the root query profile - and one or more abbreviated - names. Both names can be used in search requests, while only full - names can be used in query profiles. The full names are case - sensitive, while the abbreviated names are case insensitive. - </p><p> - The parameters modeled as query profiles are also available through - get methods as Java objects from the Query to Searcher components. - </p> - - - - <h2>Index</h2> - - <dt>Query</dt> - <dd> - <ul> - <li><a href="#yql">yql</a></li> - <li><a href="#Select">select</a></li> - <ul> - <li><a href="#where">where</a></li> - <li><a href="#grouping">grouping</a></li> - </ul> - </ul> - </dd> - </dl> - - <dl> - <dt>Native Execution Parameters</dt> - <dd> - <ul> - <li><a href="#hits">hits</a> [<em>count</em>]</li> - <li><a href="#offset">offset </a>[<em>start</em>]</li> - <li><a href="#queryProfile">queryProfile</a></li> - <li><a href="#nocache">nocache</a></li> - <li><a href="#groupingSessionCache">groupingSessionCache</a></li> - <li><a href="#searchChain">searchChain</a></li> - <li><a href="#timeout">timeout</a></li> - <li><a href="#tracelevel">tracelevel</a></li> - <li><a href="#trace.timestamps">trace.timestamps</a></li> - </ul> - </dd> - - <dt>Query Model Parameters</dt> - <dd> - <ul> - <li><a href="#model.defaultIndex">model.defaultIndex</a> [<em>default-index</em>]</li> - <li><a href="#model.encoding">model.encoding</a> [<em>encoding</em>]</li> - <li><a href="#model.filter">model.filter</a> [<em>filter</em>]</li> - <li><a href="#model.language">model.language</a> [<em>lang, language</em>]</li> - <li><a href="#model.queryString">model.queryString</a> [<em>query</em>]</li> - <li><a href="#model.restrict">model.restrict</a> [<em>restrict</em>]</li> - <li><a href="#model.searchPath">model.searchPath</a> [<em>path</em>]</li> - <li><a href="#model.sources">model.sources</a> [<em>search, sources</em>]</li> - <li><a href="#model.type">model.type</a> [<em>type</em>]</li> - </ul> - </dd> - - <dt>Ranking</dt> - <dd> - <ul> - <li><a href="#ranking.location">ranking.location</a> [<em>location</em>]</li> - <li><a href="#ranking.features">ranking.features</a> [<em>rankfeature</em>]</li> - <li><a href="#ranking.listFeatures">ranking.listFeatures</a> [<em>rankfeatures</em>]</li> - <li><a href="#ranking.profile">ranking.profile</a> [<em>ranking</em>]</li> - <li><a href="#ranking.properties">ranking.properties</a> [<em>rankproperty</em>]</li> - <li><a href="#ranking.sorting">ranking.sorting</a> [<em>sorting</em>]</li> - <li><a href="#ranking.freshness">ranking.freshness</a></li> - <li><a href="#ranking.queryCache">ranking.queryCache</a></li> - <li><a href="#ranking.matchPhase">ranking.matchPhase</a></li> - </ul> - </dd> - - <dt>Presentation</dt> - <dd> - <ul> - <li><a href="#presentation.bolding">presentation.bolding</a> [<em>bolding</em>]</li> - <li><a href="#presentation.format">presentation.format</a> [<em>format</em>]</li> - <li><a href="#presentation.template">presentation.template</a></li> - <li><a href="#presentation.summary">presentation.summary</a> [<em>summary</em>]</li> - <li><a href="#presentation.timing">presentation.timing</a></li> - </ul> - </dd> - - <dt>Grouping</dt> - <dd> - <ul> - <li><a href="#select">select</a></li> - <li><a href="#collapse.summary">collapse.summary</a></li> - <li><a href="#collapsefield">collapsefield</a></li> - <li><a href="#collapsesize">collapsesize</a></li> - </ul> - </dd> - - <dt>Geographical Searches</dt> - <dd> - <ul> - <li><a href="#pos.ll">pos.ll</a></li> - <li><a href="#pos.radius">pos.radius</a>,</li> - <li><a href="#pos.attribute">pos.attribute</a></li> - <li><a href="#pos.bb">pos.bb</a></li> - </ul> - </dd> - - <dt>Streaming Search</dt> - <dd> - <ul> - <li><a href="#streaming.userid">streaming.userid</a></li> - <li><a href="#streaming.groupname">streaming.groupname</a></li> - <li><a href="#streaming.selection">streaming.selection</a></li> - <li><a href="#streaming.priority">streaming.priority</a></li> - <li><a href="#streaming.maxbucketspervisitor">streaming.maxbucketspervisitor</a></li> - </ul> - </dd> - - <dt>Semantic Rules</dt> - <dd> - <ul> - <li><a href="#rules.off">rules.off</a></li> - <li><a href="#rules.rulebase">rules.rulebase</a></li> - <li><a href="#tracelevel.rules">tracelevel.rules</a></li> - </ul> - </dd> - - <dt>Other</dt> - <dd> - <ul> - <li><a href="#recall">recall</a></li> - <li><a href="#user">user</a></li> - <li><a href="#nocachewrite">nocachewrite</a></li> - <li><a href="#hitcountestimate">hitcountestimate</a></li> - <li><a href="#metrics.ignore">metrics.ignore</a></li> - </ul> - </dd> - </dl> - - - <h2 id="query">Query</h2> - <h3 id="yql">yql</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>String</td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - <p> - The YQL query will be parsed and executed in the backend. - Only simple YQL programs are supported, refer to - <a href="../query-language.html">YQL</a> for details. - </p> - - <h3 id="Select">select</h3> - <p>Select query is equivalent with YQL, written in JSON. Contains subparameters <code>where</code> and <code>grouping</code>.</p> - - <h4 id="where"> where</h4> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>JSON</td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - - <h4 id="grouping"> grouping</h4> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>JSON</td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - <p> - The where and grouping query will be parsed and executed in the backend. - Refer to - <a href="../reference/select-reference.html">Select Reference</a> for details. - </p> - - - - - <h2 id="native-execution-parameters">Native Execution Parameters</h2> - <p> - These parameters are defined in the <code>native</code> query profile type. - </p> - - - <h3 id="hits">hits</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>count</td></tr> - <tr><td>Values</td> - <td> - A positive integer, or 0. The sum of <a href="#offset">offset</a> and - <a href="#hits">hits</a> should be lower than the configured maxoffset - value, and will be adjusted to fit. See also comment - at <code>offset</code>. - </td> - </tr> - <tr><td>Default</td><td>10</td></tr> - </table> - <p> - The maximum number of hits to return from the result set. - Must be lower than <code>maxHits</code>, which is either set in a - <a href="#queryProfile">query profile</a>, or default 400. - <!-- ToDo: link to def file or code where this is definied --> - </p> - - - <h3 id="offset">offset</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>start</td></tr> - <tr><td>Values</td> - <td> - A positive integer, including 0. - </td> - </tr> - <tr><td>Default</td><td>0</td></tr> - </table> - <p> - The index of the first hit to return from the result set. - Must be lower than <code>maxOffset</code>, which is either set in a - <a href="#queryProfile">query profile</a>, or default 1000. - <!-- ToDo: link to def file or code where this is definied --> - </p> - - - <h3 id="queryProfile">queryProfile</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td><em>None</em></td></tr> - <tr><td>Values</td> - <td> - A query profile id - name:version, where version can be omitted - or partially specified, e.g "myprofile:2.1" - </td> - </tr> - <tr><td>Default</td><td><code>default</code></td></tr> - </table> - <p> - A <a href="../query-profiles.html">query profile</a> has default properties for a query. - The default query profile is named <em>default</em> - example: - <pre> -<query-profile id="default"> - <field name="maxHits">10</field> - <field name="maxOffset">1000</field> -</query-profile> -</pre> - </p> - - - <h3 id="nocache">nocache</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td> - <td> - True or false - </td> - </tr> - <tr><td>Default</td><td>false</td></tr> - </table> - <p> - Set to true to avoid the result being fetched from cache, and avoid - writing the result to cache after fetching it. - </p> - - - <h3 id="groupingSessionCache">groupingSessionCache</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td> - <td> - True or false - </td> - </tr> - <tr><td>Default</td><td>false</td></tr> - </table> - <p> - Set to true to store intermediate grouping results in the search back ends when - using multi level grouping expressions in order to speed up grouping at a - potential loss of accuracy. See the <a - href="grouping-syntax.html#sessionCache">grouping reference</a> for more - details. - </p> - - - <h3 id="searchChain">searchChain</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td> - <td> - A search chain id - name:version, where version can be - omitted or partially specified, e.g "mychain:2.1.3". - </td> - </tr> - <tr><td>Default</td><td><code>default</code></td></tr> - </table> - <p> - The search chain initially invoked when processing this query. This - search chain may invoke other chains. - </p> - - - <h3 id="timeout">timeout</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td> - <td> - Positive floating point number with an optional unit. Default unit - is seconds (s), valid unit strings are e.g. <em>ms</em> and <em>s</em>. To set - a timeout of one minute, the argument could be set to <em>60 s</em>. - Space between the number and the unit is optional. - </td> - </tr> - <tr><td>Default</td><td>Undefined, but guaranteed to be at least 5000 milliseconds. This default can be overridden by configuring timeout in a <a href="../query-profiles.html">query profile.</a></td></tr> - </table> - <p>The query timeout.</p> - - - <h3 id="tracelevel">tracelevel</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td> - <td> - Any positive number - </td> - </tr> - <tr><td>Default</td><td><em>No tracing</em></td></tr> - </table> - <p> - Set to a positive number to collect trace information for debugging - when running a query. Higher numbers give - progressively more detail on query transformations and searcher - execution. - </p> - - <h3 id="trace.timestamps">trace.timestamps</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td> - <td> - true or false - </td> - </tr> - <tr><td>Default</td><td><em>No timestamps in trace</em></td></tr> - </table> - <p> - Enable it to get timing information already at <a href="#tracelevel">tracelevel=1</a> which is useful for debugging latency spent at different components in the search chain without rendering a lot of string data which is associated with higher trace levels. - </p> - - - - <h2 id="query-model">Query Model Parameters</h2> - - <h3 id="model.defaultIndex">model.defaultIndex [<em>default-index</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>default-index</td></tr> - <tr><td>Values</td><td>An index name</td></tr> - <tr><td>Default</td><td><code>default</code></td></tr> - </table> - <p> - The field which is searched for query terms which doesn't explicitly specify an index. - </p> - - - <h3 id="model.encoding">model.encoding [<em>encoding</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>encoding</td></tr> - <tr><td>Values</td><td>Encoding names or aliases defined in the <a href="http://www.iana.org/assignments/character-sets">IANA character sets</a></td></tr> - <tr><td>Default</td><td>utf-8</td></tr> - </table> - <p> Sets the encoding to use when returning a result. The encodings <em>big5</em>, - <em>euc-jp</em>, <em>euc-kr</em>, <em>gb2312</em>, <em>iso-2022-jp</em> and <em>shift-jis</em> - also influences how tokenization is done in the absence of an explicit language setting. - </p><p> - The query is always encoded as UTF-8, independently of how the result will be encoded. - </p> - - - <h3 id="model.filter">model.filter [<em>filter</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>filter</td></tr> - <tr><td>Values</td><td>Any allowed collection of filter terms</td></tr> - <tr><td>Default</td><td><em>Not set</em></td></tr> - </table> - <p> - Sets a filter to be combined with the query. Typical use of a filter - is to add machine generated or preferences based filter terms to a raw - user query. The filter is parsed the same way as a query of type any, - the full syntax is available. The positive terms (preceded by +) and - phrases act as AND filters, the negative terms (preceded by -) act as - NOT filters, while the unprefixed terms will be used to RANK the - results. Unless the query has no positive terms, the filter will only - restrict and influence ranking of the result set, never cause more - matches than the query. - </p> - - - <h3 id="model.language">model.language [<em>lang, language</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>language, lang</td></tr> - <tr><td>Values</td><td>Ref. RFC 3066</td></tr> - <tr><td>Default</td><td></em>Unspecified</em></td></tr> - </table> - <p> - Informs Vespa about the natural language of the query. Please see - <a href="../linguistics.html">linguistics</a> for details. - This attribute should always be set when it is known. If this - parameter is not set, it will be guessed from the query and encoding, and - default to english if it cannot be guessed. - </p> - - - <h3 id="model.queryString">model.queryString [<em>query</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>query</td></tr> - <tr><td>Values</td><td>Any HTTP encoded legal Vespa query language string</td></tr> - <tr><td>Default</td><td><em>Not set</em></td></tr> - </table> - <p> - The <a href="simple-query-language-reference.html">Simple Vespa Query Language</a> query string - specifying which documents to match in this query. - </p> - - - <h3 id="model.restrict">model.restrict [<em>restrict</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>restrict</td></tr> - <tr><td>Values</td><td>A comma delimited list of document type names.</td></tr> - <tr><td>Default</td><td><em>Search unrestricted</em></td></tr> - </table> - <p> - The document types to restrict the search to when different document - types share the same search cluster. - </p> - - - <h3 id="model.searchPath">model.searchPath [<em>path</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>searchpath</td></tr> - <tr><td>Values</td><td><ul> - <li>searchpath::ELEMENT [';' ELEMENT]*</li> - <li>ELEMENT::PART ['/' ROW]</li> - <li>PART::EXP [',' EXP]*</li> - <li>EXP::NUM | RANGE</li> - <li>ROW::NUM</li> - <li>RANGE::'['NUM ',' NUM ' >'</li> - </ul></td></tr> - <tr><td>Default</td><td><em>Whole cluster</em></td></tr> - </table> - <p> - Specification of which path to send the query to. - Used to select which set of search nodes in the cluster should be used. - Only meant for debugging/monitoring. - </p><p> - Examples: - Note that in an indexed content cluster with flat distribution we have 1 implicit row - and each search node represents a part. - <ul> - <li>'7/3' = part 7, row 3.</li> - <li>'7/' = part 7, any row.</li> - <li>'7,1,9/0' = parts 1,7 and 9, row 0.</li> - <li>'1,[3,9>/0' = parts 1,3,4,5,6,7,8, row 0.</li> - </ul> - </p><p> - In a cluster with a multi-level dispatch setup we must specify a search path element for each level. - Lets say we have a setup with 2 mid-level dispatch groups, each containing 3 search nodes (and 3 dispatchers): - <ul> - <li>'0/;2/' = dispatch group (part) 0, any of the dispatchers (row); search node (part) 2, any row (of 1 present).</li> - <li>'0/1;2/0' = dispatch group (part) 0, dispatcher (row) 1; search node (part) 2, row 0 (of 1 present).</li> - </ul> - </p> - - - <h3 id="model.sources">model.sources [<em>search, sources</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>search, sources</td></tr> - <tr><td>Values</td><td>A comma separated list of search cluster names or other source names</td></tr> - <tr><td>Default</td><td><em>Search unrestricted</em></td></tr> - </table> - <p> - The names of the sources to search, e.g one or more search clusters and/or federated sources. - </p> - - - <h3 id="model.type">model.type [<em>type</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>type</td></tr> - <tr><td>Values</td><td>web, all, any, phrase, yql, adv (deprecated) - - refer to <a href="simple-query-language-reference.html">simple query language reference</a></td></tr> - <tr><td>Default</td><td>all</td></tr> - </table> - <p> - Selects the query language syntax of the <a href="#model.queryString">query</a> parameter. - </p> - - - - <h2 id="ranking">Ranking</h2> - - <h3 id="ranking.location">ranking.location [<em>location</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>location</td></tr> - <tr><td>Values</td><td>See <a href="../geo-search.html">Geo search</a></td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - <p> - Point (one or two dimensional) location to use as base for location ranking. - For geographical locations, it is recommended to add the location using <a href="#pos.ll">pos.ll</a> - <!-- ToDo: Why? --> - </p> - - - <h3 id="ranking.features">ranking.features.<em>featurename</em> [<em>rankfeature.</em>featurename]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>rankfeature.featurename</td></tr> - <tr><td>Values</td><td>Any string</td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - <p> - Set a rank feature to a value. This works for any key name <code>query(anyname)</code> (query features), - and also as a way to override all existing (match and document) features. - Example: <em>query=foo&ranking.features.query(userage)=42&ranking.features.fieldMatch(title)=0.65</em> - </p> - - - <h3 id="ranking.listFeatures">ranking.listFeatures [<em>rankfeatures</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>rankfeatures</td></tr> - <tr><td>Values</td><td>boolean</td></tr> - <tr><td>Default</td><td>false</td></tr> - </table> - <p> - Set to true to request <em>all</em> rank features to be calculated and returned. - The rank features will be returned in the summary field rankfeatures. - This option is typically used for MLR training, should not to be used for production. - </p> - - - <h3 id="ranking.profile">ranking.profile [<em>ranking</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>ranking</td></tr> - <tr><td>Values</td><td>Any rank profile name</td></tr> - <tr><td>Default</td><td><code>default</code></td></tr> - </table> - <p> - Sets the name of the rank profile to use for assigning relevancy scores. - The default rank profile will be used for back-ends which does not have the given rank profile. - </p> - - - <h3 id="ranking.properties">ranking.properties.<em>propertyname</em> [<em>rankproperty.propertyname</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>rankproperty.propertyname</td></tr> - <tr><td>Values</td><td>Any string</td></tr> - <tr><td>Default</td><td><em>None</em></td></tr> - </table> - <p> - Set a rank property that is passed to, and used by a feature executor for this query. - Example: <em>query=foo&ranking.properties.dotProduct.X={a:1,b:2}</em> - </p> - - - <h3 id="ranking.sorting">ranking.sorting [<em>sorting</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>sorting</td></tr> - <tr><td>Values</td><td>A valid <a href="sorting.html">sort specification</a></td></tr> - <tr><td>Default</td><td>None - order by relevance</td></tr> - </table> - <p> - A specification of how to sort the result. - Fields you want to sort on must be stored as document attributes in the index structure - by adding <a href="search-definitions-reference.html#attribute">attribute</a> to the indexing statement. - </p> - - - <h3 id="ranking.freshness">ranking.freshness</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td><code>[integer]</code>, an absolute time in seconds since epoch, or <code>now-[number]</code>, to use a time [integer] seconds into the past, or <code>now</code> to use the current time</td></tr> - <tr><td>Default</td><td>None - use the current time on each node.</td></tr> - </table> - <p> - Sets the time which will be used as <em>now</em> during execution. - </p> - - - <h3 id="ranking.queryCache">ranking.queryCache</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>boolean</td></tr> - <tr><td>Default</td><td>false</td></tr> - </table> - <p> - Turns query cache on or off. Search is a two-phase process. If the - query cache is on, the query is stored on the search nodes between the - first and second phase, saving network bandwidth and also query setup - time, at the expense of using more memory. - </p> - - - <h3 id="ranking.matchPhase">ranking.matchPhase</h3> - <p>Settings which control Vespa's behavior during the match phase. - If these are set in the query they will override any match-phase setting - in the rank profile.</p> - <dt></dt> - <dd> - <ul> - <li><a href="#ranking.matchPhase.maxHits">ranking.matchPhase.maxHits</a> the max number of hits that should be generated during the match phase</li> - <li><a href="#ranking.matchPhase.attribute">ranking.matchPhase.attribute</a> the attribute to limit matches by if more than maxHits hits will be generated</li> - <li><a href="#ranking.matchPhase.ascending">ranking.matchPhase.ascending</a> whether to keep the documents having the highest (default) or lowest values of the attribute</li> - <li><a href="#ranking.matchPhase.diversity.attribute">ranking.matchPhase.diversity.attribute</a> the attribute to use to guarantee diversity.</li> - <li><a href="#ranking.matchPhase.diversity.minGroups">ranking.matchPhase.diversity.minGroups</a> the minimum number of groups grouped by the diversity attribute.</li> - </ul> - </dd> - - - <h3 id="ranking.matchPhase.maxHits">ranking.matchPhase.maxHits</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>long</td></tr> - <tr><td>Default</td><td>If sorting and not ranking: max(10000, maxhits+maxoffset). - Otherwise: <em>none</em>.</td></tr> - </table> - <p> - The max hits the engine should attempt to produce in the match phase on each partition. - If it is determined during matching that many more hits than this will be generated, the matching will fall back to - take the best (highest or lowest) values of the attribute given by ranking.matchPhase.attribute. - </p><p> - By default, this will be turned on only when sorting is used and grouping is not. - If sorting is used, the primary sort attribute will be used as the match phase attribute if it has fast-search set. - In that case the default can be overridden by setting this value explicitly. - </p> - - - <h3 id="ranking.matchPhase.attribute">ranking.matchPhase.attribute</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>An attribute name</td></tr> - <tr><td>Default</td><td><em>none</em></td></tr> - </table> - <p> - The attribute to decide which documents are a match if the match phase - estimates that there will be more than maxHits matches. - This attribute should have fast-search set and should correlate with the order - which would be produced by a full evaluation. - </p> - - - <h3 id="ranking.matchPhase.ascending">ranking.matchPhase.ascending</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>boolean</td></tr> - <tr><td>Default</td><td>false</td></tr> - </table> - <p> - Whether the attribute should be sorted in ascending or descending (default) order - to determine which documents to keep as matches. - </p> - - - <h3 id="ranking.matchPhase.diversity.attribute">ranking.matchPhase.diversity.attribute</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>An attribute name</td></tr> - <tr><td>Default</td><td>none.</td></tr> - </table> - <p> - The attribute to be used for producing the desired diversity. - Also see <a href="search-definitions-reference.html#diversity-attribute">attribute</a>. - </p> - - - <h3 id="ranking.matchPhase.diversity.minGroups">ranking.matchPhase.diversity.minGroups</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>long</td></tr> - <tr><td>Default</td><td>none</td></tr> - </table> - <p> - The minimum number of groups that should be returned from the match phase grouped by the diversity attribute. - Also see <a href="search-definitions-reference.html#diversity-min-groups">min-groups</a>. - </p> - - - - <h2 id="presentation">Presentation</h2> - - <h3 id="presentation.bolding">presentation.bolding [<em>bolding</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>bolding</td></tr> - <tr><td>Values</td><td>boolean</td></tr> - <tr><td>Default</td><td>true</td></tr> - </table> - <p> - Whether or not to bold search terms in <a href="search-definitions-reference.html">search definition</a> - fields defined with <a href="search-definitions-reference.html#bolding">bolding: on</a> - or <a href="search-definitions-reference.html#summary">summary: dynamic</a>. - </p> - - - <h3 id="presentation.format">presentation.format [<em>format</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>format</td></tr> - <tr><td>Values</td><td> - <table class="table table-striped"> - <tr> - <td><em>No value</em> or <code><a href="default-result-format.html">default</a></code></td> - <td>The default, builtin JSON format</td> - </tr> - <tr> - <td><code><a href="default-result-format.html">json</a></code></td> - <td>Builtin JSON format</td> - </tr> - <tr> - <td><code>xml</code></td> - <td>Deprecated, builtin XML format</td> - </tr> - <tr> - <td><code><a href="page-result-format.html">page</a></code></td> - <td>Alternative deprecated XML format which is suitable for use with <a href="../page-templates.html">page templates</a>.</td> - </tr> - <tr> - <td><em>Any other value</em></td> - <td>A custom <a href="../result-rendering.html">result renderer</a> supplied by the application - </tr> - </table> - - </td></tr> - <tr><td>Default</td><td>default</td></tr> - </table> - - - <h3 id="presentation.summary">presentation.summary [<em>summary</em>]</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td>summary</td></tr> - <tr><td>Values</td><td> - The name of the <a href="../document-summaries.html#summary-classes-in-queries">summary class</a> - used to select fields in results. - </td></tr> - <tr><td>Default</td><td>The default summary class of the search definition.</td></tr> - </table> - - - <h3 id="presentation.template">presentation.template</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>Any id specification of a deployed page template.</td></tr> - <tr><td>Default</td><td></td></tr> - </table> - <p> - The id of the page template to use for this result. This should be used with the - <a href="page-result-format.html">page</a> result format. - </p> - - - <h3 id="presentation.timing">presentation.timing</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>boolean</td></tr> - <tr><td>Default</td><td>false</td></tr> - </table> - <p> - Whether a result renderer should try to add optional timing information - to the rendered page. - </p> - - - - <h2 id="">Grouping and Aggregation</h2> - - <h3 id="select">select</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>A valid grouping specification.</td></tr> - <tr><td>Default</td><td>No grouping</td></tr> - </table> - <p> - Requests specific multi-level result set statistics and/or hit groups to be returned in the result. - Fields you want to retrieve statistics or hit groups for must be stored as document attributes - in the index structure by adding attribute to the indexing statement. - See the <a href="../grouping.html">grouping guide</a>. - </p> - - - <h3 id="collapsefield">collapsefield</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>Any document summary field name</td></tr> - <tr><td>Default</td><td>No field collapsing</td></tr> - </table> - <p> - Collapse (i.e. aggregate) results using this field. - Collapsing is run in the container, not content node level. - Define a <em>collapsefield</em> to remove duplicates if the corpus has few duplicates - - this is more efficient than using <a href="#select">grouping</a>. - Otherwise, use grouping. - </p> - - - <h3 id="collapsesize">collapsesize</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>A positive integer</td></tr> - <tr><td>Default</td><td>1</td></tr> - </table> - <p>The number of hits to keep in each collapsed bucket</p> - - - <h3 id="collapse.summary">collapse.summary</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>A valid name of a document summary class.</td></tr> - <tr><td>Default</td><td>Use default summary or attributes.</td></tr> - </table> - <p>Use this summary class to fetch the field used for collapsing.</p> - - - - <h2 id="geographical-searches">Geographical Searches</h2> - - <h3 id="pos.ll">pos.ll</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td> - <td>Position given in latitude and longitude - example: <em>S22.4532;W123.9887</em> - Refer to <a href="search-definitions-reference.html#type:position">position field</a> - for format specification.</td> - </tr> - <tr><td>Default</td><td>None</td></tr> - </table> - - - <h3 id="pos.radius">pos.radius</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td> - Radius of the circle used for filtering. Valid units of measurement are km, m and mi. Examples: - <ul> - <li>pos.radius=100m</li> - <li>pos.radius=42mi</li> - <li>pos.radius=4km</li> - </ul> - One can also specify just a number (internal units, micro-degrees), but this is not recommended. - </td></tr> - <tr><td>Default</td><td>50km</td></tr> - </table> - - - <h3 id="pos.bb">pos.bb</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td> - Bounding box for positions, given as latitude and longitude boundaries. - The four boundaries must be specified as N, S, E, W, with degrees as - a decimal fraction. Degrees south of equator or west of Greenwich are - input as negative numbers. Examples: - <ul> - <li>n=37.44899,s=37.3323,e=-121.98241,w=-122.06566</li> - <li>s=40.183868,w=-74.819519,n=40.248291,e=-74.728798</li> - </ul> - </td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - - - <h3 id="pos.attribute">pos.attribute</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>Any attribute that has zcurve encoded positions as a long attribute.</td></tr> - <tr><td>Default</td><td>Random choice among the ones declared as position in the searchdefinition.</td></tr> - </table> - <p> - Which attribute to use for the position. Can be both single- or multi-value. - </p> - - - - <h2 id="">Streaming Search</h2> - <p> - The features in this section applies to <a href="../streaming-search.html">streaming search</a> only. - </p> - - <h3 id="streaming.userid">streaming.userid</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>An integer in decimal notation in the range [0, 2^64></td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - <p> - Restricts streaming search to only stream through documents with document ids having the n=<number> - modifier and the userid part matches the supplied value. This can be used for grouping documents on a 64 bit integer. - </p> - - - <h3 id="streaming.groupname">streaming.groupname</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>A string</td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - <p> - Restricts streaming search to only stream through documents with document ids having the g=<groupname> - modifier and the groupname part matches the supplied value. This can be used for grouping documents on a string. - </p> - - - <h3 id="streaming.selection">streaming.selection</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>A string</td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - <p> - Restricts streaming search using a <a href="document-select-language.html">document selection</a>. - This can be used for selecting a subset of documents based on an advanced expression. - </p> - - - <h3 id="streaming.priority">streaming.priority</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td><a href="services.html#load-types">Priority class</a></td></tr> - <tr><td>Default</td><td>VERY_HIGH</td></tr> - </table> - <p> - Priority of the streaming search visitor. Having a high priority visitor helps maintain low latencies - even when the system is under load. - </p> - - - <h3 id="streaming.maxbucketspervisitor">streaming.maxbucketspervisitor</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>int</td></tr> - <tr><td>Default</td><td>1 (if ordering is set), or infinite</td></tr> - </table> - <p> - If set, visit only this many buckets at a time. - Combine with ordering to reduce visiting time for large users/groups. - </p> - - - - <h2 id="semantic-rules">Semantic Rules</h2> - <p> - Refer to <a href="semantic-rules.html">semantic rules</a>. - </p> - - <h3 id="rules.off">rules.off</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>Boolean</td></tr> - <tr><td>Default</td><td>True</td></tr> - </table> - <p>Turn rule evaluation off for this query</p> - - - <h3 id="rules.rulebase">rules.rulebase</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>String</td></tr> - <tr><td>Default</td><td>A rule base name</td></tr> - </table> - <p>The name of the rule base to use for these queries</p> - - - <h3 id="tracelevel.rules">tracelevel.rules</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>int</td></tr> - <tr><td>Default</td><td>1-5 (?)</td></tr> - </table> - <p> - The amount of rule evaluation trace output to show, higher number means more details. - This is useful to see a trace from rule evaluation - without having to see trace from all other searchers at the same time. - </p> - - - - <h2 id="other">Other</h2> - - <h3 id="recall">recall</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>Any allowed collection of recall terms</td></tr> - <tr><td>Default</td><td>No recall</td></tr> - </table> - <p> - Sets a recall parameter to be combined with the query. - This is identical to <a href="#model.filter">filter</a>, - except that recall terms are not exposed to the ranking framework and thus not ranked. - As such, one can not use unprefixed terms; they must either by positive or negative. - </p> - - - <h3 id="user">user</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>A string</td></tr> - <tr><td>Default</td><td>None</td></tr> - </table> - <p> - The id of the user making the query. The contents of the argument are made available to the search chain, - but it triggers no features in Vespa apart from being propagated to the access log. - </p> - - - <h3 id="nocachewrite">nocachewrite</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>Boolean</td></tr> - <tr><td>Default</td><td>False</td></tr> - </table> - <p>Set to true to avoid the result being written to cache when fetched.</p> - - - <h3 id="hitcountestimate">hitcountestimate</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>Boolean</td></tr> - <tr><td>Default</td><td>False</td></tr> - </table> - <p>Make this an estimation query. - No hits will be returned, and total hit count will be set to an estimate of what executing - the query as a normal query would give. - </p> - - <h3 id="metrics.ignore">metrics.ignore</h3> - <table class="table table-striped"> - <tr><td>Alias</td><td></td></tr> - <tr><td>Values</td><td>Boolean</td></tr> - <tr><td>Default</td><td>False</td></tr> - </table> - <p>Ignore metric collection for this query request, useful for warm up queries</p> - - - </div> - - </div> -</div> - -</body> -</html> diff --git a/container-search-gui/src/main/resources/gui/icons/android-chrome-192x192.png b/container-search-gui/src/main/resources/gui/icons/android-chrome-192x192.png Binary files differindex af80e645b77..2e2d8952f86 100644 --- a/container-search-gui/src/main/resources/gui/icons/android-chrome-192x192.png +++ b/container-search-gui/src/main/resources/gui/icons/android-chrome-192x192.png diff --git a/container-search-gui/src/main/resources/gui/icons/android-chrome-512x512.png b/container-search-gui/src/main/resources/gui/icons/android-chrome-512x512.png Binary files differnew file mode 100644 index 00000000000..14724b65b30 --- /dev/null +++ b/container-search-gui/src/main/resources/gui/icons/android-chrome-512x512.png diff --git a/container-search-gui/src/main/resources/gui/icons/apple-touch-icon.png b/container-search-gui/src/main/resources/gui/icons/apple-touch-icon.png Binary files differindex 4dfc9a85a2a..402b914a17a 100644 --- a/container-search-gui/src/main/resources/gui/icons/apple-touch-icon.png +++ b/container-search-gui/src/main/resources/gui/icons/apple-touch-icon.png diff --git a/container-search-gui/src/main/resources/gui/icons/browserconfig.xml b/container-search-gui/src/main/resources/gui/icons/browserconfig.xml index efa70aac49b..6a1d00efa0e 100644 --- a/container-search-gui/src/main/resources/gui/icons/browserconfig.xml +++ b/container-search-gui/src/main/resources/gui/icons/browserconfig.xml @@ -1,10 +1,9 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. --> <browserconfig> <msapplication> <tile> <square150x150logo src="/icons/mstile-150x150.png"/> - <TileColor>#2b5797</TileColor> + <TileColor>#da532c</TileColor> </tile> </msapplication> </browserconfig> diff --git a/container-search-gui/src/main/resources/gui/icons/favicon-16x16.png b/container-search-gui/src/main/resources/gui/icons/favicon-16x16.png Binary files differindex cce56472694..5cc83a38dba 100644 --- a/container-search-gui/src/main/resources/gui/icons/favicon-16x16.png +++ b/container-search-gui/src/main/resources/gui/icons/favicon-16x16.png diff --git a/container-search-gui/src/main/resources/gui/icons/favicon-32x32.png b/container-search-gui/src/main/resources/gui/icons/favicon-32x32.png Binary files differindex 5f9f3e1b85b..dfe72c4aa0a 100644 --- a/container-search-gui/src/main/resources/gui/icons/favicon-32x32.png +++ b/container-search-gui/src/main/resources/gui/icons/favicon-32x32.png diff --git a/container-search-gui/src/main/resources/gui/icons/favicon.ico b/container-search-gui/src/main/resources/gui/icons/favicon.ico Binary files differindex 885fb77541d..52564baa44d 100644 --- a/container-search-gui/src/main/resources/gui/icons/favicon.ico +++ b/container-search-gui/src/main/resources/gui/icons/favicon.ico diff --git a/container-search-gui/src/main/resources/gui/icons/manifest.json b/container-search-gui/src/main/resources/gui/icons/manifest.json index f71a0007cf4..5b2f3618461 100644 --- a/container-search-gui/src/main/resources/gui/icons/manifest.json +++ b/container-search-gui/src/main/resources/gui/icons/manifest.json @@ -1,5 +1,6 @@ { "name": "", + "short_name": "", "icons": [ { "src": "/icons/android-chrome-192x192.png", @@ -7,12 +8,12 @@ "type": "image/png" }, { - "src": "/icons/android-chrome-384x384.png", - "sizes": "384x384", + "src": "/icons/android-chrome-512x512.png", + "sizes": "512x512", "type": "image/png" } ], "theme_color": "#ffffff", "background_color": "#ffffff", "display": "standalone" -}
\ No newline at end of file +} diff --git a/container-search-gui/src/main/resources/gui/icons/mstile-144x144.png b/container-search-gui/src/main/resources/gui/icons/mstile-144x144.png Binary files differnew file mode 100644 index 00000000000..9eacb6051d8 --- /dev/null +++ b/container-search-gui/src/main/resources/gui/icons/mstile-144x144.png diff --git a/container-search-gui/src/main/resources/gui/icons/mstile-150x150.png b/container-search-gui/src/main/resources/gui/icons/mstile-150x150.png Binary files differindex 15ba5c1404e..736a5ca47d4 100644 --- a/container-search-gui/src/main/resources/gui/icons/mstile-150x150.png +++ b/container-search-gui/src/main/resources/gui/icons/mstile-150x150.png diff --git a/container-search-gui/src/main/resources/gui/icons/mstile-310x150.png b/container-search-gui/src/main/resources/gui/icons/mstile-310x150.png Binary files differnew file mode 100644 index 00000000000..0542b761ba4 --- /dev/null +++ b/container-search-gui/src/main/resources/gui/icons/mstile-310x150.png diff --git a/container-search-gui/src/main/resources/gui/icons/mstile-310x310.png b/container-search-gui/src/main/resources/gui/icons/mstile-310x310.png Binary files differnew file mode 100644 index 00000000000..5fc7990af48 --- /dev/null +++ b/container-search-gui/src/main/resources/gui/icons/mstile-310x310.png diff --git a/container-search-gui/src/main/resources/gui/icons/mstile-70x70.png b/container-search-gui/src/main/resources/gui/icons/mstile-70x70.png Binary files differnew file mode 100644 index 00000000000..4064cb227c4 --- /dev/null +++ b/container-search-gui/src/main/resources/gui/icons/mstile-70x70.png diff --git a/container-search-gui/src/main/resources/gui/icons/safari-pinned-tab.svg b/container-search-gui/src/main/resources/gui/icons/safari-pinned-tab.svg index 7b775fcdbde..5589b2f5ed6 100644 --- a/container-search-gui/src/main/resources/gui/icons/safari-pinned-tab.svg +++ b/container-search-gui/src/main/resources/gui/icons/safari-pinned-tab.svg @@ -2,21 +2,23 @@ <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"> <svg version="1.0" xmlns="http://www.w3.org/2000/svg" - width="464.000000pt" height="464.000000pt" viewBox="0 0 464.000000 464.000000" + width="700.000000pt" height="700.000000pt" viewBox="0 0 700.000000 700.000000" preserveAspectRatio="xMidYMid meet"> <metadata> -Created by potrace 1.11, written by Peter Selinger 2001-2013 +Created by potrace 1.14, written by Peter Selinger 2001-2017 </metadata> -<g transform="translate(0.000000,464.000000) scale(0.100000,-0.100000)" +<g transform="translate(0.000000,700.000000) scale(0.100000,-0.100000)" fill="#000000" stroke="none"> -<path d="M2559 4542 c-129 -88 -531 -360 -599 -406 -25 -17 -49 -34 -55 -38 --5 -5 -26 -19 -45 -31 -35 -23 -183 -124 -761 -517 -68 -46 -144 -97 -169 --114 -25 -16 -46 -31 -48 -32 -2 -1 -4 -126 -4 -278 l1 -276 -27 18 c-15 11 --148 104 -297 209 -148 104 -294 206 -323 226 l-52 37 0 -1052 1 -1053 627 --425 c919 -624 937 -636 1056 -717 l109 -75 196 133 c603 409 710 482 1061 -721 146 99 327 221 402 271 l137 92 3 277 3 277 285 -201 c157 -110 313 -220 -348 -245 l62 -44 0 1053 -1 1053 -92 62 c-50 34 -144 97 -207 140 -63 43 -214 -146 -335 228 -121 82 -431 292 -688 467 -258 175 -469 318 -471 318 -1 0 -54 --35 -117 -78z"/> +<path d="M3820 6438 c-74 -50 -189 -128 -255 -173 -66 -45 -203 -138 -305 +-207 -325 -220 -883 -599 -1220 -828 -77 -52 -209 -142 -295 -200 l-155 -105 +-2 -363 -3 -362 -454 320 c-250 176 -455 320 -457 320 -2 0 -4 -623 -4 -1384 +l0 -1384 262 -178 c145 -98 304 -205 353 -239 50 -34 169 -115 265 -180 96 +-65 216 -146 265 -180 84 -57 163 -111 645 -438 102 -70 271 -185 377 -257 +105 -71 194 -130 198 -130 6 0 161 104 530 355 66 45 212 145 325 221 113 76 +315 213 448 304 133 91 322 219 420 285 97 66 247 168 332 226 85 58 191 130 +235 160 l80 54 0 362 c0 200 1 363 3 363 4 0 45 -29 503 -352 207 -147 386 +-271 398 -277 l21 -12 0 1384 0 1383 -247 168 c-137 92 -369 250 -518 351 +-148 101 -394 267 -545 370 -151 103 -358 243 -460 312 -102 69 -268 182 -370 +251 -102 69 -192 131 -201 139 -8 7 -20 13 -25 13 -5 0 -70 -41 -144 -92z"/> </g> </svg> diff --git a/container-search-gui/src/main/resources/gui/img/Vespa-V2.png b/container-search-gui/src/main/resources/gui/img/Vespa-V2.png Binary files differdeleted file mode 100644 index ac87f8e94d0..00000000000 --- a/container-search-gui/src/main/resources/gui/img/Vespa-V2.png +++ /dev/null diff --git a/container-search-gui/src/main/resources/gui/img/VespaIcon.png b/container-search-gui/src/main/resources/gui/img/VespaIcon.png Binary files differdeleted file mode 100644 index 33063432c20..00000000000 --- a/container-search-gui/src/main/resources/gui/img/VespaIcon.png +++ /dev/null diff --git a/container-search-gui/src/main/resources/gui/img/information.svg b/container-search-gui/src/main/resources/gui/img/information.svg deleted file mode 100644 index da42cf2caf6..00000000000 --- a/container-search-gui/src/main/resources/gui/img/information.svg +++ /dev/null @@ -1,10 +0,0 @@ -<?xml version="1.0"?> -<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Capa_1" x="0px" y="0px" viewBox="0 0 512 512" style="enable-background:new 0 0 512 512;" xml:space="preserve" width="512px" height="512px"><g><g> - <g> - <g> - <circle cx="256" cy="378.5" r="25" data-original="#000000" class="active-path" data-old_color="#898989" fill="#767474"/> - <path d="M256,0C114.516,0,0,114.497,0,256c0,141.484,114.497,256,256,256c141.484,0,256-114.497,256-256 C512,114.516,397.503,0,256,0z M256,472c-119.377,0-216-96.607-216-216c0-119.377,96.607-216,216-216 c119.377,0,216,96.607,216,216C472,375.377,375.393,472,256,472z" data-original="#000000" class="active-path" data-old_color="#898989" fill="#767474"/> - <path d="M256,128.5c-44.112,0-80,35.888-80,80c0,11.046,8.954,20,20,20s20-8.954,20-20c0-22.056,17.944-40,40-40 c22.056,0,40,17.944,40,40c0,22.056-17.944,40-40,40c-11.046,0-20,8.954-20,20v50c0,11.046,8.954,20,20,20 c11.046,0,20-8.954,20-20v-32.531c34.466-8.903,60-40.26,60-77.469C336,164.388,300.112,128.5,256,128.5z" data-original="#000000" class="active-path" data-old_color="#898989" fill="#767474"/> - </g> - </g> -</g></g> </svg> diff --git a/container-search-gui/src/main/resources/gui/img/reload.svg b/container-search-gui/src/main/resources/gui/img/reload.svg deleted file mode 100644 index c5381f9f232..00000000000 --- a/container-search-gui/src/main/resources/gui/img/reload.svg +++ /dev/null @@ -1,6 +0,0 @@ -<?xml version="1.0"?> -<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0px" y="0px" viewBox="0 0 512 512" style="enable-background:new 0 0 512 512;" xml:space="preserve" width="512px" height="512px" class=""><g><g> - <g> - <path d="M482.195,226.196C482.195,101.471,380.725,0,256.001,0S29.805,101.471,29.805,226.196c0,7.409,6.007,13.416,13.416,13.416 s13.416-6.008,13.416-13.416c0-109.93,89.434-199.363,199.363-199.363s199.363,89.434,199.363,199.363 c0,109.928-89.434,199.362-199.363,199.362h-23.276l33.282-37.255c4.937-5.525,4.458-14.007-1.067-18.944 c-5.525-4.937-14.008-4.457-18.944,1.068l-47.576,53.255c-7.788,8.718-7.788,21.866,0,30.584l47.576,53.255 c2.651,2.968,6.322,4.478,10.01,4.478c3.181,0,6.375-1.126,8.934-3.41c5.526-4.937,6.004-13.419,1.067-18.944l-33.282-37.255 h23.276C380.725,452.39,482.195,350.919,482.195,226.196z" data-original="#000000" class="active-path" data-old_color="#F0EDED" fill="#F3F2F2"/> - </g> -</g></g> </svg> |