classify

type GateJudgment struct {
	// Role is the argmax role, RoleCollectedOnPurpose when the path matches
	// `collected_on_purpose_paths` (no call), or "" when relevance is off or
	// the role answer is undecided.
	Role string `json:"role,omitempty"`
	// RoleAsked reports whether the `role` question was in the request.
	RoleAsked bool `json:"role_asked"`
	// RoleByPath reports that Role came from the path globs.
	RoleByPath bool `json:"role_by_path,omitempty"`
	// RoleProbs is the role distribution when decided.
	RoleProbs map[string]float64 `json:"role_probs,omitempty"`
	// POffTopic is P(off_topic).
	POffTopic float64 `json:"p_off_topic"`
	// PKept is P(core) + P(adjacent) + P(collected_on_purpose).
	PKept float64 `json:"p_kept"`
	// RoleDecided reports a usable role (decided answer or path glob).
	RoleDecided bool `json:"role_decided"`
	// Quality maps each decided quality noul id to P(yes).
	Quality map[string]float64 `json:"quality"`
	// QualityDecided reports that every quality noul was decided.
	QualityDecided bool `json:"quality_decided"`
	// Flags are the code flags passed in GateOptions.
	Flags []quality.Flag `json:"flags,omitempty"`
	// Undecided lists "<question>:<reason>" for every answer that was not
	// decided (not-checked answers read "<question>:not_checked:<reason>").
	Undecided []string `json:"undecided,omitempty"`
	// ReceiptKey is the receipts key of the request.
	ReceiptKey string `json:"receipt_key,omitempty"`
}

type GateOptions struct {
	// IsTranscript adds the `no_speech_content` noul.
	IsTranscript bool
	// Flags are the code quality flags already computed by the caller
	// (quality.Check); they are carried into the judgment and win over the
	// nouls in QualityReason.
	Flags []quality.Flag
	// Contract overrides the session's active contract (the impact preview
	// judges a draft). Its hash replaces the session's in the cache key, so
	// the receipts are reused once the same draft is accepted.
	Contract *contract.Contract
}

type Options struct {
	// OnlyMissing judges only documents without a state row or with a
	// missing facet key (the bootstrap follow-up after vocabulary accept).
	OnlyMissing bool
	// All re-judges every document regardless of the state record.
	All bool
	// Paths restricts the run to these topic-relative paths (ingest).
	Paths []string
}

type Report struct {
	// Documents is the number of documents considered (after Paths).
	Documents int `json:"documents"`
	// Judged is the number of documents that went through the facet pass.
	Judged int `json:"judged"`
	// Decided is the number of judged documents whose every answer and
	// literal was decided (the rest stay unclassified for the next run).
	Decided int `json:"decided"`
	// UndecidedDocuments lists, sorted, the documents left with an
	// undecided answer or literal (spec §2.3: named in the run summary).
	UndecidedDocuments []string `json:"undecided_documents"`
	// Skipped counts documents not judged, by reason: unchanged (state row
	// current), complete (--only-missing and nothing missing), locked, stub.
	Skipped map[string]int `json:"skipped"`
	// Facets counts written keys (a key rewritten with the same value is not
	// counted).
	Facets map[string]int `json:"facets"`
	// Writes counts document write outcomes: written, unchanged,
	// skipped:locked, skipped:changed.
	Writes map[string]int `json:"writes"`
	// SkippedUserKeys counts keys left alone because the user owns them
	// (skipped:user-key), by key.
	SkippedUserKeys map[string]int `json:"skipped_user_keys"`
	// Undecided counts answers and literals that were not decided, by
	// "<question>:<reason>" (not-checked answers read
	// "<question>:not_checked:<reason>"). Undecided answers never write.
	Undecided map[string]int `json:"undecided"`
	// Queued counts review items added, by queue.
	Queued map[string]int `json:"queued"`
	// DroppedEntities counts generated entity names dropped by the verbatim
	// check or the cap.
	DroppedEntities int `json:"dropped_entities"`
	// InvalidLiterals counts generated literals rejected by code, by key.
	InvalidLiterals map[string]int `json:"invalid_literals"`
	// CriterionMissing lists articles without `criterion` whose option text
	// fell back to their summary or head.
	CriterionMissing []string `json:"criterion_missing"`
	// ArticlesChanged lists articles that gained aliases (they trigger the
	// link reverse pass).
	ArticlesChanged []string `json:"articles_changed"`
	// PrimaryNone counts sources whose primary concept was `none` in this
	// run.
	PrimaryNone int `json:"primary_none"`
	// PrimaryNoneTotal counts the topic's sources whose primary concept is
	// `none` (this run plus earlier runs), the concept proposal trigger.
	PrimaryNoneTotal int `json:"primary_none_total"`
	// NoVocabulary reports a topic without articles: no concept questions
	// were asked.
	NoVocabulary bool `json:"no_vocabulary"`
	// RelevanceOff reports decisions.relevance: off (no role questions).
	RelevanceOff bool `json:"relevance_off"`
}