search

Documentation

Index

• Constants
• Variables
• type BraveConfig
• type Config
  • func ApplyEnvDefaults(cfg *Config) *Config
  • func (c *Config) WithDefaults() *Config
• type ExaConfig
• type OpenRouterConfig
• type PerplexityConfig
• type Request
• type Response
  • func Search(ctx context.Context, req Request, cfg *Config) (*Response, error)
• type Result

Constants

const (
	ProviderExa        = basesearch.ProviderExa
	ProviderBrave      = basesearch.ProviderBrave
	ProviderPerplexity = basesearch.ProviderPerplexity
	ProviderOpenRouter = basesearch.ProviderOpenRouter

	DefaultSearchCount  = basesearch.DefaultSearchCount
	MaxSearchCount      = basesearch.MaxSearchCount
	DefaultTimeoutSecs  = basesearch.DefaultTimeoutSecs
	DefaultCacheTtlSecs = basesearch.DefaultCacheTtlSecs
)

Variables

var DefaultFallbackOrder = basesearch.DefaultFallbackOrder

Types

type BraveConfig

type BraveConfig struct {
	Enabled          *bool
	BaseURL          string
	APIKey           string
	TimeoutSecs      int
	CacheTtlSecs     int
	SearchLang       string
	UILang           string
	DefaultCountry   string
	DefaultFreshness string
}

type Config

type Config struct {
	Provider  string
	Fallbacks []string

	Exa        ExaConfig
	Brave      BraveConfig
	Perplexity PerplexityConfig
	OpenRouter OpenRouterConfig
}

func ApplyEnvDefaults

func ApplyEnvDefaults(cfg *Config) *Config

func (*Config) WithDefaults

func (c *Config) WithDefaults() *Config

type ExaConfig

type ExaConfig struct {
	Enabled           *bool
	BaseURL           string
	APIKey            string
	Type              string
	Category          string
	NumResults        int
	IncludeText       bool
	TextMaxCharacters int
	Highlights        bool
}

type OpenRouterConfig

type OpenRouterConfig struct {
	Enabled      *bool
	APIKey       string
	BaseURL      string
	Model        string
	TimeoutSecs  int
	CacheTtlSecs int
}

type PerplexityConfig

type PerplexityConfig struct {
	Enabled      *bool
	APIKey       string
	BaseURL      string
	Model        string
	TimeoutSecs  int
	CacheTtlSecs int
}

type Request

type Request struct {
	Query      string
	Count      int
	Country    string
	SearchLang string
	UILang     string
	Freshness  string
}

type Response

type Response struct {
	Query      string
	Provider   string
	Count      int
	TookMs     int64
	Results    []Result
	Answer     string
	Summary    string
	Definition string
	Warning    string
	NoResults  bool
	Cached     bool
	Extras     map[string]any
}

func Search

func Search(ctx context.Context, req Request, cfg *Config) (*Response, error)

type Result

type Result struct {
	ID          string
	Title       string
	URL         string
	Description string
	Published   string
	SiteName    string
	Author      string
	Image       string
	Favicon     string
}