Перейти к содержимому
RU
Ключ 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 в папке проекта. Один звонок возвращает до пяти веб-результатов, их URLs и фактическое использование. Функция проверяет ввод, сохраняет порядок результата, удаляет дубликаты URLs и удерживает ключ от возвращаемых данных. Лимит символов 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. Добавить местный backend

Сохраните как 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, ни внешний 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 и использование ниже являются иллюстративными. Поиск возвращает фрагменты и ссылки. Используйте считыватель страниц, когда вашей функции нужен полный текст страницы.

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 и его запрос. Создавайте один бегун на задание и сохраняйте его в поворотах модели этой задачи; 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);
  };
}

Попробуйте инструмент напрямую

Сохраните tool-demo.mjs во флешдатах-поисковой демонстрации, затем запустите команду ниже из этой папки с тем же ключом API. Эта дополнительная проверка делает один дополнительный запрос FlashData без вызова модели. Ожидайте 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 / ENOENTХраните все файлы в флешдата-поисковой демонстрации и запускайте из этой папки. Сохраните index.html перед открытием страницы.
EADDRINUSEПорт 8787 занят. Прекратите свой предыдущий демо-процесс, прежде чем начать другой.
Предел поискового вызова достигнутЗадание использовало свои разрешенные попытки. Закончите с собранными доказательствами или сообщите о лимите; создание нового бегуна сбросит счет.
Пустые результатыПокажите пустое состояние и позвольте пользователю уточнить запрос; не повторяйте автоматически.
401 / 403 / 402Проверьте ключ сервера, разрешение google_search и кредиты на счет.
429Ожидайте Retry-After при предоставлении; ограничьте запросы на одного пользователя перед вызовом FlashData.
Тайм-аут / сетевая ошибкаПокажите неопределенный результат. Проверяйте History перед отправкой того же платного запроса.