-
Notifications
You must be signed in to change notification settings - Fork 123
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com>
- Loading branch information
1 parent
18d4ce6
commit 4e23fdd
Showing
3 changed files
with
83 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Get Started | ||
|
||
Milvus offers RESTful API for you to manipulate your collections and data stored in them. Before you dive in, there are several things that are worth noting: | ||
|
||
## Understanding the API endpoints | ||
|
||
These API endpoints involve manipulating collections in a specified cluster as well as the data in a specific collection. | ||
|
||
The prefix of an API endpoint should always be the URI of your Milvus instance, such as `localhost:19530`. | ||
|
||
The following is the API endpoint used to list collections in a Milvus cluster. | ||
|
||
```shell | ||
export CLUSTER_ENDPOINT="http://localhost:19530" | ||
|
||
curl --request GET \ | ||
--url '${CLUSTER_ENDPOINT}/v2/vectordb/collections/list' \ | ||
--header 'accept: application/json' \ | ||
--header 'content-type: application/json' | ||
``` | ||
|
||
## Authentication credentials | ||
|
||
With default settings, you do not need to provide any authentication credentials to access the API endpoints. However, if you have enabled authentication in your Milvus instance, you need to provide the correct credentials in the request header. You can use a token as the authentication method when you access the API endpoints. To obtain a token, you should use a colon (:) to concatenate the username and password that you use to access your Milvus instance. For example, `root:milvus`. | ||
|
||
```shell | ||
export CLUSTER_ENDPOINT="http://localhost:19530" | ||
export TOKEN="root:milvus" | ||
|
||
curl --request GET \ | ||
--url '${CLUSTER_ENDPOINT}/v2/vectordb/collections/list' \ | ||
--header "Authorization: Bearer ${TOKEN}" \ | ||
--header 'accept: application/json' \ | ||
--header 'content-type: application/json' | ||
``` | ||
|
||
## API endpoint versioning | ||
|
||
Milvus offers two sets of API endpoints, namely v1 and v2. The v1 endpoints only covers collection and vector operations, while the v2 endpoints cover more operations such as index management, partition management, and role-based access control (RBAC) operations. The v1 endpoints are to be deprecated in the near future, and the v2 endpoints are the recommended ones to use. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Get Started | ||
|
||
Milvus offers RESTful API for you to manipulate your collections and data stored in them. Before you dive in, there are several things that are worth noting: | ||
|
||
## Understanding the API endpoints | ||
|
||
These API endpoints involve manipulating collections in a specified cluster as well as the data in a specific collection. | ||
|
||
The prefix of an API endpoint should always be the URI of your Milvus instance, such as `localhost:19530`. | ||
|
||
The following is the API endpoint used to list collections in a Milvus cluster. | ||
|
||
```shell | ||
export CLUSTER_ENDPOINT="http://localhost:19530" | ||
|
||
curl --request GET \ | ||
--url '${CLUSTER_ENDPOINT}/v2/vectordb/collections/list' \ | ||
--header 'accept: application/json' \ | ||
--header 'content-type: application/json' | ||
``` | ||
|
||
## Authentication credentials | ||
|
||
With default settings, you do not need to provide any authentication credentials to access the API endpoints. However, if you have enabled authentication in your Milvus instance, you need to provide the correct credentials in the request header. You can use a token as the authentication method when you access the API endpoints. To obtain a token, you should use a colon (:) to concatenate the username and password that you use to access your Milvus instance. For example, `root:milvus`. | ||
|
||
```shell | ||
export CLUSTER_ENDPOINT="http://localhost:19530" | ||
export TOKEN="root:milvus" | ||
|
||
curl --request GET \ | ||
--url '${CLUSTER_ENDPOINT}/v2/vectordb/collections/list' \ | ||
--header "Authorization: Bearer ${TOKEN}" \ | ||
--header 'accept: application/json' \ | ||
--header 'content-type: application/json' | ||
``` | ||
|
||
## API endpoint versioning | ||
|
||
Milvus offers two sets of API endpoints, namely v1 and v2. The v1 endpoints only covers collection and vector operations, while the v2 endpoints cover more operations such as index management, partition management, and role-based access control (RBAC) operations. The v1 endpoints are to be deprecated in the near future, and the v2 endpoints are the recommended ones to use. |