Documentation
¶
Overview ¶
@index Recorded-reason retrieval: the intent index port and its answer types.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RecordedReason ¶
RecordedReason returns the line that could have earned this node its place in the intent index.
It mirrors document.BuildIntentContent, which indexes @intent and @domainRule. Reading back only @intent would drop a node indexed on a domain rule alone, and that node did not fail to record a reason — it recorded a different kind of one. @intent still wins when both are present, because it says why the code exists and a domain rule says what it must hold to. @intent read back the same tags the intent index was built from.
Types ¶
type Hit ¶
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 ¶
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 (Result) CanAnswer ¶
CanAnswer reports whether the recorded reasons speak this question's language at all: at least half of its scored terms are written in some reason.
It gates membership, not ranking. The index admits a document on any shared word, which is right for a tool that reports term counts alongside its answer — but search reports membership. A question mostly made of words nobody ever wrote down ("zzz nonexistent symbol qqq") is not answered by the one common word it happens to share with fifty reasons; a real question keeps its hits even when each one matched only the couple of words that mattered. The fraction is over the question's own terms, so no corpus-fitted cutoff hides in it. @domainRule intent hits justify membership only when at least half of the question's scored terms appear in some recorded reason.
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 ¶
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.
Source Files