IndexDescriptionResponse

Reports vector index status.

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

Use IndexDescriptionResponse to inspect the current status string for a vector table index.

Attributes

Attribute	Type	Description
index_status	str or None	Current status of the index.

Methods

Method	Return Type	Description
model_dump()	dict[str, Any]	Returns a Pydantic dictionary representation of the object.
model_dump_json()	str	Returns a Pydantic JSON string representation of the object.
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.

Iterate Attributes

Use the response serialization helper to iterate every public attribute.

response = client.describe_index(table_name="product_vectors")

payload = response.to_dict()

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

Sample Response

{
  "index_status": "COMPLETE"
}

Returned By

Returned by: describe_index().