describe_index

Use the describe index operation to get the current status and configuration of a vector table’s index.

Returns the current index status.

Parameters

Parameter	Type	Value Range	Required	Default	Description	Notes
table_name	str	Valid vector table identifier	Yes	No default	Name of the vector table whose index to describe.	Table must exist in the database schema.

Raises Exception – InvalidTableNameFormatError may be raised when the table name is invalid. The operation also fails if the table or index does not exist.

Describe an index

index = client.describe_index(table_name="MY_VECTOR_TABLE")

Returns JSON response containing the current index status in the index_status field.

Return type IndexDescriptionResponse

Example response

When the vector index has not been created, the response is:

{
  "index_status": "Vector Index is not created"
}