From 71a3fb485332e1a652fdc6e32dd84656fcd5fc4e Mon Sep 17 00:00:00 2001 From: Matt Harrison Date: Wed, 7 May 2025 22:11:38 -0400 Subject: [PATCH 1/2] doc: add Milvus environment variables and descriptions --- docs/getting-started/env-configuration.md | 37 +++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 961eb9d..06521c2 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -1066,6 +1066,43 @@ modeling files for reranking. - Default: `None` - Description: Specifies an optional connection token for Milvus. +#### `MILVUS_INDEX_TYPE` + +- Type: `str` +- Default: `AUTOINDEX` +- Options: `AUTOINDEX`, `FLAT`, `IVF_FLAT`, `HNSW` +- Description: Specifies the index type to use when creating a new collection in Milvus. `AUTOINDEX` is generally recommended for Milvus standalone. `HNSW` may offer better performance but typically requires a clustered Milvus setup. +- Persistence: This environment variable is a `PersistentConfig` variable. + +#### `MILVUS_METRIC_TYPE` + +- Type: `str` +- Default: `COSINE` +- Options: `COSINE`, `IP`, `L2` +- Description: Specifies the metric type for vector similarity search in Milvus. +- Persistence: This environment variable is a `PersistentConfig` variable. + +#### `MILVUS_HNSW_M` + +- Type: `int` +- Default: `16` +- Description: Specifies the `M` parameter for the HNSW index type in Milvus. This influences the number of bi-directional links created for each new element during construction. Only applicable if `MILVUS_INDEX_TYPE` is `HNSW`. +- Persistence: This environment variable is a `PersistentConfig` variable. + +#### `MILVUS_HNSW_EFCONSTRUCTION` + +- Type: `int` +- Default: `100` +- Description: Specifies the `efConstruction` parameter for the HNSW index type in Milvus. This influences the size of the dynamic list for the nearest neighbors during index construction. Only applicable if `MILVUS_INDEX_TYPE` is `HNSW`. +- Persistence: This environment variable is a `PersistentConfig` variable. + +#### `MILVUS_IVF_FLAT_NLIST` + +- Type: `int` +- Default: `128` +- Description: Specifies the `nlist` parameter for the IVF_FLAT index type in Milvus. This is the number of cluster units. Only applicable if `MILVUS_INDEX_TYPE` is `IVF_FLAT`. +- Persistence: This environment variable is a `PersistentConfig` variable. + ### OpenSearch #### `OPENSEARCH_CERT_VERIFY` From 630eab7d4fbd8aeef4ce6849e08fc200b8f6676f Mon Sep 17 00:00:00 2001 From: Matt Harrison Date: Thu, 8 May 2025 07:24:13 -0400 Subject: [PATCH 2/2] doc: update Milvus environment variable for backwards compatibility --- docs/getting-started/env-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 06521c2..aef9e7c 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -1069,7 +1069,7 @@ modeling files for reranking. #### `MILVUS_INDEX_TYPE` - Type: `str` -- Default: `AUTOINDEX` +- Default: `HNSW` - Options: `AUTOINDEX`, `FLAT`, `IVF_FLAT`, `HNSW` - Description: Specifies the index type to use when creating a new collection in Milvus. `AUTOINDEX` is generally recommended for Milvus standalone. `HNSW` may offer better performance but typically requires a clustered Milvus setup. - Persistence: This environment variable is a `PersistentConfig` variable.