From 110f74729e585167ccad0c500881c5dcab1b97e5 Mon Sep 17 00:00:00 2001 From: shiyu22 Date: Mon, 29 May 2023 15:36:50 +0800 Subject: [PATCH] Update README Signed-off-by: shiyu22 --- README.md | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b0d94f6..6ef7d5a 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,46 @@ collection.load() Create the operator via the following factory method: -***ann_insert.milvus_client(collection)*** +***ann_insert.milvus_client(host, port, collection_name, user= None, password=None, collection_schema=None, index_params=None)*** + +**Parameters:** + +***host:*** *str* + +The host for Milvus. + +***port:*** *str* + +The port for Milvus. + +***collection_name:*** *str* + +The collection name for Milvus. + +***user:*** *str* + +The user for Zilliz Cloud, defaults to None. + +***password:*** *str* + +The password for Zilliz Cloud, defaults to None. + +
-**Returns:** *None* + +## Interface + +Insert Milvus data. + +**Parameters:** + +***data:*** *list* + +The data to insert into milvus. + +**Returns:** MutationResult + +A MutationResult object contains `insert_count` represents how many and a `primary_keys` of primary keys.