- docid: str # a unique idenfier for the document
- tags: Set[str] # an optional set of tags
- properties: List[
- Tuple[str, str]
- ] # an optional set of key->value properties
- reference: Any # an optional reference to something else
+ tags: Set[str] = field(default_factory=set)
+ """A set of tag strings for this document. May be empty. Tags
+ are simply text labels that are associated with a document and
+ may be used to search for it later.
+ """
+
+ properties: List[Tuple[str, str]] = field(default_factory=list)
+ """A list of key->value strings for this document. May be empty.
+ Properties are more flexible tags that have both a label and a
+ value. e.g. "category:mystery" or "author:smith"."""
+
+ reference: Optional[Any] = None
+ """An optional reference to something else for convenience;
+ interpreted only by caller code, ignored here.
+ """