paperap.models.document.suggestions.model module
METADATA:
- File: suggestions.py
Project: paperap
- Created: 2025-03-18
Version: 0.0.9
Author: Jess Mann Email: jess@jmann.me
Copyright (c) 2025 Jess Mann
LAST MODIFIED:
2025-03-18 By Jess Mann
- class paperap.models.document.suggestions.model.DocumentSuggestions(**data)[source]
Bases:
StandardModelRepresents suggestions for a Paperless-NgX document.
- correspondents
List of suggested correspondent IDs.
- tags
List of suggested tag IDs.
- document_types
List of suggested document type IDs.
- storage_paths
List of suggested storage path IDs.
- dates
List of suggested dates.
- Parameters:
data (
Any)
- correspondents: list[int]
- tags: list[int]
- document_types: list[int]
- storage_paths: list[int]
- dates: list[date]
- class Meta(model)[source]
Bases:
Meta- Parameters:
model (type[_Self])
- read_only_fields: ClassVar[set[str]] = {'correspondents', 'dates', 'document_types', 'id', 'storage_paths', 'tags'}
- blacklist_filtering_params: ClassVar[set[str]] = {}
- field_map: dict[str, str] = {}
- filtering_disabled: ClassVar[set[str]] = {}
- filtering_fields: ClassVar[set[str]] = {'_resource', 'correspondents', 'dates', 'document_types', 'id', 'storage_paths', 'tags'}
- supported_filtering_params: ClassVar[set[str]] = {'id', 'id__in', 'limit'}
- model: type[_Self]
- name: str
- model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'ignore', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.
- id: int