intent

type Coverage ¶ added in v0.13.1

type Coverage struct {
	WithReason   int
	Declarations int
}

Coverage is how much of a repository ever recorded a reason: how many declarations carry at least one @intent or @domainRule, out of how many declarations were indexed at all.

WithReason counts declarations, not reasons, and that is the whole point of the type. One reason is one indexed document, so a declaration whose author wrote three of them is three documents; counting documents would report that declaration three times and say a repository is better annotated than it is.

@domainRule WithReason never exceeds Declarations, because both are counted from the same derived index. @intent let an answer say whether it came back empty because nobody wrote a reason down.

type Hit ¶

type Hit struct {
	Node  graph.Node
	Terms []string
}

Hit is one declaration the index returned, with the terms of the question that are written in its recorded reason. @intent carry the reason a declaration ranked, not only that it ranked.

type Result ¶

type Result struct {
	Hits  []Hit
	Terms []Term
	// Corpus is how many recorded reasons the scorer weighed a word's commonness
	// against — a count of reasons, so it is not Coverage.WithReason.
	Corpus int
	// Coverage is the state of the whole recorded-reason index, not of this
	// query. It is reported even when nothing matched, because that is the case
	// it exists for.
	Coverage Coverage
}

Result is what the recorded-reason index answered with: the ranked hits and the evidence that produced them. @intent keep the ranking and the evidence for it on one value, so neither can be reported without the other.

func (r Result) CanAnswer() bool

type Searcher ¶

type Searcher interface {
	QueryIntent(ctx context.Context, query string, limit int) (Result, error)
}

Searcher answers a question from the recorded-reason index alone. @intent let search consume a bound intent-index implementation without a database handle.

type Term ¶

type Term struct {
	Text      string `json:"text"`
	InReasons int    `json:"in_reasons"`
}

Term is one term of the question and how many recorded reasons hold it.

A term nobody wrote down comes back with a count of zero rather than being left out: that zero is the reader's answer to why the question came back thin. @intent let a reader weigh a match by how common the word that earned it is.