Cloudflare Web Search API icon

Cloudflare Web Search API

Cloudflare Web Search API 透過 AI Gateway 為 AI 代理與應用程式提供即時網頁搜尋,回傳結構化網址、標題與描述,支援 Ceramic.ai、Exa 和 Linkup,並可經由 REST 或 Workers AI binding 使用。

Cloudflare Web Search API

Cloudflare Web Search API

Cloudflare Web Search API 是一個開放測試版 API,讓 AI 代理與應用程式存取即時網頁搜尋。它會透過 AI Gateway 路由搜尋,並回傳結構化結果,包括標題、網址和描述,讓應用程式能以最新網頁資訊為模型回應提供依據,而不只依賴模型的訓練資料或猜測的網址。

此服務透過共用的請求介面支援 Ceramic.ai、Exa 和 Linkup,也可以從任何後端使用 REST API,或透過 Workers AI binding 從 Cloudflare Worker 使用。搜尋請求會納入 AI Gateway 記錄和分析中,而計費可使用 AI Gateway 點數,或使用儲存在 gateway 上的供應商金鑰。

Web Search API 功能

多個搜尋供應商

使用一個 provider 參數選擇 Ceramic.ai、Exa 或 Linkup。每個供應商都會回傳通用結果格式,因此無需變更整合的其餘部分即可更換供應商。

Gateway 可觀測性

搜尋會經由 AI Gateway 路由,並與模型推論請求一同顯示在 gateway 記錄和分析中,同時具備 gateway 的存取控制與作業可視性。

彈性的計費方式

使用 AI Gateway 點數時,搜尋會按照所選供應商的 API 公開定價收費,不另加價。您也可以改用儲存在 gateway 中的金鑰,透過既有的供應商帳戶使用服務。

結構化且附帶引用的結果

結果包含來源網址、標題和描述,可傳入模型上下文。供應商特定的描述可能是較長的頁面描述、重點摘要或原始搜尋結果摘要。

代理與應用程式工作流程

您可以透過 REST 從後端應用程式呼叫 API,或使用 AI binding 從 Workers 呼叫。模型也可以呼叫 web_search 工具,觸發搜尋並回傳結果,以供後續完成請求使用。

供應商特定資料與爬取條款

供應商比較中列出的 Ceramic.ai 和 Linkup 具備 Zero Data Retention,而 Exa 則列為不具備 Zero Data Retention。三家供應商都遵守 Cloudflare 的已驗證機器人要求。

Web Search API 使用情境

  • 為代理回答提供依據

    為模型定義 web_search 工具,透過 Web Search API 執行要求的搜尋,並將結構化結果傳入後續的模型完成請求。

  • 即時資訊應用程式

    使用最新網頁結果回答事件、地點、產品或其他主題相關問題,適用於資訊可能已在模型訓練資料蒐集後變更的情況。

  • 依供應商特性調整檢索

    從代理工作流程中執行重複搜尋,並根據所需的結果形式選擇供應商,例如較長的描述、與查詢相關的重點摘要或快速的原始摘要。

  • 附帶引用的應用程式結果

    將回傳的網址、標題和描述用作具來源感知能力的檢索層,適合需要顯示或保留生成回應所依據網頁連結的應用程式。

Pros and Cons

Pros

  • 單一 API 介面支援三個搜尋供應商及通用結果格式。
  • REST 和 Workers AI binding 存取方式同時支援一般後端應用程式與 Cloudflare Worker 部署。
  • AI Gateway 記錄與分析功能可讓您查看搜尋請求,以及模型推論流量。
  • 回應包含來源連結與描述,可直接提供給 AI 模型作為依據。

Cons

  • 產品文件指出此服務目前處於開放測試版,因此應根據目前的測試版文件與作業需求評估其是否適合正式環境。
  • 供應商行為與資料條款各不相同:例如,Exa 列為不具備 Zero Data Retention,而 Ceramic.ai 和 Linkup 則列為具備。
  • 每次請求最多只能取得 10 個搜尋結果,且 API 需要 AI Gateway,以及點數或已設定的供應商憑證。

FAQ

開始使用 Web Search API 需要哪些條件?

您需要 Cloudflare 帳戶、AI Gateway,以及 AI Gateway 點數或儲存在 gateway 上的供應商 API 金鑰。REST API 請求需要具備 Account > Workers AI > Read 和 Account > AI Gateway > Read 權限的 Cloudflare API token。

如何呼叫 Web Search API?

您可以從任何後端向 /ai/websearch/ 端點傳送 POST 請求,或在 Worker 中透過 Workers AI binding 呼叫 websearch()。這兩種方式都會使用 AI Gateway。

Web Search API 會回傳哪些內容?

請求會回傳標準的 Response 物件。使用 response.json() 解析後,回應會包含帶有網址、標題和描述的項目,以及供應商提供時的查詢、請求 ID 和延遲等中繼資料。

支援哪些搜尋供應商和結果數量限制?

將 provider 參數設為 ceramic、exa 或 linkup。如果省略此參數,預設會使用 Ceramic.ai。limit 參數接受 1 到 10 個結果,預設值為 10。

可以使用自己的供應商 API 金鑰嗎?

可以。請在 AI Gateway Provider Keys 設定中儲存供應商金鑰和別名,然後在請求中傳入 provider 和 byokAlias。使用 BYOK 時,供應商會直接向您收費。如果明確設定 byokAlias 但該別名無法使用,請求會失敗,而不會改用 AI Gateway 點數。

Quick Facts

類別
AI 開發者工具
平台
Cloudflare AI Gateway 和 Workers AI
可用性
開放測試版
供應商
Ceramic.ai、Exa 和 Linkup
存取方式
REST API 和 Workers AI binding
預設供應商
Ceramic.ai