跳转到正文
中文
获取 API 密钥
浏览文档

指南

为应用添加搜索

构建可运行的搜索表单,将 API Key 保留在后端,并让智能体工具复用同一个搜索函数。

本页内容

你将构建什么

一个显示排名链接、摘要及 Credits 用量的本地搜索表单。需要 Node.js 22+、具有 google_search 权限的密钥及可用 Credits,无需 npm 包。可选的智能体部分复用同一后端函数。

保存在 flashdata-search-demo 中用途
search.mjs从后端调用 FlashData,由表单与智能体工具共用。
server.mjs提供本地页面与 GET /search 接口。
index.html显示来源、空结果及错误。
Bash 或 PowerShell · 创建项目
node --version
mkdir flashdata-search-demo
cd flashdata-search-demo

设置 API Key

若已设置 FLASHDATA_API_KEY,可直接复用。否则在运行代码的终端使用下方隐藏提示输入。智能体可从密钥存储加载同一变量。

设置密钥
# Bash: paste the key into a hidden prompt, not into this command.
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
export FLASHDATA_API_KEY

1. 创建搜索函数

将 search.mjs 保存在项目目录。每次调用返回最多五条网页结果、URL 和实际用量。函数验证输入、保持结果顺序、移除重复 URL,并且不在返回数据中包含密钥。500 字符限制是此应用的设计选择。

search.mjs
// search.mjs — server only; Node.js 22+
export async function searchWeb(query) {
  if (typeof query !== "string" || !query.trim() || query.length > 500) {
    throw Object.assign(new Error("Enter a query of 1–500 characters."), { status: 400 });
  }
  const apiKey = process.env.FLASHDATA_API_KEY;
  if (!apiKey) throw new Error("Set FLASHDATA_API_KEY on the server.");
  let response;
  try {
    response = await fetch("https://data.flashdata.dev/v1/queries/realtime", {
      method: "POST", redirect: "error", signal: AbortSignal.timeout(70000),
      headers: { "X-API-Key": apiKey, "Content-Type": "application/json" },
      body: JSON.stringify({ source: "google_search", query: query.trim(),
        params: { num: 5, gl: "us", hl: "en" } }),
    });
  } catch {
    throw new Error("Search outcome unknown. Check FlashData History before retrying.");
  }
  if (!response.ok) {
    throw Object.assign(new Error("Search failed: HTTP " + response.status), {
      status: response.status, retryAfter: response.headers.get("retry-after"),
    });
  }
  const data = await response.json();
  if (data.status !== "done" || !Array.isArray(data.results)) {
    throw new Error("Search did not finish. Check FlashData History.");
  }
  const seen = new Set();
  const sources = [];
  for (const [index, item] of (data.results[0]?.organic ?? []).entries()) {
    let url;
    try { url = new URL(item.link); } catch { continue; }
    if (!["https:", "http:"].includes(url.protocol) || seen.has(item.link)) continue;
    seen.add(item.link);
    sources.push({ rank: item.position ?? index + 1, title: item.title ?? item.link,
      url: item.link, snippet: item.snippet ?? "" });
  }
  return { query: query.trim(), sources, usage: data.usage,
    retrievedAt: new Date().toISOString() };
}

2. 添加本地后端

将 server.mjs 保存到 search.mjs 旁。GET /search?q=... 调用搜索函数;GET / 提供下一步创建的表单。服务仅监听 127.0.0.1。

server.mjs
// server.mjs — local demo; keep your existing app's authentication in production.
import { createServer } from "node:http";
import { readFile } from "node:fs/promises";
import { searchWeb } from "./search.mjs";

