websearch

Documentation

Index

• Constants
• Variables
• type Config
• type Result
• type SearchRequest
• type SearchResponse
  • func Search(ctx context.Context, cfg Config, req SearchRequest) (SearchResponse, error)

Constants

const (
	ProviderSogou      = "sogou"
	ProviderBaidu      = "baidu"
	ProviderQuark      = "quark"
	ProviderBing       = "bing"
	ProviderDuckDuckGo = "duckduckgo"
)

Variables

var ErrNoResults = errors.New("no web search results found")

Types

type Config

type Config struct {
	Timeout       time.Duration
	MaxResults    int
	Language      string
	SafeSearch    int
	SafeSearchSet bool
	Providers     []string
	Quick         bool
	HTTPClient    *http.Client

	// ProviderBaseURLs is intended for tests and private deployments that need
	// to point a built-in provider at a controlled compatible endpoint.
	ProviderBaseURLs map[string]string
}

type Result

type Result struct {
	Title       string  `json:"title"`
	URL         string  `json:"url"`
	Snippet     string  `json:"snippet,omitempty"`
	Engine      string  `json:"engine,omitempty"`
	Category    string  `json:"category,omitempty"`
	Score       float64 `json:"score,omitempty"`
	PublishedAt string  `json:"published_at,omitempty"`
}

type SearchRequest

type SearchRequest struct {
	Query string
}

type SearchResponse

type SearchResponse struct {
	Query    string   `json:"query"`
	Provider string   `json:"provider,omitempty"`
	Results  []Result `json:"results"`
}

func Search

func Search(ctx context.Context, cfg Config, req SearchRequest) (SearchResponse, error)