Skip to main content
Version: 0.0.5 (stable)

agrag.candidates.CandidateQuery

Bases: BaseModel

Filter candidate groups by kind, label, state, and total sightings.

Attributes:

  • kind (CandidateKind | None) – Candidate kind to include, or all kinds when unset.
  • label (str | None) – Exact candidate label to include, or all labels when unset.
  • state (CandidateState | None) – Review state to include. Defaults to pending candidates.
  • min_count (int) – Minimum aggregate sighting count, at least one.

kind​

kind: CandidateKind | None = None

label​

label: str | None = None

min_count​

min_count: int = Field(default=1, ge=1)

model_config​

model_config = ConfigDict(frozen=True)

state​

state: CandidateState | None = 'pending'