IndexDetailsResponse

Describes vector and metadata index details returned with a vector table response.

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

Use IndexDetailsResponse through VectorTableResponse.indexes to inspect the vector index name and metadata paths indexed for a table.

Attributes

Attribute Type Description
dense_idx_name str or None Name of the dense vector index.
indexed_metadata_json_paths list[str] or None Metadata JSON paths indexed for the table.

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.

Access Fields

Use either attributes or dictionary-style access.

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

if table.indexes:
    print(table.indexes.dense_idx_name)
    print(table.indexes["indexed_metadata_json_paths"])

Returned By

Returned in VectorTableResponse.indexes from create_vector_table(), describe_vector_table(), and update_vector_table_annotation().