From b84ca0b72a81dda1183e73b4b6b4faaf51f108b7 Mon Sep 17 00:00:00 2001 From: Tavily PR Agent Date: Mon, 30 Mar 2026 15:17:48 +0000 Subject: [PATCH] feat: add Tavily as web search provider option --- .env.example | 3 + .../application/service/web_search/tavily.go | 148 ++++++++++++++++++ internal/container/container.go | 5 + 3 files changed, 156 insertions(+) create mode 100644 internal/application/service/web_search/tavily.go diff --git a/.env.example b/.env.example index e5236ac4..44eb0b42 100644 --- a/.env.example +++ b/.env.example @@ -310,6 +310,9 @@ DOCREADER_TRANSPORT=grpc # Weaviate 数据库名称(可选) #WEAVIATE_COLLECTION=your_weaviate_db_name +# Tavily Search API Key(可选,启用 Tavily 网页搜索提供者) +# TAVILY_API_KEY=tvly-your_tavily_api_key + # ----- OIDC Auth ----- # 如果需要启用OIDC登录,设为true并填写后续字段 # OIDC_AUTH_ENABLE=false diff --git a/internal/application/service/web_search/tavily.go b/internal/application/service/web_search/tavily.go new file mode 100644 index 00000000..c0750cf2 --- /dev/null +++ b/internal/application/service/web_search/tavily.go @@ -0,0 +1,148 @@ +package web_search + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "os" + "time" + + "github.com/Tencent/WeKnora/internal/types" + "github.com/Tencent/WeKnora/internal/types/interfaces" +) + +const ( + defaultTavilySearchURL = "https://api.tavily.com/search" +) + +var ( + defaultTavilyTimeout = 15 * time.Second +) + +// TavilyProvider implements web search using Tavily Search API +type TavilyProvider struct { + client *http.Client + baseURL string + apiKey string +} + +// NewTavilyProvider creates a new Tavily provider +func NewTavilyProvider() (interfaces.WebSearchProvider, error) { + apiKey := os.Getenv("TAVILY_API_KEY") + if len(apiKey) == 0 { + return nil, fmt.Errorf("TAVILY_API_KEY is not set") + } + client := &http.Client{ + Timeout: defaultTavilyTimeout, + } + return &TavilyProvider{ + client: client, + baseURL: defaultTavilySearchURL, + apiKey: apiKey, + }, nil +} + +// TavilyProviderInfo returns the provider info for registration +func TavilyProviderInfo() types.WebSearchProviderInfo { + return types.WebSearchProviderInfo{ + ID: "tavily", + Name: "Tavily", + Free: false, + RequiresAPIKey: true, + Description: "Tavily Search API", + } +} + +// Name returns the provider name +func (p *TavilyProvider) Name() string { + return "tavily" +} + +// Search performs a web search using Tavily Search API +func (p *TavilyProvider) Search( + ctx context.Context, + query string, + maxResults int, + includeDate bool, +) ([]*types.WebSearchResult, error) { + if len(query) == 0 { + return nil, fmt.Errorf("query is empty") + } + + reqBody := tavilySearchRequest{ + APIKey: p.apiKey, + Query: query, + MaxResults: maxResults, + } + + bodyBytes, err := json.Marshal(reqBody) + if err != nil { + return nil, fmt.Errorf("failed to marshal request: %w", err) + } + + req, err := http.NewRequestWithContext(ctx, "POST", p.baseURL, bytes.NewReader(bodyBytes)) + if err != nil { + return nil, fmt.Errorf("failed to create request: %w", err) + } + req.Header.Set("Content-Type", "application/json") + + resp, err := p.client.Do(req) + if err != nil { + return nil, fmt.Errorf("failed to execute request: %w", err) + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusOK { + respBody, _ := io.ReadAll(resp.Body) + return nil, fmt.Errorf("tavily API returned status %d: %s", resp.StatusCode, string(respBody)) + } + + respBody, err := io.ReadAll(resp.Body) + if err != nil { + return nil, fmt.Errorf("failed to read response: %w", err) + } + + var respData tavilySearchResponse + if err := json.Unmarshal(respBody, &respData); err != nil { + return nil, fmt.Errorf("failed to unmarshal response: %w", err) + } + + results := make([]*types.WebSearchResult, 0, len(respData.Results)) + for _, item := range respData.Results { + result := &types.WebSearchResult{ + Title: item.Title, + URL: item.URL, + Snippet: item.Content, + Source: "tavily", + } + if includeDate && item.PublishedDate != "" { + if t, err := time.Parse(time.RFC3339, item.PublishedDate); err == nil { + result.PublishedAt = &t + } + } + results = append(results, result) + } + return results, nil +} + +// tavilySearchRequest defines the request body for Tavily search API +type tavilySearchRequest struct { + APIKey string `json:"api_key"` + Query string `json:"query"` + MaxResults int `json:"max_results"` +} + +// tavilySearchResponse defines the response structure for Tavily search API +type tavilySearchResponse struct { + Query string `json:"query"` + Results []struct { + Title string `json:"title"` + URL string `json:"url"` + Content string `json:"content"` + Score float64 `json:"score"` + PublishedDate string `json:"published_date,omitempty"` + } `json:"results"` +} diff --git a/internal/container/container.go b/internal/container/container.go index 95a14912..b5dcc57d 100644 --- a/internal/container/container.go +++ b/internal/container/container.go @@ -967,6 +967,11 @@ func registerWebSearchProviders(registry *web_search.Registry) { registry.Register(web_search.BingProviderInfo(), func() (interfaces.WebSearchProvider, error) { return web_search.NewBingProvider() }) + + // Register Tavily provider + registry.Register(web_search.TavilyProviderInfo(), func() (interfaces.WebSearchProvider, error) { + return web_search.NewTavilyProvider() + }) } // registerIMAdapterFactories registers adapter factories for each IM platform