1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
|
<!DOCTYPE html>
<!-- Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -->
<html lang="en">
<head>
<!-- Copyright 2017 Yahoo Holdings. 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 2017 Yahoo Holdings. 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 2017 Yahoo Holdings. 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-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>
|
