Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc #692

Merged
merged 1 commit into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions doc/allclasses.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions doc/allpackages-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>All Packages</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
Expand Down
53 changes: 30 additions & 23 deletions doc/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>Constant Field Values</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
Expand Down Expand Up @@ -193,153 +193,160 @@ <h2 title="io.milvus">io.milvus.*</h2>
<td class="colLast"><code>""</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.DYNAMIC_FIELD_NAME">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#DYNAMIC_FIELD_NAME">DYNAMIC_FIELD_NAME</a></code></th>
<td class="colLast"><code>"$meta"</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.FAILED_REASON">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#FAILED_REASON">FAILED_REASON</a></code></th>
<td class="colLast"><code>"failed_reason"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.IGNORE_GROWING">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#IGNORE_GROWING">IGNORE_GROWING</a></code></th>
<td class="colLast"><code>"ignore_growing"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.IMPORT_COLLECTION">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#IMPORT_COLLECTION">IMPORT_COLLECTION</a></code></th>
<td class="colLast"><code>"collection"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.IMPORT_FILES">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#IMPORT_FILES">IMPORT_FILES</a></code></th>
<td class="colLast"><code>"files"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.IMPORT_PARTITION">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#IMPORT_PARTITION">IMPORT_PARTITION</a></code></th>
<td class="colLast"><code>"partition"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.IMPORT_PROGRESS">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#IMPORT_PROGRESS">IMPORT_PROGRESS</a></code></th>
<td class="colLast"><code>"progress_percent"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.INDEX_TYPE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#INDEX_TYPE">INDEX_TYPE</a></code></th>
<td class="colLast"><code>"index_type"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.LIMIT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#LIMIT">LIMIT</a></code></th>
<td class="colLast"><code>"limit"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.METRIC_TYPE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#METRIC_TYPE">METRIC_TYPE</a></code></th>
<td class="colLast"><code>"metric_type"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.OFFSET">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#OFFSET">OFFSET</a></code></th>
<td class="colLast"><code>"offset"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.PARAMS">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#PARAMS">PARAMS</a></code></th>
<td class="colLast"><code>"params"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.PRIMARY_FIELD_NAME_DEFAULT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#PRIMARY_FIELD_NAME_DEFAULT">PRIMARY_FIELD_NAME_DEFAULT</a></code></th>
<td class="colLast"><code>"id"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.ROUND_DECIMAL">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#ROUND_DECIMAL">ROUND_DECIMAL</a></code></th>
<td class="colLast"><code>"round_decimal"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.ROW_COUNT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#ROW_COUNT">ROW_COUNT</a></code></th>
<td class="colLast"><code>"row_count"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.TOP_K">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#TOP_K">TOP_K</a></code></th>
<td class="colLast"><code>"topk"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.TTL_SECONDS">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#TTL_SECONDS">TTL_SECONDS</a></code></th>
<td class="colLast"><code>"collection.ttl.seconds"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.VARCHAR_MAX_LENGTH">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#VARCHAR_MAX_LENGTH">VARCHAR_MAX_LENGTH</a></code></th>
<td class="colLast"><code>"max_length"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.VECTOR_DIM">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#VECTOR_DIM">VECTOR_DIM</a></code></th>
<td class="colLast"><code>"dim"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.VECTOR_FIELD">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#VECTOR_FIELD">VECTOR_FIELD</a></code></th>
<td class="colLast"><code>"anns_field"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.VECTOR_FIELD_NAME_DEFAULT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#VECTOR_FIELD_NAME_DEFAULT">VECTOR_FIELD_NAME_DEFAULT</a></code></th>
<td class="colLast"><code>"vector"</code></td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a id="io.milvus.param.Constant.VECTOR_INDEX_NAME_DEFAULT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/param/Constant.html#VECTOR_INDEX_NAME_DEFAULT">VECTOR_INDEX_NAME_DEFAULT</a></code></th>
<td class="colLast"><code>"vector_idx"</code></td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.param.Constant.VECTOR_TAG">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
Expand Down
35 changes: 32 additions & 3 deletions doc/deprecated-list.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>Deprecated List</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
Expand Down Expand Up @@ -97,10 +97,31 @@
<h1 title="Deprecated API" class="title">Deprecated API</h1>
<h2 title="Contents">Contents</h2>
<ul>
<li><a href="#field">Fields</a></li>
<li><a href="#method">Methods</a></li>
</ul>
</div>
<div class="contentContainer"><a id="method">
<div class="contentContainer"><a id="field">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<table class="deprecatedSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/highlevel/dml/response/DeleteResponse.html#deleteIds">io.milvus.param.highlevel.dml.response.DeleteResponse.deleteIds</a></th>
<td class="colLast"></td>
</tr>
</tbody>
</table>
</li>
</ul>
<a id="method">
<!-- -->
</a>
<ul class="blockList">
Expand Down Expand Up @@ -145,9 +166,17 @@ <h2 title="Contents">Contents</h2>
<td class="colLast"></td>
</tr>
<tr class="altColor">
<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/highlevel/dml/response/SearchResponse.html#getRowRecords()">io.milvus.param.highlevel.dml.response.SearchResponse.getRowRecords()</a></th>
<td class="colLast"></td>
</tr>
<tr class="rowColor">
<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/highlevel/dml/SearchSimpleParam.Builder.html#withLimit(int)">io.milvus.param.highlevel.dml.SearchSimpleParam.Builder.withLimit&#8203;(int)</a></th>
<td class="colLast"></td>
</tr>
<tr class="altColor">
<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/response/SearchResultsWrapper.html#getRowRecords()">io.milvus.response.SearchResultsWrapper.getRowRecords()</a></th>
<td class="colLast"></td>
</tr>
</tbody>
</table>
</li>
Expand Down
4 changes: 2 additions & 2 deletions doc/help-doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>API Help</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>A-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-10.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>J-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-11.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>K-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-12.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>L-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-13.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>M-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-14.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Thu Aug 10 17:17:28 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
<title>N-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-08-10">
<meta name="dc.created" content="2023-10-27">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
Expand Down
Loading