List Vector Indices

GET

List existing vector similarity search indices with pagination support.

Returns details about each index including:

The response can be filtered using the filter_by parameter to narrow down results based on table name, index method, or other attributes.

filtersstringOptional

offsetintegerOptional

Specifies the number of objects to skip. Defaults to 0.

limitintegerOptional

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.

Successful Response

resultsobject

total_entriesinteger

1	from r2r import R2RClient
2
3	client = R2RClient("http://localhost:7272")
4
5	# List all indices
6	indices = client.indices.list(
7	offset=0,
8	limit=10,
9	filters={"table_name": "vectors"}
10	)
11
12	# Print index details
13	for idx in indices:
14	print(f"Index: {idx['name']}")
15	print(f"Method: {idx['method']}")
16	print(f"Size: {idx['size_bytes'] / 1024 / 1024:.2f} MB")
17	print(f"Row count: {idx['row_count']}")