createServer(async (req, res) => {
  const url = new URL(req.url, "http://127.0.0.1:8787");
  res.setHeader("Cache-Control", "no-store");
  try {
    if (req.method === "GET" && url.pathname === "/") {
      const html = await readFile(new URL("./index.html", import.meta.url));
      res.writeHead(200, { "Content-Type": "text/html; charset=utf-8" });
      return res.end(html);
    }
    if (req.method !== "GET" || url.pathname !== "/search") {
      res.writeHead(404); return res.end("Not found");
    }
    const result = await searchWeb(url.searchParams.get("q"));
    res.writeHead(200, { "Content-Type": "application/json" });
    res.end(JSON.stringify(result));
  } catch (error) {
    if (error.retryAfter) res.setHeader("Retry-After", error.retryAfter);
    res.writeHead(error.status ?? 502, { "Content-Type": "application/json" });
    res.end(JSON.stringify({ error: error.message }));
  }
}).listen(8787, "127.0.0.1", () => console.log("Open http://127.0.0.1:8787"));

3. 在应用中显示结果

将 index.html 保存到同一文件夹。表单处理加载、空结果与错误。它调用你的后端,并以纯文本插入摘要,因此 API Key 和外部 HTML 都不会进入网页。

index.html
<!doctype html>
<html lang="en">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Web search</title>
<h1>Search the web</h1>
<form id="search">
  <label>Query <input name="q" required maxlength="500" value="battery recycling research"></label>
  <button>Search</button>
</form>
<p id="status" role="status"></p>
<ol id="results"></ol>
<script type="module">
const form = document.querySelector("#search");
const status = document.querySelector("#status");
const results = document.querySelector("#results");
form.addEventListener("submit", async (event) => {
  event.preventDefault();
  form.querySelector("button").disabled = true;
  results.replaceChildren(); status.textContent = "Searching…";
  try {
    const q = new FormData(form).get("q");
    const response = await fetch("/search?q=" + encodeURIComponent(q));
    const data = await response.json();
    if (!response.ok) {
      const retryAfter = response.headers.get("Retry-After");
      throw new Error(data.error + (retryAfter ? " · Retry-After: " + retryAfter : ""));
    }
    for (const source of data.sources) {
      const li = document.createElement("li");
      const link = document.createElement("a");
      link.href = source.url; link.textContent = source.title;
      const excerpt = document.createElement("p");
      excerpt.textContent = source.snippet;
      li.append(link, excerpt); results.append(li);
    }
    const credits = data.usage?.credits ?? "not reported";
    status.textContent = (data.sources.length
      ? data.sources.length + (data.sources.length === 1 ? " source" : " sources")
      : "No matching pages. Try a broader query.") + " · Credits used: " + credits;
  } catch (error) { status.textContent = error.message; }
  finally { form.querySelector("button").disabled = false; }
});
</script>
</html>

4. 运行首次搜索

在设置密钥的终端中,从 flashdata-search-demo 运行。打开地址并点击一次 Search。每次提交都会执行计费查询;打开页面或修改输入不会发起查询。完成后按 Ctrl+C 停止本地服务。

  1. 输入具体主题,例如 battery recycling recovery rates。
  2. 应看到带链接的标题、摘要和 usage.credits 返回的用量。结果会变化;零条来源也是有效的已完成搜索。
在 flashdata-search-demo 中 · 保持此终端运行
node server.mjs
在浏览器中打开
http://127.0.0.1:8787

应用收到的结果

以下为精简结构,URL 与用量仅用于展示。搜索返回摘要与链接;需要完整网页内容时,使用网页阅读工具。

GET /search?q=...
{
  "query": "battery recycling research",
  "sources": [
    {
      "rank": 1,
      "title": "Example source",
      "url": "https://example.org/research",
      "snippet": "A returned search excerpt."
    }
  ],
  "usage": {
    "credits": 0.02
  },
  "retrievedAt": "2026-11-04T00:00:00.000Z"
}

在智能体工具中复用搜索

可选:将 search-tool.mjs 保存在 search.mjs 旁。执行器仅接受 search_web 及其 query 参数。每个任务创建一个执行器,并在该任务的模型轮次间复用;maxCalls 限制搜索尝试次数,包括失败尝试,不设置 Credits 消费上限。

