The delete_index API deletes a specified vector index. This article explains how to use the delete_index API of TOS Vectors Python SDK to delete a vector index.

Notes

You need to fill in the region and endpoint in the sample code according to your actual situation. For details, see Region and Endpoint.

To prevent key leakage, the sample code in this article reads the Access Key ID and Secret Access Key from environment variables. Therefore, before using the SDK, you need to configure long-term access credentials. For details, see Configure long-term access credentials.

TOS Vectors Python SDK supports temporary access credentials and allows you to configure timeout mechanisms, retry policies, and other settings. You can customize these based on your business needs to improve application security. For details, see Common configuration scenarios.

Permissions required

The primary account has all permissions by default, but IAM users have no permissions by default. If you need a sub-account to perform the delete_index operation, the primary account must grant the following permissions to the sub-account through IAM policies and bucket policies:

tosvectors:DeleteIndex

Code example

Delete the specified vector index

# Delete the specified vector index.​
import os​
import tos​
​
# Retrieve AK and SK information from environment variables.​
ak = os.getenv('TOS_ACCESS_KEY')​
sk = os.getenv('TOS_SECRET_KEY')​
# Fill in your endpoint and your region with the endpoint corresponding to the bucket's region. # For example, for China (Beijing), set your endpoint to https://tosvectors-cn-beijing.volces.com and your region to cn-beijing.​
endpoint = 'Provide your endpoint'​
region = 'Provide your region'​
vector_bucket_name = 'Provide your bucket name'​
​
# Get the account ID and index name from environment variables.​
account_id = os.getenv('TOS_ACCOUNT_ID')​
index_name = 'examplevectorindex'​
​
try:​
    # Create a VectorClient object; all vector operations are handled through VectorClient.​
    client = tos.VectorClient(ak, sk, endpoint, region)​
    ​
    # Delete the specified vector index.​
    # Parameter description：​
    # - vector_bucket_name: Vector bucket name​
    # - account_id: Account ID, used to identify the operator's identity​
    # - index_name: Name of the vector index to be deleted​
    result = client.delete_index(​
        vector_bucket_name=vector_bucket_name,​
        account_id=account_id,​
        index_name=index_name​
    )​
    ​
    # Print the information indicating successful deletion.​
    print('Delete vector index successfully')​
    print('Request ID: {}'.format(result.request_id))​
    print('Status code: {}'.format(result.status_code))​
    print('Index name: {}'.format(index_name))​
    ​
except tos.exceptions.TosClientError as e:​
    # The operation failed and a client exception was caught. This is usually due to invalid request parameters or a network exception.​
    print('fail with client error, message:{}, cause: {}'.format(e.message, e.cause))​
except tos.exceptions.TosServerError as e:​
    # The operation failed and a server exception occurred. See the response for the error details.​
    print('fail with server error, code: {}'.format(e.code))​
    # Use the request ID for troubleshooting purposes. We strongly recommend including the request ID in the logs.​
    print('error with request id: {}'.format(e.request_id))​
    print('error with message: {}'.format(e.message))​
    print('error with http code: {}'.format(e.status_code))​
    print('error with ec: {}'.format(e.ec))​
    print('error with request url: {}'.format(e.request_url))​
except Exception as e:​
    print('fail with unknown error: {}'.format(e))​