diff --git a/core/src/server/web_impl/README.md b/core/src/server/web_impl/README.md index 6100894df918b9997d35316531417aa93a64c210..8d28f44eedec95f127bf523d752668e0eced3404 100644 --- a/core/src/server/web_impl/README.md +++ b/core/src/server/web_impl/README.md @@ -517,7 +517,7 @@ $ curl -X GET "http://127.0.0.1:19121/collections/test_collection" -H "accept: a "metric_type": "L2", "count": 0, "index": "FLAT", - "index_params": {} + "index_params": {"nprobe": 16384} } ``` @@ -539,7 +539,7 @@ $ curl -X GET "http://127.0.0.1:19121/collections/test_collection?info=stat" -H "segments_stat": [ { "count": 1000, - "index": "IVFFLAT", + "index": "FLAT", "segment_name": "1583727170217439000", "size": 5284922 } @@ -681,7 +681,7 @@ Updates the index type and nlist of a collection. | Parameter | Description | Required? | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | | `index_type` | The type of indexing method to query the collection. Please refer to [Index Types](https://www.milvus.io/docs/reference/index.md) for detailed introduction of supported indexes. The default is "FLAT". | No | -| `params` | The extra params of indexing method to query the collection. Please refer to - [Index params](#index_param) for detailed introduction of supported indexes. | No | +| `params` | The extra params of indexing method to query the collection. Please refer to `Index params`(see below) for detailed introduction of supported indexes. | No | ##### Query Parameters @@ -1122,7 +1122,7 @@ $ curl -X GET "http://127.0.0.1:19121/collections/test_collection/segments/15837 | `tags` | Tags of partitions that you need to search. You do not have to specify this value if the collection is not partitioned or you wish to search the whole collection. | No | | `file_ids` | IDs of the vector files. You do not have to specify this value if you do not use Milvus in distributed scenarios. Also, if you assign a value to `file_ids`, the value of `tags` is ignored. | No | | `vectors` | Vectors to query. | Yes | -| `params` | Extra params for search. Please refer to [Search param](#index_param) to get more detail information. | Yes | +| `params` | Extra params for search. Please refer to `Search param`(see below) to get more detail information. | Yes | > Note: Type of items of vectors depends on the metric used by the collection. If the collection uses `L2` or `IP`, you must use `float`. If the collection uses `HAMMING`, `JACCARD`, or `TANIMOTO`, you must use `uint8`. @@ -1543,7 +1543,7 @@ For each index type, the RESTful API has specific index parameters and search pa -For detailed information about the parameters above, refer to [Index Types](https://milvus.io/docs/v0.7.0/reference/index.md) +For detailed information about the parameters above, refer to [Index Types](https://milvus-io.github.io/milvus-sdk-python/pythondoc/v0.2.8/param.html) ## Error Codes