List IDs

Returns every item ID in the index.

index.list_ids()

Returns

List[str]: all IDs in the index.

Exceptions

cyborgdb.AuthenticationError

The index_key or api_key is invalid (HTTP 401).

cyborgdb.ServiceError / cyborgdb.TransportError

The service returns 5xx or can’t be reached.

See Errors for the full hierarchy.

Example Usage

all_ids = index.list_ids()
print(len(all_ids))
# Output: 3

print("doc1" in all_ids)
# Output: True

# Fetch items in batches of 100
for i in range(0, len(all_ids), 100):
    items = index.get(all_ids[i:i + 100])

Introduction

Client

Encrypted Index

Types & Helpers

Returns

Exceptions

Example Usage

​Returns

​Exceptions

​Example Usage

Returns

Exceptions

Example Usage