paperap.models.document.suggestions.queryset module
Document suggestions queryset module for interacting with document suggestions API.
This module provides the queryset implementation for document suggestions in Paperless-NgX, allowing for efficient querying and filtering of document suggestions data. Document suggestions are recommendations provided by Paperless-NgX for document metadata such as correspondents, document types, and tags based on document content analysis.
- class paperap.models.document.suggestions.queryset.DocumentSuggestionsQuerySet(resource, filters=None, _cache=None, _fetch_all=False, _next_url=None, _last_response=None, _iter=None, _urls_fetched=None)[source]
Bases:
StandardQuerySet
[DocumentSuggestions]QuerySet for interacting with document suggestions in Paperless-NgX.
This class extends StandardQuerySet to provide specialized functionality for retrieving and filtering document suggestions. Document suggestions are recommendations for metadata (correspondents, document types, tags) that Paperless-NgX generates based on document content analysis.
The queryset is lazy-loaded, meaning API requests are only made when data is actually accessed, improving performance when working with large datasets.
Examples
>>> # Get all suggestions for a document >>> suggestions = client.document_suggestions.filter(document=123) >>> >>> # Get suggestions with high confidence scores >>> high_confidence = client.document_suggestions.filter( ... document=123, ... confidence__gte=0.8 ... )
- Parameters:
resource (BaseResource[_Model, Self])
filters (dict[str, Any] | None)
_cache (list[_Model] | None)
_fetch_all (bool)
_next_url (str | None)
_last_response (ClientResponse)
_iter (Iterator[_Model] | None)
_urls_fetched (list[str] | None)