DatabaseSummaryResponse

Summarizes vector database resources.

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

Use DatabaseSummaryResponse to inspect database-level counts for vector tables, vectors, and loaded models.

Attributes

Attribute Type Description
total_tables int or float or None Total number of vector tables.
total_vectors int or float or None Total number of vectors across vector tables.
total_models int or float or None Total number of loaded models.

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) DatabaseSummaryResponse Creates a response object from a dictionary payload.
model_validate_json(json_data) DatabaseSummaryResponse Creates a response object from a JSON string.

Iterate Attributes

Use the response serialization helper to iterate every public attribute.

response = client.describe_vector_database()

payload = response.to_dict()

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

Sample Response

{
  "total_tables": 3,
  "total_vectors": 125000,
  "total_models": 2
}

Returned By

Returned by: describe_vector_database().