VectorTableCollectionResponse

Represents a page of vector tables.

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

Use VectorTableCollectionResponse to read vector table list results and pagination metadata.

Attributes

Attribute Type Description
items list of VecDBTableItem or None Vector tables returned in the current page.
has_more bool or None Indicates whether another page of vector tables is available.
limit int or float or None Page size limit applied by the service.
offset int or float or None Offset used for the current page.
count int or float or None Number of vector tables returned in the current page.
links list[LinkRelation] or None Hypermedia links returned by the service.

VecDBTableItem

Represents one vector table returned in the items list of a VectorTableCollectionResponse response.

Attributes

Attribute Type Description
table_name str or None The name of the table.
comment str or None Public comment for the vector table.
auto_generate_id int or None Whether the ID column is generated automatically.
owner str or None Owner of the vector table.
status str or None Population status of the vector table.
vector_type str or None Vector storage type.
vector_table_type str or None Creation mode of the table.
index_params VecDBTableNoLinksIndexParams or None Index configuration for the table.
annotations dict[str, Any] or None User metadata attached to the table.
embed_params VecDBTableNoLinksEmbedParams or None Embedding configuration for the table.
dense_idx_name str or None Name of the vector index associated with the table.
stats VecDBTableNoLinksStats 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.
links list[LinkRelation] or None Hypermedia links returned by the service.

Iterate Items

Iterate over response.items to access each VecDBTableItem and its attributes.

response = client.list_vector_tables()

for table in response.items or []:
    print(table.table_name)
    print(table.status)

    table_payload = table.to_dict()
    print(table_payload)

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

Iterate Attributes

Use serialization helpers to iterate response attributes and item attributes.

response = client.list_vector_tables()

payload = response.to_dict()

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

for table in response.items or []:
    table_payload = table.to_dict()
    for attribute, value in table_payload.items():
        print(attribute, value)

Sample Response

{
  "items": [
    {
      "table_name": "DEMO_PRODUCTS",
      "comment": "Demo table for SDK examples",
      "status": "Empty",
      "vector_type": "dense",
      "vector_table_type": "BYOV"
    }
  ],
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "count": 1
}

Returned By

Returned by: list_vector_tables().