Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

8.4 KB
Raw Blame
/*
 *  Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

import anysearchLogo from '@/assets/anysearch.webp';
import braveLogo from '@/assets/svg/brave.svg';
import exaLogo from '@/assets/exa.png';
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 searchapiLogo from '@/assets/searchapi.png';
import serplyLogo from '@/assets/serply.png';
import tavilyLogo from '@/assets/svg/tavily.svg';
import youcomLogo from '@/assets/svg/youcom.svg';
import { RAGFlowFormItem } from '@/components/ragflow-form';
import { WebSearchProvider } from '@/constants/chat';
import { useTranslate } from '@/hooks/common-hooks';
import { isWebSearchApiKeyRequired } from '@/pages/next-chats/chat/web-search-api-key';
import { prefixName } from '@/utils/form';
import { useFormContext, useWatch } from 'react-hook-form';
import PasswordInput from './originui/password-input';
import { SelectWithSearch } from './originui/select-with-search';

interface IProps {
  prefix?: string;
}

// One entry per provider. `name` is the BRAND, so it stays untranslated; it is what
// the key field's label is interpolated into (chat.webSearchApiKeyLabel).
const webSearchProviderCatalog = [
  {
    name: 'AnySearch',
    logo: anysearchLogo,
    value: WebSearchProvider.AnySearch,
  },
  {
    name: 'Brave Search',
    logo: braveLogo,
    value: WebSearchProvider.Brave,
  },
  {
    name: 'Exa',
    logo: exaLogo,
    value: WebSearchProvider.Exa,
  },
  {
    name: 'Firecrawl',
    logo: firecrawlLogo,
    value: WebSearchProvider.Firecrawl,
  },
  {
    name: 'Linkup',
    logo: linkupLogo,
    value: WebSearchProvider.Linkup,
  },
  {
    name: 'Parallel',
    logo: parallelLogo,
    value: WebSearchProvider.Parallel,
  },
  {
    name: 'Querit',
    logo: queritLogo,
    value: WebSearchProvider.Querit,
  },
  {
    name: 'Search1API',
    logo: search1apiLogo,
    value: WebSearchProvider.Search1API,
  },
  {
    name: 'SearchApi',
    logo: searchapiLogo,
    value: WebSearchProvider.SearchApi,
  },
  {
    name: 'Serply',
    logo: serplyLogo,
    value: WebSearchProvider.Serply,
  },
  {
    name: 'Tavily',
    logo: tavilyLogo,
    value: WebSearchProvider.Tavily,
  },
  {
    name: 'You.com',
    logo: youcomLogo,
    value: WebSearchProvider.YouCom,
  },
];

const providerOptions = webSearchProviderCatalog
  .slice()
  .sort((left, right) => left.name.localeCompare(right.name))
  .map(({ name, logo, value }) => ({
    label: (
      <span className="flex items-center gap-2">
        <img
          src={logo}
          alt=""
          aria-hidden="true"
          className="size-4 shrink-0 object-contain"
        />
        {name}
      </span>
    ),
    // The dropdown filters on value + keywords, so the shown name has to be
    // searchable too: typing "You.com" must find the "youcom" entry.
    keywords: [name],
    value,
  }));

const providerDisplayName = (provider?: WebSearchProvider) =>
  webSearchProviderCatalog.find((entry) => entry.value === provider)?.name ??
  '';

const providerKeyConfig = {
  [WebSearchProvider.AnySearch]: {
    name: 'prompt_config.anysearch_api_key',
    tip: 'anysearchApiKeyTip',
    placeholder: 'anysearchApiKeyMessage',
    helpUrl: 'https://anysearch.com/console/api-keys',
  },
  [WebSearchProvider.Brave]: {
    name: 'prompt_config.brave_api_key',
    tip: 'braveApiKeyTip',
    placeholder: 'braveApiKeyMessage',
    helpUrl: 'https://brave.com/search/api/',
  },
  [WebSearchProvider.Exa]: {
    name: 'prompt_config.exa_api_key',
    tip: 'exaApiKeyTip',
    placeholder: 'exaApiKeyMessage',
    helpUrl: 'https://dashboard.exa.ai/api-keys',
  },
  [WebSearchProvider.Firecrawl]: {
    name: 'prompt_config.firecrawl_api_key',
    tip: 'firecrawlApiKeyTip',
    placeholder: 'firecrawlApiKeyMessage',
    helpUrl: 'https://www.firecrawl.dev/app/api-keys',
  },
  [WebSearchProvider.Linkup]: {
    name: 'prompt_config.linkup_api_key',
    tip: 'linkupApiKeyTip',
    placeholder: 'linkupApiKeyMessage',
    helpUrl: 'https://app.linkup.so',
  },
  [WebSearchProvider.Parallel]: {
    name: 'prompt_config.parallel_api_key',
    tip: 'parallelApiKeyTip',
    placeholder: 'parallelApiKeyMessage',
    helpUrl: 'https://platform.parallel.ai',
  },
  [WebSearchProvider.Querit]: {
    name: 'prompt_config.querit_api_key',
    tip: 'queritApiKeyTip',
    placeholder: 'queritApiKeyMessage',
    helpUrl: 'https://querit.ai',
  },
  [WebSearchProvider.Search1API]: {
    name: 'prompt_config.search1api_api_key',
    tip: 'search1apiApiKeyTip',
    placeholder: 'search1apiApiKeyMessage',
    helpUrl: 'https://app.s1.dev',
  },
  [WebSearchProvider.SearchApi]: {
    name: 'prompt_config.searchapi_api_key',
    tip: 'searchapiApiKeyTip',
    placeholder: 'searchapiApiKeyMessage',
    helpUrl: 'https://www.searchapi.io',
  },
  [WebSearchProvider.Serply]: {
    name: 'prompt_config.serply_api_key',
    tip: 'serplyApiKeyTip',
    placeholder: 'serplyApiKeyMessage',
    helpUrl: 'https://serply.io',
  },
  [WebSearchProvider.Tavily]: {
    name: 'prompt_config.tavily_api_key',
    tip: 'tavilyApiKeyTip',
    placeholder: 'tavilyApiKeyMessage',
    helpUrl: 'https://app.tavily.com/home',
  },
  [WebSearchProvider.YouCom]: {
    name: 'prompt_config.youcom_api_key',
    tip: 'youcomApiKeyTip',
    placeholder: 'youcomApiKeyMessage',
    helpUrl:
      'https://you.com/platform?utm_source=infiniflow-ragflow&utm_medium=oss_integration&utm_campaign=2026-08-oss-integrations&utm_content=app',
  },
} as const;

export function WebSearchFormField({ prefix = '' }: IProps) {
  const form = useFormContext();
  const { t } = useTranslate('chat');
  const providerName = prefixName(prefix, 'prompt_config.web_search_provider');
  const selectedProvider = useWatch({
    control: form.control,
    name: providerName,
  });
  const keyConfig = providerKeyConfig[selectedProvider as WebSearchProvider];
  // Leaving the key blank on a provider that needs one is a SILENT failure: the
  // chat box simply never offers the Internet switch. Mark the field required
  // so the asterisk says so before the user has to discover it.
  const keyRequired = isWebSearchApiKeyRequired(
    selectedProvider as WebSearchProvider,
  );

  return (
    <>
      <RAGFlowFormItem
        name={providerName}
        label={t('webSearchProvider')}
        tooltip={t('webSearchProviderTip')}
      >
        {(field) => (
          <SelectWithSearch
            value={field.value}
            onChange={field.onChange}
            options={providerOptions}
            placeholder={t('webSearchProviderPlaceholder')}
            allowClear
            testId="web-search-provider"
            optionTestIdPrefix="web-search-provider-option"
          />
        )}
      </RAGFlowFormItem>
      {keyConfig && (
        <RAGFlowFormItem
          key={selectedProvider}
          name={prefixName(prefix, keyConfig.name)}
          label={t('webSearchApiKeyLabel', {
            provider: providerDisplayName(
              selectedProvider as WebSearchProvider,
            ),
          })}
          tooltip={t(keyConfig.tip)}
          required={keyRequired}
          rules={{
            validate: (value) =>
              !keyRequired ||
              Boolean(String(value ?? '').trim()) ||
              t('webSearchApiKeyRequired'),
          }}
          description={
            <a href={keyConfig.helpUrl} target="_blank" rel="noreferrer">
              {t('webSearchApiKeyHelp')}
            </a>
          }
        >
          {(field) => (
            <PasswordInput
              {...field}
              value={field.value ?? ''}
              placeholder={t(keyConfig.placeholder)}
              autoComplete="new-password"
            />
          )}
        </RAGFlowFormItem>
      )}
    </>
  );
}