index-19.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.13) on Thu Jan 27 13:56:42 CST 2022 -->
  6. <title>S-Index</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2022-01-27">
  9. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.css" title="Style">
  11. <script type="text/javascript" src="../script.js"></script>
  12. <script type="text/javascript" src="../jquery/jszip/dist/jszip.min.js"></script>
  13. <script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  14. <!--[if IE]>
  15. <script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  16. <![endif]-->
  17. <script type="text/javascript" src="../jquery/jquery-3.5.1.js"></script>
  18. <script type="text/javascript" src="../jquery/jquery-ui.js"></script>
  19. </head>
  20. <body>
  21. <script type="text/javascript"><!--
  22. try {
  23. if (location.href.indexOf('is-external=true') == -1) {
  24. parent.document.title="S-Index";
  25. }
  26. }
  27. catch(err) {
  28. }
  29. //-->
  30. var pathtoroot = "../";
  31. var useModuleDirectories = true;
  32. loadScripts(document, 'script');</script>
  33. <noscript>
  34. <div>JavaScript is disabled on your browser.</div>
  35. </noscript>
  36. <header role="banner">
  37. <nav role="navigation">
  38. <div class="fixedNav">
  39. <!-- ========= START OF TOP NAVBAR ======= -->
  40. <div class="topNav"><a id="navbar.top">
  41. <!-- -->
  42. </a>
  43. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  44. <a id="navbar.top.firstrow">
  45. <!-- -->
  46. </a>
  47. <ul class="navList" title="Navigation">
  48. <li><a href="../index.html">Overview</a></li>
  49. <li>Package</li>
  50. <li>Class</li>
  51. <li><a href="../overview-tree.html">Tree</a></li>
  52. <li><a href="../deprecated-list.html">Deprecated</a></li>
  53. <li class="navBarCell1Rev">Index</li>
  54. <li><a href="../help-doc.html">Help</a></li>
  55. </ul>
  56. </div>
  57. <div class="subNav">
  58. <ul class="navList" id="allclasses_navbar_top">
  59. <li><a href="../allclasses.html">All&nbsp;Classes</a></li>
  60. </ul>
  61. <ul class="navListSearch">
  62. <li><label for="search">SEARCH:</label>
  63. <input type="text" id="search" value="search" disabled="disabled">
  64. <input type="reset" id="reset" value="reset" disabled="disabled">
  65. </li>
  66. </ul>
  67. <div>
  68. <script type="text/javascript"><!--
  69. allClassesLink = document.getElementById("allclasses_navbar_top");
  70. if(window==top) {
  71. allClassesLink.style.display = "block";
  72. }
  73. else {
  74. allClassesLink.style.display = "none";
  75. }
  76. //-->
  77. </script>
  78. <noscript>
  79. <div>JavaScript is disabled on your browser.</div>
  80. </noscript>
  81. </div>
  82. <a id="skip.navbar.top">
  83. <!-- -->
  84. </a></div>
  85. <!-- ========= END OF TOP NAVBAR ========= -->
  86. </div>
  87. <div class="navPadding">&nbsp;</div>
  88. <script type="text/javascript"><!--
  89. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  90. //-->
  91. </script>
  92. </nav>
  93. </header>
  94. <main role="main">
  95. <div class="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">J</a>&nbsp;<a href="index-11.html">K</a>&nbsp;<a href="index-12.html">L</a>&nbsp;<a href="index-13.html">M</a>&nbsp;<a href="index-14.html">N</a>&nbsp;<a href="index-15.html">O</a>&nbsp;<a href="index-16.html">P</a>&nbsp;<a href="index-17.html">Q</a>&nbsp;<a href="index-18.html">R</a>&nbsp;<a href="index-19.html">S</a>&nbsp;<a href="index-20.html">T</a>&nbsp;<a href="index-21.html">U</a>&nbsp;<a href="index-22.html">V</a>&nbsp;<a href="index-23.html">W</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a><a id="I:S">
  96. <!-- -->
  97. </a>
  98. <h2 class="title">S</h2>
  99. <dl>
  100. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#search(io.milvus.param.dml.SearchParam)">search(SearchParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  101. <dd>&nbsp;</dd>
  102. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#search(io.milvus.param.dml.SearchParam)">search(SearchParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  103. <dd>
  104. <div class="block">Conducts ANN search on a vector field.</div>
  105. </dd>
  106. <dt><a href="../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml"><span class="typeNameLink">SearchParam</span></a> - Class in <a href="../io/milvus/param/dml/package-summary.html">io.milvus.param.dml</a></dt>
  107. <dd>
  108. <div class="block">Parameters for <code>search</code> interface.</div>
  109. </dd>
  110. <dt><a href="../io/milvus/param/dml/SearchParam.Builder.html" title="class in io.milvus.param.dml"><span class="typeNameLink">SearchParam.Builder</span></a> - Class in <a href="../io/milvus/param/dml/package-summary.html">io.milvus.param.dml</a></dt>
  111. <dd>
  112. <div class="block">Builder for <code>SearchParam</code> class.</div>
  113. </dd>
  114. <dt><a href="../io/milvus/response/SearchResultsWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">SearchResultsWrapper</span></a> - Class in <a href="../io/milvus/response/package-summary.html">io.milvus.response</a></dt>
  115. <dd>
  116. <div class="block">Utility class to wrap response of <code>search</code> interface.</div>
  117. </dd>
  118. <dt><span class="memberNameLink"><a href="../io/milvus/response/SearchResultsWrapper.html#%3Cinit%3E(io.milvus.grpc.SearchResultData)">SearchResultsWrapper(SearchResultData)</a></span> - Constructor for class io.milvus.response.<a href="../io/milvus/response/SearchResultsWrapper.html" title="class in io.milvus.response">SearchResultsWrapper</a></dt>
  119. <dd>&nbsp;</dd>
  120. <dt><a href="../io/milvus/response/SearchResultsWrapper.IDScore.html" title="class in io.milvus.response"><span class="typeNameLink">SearchResultsWrapper.IDScore</span></a> - Class in <a href="../io/milvus/response/package-summary.html">io.milvus.response</a></dt>
  121. <dd>
  122. <div class="block">Internal-use class to wrap response of <code>search</code> interface.</div>
  123. </dd>
  124. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#setData(T)">setData(T)</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  125. <dd>&nbsp;</dd>
  126. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#setException(java.lang.Exception)">setException(Exception)</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  127. <dd>&nbsp;</dd>
  128. <dt><span class="memberNameLink"><a href="../io/milvus/response/ShowPartResponseWrapper.PartitionInfo.html#setInMemoryPercentage(long)">setInMemoryPercentage(long)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/ShowPartResponseWrapper.PartitionInfo.html" title="class in io.milvus.response">ShowPartResponseWrapper.PartitionInfo</a></dt>
  129. <dd>&nbsp;</dd>
  130. <dt><span class="memberNameLink"><a href="../io/milvus/response/ShowCollResponseWrapper.CollectionInfo.html#SetInMemoryPercentage(long)">SetInMemoryPercentage(long)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/ShowCollResponseWrapper.CollectionInfo.html" title="class in io.milvus.response">ShowCollResponseWrapper.CollectionInfo</a></dt>
  131. <dd>&nbsp;</dd>
  132. <dt><span class="memberNameLink"><a href="../io/milvus/exception/MilvusException.html#setStatus(java.lang.Integer)">setStatus(Integer)</a></span> - Method in exception io.milvus.exception.<a href="../io/milvus/exception/MilvusException.html" title="class in io.milvus.exception">MilvusException</a></dt>
  133. <dd>&nbsp;</dd>
  134. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#setStatus(java.lang.Integer)">setStatus(Integer)</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  135. <dd>&nbsp;</dd>
  136. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections(ShowCollectionsParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  137. <dd>&nbsp;</dd>
  138. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections(ShowCollectionsParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  139. <dd>
  140. <div class="block">Lists all collections or gets collection loading status.</div>
  141. </dd>
  142. <dt><a href="../io/milvus/param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection"><span class="typeNameLink">ShowCollectionsParam</span></a> - Class in <a href="../io/milvus/param/collection/package-summary.html">io.milvus.param.collection</a></dt>
  143. <dd>
  144. <div class="block">Parameters for <code>showCollections</code> interface.</div>
  145. </dd>
  146. <dt><a href="../io/milvus/param/collection/ShowCollectionsParam.Builder.html" title="class in io.milvus.param.collection"><span class="typeNameLink">ShowCollectionsParam.Builder</span></a> - Class in <a href="../io/milvus/param/collection/package-summary.html">io.milvus.param.collection</a></dt>
  147. <dd>
  148. <div class="block">Builder for <code>ShowCollectionsParam</code> class.</div>
  149. </dd>
  150. <dt><a href="../io/milvus/response/ShowCollResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">ShowCollResponseWrapper</span></a> - Class in <a href="../io/milvus/response/package-summary.html">io.milvus.response</a></dt>
  151. <dd>
  152. <div class="block">Util class to wrap response of <code>showCollections</code> interface.</div>
  153. </dd>
  154. <dt><span class="memberNameLink"><a href="../io/milvus/response/ShowCollResponseWrapper.html#%3Cinit%3E(io.milvus.grpc.ShowCollectionsResponse)">ShowCollResponseWrapper(ShowCollectionsResponse)</a></span> - Constructor for class io.milvus.response.<a href="../io/milvus/response/ShowCollResponseWrapper.html" title="class in io.milvus.response">ShowCollResponseWrapper</a></dt>
  155. <dd>&nbsp;</dd>
  156. <dt><a href="../io/milvus/response/ShowCollResponseWrapper.CollectionInfo.html" title="class in io.milvus.response"><span class="typeNameLink">ShowCollResponseWrapper.CollectionInfo</span></a> - Class in <a href="../io/milvus/response/package-summary.html">io.milvus.response</a></dt>
  157. <dd>
  158. <div class="block">Internal-use class to wrap response of <code>ShowCollections</code> interface.</div>
  159. </dd>
  160. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions(ShowPartitionsParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  161. <dd>&nbsp;</dd>
  162. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions(ShowPartitionsParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  163. <dd>
  164. <div class="block">Shows all partitions in the specified collection.</div>
  165. </dd>
  166. <dt><a href="../io/milvus/param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition"><span class="typeNameLink">ShowPartitionsParam</span></a> - Class in <a href="../io/milvus/param/partition/package-summary.html">io.milvus.param.partition</a></dt>
  167. <dd>
  168. <div class="block">Parameters for <code>showPartition</code> interface.</div>
  169. </dd>
  170. <dt><a href="../io/milvus/param/partition/ShowPartitionsParam.Builder.html" title="class in io.milvus.param.partition"><span class="typeNameLink">ShowPartitionsParam.Builder</span></a> - Class in <a href="../io/milvus/param/partition/package-summary.html">io.milvus.param.partition</a></dt>
  171. <dd>
  172. <div class="block">Builder for <code>ShowPartitionsParam</code> class.</div>
  173. </dd>
  174. <dt><a href="../io/milvus/response/ShowPartResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">ShowPartResponseWrapper</span></a> - Class in <a href="../io/milvus/response/package-summary.html">io.milvus.response</a></dt>
  175. <dd>
  176. <div class="block">Util class to wrap response of <code>showPartitions</code> interface.</div>
  177. </dd>
  178. <dt><span class="memberNameLink"><a href="../io/milvus/response/ShowPartResponseWrapper.html#%3Cinit%3E(io.milvus.grpc.ShowPartitionsResponse)">ShowPartResponseWrapper(ShowPartitionsResponse)</a></span> - Constructor for class io.milvus.response.<a href="../io/milvus/response/ShowPartResponseWrapper.html" title="class in io.milvus.response">ShowPartResponseWrapper</a></dt>
  179. <dd>&nbsp;</dd>
  180. <dt><a href="../io/milvus/response/ShowPartResponseWrapper.PartitionInfo.html" title="class in io.milvus.response"><span class="typeNameLink">ShowPartResponseWrapper.PartitionInfo</span></a> - Class in <a href="../io/milvus/response/package-summary.html">io.milvus.response</a></dt>
  181. <dd>
  182. <div class="block">Internal-use class to wrap response of <code>ShowPartitions</code> interface.</div>
  183. </dd>
  184. <dt><span class="memberNameLink"><a href="../io/milvus/exception/MilvusException.html#status">status</a></span> - Variable in exception io.milvus.exception.<a href="../io/milvus/exception/MilvusException.html" title="class in io.milvus.exception">MilvusException</a></dt>
  185. <dd>&nbsp;</dd>
  186. <dt><span class="memberNameLink"><a href="../io/milvus/param/MetricType.html#SUBSTRUCTURE">SUBSTRUCTURE</a></span> - io.milvus.param.<a href="../io/milvus/param/MetricType.html" title="enum in io.milvus.param">MetricType</a></dt>
  187. <dd>&nbsp;</dd>
  188. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#success()">success()</a></span> - Static method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  189. <dd>
  190. <div class="block">Returns a succeed status.</div>
  191. </dd>
  192. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#success(T)">success(T)</a></span> - Static method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  193. <dd>
  194. <div class="block">Wraps a succeed rpc response object.</div>
  195. </dd>
  196. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.Status.html#Success">Success</a></span> - io.milvus.param.<a href="../io/milvus/param/R.Status.html" title="enum in io.milvus.param">R.Status</a></dt>
  197. <dd>&nbsp;</dd>
  198. <dt><span class="memberNameLink"><a href="../io/milvus/param/RpcStatus.html#SUCCESS_MSG">SUCCESS_MSG</a></span> - Static variable in class io.milvus.param.<a href="../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a></dt>
  199. <dd>&nbsp;</dd>
  200. <dt><span class="memberNameLink"><a href="../io/milvus/param/MetricType.html#SUPERSTRUCTURE">SUPERSTRUCTURE</a></span> - io.milvus.param.<a href="../io/milvus/param/MetricType.html" title="enum in io.milvus.param">MetricType</a></dt>
  201. <dd>&nbsp;</dd>
  202. </dl>
  203. <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">J</a>&nbsp;<a href="index-11.html">K</a>&nbsp;<a href="index-12.html">L</a>&nbsp;<a href="index-13.html">M</a>&nbsp;<a href="index-14.html">N</a>&nbsp;<a href="index-15.html">O</a>&nbsp;<a href="index-16.html">P</a>&nbsp;<a href="index-17.html">Q</a>&nbsp;<a href="index-18.html">R</a>&nbsp;<a href="index-19.html">S</a>&nbsp;<a href="index-20.html">T</a>&nbsp;<a href="index-21.html">U</a>&nbsp;<a href="index-22.html">V</a>&nbsp;<a href="index-23.html">W</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a></div>
  204. </main>
  205. <footer role="contentinfo">
  206. <nav role="navigation">
  207. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  208. <div class="bottomNav"><a id="navbar.bottom">
  209. <!-- -->
  210. </a>
  211. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  212. <a id="navbar.bottom.firstrow">
  213. <!-- -->
  214. </a>
  215. <ul class="navList" title="Navigation">
  216. <li><a href="../index.html">Overview</a></li>
  217. <li>Package</li>
  218. <li>Class</li>
  219. <li><a href="../overview-tree.html">Tree</a></li>
  220. <li><a href="../deprecated-list.html">Deprecated</a></li>
  221. <li class="navBarCell1Rev">Index</li>
  222. <li><a href="../help-doc.html">Help</a></li>
  223. </ul>
  224. </div>
  225. <div class="subNav">
  226. <ul class="navList" id="allclasses_navbar_bottom">
  227. <li><a href="../allclasses.html">All&nbsp;Classes</a></li>
  228. </ul>
  229. <div>
  230. <script type="text/javascript"><!--
  231. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  232. if(window==top) {
  233. allClassesLink.style.display = "block";
  234. }
  235. else {
  236. allClassesLink.style.display = "none";
  237. }
  238. //-->
  239. </script>
  240. <noscript>
  241. <div>JavaScript is disabled on your browser.</div>
  242. </noscript>
  243. </div>
  244. <a id="skip.navbar.bottom">
  245. <!-- -->
  246. </a></div>
  247. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  248. </nav>
  249. </footer>
  250. </body>
  251. </html>