docs

package
v2026.611.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FormatSlashPayload

func FormatSlashPayload(query string, res *RetrievalResult) string

Types

type Options

type Options struct {
	MinNormalizedScore float64
	FullArticleScore   float64
}

type RetrievalResult

type RetrievalResult struct {
	Mode    string          `json:"mode"`
	Query   string          `json:"query"`
	Path    string          `json:"path,omitempty"`
	Lines   int             `json:"lines,omitempty"`
	Content string          `json:"content,omitempty"`
	Results []SnippetResult `json:"results,omitempty"`
}

func Retrieve

func Retrieve(query string, opts Options) (*RetrievalResult, error)

type SnippetResult

type SnippetResult struct {
	Path      string  `json:"path"`
	Heading   string  `json:"heading"`
	StartLine int     `json:"startLine"`
	EndLine   int     `json:"endLine"`
	Snippet   string  `json:"snippet"`
	Score     float64 `json:"score"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL