describe_vector_table

Use the describe vector table operation to retrieve detailed configuration and metadata for a vector table.

Returns comprehensive information about the specified table including its schema, index configuration, embedding settings, row count, and creation timestamp.

Parameters

Parameter	Type	Value Range	Required	Default	Description	Notes
name	str	Valid vector table identifier	Yes	No default	Name of the vector table 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 does not exist.

Describe a table and print key attributes

details = client.describe_vector_table(name="product_vectors")
print(details.to_dict())

Return type VectorTableResponse

Returns JSON response describing the table.

• Table name and comment
• Vector type and dimensions
• Index parameters and status
• Embedding model configuration (if applicable)
• Row count and storage statistics
• Annotations and metadata

Example response:

{
    "table_name": "DEMO_PRODUCTS",
    "owner": "VECTOR3",
    "status": "Empty",
    "vector_type": "dense",
    "vector_table_type": "BYOV",
    "index_params": {
        "vector_index_params": {
            "auto_index": true,
            "organization": "PARTITIONS",
            "advanced_params": {
                "partitions": 10
            }
        },
        "parallel_creation": 4
    },
    "annotations": {
        "metric": "cosine",
        "dimension": "5"
    },
    "embed_params": null,
    "created": "2026-03-12T11:21:30Z",
    "comment": "Demo table for SDK examples"
}