Felo API PlatformFelo API Platform
全部 Tavily 端點
v0.2.0-beta
OpenAPI 3.1.0

Tavily Search

伺服器:https://openapi.felo.ai
用戶端程式庫

Tavily Search

​

搜尋網路並傳回含標題、URL 與內容摘要的排序結果。query 為必填。使用 max_results 控制結果數量,使用 search_depth 選擇搜尋模式。額外的 answer、images 與原始內容僅在要求時傳回。設定 include_usage 以接收資源用量資訊;usage.credits 並非 Felo 費用。

計費參考

  • 計量方式:依回應單位計量。
  • 參考請求估算:0.016 美元。
  • 單位成本基準:0.008 美元。
  • 資源單位:tavily_credit。
  • 參考客戶乘數:1.0。不得再次套用於已結算的客戶金額。
  • 成本基礎不構成最終客戶價格,即使為零亦同。

僅供參考的中繼資料,並非帳戶報價、保證價格或消費上限。資源額度並非 Felo 額度。最終費用依 Felo 計費記錄為準。

請求本文
必填
application/json
  • query
    類型: string
    必填

    使用 Tavily 執行的搜尋查詢。

  • auto_parameters
    類型: boolean

    根據查詢內容自動設定搜尋參數。

  • chunks_per_source
    類型: integer
    最小值:  
    1
    最大值:  
    3

    每個來源傳回的相關區塊最大數。

  • country
    類型: string 列舉

    提升來自特定國家的搜尋結果。僅在 topic 為 general 時可用。

    值
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    類型: string 格式: date

    傳回指定結束日期之前的結果。

  • exclude_domains
    類型: array string[] …150

    要從搜尋結果中明確排除的網域清單。

  • include_answer

    包含 LLM 產生的答案。true 使用預設答案模式;basic 或 advanced 指定答案產生模式。

    • 類型: boolean

      包含 LLM 產生的答案。true 使用預設答案模式;basic 或 advanced 指定答案產生模式。

  • include_domains
    類型: array string[] …300

    要明確包含在搜尋結果中的網域清單。

  • include_favicon
    類型: boolean

    為每筆結果包含 favicon URL。

  • include_image_descriptions
    類型: boolean

    include_images 為 true 時,為每張圖片新增描述文字。

  • include_images
    類型: boolean

    執行圖片搜尋並包含結果。

  • include_raw_content

    為每筆搜尋結果包含清理並解析後的內容。true 或 markdown 傳回 Markdown;text 傳回純文字,可能增加延遲。

    • 類型: boolean

      為每筆搜尋結果包含清理並解析後的內容。true 或 markdown 傳回 Markdown;text 傳回純文字,可能增加延遲。

  • include_usage
    類型: boolean

    在回應中包含資源用量資訊。此資訊不是 Felo 計費資訊。

  • max_results
    類型: integer
    最小值:  
    0
    最大值:  
    20

    要傳回的搜尋結果數量上限。

  • 類型: boolean

    從搜尋結果中過濾成人或不安全內容。僅限企業版;search_depth 為 fast 或 ultra-fast 時不支援。

  • search_depth
    類型: string 列舉

    控制延遲與相關性的取捨。advanced 相關性最高,但延遲和成本也更高;basic 較為均衡;fast 和 ultra-fast 著重降低延遲。

    值
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    類型: string 格式: date

    傳回指定開始日期之後的結果。

  • time_range
    類型: string 列舉

    依發布日期篩選結果的時間範圍。

    值
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    類型: string 列舉

    搜尋類別。

    值
    • general
    • news
    • finance
回應
  • 200
    類型: object

    已成功傳回搜尋結果。

    • answer
      類型: string | null

      簡短的 LLM 產生答案。include_answer 為 false 或未產生答案時為 null。

    • images
      類型: array object[]
      • description
        類型: string

        圖片描述。

      • url
        類型: string

        圖片 URL。

    • query
      類型: string

      實際執行的搜尋查詢。

    • request_id
      類型: string

      唯一的請求識別碼。

    • response_time
      類型: number 格式: float

      完成該請求所用的時間(秒)。

    • results
      類型: array object[]
      • content
        類型: string

        搜尋結果的內容摘要。

      • favicon
        類型: string | null

        搜尋結果的 Favicon URL。

      • raw_content
        類型: string | null

        清理並解析後的來源內容。除非請求 include_raw_content,否則為 null;沒有可用的原始內容時同為 null。

      • score
        類型: number 格式: float

        搜尋結果的相關性分數。

      • title
        類型: string

        搜尋結果的標題。

      • url
        類型: string

        搜尋結果的 URL。

    • usage
      類型: object
      • credits
        類型: integer

        此請求消耗的資源單位,不是美元或 Felo 額度。

    application/json
  • 400

    無法處理該要求。請檢查請求參數。

  • 401

    需要有效的 Felo API 金鑰。

  • 402

    由於未符合計費要求,要求無法繼續。

  • 403

    該帳戶無權執行此操作。

  • 429

    已達到要求或支出上限。

  • 502

    服務無法完成該要求。

  • 503

    API 或計費服務暫時無法使用。

  • 504

    服務在處理要求時逾時。

  • default

    錯誤回應;上游透傳回應可能採用供應商格式

    application/json
Request Example for post/v1/beta/tavily/search
curl --request POST https://openapi.felo.ai/v1/beta/tavily/search \
  --header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"query": "Python official documentation", "search_depth": "basic", "max_results": 2, "include_usage": true}'
{
  "query": "Python official documentation",
  "answer": null,
  "images": [],
  "results": [
    {
      "title": "Python Documentation",
      "url": "https://docs.python.org/3/",
      "content": "Documentation for the Python programming language.",
      "score": 0.98,
      "raw_content": null
    }
  ],
  "response_time": 1.2,
  "usage": {
    "credits": 1
  },
  "request_id": "example-search-request"
}
Tavily Search

需要協助嗎?