Update doc

Signed-off-by: yhmo <yihua.mo@zilliz.com>
milvus-io · Mar 29, 2024 · 75ec79e · 75ec79e
1 parent 949d4e3
commit 75ec79e
Show file tree

Hide file tree

Showing 487 changed files with 54,510 additions and 4,505 deletions.
diff --git a/doc/allclasses-index.html b/doc/allclasses-index.html
diff --git a/doc/allclasses.html b/doc/allclasses.html
diff --git a/doc/allpackages-index.html b/doc/allpackages-index.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
+<!-- Generated by javadoc (11.0.18) on Fri Mar 29 17:26:43 CST 2024 -->
 <title>All Packages</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-01-02">
+<meta name="dc.created" content="2024-03-29">
 <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">
@@ -107,101 +107,221 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 </tr>
 <tbody>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/client/package-summary.html">io.milvus.client</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/bulkwriter/package-summary.html">io.milvus.bulkwriter</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/common/clientenum/package-summary.html">io.milvus.common.clientenum</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/bulkwriter/common/clientenum/package-summary.html">io.milvus.bulkwriter.common.clientenum</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/common/constant/package-summary.html">io.milvus.common.constant</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/bulkwriter/common/utils/package-summary.html">io.milvus.bulkwriter.common.utils</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/common/utils/package-summary.html">io.milvus.common.utils</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/bulkwriter/connect/package-summary.html">io.milvus.bulkwriter.connect</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/connection/package-summary.html">io.milvus.connection</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/bulkwriter/response/package-summary.html">io.milvus.bulkwriter.response</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/exception/package-summary.html">io.milvus.exception</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/bulkwriter/storage/package-summary.html">io.milvus.bulkwriter.storage</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/package-summary.html">io.milvus.param</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/bulkwriter/storage/client/package-summary.html">io.milvus.bulkwriter.storage.client</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/alias/package-summary.html">io.milvus.param.alias</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/client/package-summary.html">io.milvus.client</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/bulkinsert/package-summary.html">io.milvus.param.bulkinsert</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/common/clientenum/package-summary.html">io.milvus.common.clientenum</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/collection/package-summary.html">io.milvus.param.collection</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/common/constant/package-summary.html">io.milvus.common.constant</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/control/package-summary.html">io.milvus.param.control</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/common/utils/package-summary.html">io.milvus.common.utils</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/credential/package-summary.html">io.milvus.param.credential</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/connection/package-summary.html">io.milvus.connection</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/dml/package-summary.html">io.milvus.param.dml</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/exception/package-summary.html">io.milvus.exception</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/highlevel/collection/package-summary.html">io.milvus.param.highlevel.collection</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/package-summary.html">io.milvus.param</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/highlevel/collection/response/package-summary.html">io.milvus.param.highlevel.collection.response</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/alias/package-summary.html">io.milvus.param.alias</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/highlevel/dml/package-summary.html">io.milvus.param.highlevel.dml</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/bulkinsert/package-summary.html">io.milvus.param.bulkinsert</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/highlevel/dml/response/package-summary.html">io.milvus.param.highlevel.dml.response</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/collection/package-summary.html">io.milvus.param.collection</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/index/package-summary.html">io.milvus.param.index</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/control/package-summary.html">io.milvus.param.control</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/partition/package-summary.html">io.milvus.param.partition</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/credential/package-summary.html">io.milvus.param.credential</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/resourcegroup/package-summary.html">io.milvus.param.resourcegroup</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/dml/package-summary.html">io.milvus.param.dml</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/role/package-summary.html">io.milvus.param.role</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/highlevel/collection/package-summary.html">io.milvus.param.highlevel.collection</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/response/package-summary.html">io.milvus.response</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/highlevel/collection/response/package-summary.html">io.milvus.param.highlevel.collection.response</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/response/basic/package-summary.html">io.milvus.response.basic</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/highlevel/dml/package-summary.html">io.milvus.param.highlevel.dml</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/param/highlevel/dml/response/package-summary.html">io.milvus.param.highlevel.dml.response</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/param/index/package-summary.html">io.milvus.param.index</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/param/partition/package-summary.html">io.milvus.param.partition</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/param/resourcegroup/package-summary.html">io.milvus.param.resourcegroup</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/param/role/package-summary.html">io.milvus.param.role</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/response/package-summary.html">io.milvus.response</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/response/basic/package-summary.html">io.milvus.response.basic</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
 <th class="colFirst" scope="row"><a href="io/milvus/utils/package-summary.html">io.milvus.utils</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/client/package-summary.html">io.milvus.v2.client</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/common/package-summary.html">io.milvus.v2.common</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/examples/package-summary.html">io.milvus.v2.examples</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/exception/package-summary.html">io.milvus.v2.exception</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/package-summary.html">io.milvus.v2.service</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/collection/package-summary.html">io.milvus.v2.service.collection</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/collection/request/package-summary.html">io.milvus.v2.service.collection.request</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/collection/response/package-summary.html">io.milvus.v2.service.collection.response</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/index/package-summary.html">io.milvus.v2.service.index</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/index/request/package-summary.html">io.milvus.v2.service.index.request</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/index/response/package-summary.html">io.milvus.v2.service.index.response</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/partition/package-summary.html">io.milvus.v2.service.partition</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/partition/request/package-summary.html">io.milvus.v2.service.partition.request</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/rbac/package-summary.html">io.milvus.v2.service.rbac</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/rbac/request/package-summary.html">io.milvus.v2.service.rbac.request</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/rbac/response/package-summary.html">io.milvus.v2.service.rbac.response</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/utility/package-summary.html">io.milvus.v2.service.utility</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/utility/request/package-summary.html">io.milvus.v2.service.utility.request</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/utility/response/package-summary.html">io.milvus.v2.service.utility.response</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/vector/package-summary.html">io.milvus.v2.service.vector</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/vector/request/package-summary.html">io.milvus.v2.service.vector.request</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/service/vector/response/package-summary.html">io.milvus.v2.service.vector.response</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<th class="colFirst" scope="row"><a href="io/milvus/v2/utils/package-summary.html">io.milvus.v2.utils</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
 </tbody>
 </table>
 </li>

