docs(zilliz): connection_args add token description for serverless cl… (#7810)

Description:

Currently, Zilliz only support dedicated clusters using a pair of
username and password for connection. Regarding serverless clusters,
they can connect to them by using API keys( [ see official note
detail](https://docs.zilliz.com/docs/manage-cluster-credentials)), so I
add API key(token) description in Zilliz docs to make it more obvious
and convenient for this group of users to better utilize Zilliz. No
changes done to code.

---------

Co-authored-by: Robin.Wang <3Jg$94sbQ@q1>
Co-authored-by: Bagatur <baskaryan@gmail.com>
This commit is contained in:
satorioh 2023-07-19 00:31:39 +08:00 committed by GitHub
parent 235264a246
commit 259a409998
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 2 deletions

View File

@ -65,7 +65,8 @@
"# replace\n", "# replace\n",
"ZILLIZ_CLOUD_URI = \"\" # example: \"https://in01-17f69c292d4a5sa.aws-us-west-2.vectordb.zillizcloud.com:19536\"\n", "ZILLIZ_CLOUD_URI = \"\" # example: \"https://in01-17f69c292d4a5sa.aws-us-west-2.vectordb.zillizcloud.com:19536\"\n",
"ZILLIZ_CLOUD_USERNAME = \"\" # example: \"username\"\n", "ZILLIZ_CLOUD_USERNAME = \"\" # example: \"username\"\n",
"ZILLIZ_CLOUD_PASSWORD = \"\" # example: \"*********\"" "ZILLIZ_CLOUD_PASSWORD = \"\" # example: \"*********\"\n",
"ZILLIZ_CLOUD_API_KEY = \"\" # example: \"*********\" (for serverless clusters which can be used as replacements for user and password)"
] ]
}, },
{ {
@ -112,6 +113,7 @@
" \"uri\": ZILLIZ_CLOUD_URI,\n", " \"uri\": ZILLIZ_CLOUD_URI,\n",
" \"user\": ZILLIZ_CLOUD_USERNAME,\n", " \"user\": ZILLIZ_CLOUD_USERNAME,\n",
" \"password\": ZILLIZ_CLOUD_PASSWORD,\n", " \"password\": ZILLIZ_CLOUD_PASSWORD,\n",
" # \"token\": ZILLIZ_CLOUD_API_KEY, # API key, for serverless clusters which can be used as replacements for user and password\n",
" \"secure\": True,\n", " \"secure\": True,\n",
" },\n", " },\n",
")" ")"
@ -174,7 +176,7 @@
"name": "python", "name": "python",
"nbconvert_exporter": "python", "nbconvert_exporter": "python",
"pygments_lexer": "ipython3", "pygments_lexer": "ipython3",
"version": "3.9.12" "version": "3.11.3"
} }
}, },
"nbformat": 4, "nbformat": 4,

View File

@ -50,6 +50,8 @@ class Zilliz(Milvus):
password are provided, we will add related header in every RPC call. password are provided, we will add related header in every RPC call.
password (str): Required when user is provided. The password password (str): Required when user is provided. The password
corresponding to the user. corresponding to the user.
token (str): API key, for serverless clusters which can be used as
replacements for user and password.
secure (bool): Default is false. If set to true, tls will be enabled. secure (bool): Default is false. If set to true, tls will be enabled.
client_key_path (str): If use tls two-way authentication, need to client_key_path (str): If use tls two-way authentication, need to
write the client.key path. write the client.key path.
@ -76,6 +78,7 @@ class Zilliz(Milvus):
"uri": "https://in03-ba4234asae.api.gcp-us-west1.zillizcloud.com", "uri": "https://in03-ba4234asae.api.gcp-us-west1.zillizcloud.com",
"user": "temp", "user": "temp",
"password": "temp", "password": "temp",
"token": "temp", # API key as replacements for user and password
"secure": True "secure": True
} }
drop_old: True, drop_old: True,