コンテンツへスキップ
JA
APIキーを取得する
ドキュメントを探す

ガイド

アプリケーションに検索を追加する

作業検索フォームを構築し、APIキーをバックエンドに保持し、エージェントツールで同じ検索機能を再利用します。

このページの内容

ビルドする

ランクされたリンク、スニペット、クレジット使用によるローカル検索フォーム。 Node.js 22+、google_searchの許可と利用可能なクレジットのキーが必要です。 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キーを設定する

既に設定されている場合は、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として保存します。 1つのコールは、Web結果の5つ、URLs、実際の使用量を最大5つまで返します。 関数は、入力を検証し、結果の順序を保存し、重複URLsを削除し、返されたデータのキーを保ちます。 500-characterの制限はアプリの選択肢です。

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. ローカルバックエンドを追加する

search.mjsの横にserver.mjsとして保存します。 GET /search?q=...関数を呼び出します。 GET / 次のフォームを作成します。 サーバは127.0.0.1のみを listen します。

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キーや外部の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. 最初の検索を実行する

キーボードをセットする端末でフラッシュデータ検索デモから実行します。 URLを開き、一度検索をクリックします。 各投稿は有料のクエリになります。ページを開くか、入力を編集すると、どれもなります。 ローカルサーバーをCtrl+Cで終了したら停止します。

  1. 電池のリサイクルの回復率のような特定のトピックを、入れて下さい。
  2. リンク先のタイトル、スニペット、クレジットをusage.creditsで返済します。 結果は異なります。 ゼロソースは有効な完了検索です。
Flashdata-search-demo では、この端末を稼働させ続ける
node server.mjs
ブラウザで開く
http://127.0.0.1:8787

アプリが受け取れる結果

吸収された形; URLs および下記の使用法はillustrativeです。 検索はスニペットとリンクを返します。 機能がフルページテキストを必要とするとき、ページリーダーを使用してください。

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.mjs の横の search-tool.mjs を保存して下さい。 ランナーはsearch_webとそのクエリのみを受け入れます。 タスクごとに1つのランナーを作成し、そのタスクのモデルのターン全体に保つ。maxCallsは、失敗した試みを含む検索を試みた制限。 クレジット決済の制限は設定されません。

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);
  };
}

ツールを直接試す

Flashdata-search-demo で tool-demo.mjs を保存し、同じ API キーでそのフォルダーから以下のコマンドを実行します。 このオプションのチェックでは、モデルを呼び出しずに追加のFlashDataクエリが1つ追加されます。 JSONをクエリ、ソース、使用量、retrievedAtを期待します。フォームと同じ結果形状です。

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、説明、inputSchemaをフレームワークのツール定義フォーマットで登録します。 APIキーをバックエンド環境に保ちます。
  2. タスク開始時に、createSearchToolRunner({ maxCalls: 2 }) を呼び出します。 各モデルのツールコールでは、JSON 引数を解析し、名前とパースされたオブジェクトを同じランナーに渡します。 ディスパッチの前に無効なJSONを注入して下さい。
  3. JSON は、元のコール ID でツール結果としてモデルに結果を返します。 sources[].url を引用符で保存します。 実行が限界に達した場合、エラーを返し、再試行するために新しいランナーを作成しないでください。

故障を扱い、それを出荷して下さい

展開のために、アプリケーションのサインインとパーユーザー制限の後ろに/searchを移動します。 API キーをサーバー構成で保ち、要求と使用法を保ち、外的な内容をテキストとしてレンダリングして下さい。 Realtime は、このインタラクティブな形式に適しています。バックグラウンドワークの非同期を使用します。

投稿ナビゲーションアプリの動作
ERR_MODULE_NOT_FOUND / ENOENTFlashdata-search-demo のすべてのファイルを保存し、そのフォルダーから実行します。 index.html を保存し、ページを開く前に保存します。
EADDRINUSEポート8787は占有されています。 先ほどのデモプロセスを止めて、別のプロセスを開始してください。
通話制限の検索タスクは許可された試みを使用しました。 収集された証拠で完了するか、限界を報告するか。新しいランナーを作成すると、カウントをリセットします。
空の結果空の状態を表示し、ユーザがクエリーを洗うようにします。自動的に再試行しないでください。
401 / 403 / 402サーバキー、google_search 権限、アカウントのクレジットを確認してください。
429Retry-After が提供されると待ちます。FlashData を呼び出す前に、ユーザごとのリクエストを制限します。
タイムアウト/ネットワークエラー不確実な結果を表示します。 Historyを調べて、同じ有料クエリを再度送信してください。