RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.
Go agent-harnessagent-native-databaseagentic-aiagentic-retrievalagentic-searchaiai-agentscontext-enginecontext-engineeringcontext-managementharness-engineeringknowledge-compilationragretrieval-augmented-generationretrieval-harnesssearch-harness
feat(chat): add Search1API web search provider (#20561)
wang23d7d8e3dd0f5
diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.mdindex 1d7878c224..f0ffd22fe1 100644--- a/docs/references/http_api_reference.md+++ b/docs/references/http_api_reference.md@@ -2710,10 +2710,15 @@ curl --request POST \- `"refine_multiturn"`: `boolean`- `"reasoning"`: `boolean`- `"cross_languages"`: `list[string]`- - `"web_search_provider"`: `string` The web search service to use. Supported values are `"tavily"`, `"firecrawl"`, `"querit"`, `"serply"`, and `"youcom"`. If omitted, Tavily is selected only when `"tavily_api_key"` is configured; otherwise web search is disabled.+ - `"web_search_provider"`: `string` The web search service to use. Supported values are `"brave"`, `"exa"`, `"firecrawl"`, `"linkup"`, `"parallel"`, `"querit"`, `"search1api"`, `"serply"`, `"tavily"`, and `"youcom"`. If omitted, Tavily is selected only when `"tavily_api_key"` is configured; otherwise web search is disabled.- `"tavily_api_key"`: `string`+ - `"brave_api_key"`: `string` The Brave Search API key. Set `web_search_provider` to `"brave"` when using this field.+ - `"exa_api_key"`: `string` The Exa API key. Set `web_search_provider` to `"exa"` when using this field.- `"firecrawl_api_key"`: `string` The [Firecrawl](https://www.firecrawl.dev/search) API key. Set `web_search_provider` to `"firecrawl"` when using this field. See the [Firecrawl Search API reference](https://docs.firecrawl.dev/api-reference/endpoint/search) for details.+ - `"linkup_api_key"`: `string` The Linkup API key. Set `web_search_provider` to `"linkup"` when using this field.+ - `"parallel_api_key"`: `string` The Parallel API key. Set `web_search_provider` to `"parallel"` when using this field.- `"querit_api_key"`: `string` The Querit API key. Set `web_search_provider` to `"querit"` when using this field.+ - `"search1api_api_key"`: `string` The [Search1API](https://s1.dev) API key. Set `web_search_provider` to `"search1api"` when using this field. See the [Search1API documentation](https://s1.dev/docs/basic/search) for details.- `"serply_api_key"`: `string` The [Serply](https://serply.io) API key. Set `web_search_provider` to `"serply"` when using this field. See the [Serply documentation](https://serply.io/docs) for details.- `"youcom_api_key"`: `string` The You.com API key. Set `web_search_provider` to `"youcom"` when using this field. Optional: You.com serves a rate-limited keyless endpoint, so `"youcom"` works with this field omitted, and a key lifts those limits.- `"similarity_threshold"`: (*Body parameter*), `float`diff --git a/internal/service/web_search_provider.go b/internal/service/web_search_provider.goindex 8faf9970e3..6ae7f9143b 100644--- a/internal/service/web_search_provider.go+++ b/internal/service/web_search_provider.go@@ -30,29 +30,31 @@ import ()// Providers, endpoints and clients are listed alphabetically by provider id-// (brave, exa, firecrawl, linkup, parallel, querit, serply, tavily, youcom) so-// a new provider has exactly one obvious place in each list. Tavily's endpoint-// lives with its retrieval code in chat_pipeline.go, which is why it has no-// entry here.+// (brave, exa, firecrawl, linkup, parallel, querit, search1api, serply, tavily,+// youcom) so a new provider has exactly one obvious place in each list.+// Tavily's endpoint lives with its retrieval code in chat_pipeline.go, which is+// why it has no entry here.const (- webSearchProviderBrave = "brave"- webSearchProviderExa = "exa"- webSearchProviderFirecrawl = "firecrawl"- webSearchProviderLinkup = "linkup"- webSearchProviderParallel = "parallel"- webSearchProviderQuerit = "querit"- webSearchProviderSerply = "serply"- webSearchProviderTavily = "tavily"- webSearchProviderYouCom = "youcom"+ webSearchProviderBrave = "brave"+ webSearchProviderExa = "exa"+ webSearchProviderFirecrawl = "firecrawl"+ webSearchProviderLinkup = "linkup"+ webSearchProviderParallel = "parallel"+ webSearchProviderQuerit = "querit"+ webSearchProviderSearch1API = "search1api"+ webSearchProviderSerply = "serply"+ webSearchProviderTavily = "tavily"+ webSearchProviderYouCom = "youcom"braveWebSearchEndpoint = "https://api.search.brave.com/res/v1/web/search"exaWebSearchEndpoint = "https://api.exa.ai/search"// v2 is Firecrawl's current search shape; the v1 endpoint is deprecated.- firecrawlWebSearchEndpoint = "https://api.firecrawl.dev/v2/search"- linkupWebSearchEndpoint = "https://api.linkup.so/v1/search"- parallelWebSearchEndpoint = "https://api.parallel.ai/v1/search"- queritWebSearchEndpoint = "https://api.querit.ai/v1/search"- serplyWebSearchEndpoint = "https://api.serply.io/v1/search/"+ firecrawlWebSearchEndpoint = "https://api.firecrawl.dev/v2/search"+ linkupWebSearchEndpoint = "https://api.linkup.so/v1/search"+ parallelWebSearchEndpoint = "https://api.parallel.ai/v1/search"+ queritWebSearchEndpoint = "https://api.querit.ai/v1/search"+ search1apiWebSearchEndpoint = "https://api.search1api.com/search"+ serplyWebSearchEndpoint = "https://api.serply.io/v1/search/"// You.com serves the same response shape from two endpoints. The keyless// one is rate-limited but needs no credentials; the keyed one lifts those// limits. The keyless endpoint rejects an X-API-Key header, so the endpoint@@ -76,14 +78,15 @@ const ()var (- braveWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}- exaWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}- firecrawlWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}- linkupWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}- parallelWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}- queritWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}- serplyWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}- youComWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ braveWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ exaWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ firecrawlWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ linkupWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ parallelWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ queritWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ search1apiWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ serplyWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}+ youComWebSearchHTTPClient = &http.Client{Timeout: 30 * time.Second}// Tavily is reached from two call sites (the chat pipeline and the deep// researcher) and they used different timeouts; keeping one client per// call site preserves both while allowing connection reuse — a fresh@@ -133,6 +136,8 @@ func resolveWebSearchProvider(promptConfig map[string]interface{}) *webSearchProapiKeyField = "parallel_api_key"case webSearchProviderQuerit:apiKeyField = "querit_api_key"+ case webSearchProviderSearch1API:+ apiKeyField = "search1api_api_key"case webSearchProviderSerply:apiKeyField = "serply_api_key"case webSearchProviderTavily:@@ -238,6 +243,14 @@ func retrieveWebSearchWithTavily(provider.APIKey,question,)+ case webSearchProviderSearch1API:+ return retrieveSearch1APIWebSearch(+ ctx,+ search1apiWebSearchHTTPClient,+ search1apiWebSearchEndpoint,+ provider.APIKey,+ question,+ )case webSearchProviderSerply:return retrieveSerplyWebSearch(ctx,@@ -822,6 +835,75 @@ func decodeQueritWebSearchResults(responseBody []byte) ([]queritWebSearchResult,return results, nil}+type search1apiWebSearchResult struct {+ Title string `json:"title"`+ Link string `json:"link"`+ Snippet string `json:"snippet"`+}++func retrieveSearch1APIWebSearch(+ ctx context.Context,+ client *http.Client,+ endpoint string,+ apiKey string,+ query string,+) (map[string]interface{}, error) {+ requestBody, err := json.Marshal(map[string]interface{}{+ "query": query,+ "max_results": webSearchResultCount,+ })+ if err != nil {+ return nil, fmt.Errorf("search1api: marshal request: %w", err)+ }++ responseBody, err := webSearchRequest(ctx, client, http.MethodPost, endpoint, map[string]string{+ "Accept": "application/json",+ "Authorization": "Bearer " + apiKey,+ "Content-Type": "application/json",+ }, bytes.NewReader(requestBody))+ if err != nil {+ return nil, fmt.Errorf("search1api: %w", err)+ }+ results, err := decodeSearch1APIWebSearchResults(responseBody)+ if err != nil {+ return nil, err+ }++ hits := make([]webSearchHit, 0, len(results))+ for _, result := range results {+ hits = append(hits, webSearchHit{+ Title: result.Title,+ URL: result.Link,+ Content: result.Snippet,+ })+ }+ return webSearchPayload("search1api", hits), nil+}++func decodeSearch1APIWebSearchResults(responseBody []byte) ([]search1apiWebSearchResult, error) {+ var envelope map[string]json.RawMessage+ if err := json.Unmarshal(responseBody, &envelope); err != nil {+ return nil, fmt.Errorf("search1api: decode response: %w", err)+ }+ if envelope == nil {+ return nil, fmt.Errorf("search1api: response must be an object")+ }++ resultsValue, exists := envelope["results"]+ if !exists {+ return []search1apiWebSearchResult{}, nil+ }+ if strings.TrimSpace(string(resultsValue)) == "null" {+ return nil, fmt.Errorf("search1api: response field results must be an array")+ }++ var results []search1apiWebSearchResult+ if err := json.Unmarshal(resultsValue, &results); err != nil {+ return nil, fmt.Errorf("search1api: response field results must be an array: %w", err)+ }+ return results, nil+}+type serplyWebSearchResult struct {Title string `json:"title"`Link string `json:"link"`diff --git a/internal/service/web_search_provider_test.go b/internal/service/web_search_provider_test.goindex 982c04e996..7d10eb99bb 100644--- a/internal/service/web_search_provider_test.go+++ b/internal/service/web_search_provider_test.go@@ -680,6 +680,7 @@ func TestResolveWebSearchProviderSelectsKeyedProviders(t *testing.T) {{provider: "firecrawl", apiKeyName: "firecrawl_api_key", apiKey: "firecrawl-test"},{provider: "linkup", apiKeyName: "linkup_api_key", apiKey: "linkup-test"},{provider: "parallel", apiKeyName: "parallel_api_key", apiKey: "parallel-test"},+ {provider: "search1api", apiKeyName: "search1api_api_key", apiKey: "search1api-test"},}for _, tc := range cases {@@ -920,6 +921,86 @@ func TestRetrieveFirecrawlWebSearchUsesSearchSnippets(t *testing.T) {assertWebSearchChunk(t, result, "firecrawl-https://example.com/ragflow", "RAGFlow", "An open-source RAG engine.")}+func TestRetrieveSearch1APIWebSearchSendsBearerKeyAndUsesSnippets(t *testing.T) {+ var requestBody map[string]interface{}+ server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {+ if r.Method != http.MethodPost {+ t.Errorf("method = %q, want POST", r.Method)+ }+ if got := r.Header.Get("Authorization"); got != "Bearer search1api-test" {+ t.Errorf("Authorization = %q, want %q", got, "Bearer search1api-test")+ }+ if err := json.NewDecoder(r.Body).Decode(&requestBody); err != nil {+ t.Errorf("decode request: %v", err)+ return+ }+ w.Header().Set("Content-Type", "application/json")+ _, _ = w.Write([]byte(`{+ "searchParameters": {"query": "What is RAGFlow?", "max_results": 6},+ "results": [+ {"title": "No snippet", "link": "https://example.com/empty", "snippet": " \t\n"},+ {"title": "RAGFlow", "link": "https://example.com/ragflow", "snippet": "An open-source RAG engine."}+ ]+ }`))+ }))+ defer server.Close()++ result, err := retrieveSearch1APIWebSearch(t.Context(), server.Client(), server.URL, "search1api-test", "What is RAGFlow?")+ if err != nil {+ t.Fatalf("retrieve Search1API web search: %v", err)+ }+ if requestBody["query"] != "What is RAGFlow?" {+ t.Fatalf("query = %#v", requestBody["query"])+ }+ if requestBody["max_results"] != float64(6) {+ t.Fatalf("max_results = %#v, want 6", requestBody["max_results"])+ }+ assertWebSearchChunk(t, result, "search1api-https://example.com/ragflow", "RAGFlow", "An open-source RAG engine.")+}++func TestRetrieveSearch1APIWebSearchRejectsErrorStatuses(t *testing.T) {+ server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {+ w.Header().Set("Content-Type", "application/json")+ w.WriteHeader(http.StatusUnauthorized)+ _, _ = w.Write([]byte(`{"error": "Unauthorized", "message": "Invalid bearer credential"}`))+ }))+ defer server.Close()++ if _, err := retrieveSearch1APIWebSearch(t.Context(), server.Client(), server.URL, "bad-key", "ragflow"); err == nil {+ t.Fatal("error is nil")+ }+}++func TestDecodeSearch1APIWebSearchResultsRejectsMalformedContainers(t *testing.T) {+ cases := []struct {+ name string+ body string+ }{+ {name: "null response", body: `null`},+ {name: "null results", body: `{"results":null}`},+ {name: "object results", body: `{"results":{}}`},+ {name: "string results", body: `{"results":"nope"}`},+ }++ for _, tc := range cases {+ t.Run(tc.name, func(t *testing.T) {+ if _, err := decodeSearch1APIWebSearchResults([]byte(tc.body)); err == nil {+ t.Fatal("error is nil")+ }+ })+ }+}++func TestDecodeSearch1APIWebSearchResultsAcceptsMissingResults(t *testing.T) {+ results, err := decodeSearch1APIWebSearchResults([]byte(`{"searchParameters": {"query": "ragflow"}}`))+ if err != nil {+ t.Fatalf("decode: %v", err)+ }+ if len(results) != 0 {+ t.Fatalf("results = %#v, want empty", results)+ }+}+// A hit with no text is dropped rather than shipped as an empty citation.func TestWebSearchPayloadSkipsHitsWithoutContent(t *testing.T) {payload := webSearchPayload("exa", []webSearchHit{diff --git a/web/src/assets/search1api.png b/web/src/assets/search1api.pngnew file mode 100644index 0000000000..5dc805274aBinary files /dev/null and b/web/src/assets/search1api.png differdiff --git a/web/src/components/web-search-form-field.tsx b/web/src/components/web-search-form-field.tsxindex 943b432cbf..276efe1d5d 100644--- a/web/src/components/web-search-form-field.tsx+++ b/web/src/components/web-search-form-field.tsx@@ -20,6 +20,7 @@ import firecrawlLogo from '@/assets/firecrawl.png';import linkupLogo from '@/assets/linkup.png';import parallelLogo from '@/assets/svg/parallel.svg';import queritLogo from '@/assets/querit.png';+import search1apiLogo from '@/assets/search1api.png';import serplyLogo from '@/assets/serply.png';import tavilyLogo from '@/assets/svg/tavily.svg';import youcomLogo from '@/assets/svg/youcom.svg';@@ -69,6 +70,11 @@ const webSearchProviderCatalog = [logo: queritLogo,value: WebSearchProvider.Querit,},+ {+ name: 'Search1API',+ logo: search1apiLogo,+ value: WebSearchProvider.Search1API,+ },{name: 'Serply',logo: serplyLogo,@@ -148,6 +154,12 @@ const providerKeyConfig = {placeholder: 'queritApiKeyMessage',helpUrl: 'https://querit.ai',},+ [WebSearchProvider.Search1API]: {+ name: 'prompt_config.search1api_api_key',+ tip: 'search1apiApiKeyTip',+ placeholder: 'search1apiApiKeyMessage',+ helpUrl: 'https://app.s1.dev',+ },[WebSearchProvider.Serply]: {name: 'prompt_config.serply_api_key',tip: 'serplyApiKeyTip',diff --git a/web/src/constants/chat.ts b/web/src/constants/chat.tsindex f242998474..e809028aed 100644--- a/web/src/constants/chat.ts+++ b/web/src/constants/chat.ts@@ -63,6 +63,7 @@ export enum WebSearchProvider {Linkup = 'linkup',Parallel = 'parallel',Querit = 'querit',+ Search1API = 'search1api',Serply = 'serply',Tavily = 'tavily',YouCom = 'youcom',diff --git a/web/src/interfaces/database/chat.ts b/web/src/interfaces/database/chat.tsindex 84a3b50ad5..f9f055cfb4 100644--- a/web/src/interfaces/database/chat.ts+++ b/web/src/interfaces/database/chat.ts@@ -26,6 +26,7 @@ export interface PromptConfig {linkup_api_key?: string;parallel_api_key?: string;querit_api_key?: string;+ search1api_api_key?: string;serply_api_key?: string;tavily_api_key?: string;youcom_api_key?: string;diff --git a/web/src/locales/en.ts b/web/src/locales/en.tsindex 6f04ab64fc..593096ff49 100644--- a/web/src/locales/en.ts+++ b/web/src/locales/en.ts@@ -1280,6 +1280,9 @@ This auto-tagging feature enhances retrieval by adding another layer of domain-squeritApiKeyTip:'When Querit is selected, its web search results supplement dataset retrieval.',queritApiKeyMessage: 'Please enter your Querit API Key',+ search1apiApiKeyTip:+ 'When Search1API is selected, its web search results supplement dataset retrieval.',+ search1apiApiKeyMessage: 'Please enter your Search1API API Key',serplyApiKeyTip:'When Serply is selected, its web search results supplement dataset retrieval.',serplyApiKeyMessage: 'Please enter your Serply API Key',diff --git a/web/src/locales/zh.ts b/web/src/locales/zh.tsindex 4e387475bc..a97762e5bc 100644--- a/web/src/locales/zh.ts+++ b/web/src/locales/zh.ts@@ -1168,6 +1168,9 @@ NER:使用 spaCy NER 和基于规则的关键词提取来抽取 Entities 和 RqueritApiKeyTip:'选择 Querit 后,将使用 Querit 的网络搜索结果补充知识库检索。',queritApiKeyMessage: '请输入 Querit API Key',+ search1apiApiKeyTip:+ '选择 Search1API 后,将使用 Search1API 的网络搜索结果补充知识库检索。',+ search1apiApiKeyMessage: '请输入 Search1API API Key',serplyApiKeyTip:'选择 Serply 后,将使用 Serply 的网络搜索结果补充知识库检索。',serplyApiKeyMessage: '请输入 Serply API Key',diff --git a/web/src/pages/next-chats/chat/app-settings/use-chat-setting-schema.tsx b/web/src/pages/next-chats/chat/app-settings/use-chat-setting-schema.tsxindex 0cb73987c9..b9244d5c92 100644--- a/web/src/pages/next-chats/chat/app-settings/use-chat-setting-schema.tsx+++ b/web/src/pages/next-chats/chat/app-settings/use-chat-setting-schema.tsx@@ -41,6 +41,7 @@ export function useChatSettingSchema() {linkup_api_key: z.string().optional(),parallel_api_key: z.string().optional(),querit_api_key: z.string().optional(),+ search1api_api_key: z.string().optional(),serply_api_key: z.string().optional(),tavily_api_key: z.string().optional(),youcom_api_key: z.string().optional(),@@ -52,6 +53,7 @@ export function useChatSettingSchema() {WebSearchProvider.Linkup,WebSearchProvider.Parallel,WebSearchProvider.Querit,+ WebSearchProvider.Search1API,WebSearchProvider.Serply,WebSearchProvider.Tavily,WebSearchProvider.YouCom,diff --git a/web/src/pages/next-chats/chat/web-search-api-key.test.ts b/web/src/pages/next-chats/chat/web-search-api-key.test.tsindex f5efc75053..3d6aee6a5c 100644--- a/web/src/pages/next-chats/chat/web-search-api-key.test.ts+++ b/web/src/pages/next-chats/chat/web-search-api-key.test.ts@@ -42,6 +42,25 @@ describe('getWebSearchApiKey', () => {expect(getWebSearchApiKey(promptConfig)).toBe('querit-test');});+ it('uses only the selected Search1API key', () => {+ const promptConfig = {+ web_search_provider: WebSearchProvider.Search1API,+ search1api_api_key: 'search1api-test',+ tavily_api_key: 'tvly-test',+ } as PromptConfig;++ expect(getWebSearchApiKey(promptConfig)).toBe('search1api-test');+ });++ it('does not fall back to Tavily when Search1API is selected without a key', () => {+ const promptConfig = {+ web_search_provider: WebSearchProvider.Search1API,+ tavily_api_key: 'tvly-test',+ } as PromptConfig;++ expect(getWebSearchApiKey(promptConfig)).toBeUndefined();+ });+it('uses only the selected Serply key', () => {const promptConfig = {web_search_provider: WebSearchProvider.Serply,@@ -227,6 +246,9 @@ describe('provider key field mapping', () => {expect(getWebSearchApiKeyField(WebSearchProvider.Querit)).toBe('querit_api_key',);+ expect(getWebSearchApiKeyField(WebSearchProvider.Search1API)).toBe(+ 'search1api_api_key',+ );expect(getWebSearchApiKeyField(WebSearchProvider.Serply)).toBe('serply_api_key',);diff --git a/web/src/pages/next-chats/chat/web-search-api-key.ts b/web/src/pages/next-chats/chat/web-search-api-key.tsindex 1d648f68a9..5da795b044 100644--- a/web/src/pages/next-chats/chat/web-search-api-key.ts+++ b/web/src/pages/next-chats/chat/web-search-api-key.ts@@ -59,6 +59,7 @@ const webSearchApiKeyFields: Record<WebSearchProvider, string> = {[WebSearchProvider.Linkup]: 'linkup_api_key',[WebSearchProvider.Parallel]: 'parallel_api_key',[WebSearchProvider.Querit]: 'querit_api_key',+ [WebSearchProvider.Search1API]: 'search1api_api_key',[WebSearchProvider.Serply]: 'serply_api_key',[WebSearchProvider.Tavily]: 'tavily_api_key',[WebSearchProvider.YouCom]: 'youcom_api_key',