SearchResultsWrapper.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_251) on Fri Jul 22 10:32:49 CST 2022 -->
  6. <title>SearchResultsWrapper</title>
  7. <meta name="date" content="2022-07-22">
  8. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="SearchResultsWrapper";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="package-tree.html">Tree</a></li>
  44. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  45. <li><a href="../../../index-files/index-1.html">Index</a></li>
  46. <li><a href="../../../help-doc.html">Help</a></li>
  47. </ul>
  48. </div>
  49. <div class="subNav">
  50. <ul class="navList">
  51. <li><a href="../../../io/milvus/response/QueryResultsWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../io/milvus/response/SearchResultsWrapper.IDScore.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53. </ul>
  54. <ul class="navList">
  55. <li><a href="../../../index.html?io/milvus/response/SearchResultsWrapper.html" target="_top">Frames</a></li>
  56. <li><a href="SearchResultsWrapper.html" target="_top">No&nbsp;Frames</a></li>
  57. </ul>
  58. <ul class="navList" id="allclasses_navbar_top">
  59. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  60. </ul>
  61. <div>
  62. <script type="text/javascript"><!--
  63. allClassesLink = document.getElementById("allclasses_navbar_top");
  64. if(window==top) {
  65. allClassesLink.style.display = "block";
  66. }
  67. else {
  68. allClassesLink.style.display = "none";
  69. }
  70. //-->
  71. </script>
  72. </div>
  73. <div>
  74. <ul class="subNavList">
  75. <li>Summary:&nbsp;</li>
  76. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  77. <li>Field&nbsp;|&nbsp;</li>
  78. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#method.summary">Method</a></li>
  80. </ul>
  81. <ul class="subNavList">
  82. <li>Detail:&nbsp;</li>
  83. <li>Field&nbsp;|&nbsp;</li>
  84. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  85. <li><a href="#method.detail">Method</a></li>
  86. </ul>
  87. </div>
  88. <a name="skip.navbar.top">
  89. <!-- -->
  90. </a></div>
  91. <!-- ========= END OF TOP NAVBAR ========= -->
  92. <!-- ======== START OF CLASS DATA ======== -->
  93. <div class="header">
  94. <div class="subTitle">io.milvus.response</div>
  95. <h2 title="Class SearchResultsWrapper" class="title">Class SearchResultsWrapper</h2>
  96. </div>
  97. <div class="contentContainer">
  98. <ul class="inheritance">
  99. <li>java.lang.Object</li>
  100. <li>
  101. <ul class="inheritance">
  102. <li>io.milvus.response.SearchResultsWrapper</li>
  103. </ul>
  104. </li>
  105. </ul>
  106. <div class="description">
  107. <ul class="blockList">
  108. <li class="blockList">
  109. <hr>
  110. <br>
  111. <pre>public class <span class="typeNameLabel">SearchResultsWrapper</span>
  112. extends java.lang.Object</pre>
  113. <div class="block">Utility class to wrap response of <code>search</code> interface.</div>
  114. </li>
  115. </ul>
  116. </div>
  117. <div class="summary">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <!-- ======== NESTED CLASS SUMMARY ======== -->
  121. <ul class="blockList">
  122. <li class="blockList"><a name="nested.class.summary">
  123. <!-- -->
  124. </a>
  125. <h3>Nested Class Summary</h3>
  126. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
  127. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
  128. <tr>
  129. <th class="colFirst" scope="col">Modifier and Type</th>
  130. <th class="colLast" scope="col">Class and Description</th>
  131. </tr>
  132. <tr class="altColor">
  133. <td class="colFirst"><code>static class&nbsp;</code></td>
  134. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/SearchResultsWrapper.IDScore.html" title="class in io.milvus.response">SearchResultsWrapper.IDScore</a></span></code>
  135. <div class="block">Internal-use class to wrap response of <code>search</code> interface.</div>
  136. </td>
  137. </tr>
  138. </table>
  139. </li>
  140. </ul>
  141. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  142. <ul class="blockList">
  143. <li class="blockList"><a name="constructor.summary">
  144. <!-- -->
  145. </a>
  146. <h3>Constructor Summary</h3>
  147. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  148. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  149. <tr>
  150. <th class="colOne" scope="col">Constructor and Description</th>
  151. </tr>
  152. <tr class="altColor">
  153. <td class="colOne"><code><span class="memberNameLink"><a href="../../../io/milvus/response/SearchResultsWrapper.html#SearchResultsWrapper-io.milvus.grpc.SearchResultData-">SearchResultsWrapper</a></span>(@NonNull io.milvus.grpc.SearchResultData&nbsp;results)</code>&nbsp;</td>
  154. </tr>
  155. </table>
  156. </li>
  157. </ul>
  158. <!-- ========== METHOD SUMMARY =========== -->
  159. <ul class="blockList">
  160. <li class="blockList"><a name="method.summary">
  161. <!-- -->
  162. </a>
  163. <h3>Method Summary</h3>
  164. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  165. <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>
  166. <tr>
  167. <th class="colFirst" scope="col">Modifier and Type</th>
  168. <th class="colLast" scope="col">Method and Description</th>
  169. </tr>
  170. <tr id="i0" class="altColor">
  171. <td class="colFirst"><code>java.util.List&lt;?&gt;</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/SearchResultsWrapper.html#getFieldData-java.lang.String-int-">getFieldData</a></span>(@NonNull java.lang.String&nbsp;fieldName,
  173. int&nbsp;indexOfTarget)</code>
  174. <div class="block">Gets data for an output field which is specified by search request.</div>
  175. </td>
  176. </tr>
  177. <tr id="i1" class="rowColor">
  178. <td class="colFirst"><code>java.util.List&lt;<a href="../../../io/milvus/response/SearchResultsWrapper.IDScore.html" title="class in io.milvus.response">SearchResultsWrapper.IDScore</a>&gt;</code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/SearchResultsWrapper.html#getIDScore-int-">getIDScore</a></span>(int&nbsp;indexOfTarget)</code>
  180. <div class="block">Gets ID-score pairs returned by search interface.</div>
  181. </td>
  182. </tr>
  183. </table>
  184. <ul class="blockList">
  185. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  186. <!-- -->
  187. </a>
  188. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  189. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  190. </ul>
  191. </li>
  192. </ul>
  193. </li>
  194. </ul>
  195. </div>
  196. <div class="details">
  197. <ul class="blockList">
  198. <li class="blockList">
  199. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  200. <ul class="blockList">
  201. <li class="blockList"><a name="constructor.detail">
  202. <!-- -->
  203. </a>
  204. <h3>Constructor Detail</h3>
  205. <a name="SearchResultsWrapper-io.milvus.grpc.SearchResultData-">
  206. <!-- -->
  207. </a>
  208. <ul class="blockListLast">
  209. <li class="blockList">
  210. <h4>SearchResultsWrapper</h4>
  211. <pre>public&nbsp;SearchResultsWrapper(@NonNull
  212. @NonNull io.milvus.grpc.SearchResultData&nbsp;results)</pre>
  213. </li>
  214. </ul>
  215. </li>
  216. </ul>
  217. <!-- ============ METHOD DETAIL ========== -->
  218. <ul class="blockList">
  219. <li class="blockList"><a name="method.detail">
  220. <!-- -->
  221. </a>
  222. <h3>Method Detail</h3>
  223. <a name="getFieldData-java.lang.String-int-">
  224. <!-- -->
  225. </a>
  226. <ul class="blockList">
  227. <li class="blockList">
  228. <h4>getFieldData</h4>
  229. <pre>public&nbsp;java.util.List&lt;?&gt;&nbsp;getFieldData(@NonNull
  230. @NonNull java.lang.String&nbsp;fieldName,
  231. int&nbsp;indexOfTarget)</pre>
  232. <div class="block">Gets data for an output field which is specified by search request.
  233. Throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the field doesn't exist.
  234. Throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the indexOfTarget is illegal.</div>
  235. <dl>
  236. <dt><span class="paramLabel">Parameters:</span></dt>
  237. <dd><code>fieldName</code> - field name to get output data</dd>
  238. <dd><code>indexOfTarget</code> - which target vector the field data belongs to</dd>
  239. <dt><span class="returnLabel">Returns:</span></dt>
  240. <dd><a href="../../../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response"><code>FieldDataWrapper</code></a></dd>
  241. </dl>
  242. </li>
  243. </ul>
  244. <a name="getIDScore-int-">
  245. <!-- -->
  246. </a>
  247. <ul class="blockListLast">
  248. <li class="blockList">
  249. <h4>getIDScore</h4>
  250. <pre>public&nbsp;java.util.List&lt;<a href="../../../io/milvus/response/SearchResultsWrapper.IDScore.html" title="class in io.milvus.response">SearchResultsWrapper.IDScore</a>&gt;&nbsp;getIDScore(int&nbsp;indexOfTarget)
  251. throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a>,
  252. <a href="../../../io/milvus/exception/IllegalResponseException.html" title="class in io.milvus.exception">IllegalResponseException</a></pre>
  253. <div class="block">Gets ID-score pairs returned by search interface.
  254. Throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the indexOfTarget is illegal.
  255. Throws <a href="../../../io/milvus/exception/IllegalResponseException.html" title="class in io.milvus.exception"><code>IllegalResponseException</code></a> if the returned results is illegal.</div>
  256. <dl>
  257. <dt><span class="paramLabel">Parameters:</span></dt>
  258. <dd><code>indexOfTarget</code> - which target vector the result belongs to</dd>
  259. <dt><span class="returnLabel">Returns:</span></dt>
  260. <dd>List of IDScore, ID-score pairs returned by search interface</dd>
  261. <dt><span class="throwsLabel">Throws:</span></dt>
  262. <dd><code><a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  263. <dd><code><a href="../../../io/milvus/exception/IllegalResponseException.html" title="class in io.milvus.exception">IllegalResponseException</a></code></dd>
  264. </dl>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. </li>
  270. </ul>
  271. </div>
  272. </div>
  273. <!-- ========= END OF CLASS DATA ========= -->
  274. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  275. <div class="bottomNav"><a name="navbar.bottom">
  276. <!-- -->
  277. </a>
  278. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  279. <a name="navbar.bottom.firstrow">
  280. <!-- -->
  281. </a>
  282. <ul class="navList" title="Navigation">
  283. <li><a href="../../../overview-summary.html">Overview</a></li>
  284. <li><a href="package-summary.html">Package</a></li>
  285. <li class="navBarCell1Rev">Class</li>
  286. <li><a href="package-tree.html">Tree</a></li>
  287. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  288. <li><a href="../../../index-files/index-1.html">Index</a></li>
  289. <li><a href="../../../help-doc.html">Help</a></li>
  290. </ul>
  291. </div>
  292. <div class="subNav">
  293. <ul class="navList">
  294. <li><a href="../../../io/milvus/response/QueryResultsWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  295. <li><a href="../../../io/milvus/response/SearchResultsWrapper.IDScore.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  296. </ul>
  297. <ul class="navList">
  298. <li><a href="../../../index.html?io/milvus/response/SearchResultsWrapper.html" target="_top">Frames</a></li>
  299. <li><a href="SearchResultsWrapper.html" target="_top">No&nbsp;Frames</a></li>
  300. </ul>
  301. <ul class="navList" id="allclasses_navbar_bottom">
  302. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  303. </ul>
  304. <div>
  305. <script type="text/javascript"><!--
  306. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  307. if(window==top) {
  308. allClassesLink.style.display = "block";
  309. }
  310. else {
  311. allClassesLink.style.display = "none";
  312. }
  313. //-->
  314. </script>
  315. </div>
  316. <div>
  317. <ul class="subNavList">
  318. <li>Summary:&nbsp;</li>
  319. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  320. <li>Field&nbsp;|&nbsp;</li>
  321. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  322. <li><a href="#method.summary">Method</a></li>
  323. </ul>
  324. <ul class="subNavList">
  325. <li>Detail:&nbsp;</li>
  326. <li>Field&nbsp;|&nbsp;</li>
  327. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  328. <li><a href="#method.detail">Method</a></li>
  329. </ul>
  330. </div>
  331. <a name="skip.navbar.bottom">
  332. <!-- -->
  333. </a></div>
  334. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  335. </body>
  336. </html>