milvus
/
milvus-sdk-java
mirror of https://github.com/milvus-io/milvus-sdk-java.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
							<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_251) on Fri Jul 22 10:32:49 CST 2022 -->
<title>SearchResultsWrapper</title>
<meta name="date" content="2022-07-22">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="SearchResultsWrapper";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../io/milvus/response/QueryResultsWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../io/milvus/response/SearchResultsWrapper.IDScore.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?io/milvus/response/SearchResultsWrapper.html" target="_top">Frames</a></li>
<li><a href="SearchResultsWrapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">io.milvus.response</div>
<h2 title="Class SearchResultsWrapper" class="title">Class SearchResultsWrapper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>io.milvus.response.SearchResultsWrapper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SearchResultsWrapper</span>
extends java.lang.Object</pre>
<div class="block">Utility class to wrap response of <code>search</code> interface.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<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>
<div class="block">Internal-use class to wrap response of <code>search</code> interface.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<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>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;?&gt;</code></td>
<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,
            int&nbsp;indexOfTarget)</code>
<div class="block">Gets data for an output field which is specified by search request.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/SearchResultsWrapper.html#getIDScore-int-">getIDScore</a></span>(int&nbsp;indexOfTarget)</code>
<div class="block">Gets ID-score pairs returned by search interface.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="SearchResultsWrapper-io.milvus.grpc.SearchResultData-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SearchResultsWrapper</h4>
<pre>public&nbsp;SearchResultsWrapper(@NonNull
                            @NonNull io.milvus.grpc.SearchResultData&nbsp;results)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getFieldData-java.lang.String-int-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldData</h4>
<pre>public&nbsp;java.util.List&lt;?&gt;&nbsp;getFieldData(@NonNull
                                      @NonNull java.lang.String&nbsp;fieldName,
                                      int&nbsp;indexOfTarget)</pre>
<div class="block">Gets data for an output field which is specified by search request.
 Throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the field doesn't exist.
 Throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the indexOfTarget is illegal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldName</code> - field name to get output data</dd>
<dd><code>indexOfTarget</code> - which target vector the field data belongs to</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response"><code>FieldDataWrapper</code></a></dd>
</dl>
</li>
</ul>
<a name="getIDScore-int-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getIDScore</h4>
<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)
                                                        throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a>,
                                                               <a href="../../../io/milvus/exception/IllegalResponseException.html" title="class in io.milvus.exception">IllegalResponseException</a></pre>
<div class="block">Gets ID-score pairs returned by search interface.
 Throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the indexOfTarget is illegal.
 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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>indexOfTarget</code> - which target vector the result belongs to</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of IDScore, ID-score pairs returned by search interface</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
<dd><code><a href="../../../io/milvus/exception/IllegalResponseException.html" title="class in io.milvus.exception">IllegalResponseException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../io/milvus/response/QueryResultsWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../io/milvus/response/SearchResultsWrapper.IDScore.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?io/milvus/response/SearchResultsWrapper.html" target="_top">Frames</a></li>
<li><a href="SearchResultsWrapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>