Documentation
¶
Index ¶
- Variables
- func AddCollection(configPath string, col Collection) error
- func CanonicalPath(path string) (string, error)
- func DefaultConfigPath() string
- func DefaultDBPath() string
- func ExpandHome(path string) string
- func RemoveCollection(configPath string, name string) error
- func SlugFromPath(path string) string
- type Collection
- type Config
- type EmbeddingProviderConfig
- type GenerationProviderConfig
- type Providers
- type RerankProviderConfig
- type SearchConfig
Constants ¶
This section is empty.
Variables ¶
var DefaultConfigTemplate = `` /* 1431-byte string literal not displayed */
Functions ¶
func AddCollection ¶ added in v0.4.0
func AddCollection(configPath string, col Collection) error
AddCollection adds or updates a collection in the config file at configPath. Existing YAML comments and structure are preserved via yaml.Node round-trip.
func CanonicalPath ¶ added in v0.7.0
CanonicalPath expands a filesystem path to an absolute, symlink-resolved, clean path. Symlink resolution is best effort so nonexistent paths can still be compared by their cleaned absolute form.
func DefaultConfigPath ¶
func DefaultConfigPath() string
func DefaultDBPath ¶
func DefaultDBPath() string
func ExpandHome ¶
ExpandHome expands a leading ~ to the user home directory.
func RemoveCollection ¶ added in v0.4.0
RemoveCollection removes a collection from the config file at configPath. Existing YAML comments and structure are preserved via yaml.Node round-trip. Returns an error if the collection name is not found.
func SlugFromPath ¶ added in v0.5.0
SlugFromPath returns a stable collection name derived from a filesystem path.
Types ¶
type Collection ¶
type Config ¶
type Config struct {
DatabasePath string `yaml:"database_path"`
Collections []Collection `yaml:"collections"`
Providers Providers `yaml:"providers"`
Search SearchConfig `yaml:"search"`
}
func DefaultConfig ¶
func DefaultConfig() *Config
type EmbeddingProviderConfig ¶
type Providers ¶
type Providers struct {
Embedding *EmbeddingProviderConfig `yaml:"embedding,omitempty"`
Rerank *RerankProviderConfig `yaml:"rerank,omitempty"`
Generation *GenerationProviderConfig `yaml:"generation,omitempty"`
}
type RerankProviderConfig ¶
type SearchConfig ¶
type SearchConfig struct {
DefaultMode string `yaml:"default_mode"`
BM25TopK int `yaml:"bm25_top_k"`
VectorTopK int `yaml:"vector_top_k"`
RerankTopK int `yaml:"rerank_top_k"`
RRFK int `yaml:"rrf_k"`
ChunkSize int `yaml:"chunk_size"`
ChunkOverlap int `yaml:"chunk_overlap"`
PreferExtensions []string `yaml:"prefer_extensions,omitempty"`
ExtensionBoost float64 `yaml:"extension_boost,omitempty"`
}