From cc50228072dd5a67900201ab379f86b33d144875 Mon Sep 17 00:00:00 2001 From: Milvus-doc-bot Date: Fri, 22 Sep 2023 09:11:50 +0000 Subject: [PATCH] Release new docs --- v2.3.x/site/en/faq/product_faq.md | 4 +--- v2.3.x/site/en/userGuide/bulk_insert.md | 2 ++ v2.3.x/site/en/userGuide/insert_data.md | 10 ++++++++-- v2.3.x/site/en/userGuide/search/query.md | 10 +++++----- v2.3.x/site/en/userGuide/search/search.md | 19 ++++++++++--------- v2.3.x/site/en/userGuide/upsert_entities.md | 8 +++++++- 6 files changed, 33 insertions(+), 20 deletions(-) diff --git a/v2.3.x/site/en/faq/product_faq.md b/v2.3.x/site/en/faq/product_faq.md index 47b343e37..d88dc40a7 100644 --- a/v2.3.x/site/en/faq/product_faq.md +++ b/v2.3.x/site/en/faq/product_faq.md @@ -81,9 +81,7 @@ No. Milvus has varied behavior. Data must be loaded to memory before searching. #### Can indexes be created after inserting vectors? -Yes. If `create_index()` is called, Milvus builds an index for subsequently inserted vectors. However, Milvus does not build an index until the newly inserted vectors fill an entire segment and the newly created index file is separate from the previous one. - - +Yes. If an index has been built for a collection by `create_index()` before, Milvus will automatically build an index for subsequently inserted vectors. However, Milvus does not build an index until the newly inserted vectors fill an entire segment and the newly created index file is separate from the previous one. #### How are the FLAT and IVF_FLAT indexes different? diff --git a/v2.3.x/site/en/userGuide/bulk_insert.md b/v2.3.x/site/en/userGuide/bulk_insert.md index 340643155..ff947622e 100644 --- a/v2.3.x/site/en/userGuide/bulk_insert.md +++ b/v2.3.x/site/en/userGuide/bulk_insert.md @@ -203,6 +203,8 @@ In this method, you need to set the name of the target collection as **collectio +After inserting entities into a collection that has previously been indexed, you do not need to re-index the collection, as Milvus will automatically create an index for the newly inserted data. For more information, refer to [Can indexes be created after inserting vectors?](product_faq.md#Can-indexes-be-created-after-inserting-vectors) + ## List tasks ### Check task state diff --git a/v2.3.x/site/en/userGuide/insert_data.md b/v2.3.x/site/en/userGuide/insert_data.md index fd7b97679..0f0d14b94 100644 --- a/v2.3.x/site/en/userGuide/insert_data.md +++ b/v2.3.x/site/en/userGuide/insert_data.md @@ -10,7 +10,7 @@ This topic describes how to insert data in Milvus via client. You can also migrate data to Milvus with [MilvusDM](migrate_overview.md), an open-source tool designed specifically for importing and exporting data with Milvus. -Milvus 2.1 supports VARCHAR data type on scalar field. When building indexes for VARCHAR-type scalar fields, the default index type is dictionary tree. +Milvus 2.1 supports the `VARCHAR` data type on scalar fields. When building indexes for VARCHAR-type scalar fields, the default index type is dictionary tree. The following example inserts 2,000 rows of randomly generated data as the example data (Milvus CLI example uses a pre-built, remote CSV file containing similar data). Real applications will likely use much higher dimensional vectors than the example. You can prepare your own data to replace the example. @@ -373,9 +373,15 @@ Output: +
+ +After inserting entities into a collection that has previously been indexed, you do not need to re-index the collection, as Milvus will automatically create an index for the newly inserted data. For more information, refer to [Can indexes be created after inserting vectors?](product_faq.md#Can-indexes-be-created-after-inserting-vectors) + +
+ ## Flush the Data in Milvus -When data is inserted into Milvus it is inserted into segments. Segments have to reach a certain size to be sealed and indexed. Unsealed segments will be searched brute force. In order to avoid this with any remainder data, it is best to call flush(). The flush call will seal any remaining segments and send them for indexing. It is important to only call this at the end of an insert session, as calling this too much will cause fragmented data that will need to be cleaned later on. +When data is inserted into Milvus it is inserted into segments. Segments have to reach a certain size to be sealed and indexed. Unsealed segments will be searched brute force. In order to avoid this with any remainder data, it is best to call `flush()`. The `flush()` call will seal any remaining segments and send them for indexing. It is important to only call this method at the end of an insert session. Calling it too often will cause fragmented data that will need to be cleaned later on. ## Limits diff --git a/v2.3.x/site/en/userGuide/search/query.md b/v2.3.x/site/en/userGuide/search/query.md index 927b24089..95c09372e 100644 --- a/v2.3.x/site/en/userGuide/search/query.md +++ b/v2.3.x/site/en/userGuide/search/query.md @@ -202,7 +202,7 @@ Output: offset - Number of results to skip in the returned set. This parameter is available only when limit is specified, and the sum of this value and limit should be less than 16384. + Number of results to skip in the returned set. This parameter is available only when limit is specified, and the sum of this value and limit should be less than 16384. For example, if you want the 9th and 10th nearest neighbors to the query vector, set limit to 2 and offset to 8. output_fields (optional) @@ -246,7 +246,7 @@ Output: offset (optional) - Number of results to skip in the returned set. This parameter is available only when limit is specified, and the sum of this value and limit should be less than 16384. + Number of results to skip in the returned set. This parameter is available only when limit is specified, and the sum of this value and limit should be less than 16384. For example, if you want the 9th and 10th nearest neighbors to the query vector, set limit to 2 and offset to 8. @@ -328,7 +328,7 @@ Output: Offset (optional) - Number of results to skip in the returned set. This parameter is available only when limit is specified, and the sum of this value and limit in WithLimit() should be less than 16384. + Number of results to skip in the returned set. This parameter is available only when limit is specified, and the sum of this value and limit in WithLimit() should be less than 16384. For example, if you want the 9th and 10th nearest neighbors to the query vector, set limit to 2 and offset to 8. ConsistencyLevel @@ -373,11 +373,11 @@ Output: limit - The maximum number of entities to return.
The sum of this value of that of `offset` should be less than **1024**.
The value defaults to 100.
The value ranges from 1 to 100 + The maximum number of entities to return.
The sum of this value of that of offset should be less than 1024.
The value defaults to 100.
The value ranges from 1 to 100 offset - The number of entities to skip in the search results.
The sum of this value and that of `limit` should not be greater than 1024.
The maximum value is 1024. + The number of entities to skip in the search results.
The sum of this value and that of limit should not be greater than 1024.
The maximum value is 1024. For example, if you want the 9th and 10th nearest neighbors to the query vector, set limit to 2 and offset to 8. outputFields diff --git a/v2.3.x/site/en/userGuide/search/search.md b/v2.3.x/site/en/userGuide/search/search.md index 9881e4f8b..46f58a2e3 100644 --- a/v2.3.x/site/en/userGuide/search/search.md +++ b/v2.3.x/site/en/userGuide/search/search.md @@ -204,7 +204,7 @@ Output: offset - Number of entities to skip during the search. The sum of this parameter and limit of the search method should be less than 16384. + Number of entities to skip during the search. The sum of this value and limit of the search method should be less than 16384. For example, if you want the 9th and 10th nearest neighbors to the query vector, set limit to 2 and offset to 8. ignore_growing @@ -277,7 +277,7 @@ Output: Options for ANN searches. @@ -306,7 +306,8 @@ Output:
  • nprobe Indicates the number of cluster units to search. This parameter is available only when index_type is set to IVF_FLAT, IVF_SQ8, or IVF_PQ. The value should be less than nlist specified for the index-building process.
  • ef Indicates the search scope. This parameter is available only when index_type is set to HNSW. The value should be within the range from top_k to 32768.
  • metric_type Indicates the metric type used in the search. It should be the same as the one specified when you index the collection.
    • -
  • offset Indicates the number of entities to skip during the search. The sum of this parameter and topK of the withTopK() method should be less than 16384.
    • +
  • limit Indicates the number of entities to return starting from the last skippped entity.
    • +
  • offset Indicates the number of entities to skip during the search. The sum of this value and topK of the withTopK() method should be less than 16384. For example, if you want the 9th and 10th nearest neighbors to the query vector, set topK to 2 and offset to 8.
    • @@ -348,11 +349,11 @@ Output: limit - The maximum number of entities to return.
    The sum of this value of that of `offset` should be less than **1024**.
    The value defaults to 100.
    The value ranges from 1 to 100 + The maximum number of entities to return.
    The sum of this parameter value and offset should be less than 1024.
    The value defaults to 100.
    The value ranges from 1 to 100 offset - The number of entities to skip in the search results.
    The sum of this value and that of `limit` should not be greater than 1024.
    The maximum value is 1024. + The number of entities to skip in the search results.
    The sum of this parameter value and limit should not be greater than 1024.
    The maximum value is 1024. For example, if you want the 9th and 10th nearest neighbors to the query vector, set limit to 2 and offset to 8. outputFields @@ -485,7 +486,7 @@ R respSearch = milvusClient.search(searchParam); limit - Number of the most similar results to return. The sum of this value and offset in param should be less than 16384. + Number of the results to return. The sum of this value and offset in param should be less than 16384. expr @@ -528,11 +529,11 @@ R respSearch = milvusClient.search(searchParam); limit (optional) - Number of the most similar results to return. The sum of this value and offset should be less than 16384. + Number of the results to return. The sum of this value and offset should be less than 16384. offset (optional) - Number of entities to skip. The sum of this value of limit should be less than 16384. + Number of entities to skip. The sum of this value and limit should be less than 16384. For example, if you want the 9th and 10th nearest neighbors to the query vector, set limit to 2 and offset to 8. filter (optional) @@ -596,7 +597,7 @@ R respSearch = milvusClient.search(searchParam); topK - Number of the most similar results to return. The sum of this value and that of offset in WithOffset of opts should be less than 16384. + Number of the results to return. The sum of this value and that of offset in WithOffset of opts should be less than 16384. N/A diff --git a/v2.3.x/site/en/userGuide/upsert_entities.md b/v2.3.x/site/en/userGuide/upsert_entities.md index 4480631e3..0a45331f1 100644 --- a/v2.3.x/site/en/userGuide/upsert_entities.md +++ b/v2.3.x/site/en/userGuide/upsert_entities.md @@ -138,9 +138,15 @@ err != nil { +
    + +After upserting entities into a collection that has previously been indexed, you do not need to re-index the collection, as Milvus will automatically create an index for the newly upserted data. For more information, refer to [Can indexes be created after inserting vectors?](product_faq.md#Can-indexes-be-created-after-inserting-vectors) + +
    + ## Flush data -When data is upserted into Milvus it is updated and inserted into segments. Segments have to reach a certain size to be sealed and indexed. Unsealed segments will be searched brute force. In order to avoid this with any remainder data, it is best to call `flush()`. The `flush()` call will seal any remaining segments and send them for indexing. It is important to only call this at the end of an upsert session, as calling this too much will cause fragmented data that will need to be cleaned later on. +When data is upserted into Milvus it is updated and inserted into segments. Segments have to reach a certain size to be sealed and indexed. Unsealed segments will be searched brute force. In order to avoid this with any remainder data, it is best to call `flush()`. The `flush()` call will seal any remaining segments and send them for indexing. It is important to only call this method at the end of an upsert session. Calling it too often will cause fragmented data that will need to be cleaned later on. ## Limits