This topic describes how to obtain an existing collection by using the SDK for Python.
In a collection, you can perform operations on documents and partitions, such as inserting a document, searching for a document, and managing a partition.
Prerequisites
A cluster is created. For more information, see Create a cluster.
An API key is obtained. For more information, see Manage API keys.
The SDK of the latest version is installed. For more information, see Install DashVector SDK.
API definition
Client.get(name: str) -> Union[Collection, DashVectorResponse]Example
You need to replace YOUR_API_KEY with your API key and YOUR_CLUSTER_ENDPOINT with the endpoint of your cluster in the sample code for the code to run properly.
You need to create a collection named
quickstartin advance. For more information, see the "Example" section of the Create a collection topic.
import dashvector
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')
# Check whether the get method is successfully called.
assert collectionRequest parameters
Parameter | Type | Default value | Description |
name | str | - | The name of the existing collection. |
Response parameters
A Collection object is returned if the method is successfully called, which contains the operation result, as described in the following table.
A DashVectorResponse object is returned if the method fails to be called, which contains the operation error information, as described in the following table.
Parameter | Type | Description | Example |
code | int | The returned status code. For more information, see Status codes. | 0 |
message | str | The returned message. | success |
request_id | str | The unique ID of the request. | 19215409-ea66-4db9-8764-26ce2eb5bb99 |