-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Description
What feature(s) would you like to see?
Problem
Currently there's no direct method in the CompassClient SDK to list all documents in an index. Users have to work around this by using search_documents
with a wildcard query, which isn't intuitive and may not be the most efficient approach, esp. when you have thousands of chunks per document.
Proposed Solution
Add a new method to CompassClient
class:
list_documents()
Implementation Details
- Add new endpoint to Compass API for efficient document listing
- Return paginated results to handle large document sets
- Include basic document metadata (id, path, creation date)
- Support filtering by document attributes
Acceptance Criteria
- New
list_documents
method added to CompassClient - Proper pagination support
- Filter support
- Unit tests
- Documentation updated with examples
Additional Context
This will provide a more intuitive and potentially more efficient way to:
- List all documents in an index
- Check indexing status
- Verify document counts
- Build document management features
/label enhancement
/label sdk
Additional information
No response
Metadata
Metadata
Assignees
Labels
No labels