@lobehub/chat/src/server/services/search/impls/tavily/index.ts

Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.

import { TRPCError } from '@trpc/server';
import debug from 'debug';
import urlJoin from 'url-join';

import { SearchParams, UniformSearchResponse, UniformSearchResult } from '@/types/tool/search';

import { SearchServiceImpl } from '../type';
import { TavilySearchParameters, TavilyResponse } from './type';

const log = debug('lobe-search:Tavily');

/**
 * Tavily implementation of the search service
 * Primarily used for web crawling
 */
export class TavilyImpl implements SearchServiceImpl {
  private get apiKey(): string | undefined {
    return process.env.TAVILY_API_KEY;
  }

  private get baseUrl(): string {
    // Assuming the base URL is consistent with the crawl endpoint
    return 'https://api.tavily.com';
  }

  async query(query: string, params: SearchParams = {}): Promise<UniformSearchResponse> {
    log('Starting Tavily query with query: "%s", params: %o', query, params);
    const endpoint = urlJoin(this.baseUrl, '/search');

    const defaultQueryParams: TavilySearchParameters = {
      include_answer: false,
      include_image_descriptions: true,
      include_images: false,
      include_raw_content: false,
      max_results: 15,
      query,
      search_depth: process.env.TAVILY_SEARCH_DEPTH || 'basic' // basic or advanced
    };

    let body: TavilySearchParameters = {
      ...defaultQueryParams,
      time_range:
        params?.searchTimeRange && params.searchTimeRange !== 'anytime'
          ? params.searchTimeRange
          : undefined,
      topic:
        // Tavily 只支持 news 和 general 两种类型
        params?.searchCategories?.filter(cat => ['news', 'general'].includes(cat))?.[0],
    };

    log('Constructed request body: %o', body);

    let response: Response;
    const startAt = Date.now();
    let costTime = 0;
    try {
      log('Sending request to endpoint: %s', endpoint);
      response = await fetch(endpoint, {
        body: JSON.stringify(body),
        headers: {
          'Authorization': this.apiKey ? `Bearer ${this.apiKey}` : '',
          'Content-Type': 'application/json',
        },
        method: 'POST',
      });
      log('Received response with status: %d', response.status);
      costTime = Date.now() - startAt;
    } catch (error) {
      log.extend('error')('Tavily fetch error: %o', error);
      throw new TRPCError({
        cause: error,
        code: 'SERVICE_UNAVAILABLE',
        message: 'Failed to connect to Tavily.',
      });
    }

    if (!response.ok) {
      const errorBody = await response.text();
      log.extend('error')(
        `Tavily request failed with status ${response.status}: %s`,
        errorBody.length > 200 ? `${errorBody.slice(0, 200)}...` : errorBody,
      );
      throw new TRPCError({
        cause: errorBody,
        code: 'SERVICE_UNAVAILABLE',
        message: `Tavily request failed: ${response.statusText}`,
      });
    }

    try {
      const tavilyResponse = (await response.json()) as TavilyResponse;

      log('Parsed Tavily response: %o', tavilyResponse);

      const mappedResults = (tavilyResponse.results || []).map(
        (result): UniformSearchResult => ({
          category: body.topic || 'general', // Default category
          content: result.content || '', // Prioritize content, fallback to snippet
          engines: ['tavily'], // Use 'tavily' as the engine name
          parsedUrl: result.url ? new URL(result.url).hostname : '', // Basic URL parsing
          score: result.score || 0, // Default score to 0 if undefined
          title: result.title || '',
          url: result.url,
        }),
      );

      log('Mapped %d results to SearchResult format', mappedResults.length);

      return {
        costTime,
        query: query,
        resultNumbers: mappedResults.length,
        results: mappedResults,
      };
    } catch (error) {
      log.extend('error')('Error parsing Tavily response: %o', error);
      throw new TRPCError({
        cause: error,
        code: 'INTERNAL_SERVER_ERROR',
        message: 'Failed to parse Tavily response.',
      });
    }
  }
}