diff --git a/doc/constant-values.html b/doc/constant-values.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
+<!-- Generated by javadoc (11.0.18) on Fri Mar 29 17:26:43 CST 2024 -->
 <title>Constant Field Values</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-01-02">
+<meta name="dc.created" content="2024-03-29">
 <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">

diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
+<!-- Generated by javadoc (11.0.18) on Fri Mar 29 17:26:43 CST 2024 -->
 <title>Deprecated List</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-01-02">
+<meta name="dc.created" content="2024-03-29">
 <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">
@@ -150,22 +150,40 @@ <h2 title="Contents">Contents</h2>
 <td class="colLast"></td>
 </tr>
 <tr class="altColor">
+<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/collection/CreateCollectionParam.Builder.html#addFieldType(io.milvus.param.collection.FieldType)">io.milvus.param.collection.CreateCollectionParam.Builder.addFieldType&#8203;(FieldType)</a></th>
+<td class="colLast">
+<div class="deprecationComment">Use <a href="io/milvus/param/collection/CreateCollectionParam.Builder.html#withSchema(io.milvus.param.collection.CollectionSchemaParam)"><code>CreateCollectionParam.Builder.withSchema(CollectionSchemaParam)</code></a> repace</div>
+</td>
+</tr>
+<tr class="rowColor">
+<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/collection/CreateCollectionParam.Builder.html#withEnableDynamicField(boolean)">io.milvus.param.collection.CreateCollectionParam.Builder.withEnableDynamicField&#8203;(boolean)</a></th>
+<td class="colLast">
+<div class="deprecationComment">Use <a href="io/milvus/param/collection/CreateCollectionParam.Builder.html#withSchema(io.milvus.param.collection.CollectionSchemaParam)"><code>CreateCollectionParam.Builder.withSchema(CollectionSchemaParam)</code></a> repace</div>
+</td>
+</tr>
+<tr class="altColor">
+<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/collection/CreateCollectionParam.Builder.html#withFieldTypes(java.util.List)">io.milvus.param.collection.CreateCollectionParam.Builder.withFieldTypes&#8203;(List&lt;FieldType&gt;)</a></th>
+<td class="colLast">
+<div class="deprecationComment">Use <a href="io/milvus/param/collection/CreateCollectionParam.Builder.html#withSchema(io.milvus.param.collection.CollectionSchemaParam)"><code>CreateCollectionParam.Builder.withSchema(CollectionSchemaParam)</code></a> repace</div>
+</td>
+</tr>
+<tr class="rowColor">
 <th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/ConnectParam.Builder.html#secure(boolean)">io.milvus.param.ConnectParam.Builder.secure&#8203;(boolean)</a></th>
 <td class="colLast"></td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/control/GetFlushStateParam.Builder.html#addSegmentID(java.lang.Long)">io.milvus.param.control.GetFlushStateParam.Builder.addSegmentID&#8203;(Long)</a></th>
 <td class="colLast"></td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/control/GetFlushStateParam.Builder.html#withSegmentIDs(java.util.List)">io.milvus.param.control.GetFlushStateParam.Builder.withSegmentIDs&#8203;(List&lt;Long&gt;)</a></th>
 <td class="colLast"></td>
 </tr>
-<tr class="rowColor">
+<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="altColor">
+<tr class="rowColor">
 <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>

diff --git a/doc/element-list b/doc/element-list
@@ -1,3 +1,10 @@
+io.milvus.bulkwriter
+io.milvus.bulkwriter.common.clientenum
+io.milvus.bulkwriter.common.utils
+io.milvus.bulkwriter.connect
+io.milvus.bulkwriter.response
+io.milvus.bulkwriter.storage
+io.milvus.bulkwriter.storage.client
 io.milvus.client
 io.milvus.common.clientenum
 io.milvus.common.constant
@@ -22,3 +29,26 @@ io.milvus.param.role
 io.milvus.response
 io.milvus.response.basic
 io.milvus.utils
+io.milvus.v2.client
+io.milvus.v2.common
+io.milvus.v2.examples
+io.milvus.v2.exception
+io.milvus.v2.service
+io.milvus.v2.service.collection
+io.milvus.v2.service.collection.request
+io.milvus.v2.service.collection.response
+io.milvus.v2.service.index
+io.milvus.v2.service.index.request
+io.milvus.v2.service.index.response
+io.milvus.v2.service.partition
+io.milvus.v2.service.partition.request
+io.milvus.v2.service.rbac
+io.milvus.v2.service.rbac.request
+io.milvus.v2.service.rbac.response
+io.milvus.v2.service.utility
+io.milvus.v2.service.utility.request
+io.milvus.v2.service.utility.response
+io.milvus.v2.service.vector
+io.milvus.v2.service.vector.request
+io.milvus.v2.service.vector.response
+io.milvus.v2.utils