2
0

QueryNodeSingleSearch.Builder.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.18) on Fri Apr 19 15:06:25 CST 2024 -->
  6. <title>QueryNodeSingleSearch.Builder</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2024-04-19">
  9. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
  11. <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
  12. <script type="text/javascript" src="../../../script.js"></script>
  13. <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
  14. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  15. <!--[if IE]>
  16. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  17. <![endif]-->
  18. <script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script>
  19. <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
  20. </head>
  21. <body>
  22. <script type="text/javascript"><!--
  23. try {
  24. if (location.href.indexOf('is-external=true') == -1) {
  25. parent.document.title="QueryNodeSingleSearch.Builder";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
  32. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  33. var altColor = "altColor";
  34. var rowColor = "rowColor";
  35. var tableTab = "tableTab";
  36. var activeTableTab = "activeTableTab";
  37. var pathtoroot = "../../../";
  38. var useModuleDirectories = true;
  39. loadScripts(document, 'script');</script>
  40. <noscript>
  41. <div>JavaScript is disabled on your browser.</div>
  42. </noscript>
  43. <header role="banner">
  44. <nav role="navigation">
  45. <div class="fixedNav">
  46. <!-- ========= START OF TOP NAVBAR ======= -->
  47. <div class="topNav"><a id="navbar.top">
  48. <!-- -->
  49. </a>
  50. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  51. <a id="navbar.top.firstrow">
  52. <!-- -->
  53. </a>
  54. <ul class="navList" title="Navigation">
  55. <li><a href="../../../index.html">Overview</a></li>
  56. <li><a href="package-summary.html">Package</a></li>
  57. <li class="navBarCell1Rev">Class</li>
  58. <li><a href="package-tree.html">Tree</a></li>
  59. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  60. <li><a href="../../../index-files/index-1.html">Index</a></li>
  61. <li><a href="../../../help-doc.html">Help</a></li>
  62. </ul>
  63. </div>
  64. <div class="subNav">
  65. <ul class="navList" id="allclasses_navbar_top">
  66. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  67. </ul>
  68. <ul class="navListSearch">
  69. <li><label for="search">SEARCH:</label>
  70. <input type="text" id="search" value="search" disabled="disabled">
  71. <input type="reset" id="reset" value="reset" disabled="disabled">
  72. </li>
  73. </ul>
  74. <div>
  75. <script type="text/javascript"><!--
  76. allClassesLink = document.getElementById("allclasses_navbar_top");
  77. if(window==top) {
  78. allClassesLink.style.display = "block";
  79. }
  80. else {
  81. allClassesLink.style.display = "none";
  82. }
  83. //-->
  84. </script>
  85. <noscript>
  86. <div>JavaScript is disabled on your browser.</div>
  87. </noscript>
  88. </div>
  89. <div>
  90. <ul class="subNavList">
  91. <li>Summary:&nbsp;</li>
  92. <li>Nested&nbsp;|&nbsp;</li>
  93. <li>Field&nbsp;|&nbsp;</li>
  94. <li>Constr&nbsp;|&nbsp;</li>
  95. <li><a href="#method.summary">Method</a></li>
  96. </ul>
  97. <ul class="subNavList">
  98. <li>Detail:&nbsp;</li>
  99. <li>Field&nbsp;|&nbsp;</li>
  100. <li>Constr&nbsp;|&nbsp;</li>
  101. <li><a href="#method.detail">Method</a></li>
  102. </ul>
  103. </div>
  104. <a id="skip.navbar.top">
  105. <!-- -->
  106. </a></div>
  107. <!-- ========= END OF TOP NAVBAR ========= -->
  108. </div>
  109. <div class="navPadding">&nbsp;</div>
  110. <script type="text/javascript"><!--
  111. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  112. //-->
  113. </script>
  114. </nav>
  115. </header>
  116. <!-- ======== START OF CLASS DATA ======== -->
  117. <main role="main">
  118. <div class="header">
  119. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.param</a></div>
  120. <h2 title="Class QueryNodeSingleSearch.Builder" class="title">Class QueryNodeSingleSearch.Builder</h2>
  121. </div>
  122. <div class="contentContainer">
  123. <ul class="inheritance">
  124. <li>java.lang.Object</li>
  125. <li>
  126. <ul class="inheritance">
  127. <li>io.milvus.param.QueryNodeSingleSearch.Builder</li>
  128. </ul>
  129. </li>
  130. </ul>
  131. <div class="description">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <dl>
  135. <dt>Enclosing class:</dt>
  136. <dd><a href="QueryNodeSingleSearch.html" title="class in io.milvus.param">QueryNodeSingleSearch</a></dd>
  137. </dl>
  138. <hr>
  139. <pre>public static class <span class="typeNameLabel">QueryNodeSingleSearch.Builder</span>
  140. extends java.lang.Object</pre>
  141. <div class="block">Builder for <a href="QueryNodeSingleSearch.html" title="class in io.milvus.param"><code>QueryNodeSingleSearch</code></a></div>
  142. </li>
  143. </ul>
  144. </div>
  145. <div class="summary">
  146. <ul class="blockList">
  147. <li class="blockList">
  148. <!-- ========== METHOD SUMMARY =========== -->
  149. <section>
  150. <ul class="blockList">
  151. <li class="blockList"><a id="method.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Method Summary</h3>
  155. <table class="memberSummary">
  156. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  157. <tr>
  158. <th class="colFirst" scope="col">Modifier and Type</th>
  159. <th class="colSecond" scope="col">Method</th>
  160. <th class="colLast" scope="col">Description</th>
  161. </tr>
  162. <tr id="i0" class="altColor">
  163. <td class="colFirst"><code><a href="QueryNodeSingleSearch.html" title="class in io.milvus.param">QueryNodeSingleSearch</a></code></td>
  164. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
  165. <td class="colLast">
  166. <div class="block">Verifies parameters and creates a new <a href="QueryNodeSingleSearch.html" title="class in io.milvus.param"><code>QueryNodeSingleSearch</code></a> instance.</div>
  167. </td>
  168. </tr>
  169. <tr id="i1" class="rowColor">
  170. <td class="colFirst"><code><a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a></code></td>
  171. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withCollectionName(java.lang.String)">withCollectionName</a></span>&#8203;(@NonNull java.lang.String&nbsp;collectionName)</code></th>
  172. <td class="colLast">
  173. <div class="block">Sets the collection name.</div>
  174. </td>
  175. </tr>
  176. <tr id="i2" class="altColor">
  177. <td class="colFirst"><code><a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a></code></td>
  178. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withMetricType(io.milvus.param.MetricType)">withMetricType</a></span>&#8203;(@NonNull <a href="MetricType.html" title="enum in io.milvus.param">MetricType</a>&nbsp;metricType)</code></th>
  179. <td class="colLast">
  180. <div class="block">Sets metric type of ANN searching.</div>
  181. </td>
  182. </tr>
  183. <tr id="i3" class="rowColor">
  184. <td class="colFirst"><code><a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a></code></td>
  185. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withParams(java.lang.String)">withParams</a></span>&#8203;(@NonNull java.lang.String&nbsp;params)</code></th>
  186. <td class="colLast">
  187. <div class="block">Sets the search parameters specific to the index type.</div>
  188. </td>
  189. </tr>
  190. <tr id="i4" class="altColor">
  191. <td class="colFirst"><code><a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a></code></td>
  192. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withVectorFieldName(java.lang.String)">withVectorFieldName</a></span>&#8203;(@NonNull java.lang.String&nbsp;vectorFieldName)</code></th>
  193. <td class="colLast">
  194. <div class="block">Sets target vector field by name.</div>
  195. </td>
  196. </tr>
  197. <tr id="i5" class="rowColor">
  198. <td class="colFirst"><code><a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a></code></td>
  199. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withVectors(java.util.List)">withVectors</a></span>&#8203;(@NonNull java.util.List&lt;?&gt;&nbsp;vectors)</code></th>
  200. <td class="colLast">
  201. <div class="block">Sets the target vectors.</div>
  202. </td>
  203. </tr>
  204. </table>
  205. <ul class="blockList">
  206. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  207. <!-- -->
  208. </a>
  209. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  210. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  211. </ul>
  212. </li>
  213. </ul>
  214. </section>
  215. </li>
  216. </ul>
  217. </div>
  218. <div class="details">
  219. <ul class="blockList">
  220. <li class="blockList">
  221. <!-- ============ METHOD DETAIL ========== -->
  222. <section>
  223. <ul class="blockList">
  224. <li class="blockList"><a id="method.detail">
  225. <!-- -->
  226. </a>
  227. <h3>Method Detail</h3>
  228. <a id="withCollectionName(java.lang.String)">
  229. <!-- -->
  230. </a>
  231. <ul class="blockList">
  232. <li class="blockList">
  233. <h4>withCollectionName</h4>
  234. <pre class="methodSignature">public&nbsp;<a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a>&nbsp;withCollectionName&#8203;(@NonNull
  235. @NonNull java.lang.String&nbsp;collectionName)</pre>
  236. <div class="block">Sets the collection name. Collection name cannot be empty or null.</div>
  237. <dl>
  238. <dt><span class="paramLabel">Parameters:</span></dt>
  239. <dd><code>collectionName</code> - collection name</dd>
  240. <dt><span class="returnLabel">Returns:</span></dt>
  241. <dd><code>Builder</code></dd>
  242. </dl>
  243. </li>
  244. </ul>
  245. <a id="withMetricType(io.milvus.param.MetricType)">
  246. <!-- -->
  247. </a>
  248. <ul class="blockList">
  249. <li class="blockList">
  250. <h4>withMetricType</h4>
  251. <pre class="methodSignature">public&nbsp;<a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a>&nbsp;withMetricType&#8203;(@NonNull
  252. @NonNull <a href="MetricType.html" title="enum in io.milvus.param">MetricType</a>&nbsp;metricType)</pre>
  253. <div class="block">Sets metric type of ANN searching.</div>
  254. <dl>
  255. <dt><span class="paramLabel">Parameters:</span></dt>
  256. <dd><code>metricType</code> - metric type</dd>
  257. <dt><span class="returnLabel">Returns:</span></dt>
  258. <dd><code>Builder</code></dd>
  259. </dl>
  260. </li>
  261. </ul>
  262. <a id="withVectorFieldName(java.lang.String)">
  263. <!-- -->
  264. </a>
  265. <ul class="blockList">
  266. <li class="blockList">
  267. <h4>withVectorFieldName</h4>
  268. <pre class="methodSignature">public&nbsp;<a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a>&nbsp;withVectorFieldName&#8203;(@NonNull
  269. @NonNull java.lang.String&nbsp;vectorFieldName)</pre>
  270. <div class="block">Sets target vector field by name. Field name cannot be empty or null.</div>
  271. <dl>
  272. <dt><span class="paramLabel">Parameters:</span></dt>
  273. <dd><code>vectorFieldName</code> - vector field name</dd>
  274. <dt><span class="returnLabel">Returns:</span></dt>
  275. <dd><code>Builder</code></dd>
  276. </dl>
  277. </li>
  278. </ul>
  279. <a id="withVectors(java.util.List)">
  280. <!-- -->
  281. </a>
  282. <ul class="blockList">
  283. <li class="blockList">
  284. <h4>withVectors</h4>
  285. <pre class="methodSignature">public&nbsp;<a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a>&nbsp;withVectors&#8203;(@NonNull
  286. @NonNull java.util.List&lt;?&gt;&nbsp;vectors)</pre>
  287. <div class="block">Sets the target vectors.</div>
  288. <dl>
  289. <dt><span class="paramLabel">Parameters:</span></dt>
  290. <dd><code>vectors</code> - list of target vectors:
  291. if vector type is FloatVector, vectors is List of List Float
  292. if vector type is BinaryVector, vectors is List of ByteBuffer</dd>
  293. <dt><span class="returnLabel">Returns:</span></dt>
  294. <dd><code>Builder</code></dd>
  295. </dl>
  296. </li>
  297. </ul>
  298. <a id="withParams(java.lang.String)">
  299. <!-- -->
  300. </a>
  301. <ul class="blockList">
  302. <li class="blockList">
  303. <h4>withParams</h4>
  304. <pre class="methodSignature">public&nbsp;<a href="QueryNodeSingleSearch.Builder.html" title="class in io.milvus.param">QueryNodeSingleSearch.Builder</a>&nbsp;withParams&#8203;(@NonNull
  305. @NonNull java.lang.String&nbsp;params)</pre>
  306. <div class="block">Sets the search parameters specific to the index type.
  307. For example: IVF index, the search parameters can be "{\"nprobe\":10}"
  308. For more information: @see <a href="https://milvus.io/docs/v2.0.0/index_selection.md">Index Selection</a></div>
  309. <dl>
  310. <dt><span class="paramLabel">Parameters:</span></dt>
  311. <dd><code>params</code> - extra parameters in json format</dd>
  312. <dt><span class="returnLabel">Returns:</span></dt>
  313. <dd><code>Builder</code></dd>
  314. </dl>
  315. </li>
  316. </ul>
  317. <a id="build()">
  318. <!-- -->
  319. </a>
  320. <ul class="blockListLast">
  321. <li class="blockList">
  322. <h4>build</h4>
  323. <pre class="methodSignature">public&nbsp;<a href="QueryNodeSingleSearch.html" title="class in io.milvus.param">QueryNodeSingleSearch</a>&nbsp;build()
  324. throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  325. <div class="block">Verifies parameters and creates a new <a href="QueryNodeSingleSearch.html" title="class in io.milvus.param"><code>QueryNodeSingleSearch</code></a> instance.</div>
  326. <dl>
  327. <dt><span class="returnLabel">Returns:</span></dt>
  328. <dd><a href="QueryNodeSingleSearch.html" title="class in io.milvus.param"><code>QueryNodeSingleSearch</code></a></dd>
  329. <dt><span class="throwsLabel">Throws:</span></dt>
  330. <dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  331. </dl>
  332. </li>
  333. </ul>
  334. </li>
  335. </ul>
  336. </section>
  337. </li>
  338. </ul>
  339. </div>
  340. </div>
  341. </main>
  342. <!-- ========= END OF CLASS DATA ========= -->
  343. <footer role="contentinfo">
  344. <nav role="navigation">
  345. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  346. <div class="bottomNav"><a id="navbar.bottom">
  347. <!-- -->
  348. </a>
  349. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  350. <a id="navbar.bottom.firstrow">
  351. <!-- -->
  352. </a>
  353. <ul class="navList" title="Navigation">
  354. <li><a href="../../../index.html">Overview</a></li>
  355. <li><a href="package-summary.html">Package</a></li>
  356. <li class="navBarCell1Rev">Class</li>
  357. <li><a href="package-tree.html">Tree</a></li>
  358. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  359. <li><a href="../../../index-files/index-1.html">Index</a></li>
  360. <li><a href="../../../help-doc.html">Help</a></li>
  361. </ul>
  362. </div>
  363. <div class="subNav">
  364. <ul class="navList" id="allclasses_navbar_bottom">
  365. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  366. </ul>
  367. <div>
  368. <script type="text/javascript"><!--
  369. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  370. if(window==top) {
  371. allClassesLink.style.display = "block";
  372. }
  373. else {
  374. allClassesLink.style.display = "none";
  375. }
  376. //-->
  377. </script>
  378. <noscript>
  379. <div>JavaScript is disabled on your browser.</div>
  380. </noscript>
  381. </div>
  382. <div>
  383. <ul class="subNavList">
  384. <li>Summary:&nbsp;</li>
  385. <li>Nested&nbsp;|&nbsp;</li>
  386. <li>Field&nbsp;|&nbsp;</li>
  387. <li>Constr&nbsp;|&nbsp;</li>
  388. <li><a href="#method.summary">Method</a></li>
  389. </ul>
  390. <ul class="subNavList">
  391. <li>Detail:&nbsp;</li>
  392. <li>Field&nbsp;|&nbsp;</li>
  393. <li>Constr&nbsp;|&nbsp;</li>
  394. <li><a href="#method.detail">Method</a></li>
  395. </ul>
  396. </div>
  397. <a id="skip.navbar.bottom">
  398. <!-- -->
  399. </a></div>
  400. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  401. </nav>
  402. </footer>
  403. </body>
  404. </html>