Cloudflare Web Search API icon

Cloudflare Web Search API

Cloudflare Web Search API 通过 AI Gateway 为 AI 智能体和应用提供实时网络搜索,返回结构化网址、标题和描述,支持 Ceramic.ai、Exa 与 Linkup,并可通过 REST 或 Workers AI 调用。

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 额度,也可以使用存储在网关中的提供商密钥。

Web Search API 功能

多个搜索提供商

通过一个 provider 参数选择 Ceramic.ai、Exa 或 Linkup。每个提供商都会返回通用结果格式,因此无需更改集成的其余部分即可切换提供商。

网关可观测性

搜索请求会通过 AI Gateway 路由,并与模型推理请求一起显示在网关日志和分析中,同时享有网关的访问控制和运营可见性。

灵活的计费方式

使用 AI Gateway 额度时,搜索会按所选提供商的 API 标价计费,不收取额外加价。也可以改用通过存储在网关中的密钥访问现有提供商账户。

结构化且带来源的结果

结果包含可传入模型上下文的来源网址、标题和描述。提供商特定的描述可能是较长的页面描述、重点摘要或原始搜索结果片段。

智能体和应用工作流

可以通过 REST 从后端应用调用 API,也可以在 Workers 中使用 AI binding。模型还可以调用 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 额度或存储在网关中的提供商 API 密钥。REST API 请求需要具有 Account > Workers AI > Read 和 Account > AI Gateway > Read 权限的 Cloudflare API 令牌。

如何调用 Web Search API?

你可以从任意后端向 /ai/websearch/ 端点发送 POST 请求,或在 Worker 中通过 Workers AI binding 调用 websearch()。这两种方式都使用 AI Gateway。

Web Search API 会返回什么?

请求会返回一个标准的 Response 对象。使用 response.json() 解析后,响应会包含带有网址、标题和描述的 items,以及查询、请求 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