VectorTableResponse

Describes one vector table.

For the list of response object types, see Response Objects.

Use VectorTableResponse to inspect vector table metadata, annotations, automatic embedding settings, index settings, status, timestamps, and table creation options.

Attributes

Attribute Type Description
table_name str or None Name of the vector table.
comment str or None Table comment.
annotations dict[str, Any] or None User metadata attached to the table.
vector_type str or None Vector storage type returned by the service.
vector_table_type str or None Creation mode of the table.
embed_params VecDBTableBaseNoLinksEmbedParams or None Automatic embedding configuration for the table.
index_params VectorIndexParams or None Index configuration associated with the table.
owner str or None Database schema that owns the table.
indexes IndexDetailsResponse or None Vector and metadata index details returned for the table.
status str or None Population status of the vector table.
stats dict[str, Any] or None Statistics for the vector table.
created datetime or None Creation timestamp of the vector table.
updated datetime or None Last update timestamp of the vector table.
table_params VecDBTableNoLinksAllOfTableParams or None Table creation options returned with the table description.

Methods

Method Return Type Description
model_dump() dict[str, Any] Returns a dictionary representation of the response.
model_dump_json() str Returns a JSON string representation of the response.
to_dict() dict[str, Any] Returns a dictionary representation compatible with earlier SDK response handling.
to_json() str Returns a JSON string representation compatible with earlier SDK response handling.
to_str() str Returns a readable string representation compatible with earlier SDK response handling.
model_validate(obj) VectorTableResponse Creates a response object from a dictionary payload.
model_validate_json(json_data) VectorTableResponse Creates a response object from a JSON string.

Iterate Attributes

Use the response serialization helper to iterate every public attribute.

response = client.describe_vector_table(name="product_vectors")

payload = response.to_dict()

for attribute, value in payload.items():
    print(attribute, value)

Sample Response

{
  "table_name": "DEMO_PRODUCTS",
  "owner": "VECTOR3",
  "status": "Empty",
  "vector_type": "dense",
  "vector_table_type": "BYOV",
  "comment": "Demo table for SDK examples",
  "annotations": {
    "metric": "cosine",
    "dimension": "5"
  },
  "index_params": {
    "vector_index_params": {
      "auto_index": true,
      "organization": "PARTITIONS",
      "distance_metric": "COSINE"
    }
  },
  "stats": {
    "total_vectors": 0
  },
  "created": "2026-03-12T11:21:30Z",
  "updated": "2026-03-12T11:21:30Z"
}

Returned By

Returned by: create_vector_table(), describe_vector_table(), update_vector_table_annotation().