Skip to main content
moss v1.0.1 moss / GetDocumentsOptions

Interface: GetDocumentsOptions

Options for get_docs — deterministic retrieval (no query vector, no ranking). See Exact / Graph Retrieval.

Properties

  • doc_ids: Optional[List[str]] - Fetch these exact ids, returned in this order. Missing ids are skipped.
  • filter: Optional[dict] - Metadata predicate (same dict shape as QueryOptions.filter / metadata filtering). (moss 1.6.0+)
  • sort_by: Optional[str] - Metadata field to order results by (numeric-aware). (moss 1.6.0+)
  • ascending: Optional[bool] - Sort direction for sort_by; defaults to ascending. (moss 1.6.0+)
  • group_by: Optional[ParentGrouping] - Collapse sibling docs sharing a parent id into one result per unit. See ParentGrouping. (moss 1.6.0+)