flashdata-search-demo/search-tool.mjs
// search-tool.mjs — one runner per task, reused across its model turns.
import { searchWeb } from "./search.mjs";

export const searchTool = {
  name: "search_web",
  description: "Find ranked web URLs and snippets for a focused query.",
  inputSchema: {
    type: "object", additionalProperties: false,
    properties: { query: { type: "string", minLength: 1, maxLength: 500 } },
    required: ["query"],
  },
};
export function createSearchToolRunner({ maxCalls = 2 } = {}) {
  if (!Number.isSafeInteger(maxCalls) || maxCalls < 1) {
    throw new Error("maxCalls must be a positive integer.");
  }
  let attempts = 0;
  return async function runTool(name, args) {
    if (name !== searchTool.name) throw new Error("Unknown tool: " + name);
    if (!args || typeof args !== "object" || Array.isArray(args) ||
        Object.keys(args).some(key => key !== "query") ||
        typeof args.query !== "string" || !args.query.trim() || args.query.length > 500) {
      throw new Error("Expected only query: a string of 1–500 characters.");
    }
    if (attempts >= maxCalls) throw new Error("Search call limit reached for this task.");
    attempts++; // Reserve before awaiting; a failed attempt still counts.
    return searchWeb(args.query);
  };
}

直接试用工具

将 tool-demo.mjs 保存在 flashdata-search-demo 中,再从该目录使用同一 API Key 运行下方命令。此可选检查会额外执行一次 FlashData 查询,不调用模型。预期得到包含 query、sources、usage 及 retrievedAt 的 JSON,与表单的结果结构相同。

flashdata-search-demo/tool-demo.mjs
// tool-demo.mjs — one direct tool call; no model-provider dependency.
import { createSearchToolRunner, searchTool } from "./search-tool.mjs";

if (process.argv.length !== 3) {
  console.error('Usage: node tool-demo.mjs "your search query"');
  process.exit(1);
}
const runTool = createSearchToolRunner({ maxCalls: 1 });
const result = await runTool(searchTool.name, { query: process.argv[2] });
console.log(JSON.stringify(result, null, 2));
从 flashdata-search-demo 运行一次
node tool-demo.mjs "battery recycling research"

接入模型

示例验证工具函数,模型连接及消息循环由你的框架提供。搜索返回链接与摘要;回答需要完整内容时应先阅读选定页面。恢复任务或分布式执行时,将尝试次数和结果与任务 ID 一起持久保存。

  1. 按框架的工具定义格式注册 searchTool.name、description 和 inputSchema。API Key 保留在后端环境中。
  2. 任务开始时调用 createSearchToolRunner({ maxCalls: 2 })。对每次模型工具调用,解析其 JSON 参数,再将名称及解析后的对象传给同一执行器。无效 JSON 应在分派前拒绝。
  3. 将 JSON 结果作为工具结果返回给模型,并关联原始调用 ID。保留 sources[].url 以便引用。执行失败或达到上限时返回错误,不要创建新执行器重试。

处理失败并上线

部署时,将 /search 放在应用登录和每用户限制之后。密钥放在服务端配置中,按请求保留用量,将外部内容作为文本渲染。此交互表单使用实时模式;后台任务可使用异步模式。

情况应用处理
ERR_MODULE_NOT_FOUND / ENOENT将所有文件保存在 flashdata-search-demo 中,并从该目录运行。打开页面前先保存 index.html。
EADDRINUSE8787 端口被占用。先停止之前启动的示例进程,再启动新的进程。
达到搜索调用上限任务已用完允许的尝试次数。使用已收集证据完成任务或报告上限;创建新执行器会重置计数。
空结果显示空状态,让用户改进查询;不要自动重试。
401 / 403 / 402检查服务器密钥、google_search 权限和账户余额。
429存在 Retry-After 时按其等待;调用 FlashData 前限制每个用户的请求频率。
超时 / 网络错误显示结果尚未确定。再次提交同一计费查询前先查看历史。