link

type Candidate struct {
	// ID is the element name used in question ids (`c1`, `c2`, ...).
	ID        string
	Path      string
	Title     string
	Aliases   []string
	Criterion string
	Summary   string
	Origins   []string
}

type Generator struct {
	// contains filtered or unexported fields
}

type Insertion struct {
	Target   string // candidate path
	Form     string
	Relation string
	Text     string
	Start    int
	End      int
	P        float64
	Receipt  string
}

type MentionRef struct {
	N int
	// Candidate is the candidate ID the mention points to.
	Candidate string
	Start     int
	End       int
	Text      string
	Sentence  string
}

type Neighbours interface {
	Neighbours(ctx context.Context, doc *corpus.Document, k int) ([]string, error)
}

type Options struct {
	// Paths limits the run to these topic-relative documents (ingest); empty
	// means every document of the topic.
	Paths []string
	// All relinks documents whose body and candidate set are unchanged.
	All bool
	// DryRun asks (cached) decisions but writes nothing: no files, state
	// rows, queue items or inserted-links rows.
	DryRun bool
	// Neighbours is the optional semantic-neighbour source (nil = off).
	Neighbours Neighbours
}

type Outcome struct {
	// Updates are the owned-key writes (relation lists, affects).
	Updates map[string]any
	// Added lists, per key, the targets newly added.
	Added map[string][]string
	// Insertions are the body links to insert (apply mode only).
	Insertions []Insertion
	// Items are review-queue items to add.
	Items          []review.Item
	Proposals      int
	Reviews        int
	Contradictions int
	Demotions      int
	Undecided      int
}

type Plan struct {
	Doc        *corpus.Document
	Candidates []Candidate
	Mentions   []MentionRef
	// Forms maps candidate path → relation target form (stem or vault path).
	Forms map[string]string
	// Relations holds the document's current relation lists (raw entries)
	// for every relation key and `affects`.
	Relations map[string][]string
	// Present maps key → candidate paths already listed under that key.
	Present map[string]map[string]bool
	// KBOwned reports keys whose current value kb wrote (value hash equals
	// the state row's written hash).
	KBOwned map[string]bool
	// BodyLinked lists candidate paths the body already links to.
	BodyLinked map[string]bool
}

type Report struct {
	DryRun    bool
	BodyMode  string
	Documents int
	Judged    int
	// Applied counts new targets per relation key (and `affects`).
	Applied        map[string]int
	Inserted       int
	Proposals      int
	Reviews        int
	Demotions      int
	Contradictions int
	// Undecided counts undecided answers.
	Undecided int
	// Decided counts judged documents whose every answer was decided.
	Decided int
	// UndecidedDocuments lists, sorted, the judged documents with an
	// undecided answer: they keep no link bookkeeping, so the next run
	// judges them again (through the cache for the decided answers).
	UndecidedDocuments []string
	Skipped            map[string]int
	// Changes lists what was (or, in a dry run, would be) changed.
	Changes []string
}

type Targets struct {
	// contains filtered or unexported fields
}

type Thresholds struct {
	Apply   float64 // link_apply
	Review  float64 // link_review
	Mention float64 // mention_sense
	Affects float64 // affects
}