web

type WebFetchHTTPConfig struct {
	// TimeoutSeconds is per-request wall clock; defaults to 30.
	TimeoutSeconds int `json:"timeoutSeconds,omitempty"`
	// MaxBytes is body read limit before extraction; defaults to 1 MiB.
	MaxBytes int `json:"maxBytes,omitempty"`
	// MaxRedirects is redirect chain limit; defaults to 5.
	MaxRedirects int `json:"maxRedirects,omitempty"`
	// UserAgent overrides the outgoing User-Agent.
	UserAgent string `json:"userAgent,omitempty"`
	// AllowPrivateHosts allows loopback / private / link-local targets; off by default.
	AllowPrivateHosts bool `json:"allowPrivateHosts,omitempty"`
	// AllowHosts, when non-empty, only these hosts (and their subdomains) may be fetched.
	AllowHosts []string `json:"allowHosts,omitempty"`
	// DenyHosts are hosts to refuse, applied after AllowHosts.
	DenyHosts []string `json:"denyHosts,omitempty"`
}

type WebFetchInput struct {
	URL string `json:"url" jsonschema:"required,description=Absolute http or https URL to fetch"`
	Raw bool   `json:"raw,omitempty" jsonschema:"description=Return the body as served instead of extracting readable text from HTML"`
}

type WebFetchOutput struct {
	URL         string `json:"url"`
	Status      int    `json:"status"`
	ContentType string `json:"contentType,omitempty"`
	Title       string `json:"title,omitempty"`
	Content     string `json:"content"`
	Truncated   bool   `json:"truncated,omitempty"`
}

type WebFetchScriptedConfig struct {
	// Pages maps URL substring to the HTML served for it.
	Pages map[string]string `json:"pages,omitempty"`
	// Default is body served when no Pages key matches; empty means not found.
	Default string `json:"default,omitempty"`
}

type WebSearchExaConfig struct {
	// APIKeyRef is credential ref resolved via deps.credentials, e.g. "env:EXA_API_KEY".
	APIKeyRef string `json:"apiKeyRef,omitempty"`
	// APIKey is literal key; prefer APIKeyRef so the secret stays out of config files.
	APIKey string `json:"apiKey,omitempty"`
	// BaseURL overrides the API host; defaults to https://api.exa.ai.
	BaseURL string `json:"baseUrl,omitempty"`
	// MaxResults is cap on hits per call; defaults to 5.
	MaxResults int `json:"maxResults,omitempty"`
	// TimeoutSeconds is per-request wall clock; defaults to 30.
	TimeoutSeconds int `json:"timeoutSeconds,omitempty"`
	// Type is Exa search mode: auto (default), fast, instant, deep.
	Type string `json:"type,omitempty"`
	// Category narrows results, e.g. "news" or "research paper".
	Category string `json:"category,omitempty"`
	// IncludeText also requests page text; costs more tokens and money than highlights alone.
	IncludeText bool `json:"includeText,omitempty"`
	// SnippetChars is snippet truncation limit; defaults to 800.
	SnippetChars int `json:"snippetChars,omitempty"`
	// IncludeDomains restricts results to these domains.
	IncludeDomains []string `json:"includeDomains,omitempty"`
	// ExcludeDomains drops results from these domains.
	ExcludeDomains []string `json:"excludeDomains,omitempty"`
}

type WebSearchExaDeps struct {
	Credentials credentials.Store `json:"credentials,omitempty"`
}

type WebSearchHit struct {
	Title       string `json:"title"`
	URL         string `json:"url"`
	Snippet     string `json:"snippet,omitempty"`
	PublishedAt string `json:"publishedAt,omitempty"`
}

type WebSearchInput struct {
	Query      string `json:"query" jsonschema:"required,description=What to search for, as a natural-language query"`
	MaxResults int    `json:"maxResults,omitempty" jsonschema:"description=Maximum hits to return"`
}

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

type WebSearchScriptedConfig struct {
	// Results are hits returned for any query ByQuery does not match.
	Results []WebSearchHit `json:"results,omitempty"`
	// ByQuery maps case-insensitive query substring to hits; keep keys mutually exclusive.
	ByQuery map[string][]WebSearchHit `json:"byQuery,omitempty"`
	// MaxResults is default cap on hits per call when the model does not ask for one.
	MaxResults int `json:"maxResults,omitempty"`
}