Olostep + Vercel AI SDK 統合

Olostep AI SDK 統合は、Vercel AI SDK で構築されたエージェントにライブウェブデータ用の準備済みツールを提供します。Olostep はウェブ検索、スクレイピング、クロールの API です：ウェブデータを検索、抽出、構造化するための API です。generateText または streamText にツールを渡すと、モデルが検索、スクレイピング、クロールのタイミングを決定します。 npm からインストール →

機能

このパッケージは6つのツールを提供します：

スクレイプ

任意の URL をスクレイプし、JavaScript レンダリングを伴うクリーンなマークダウンを返します

検索

ライブウェブを検索し、タイトル、URL、説明を返します

回答

ライブウェブからの質問に、ソース URL と共に回答します

マップ

ウェブサイト上の URL をリストし、オプションでクエリによってランク付けします

クロール

開始 URL からサイトをクロールし、各ページのマークダウンを返します

バッチ

一括で URL のリストをスクレイプし、各ページのマークダウンを返します

インストール

npm install @olostep/ai-sdk ai zod

yarn add @olostep/ai-sdk ai zod

pnpm add @olostep/ai-sdk ai zod

AI SDK 5, 6, 7、Zod 3.25+ または 4、Node.js 18+ で動作します。

セットアップ

Olostep API キーを環境変数として設定します：

export OLOSTEP_API_KEY=your-api-key-here

または .env ファイルに：

OLOSTEP_API_KEY=your-api-key-here

API キーは Olostep ダッシュボードから取得してください。

クイックスタート

すべての Olostep ツールを olostepTools() でモデルに渡します：

import { generateText, stepCountIs } from 'ai';
import { olostepTools } from '@olostep/ai-sdk';

const { text } = await generateText({
  model: 'openai/gpt-5-mini',
  tools: olostepTools(),
  stopWhen: stepCountIs(5),
  prompt: 'Next.js 15 のリリースノートを読み、破壊的変更をソースと共にリストしてください。',
});

console.log(text);

stopWhen を使用すると、モデルは複数のステップにわたってツールを呼び出すことができ、たとえば最初に検索し、次に最良の結果をスクレイプします。モデル文字列は Vercel AI Gateway を使用します。また、@ai-sdk/openai の openai('gpt-5-mini') など、任意の AI SDK プロバイダーモデルを渡すこともできます。

個別ツールの選択

必要なツールだけをモデルに与えます：

import { olostepScrape, olostepSearch } from '@olostep/ai-sdk';

const tools = {
  scrape: olostepScrape(),
  search: olostepSearch(),
};

利用可能なツール

以下のツール名は olostepTools() で使用されるキーです。

scrape

olostepScrape()。単一の URL をスクレイプし、その内容をマークダウンとして返します。 入力:

string

必須

スクレイプするページの URL

number

JavaScript が多いページのレンダリングを待つミリ秒数 (0 から 10000)

返り値: { url, markdown }

search

olostepSearch()。ライブウェブを検索します。 入力:

string

必須

検索クエリ

number

デフォルト:"10"

最大結果数 (1 から 20)

返り値: { query, results: [{ title, url, description }] }

answer

olostepAnswer()。質問に答えるためにライブウェブを検索し、読み、ソースを提供します。 入力:

string

必須

質問または調査タスク

返り値: { answer, sources }

map

olostepMap()。ウェブサイト上の URL を発見します。 入力:

string

必須

マッピングするウェブサイト

string

このクエリに関連する URL をランク付け

number

返す URL の最大数 (1 から 500)

返り値: { url, urls }

crawl

olostepCrawl()。開始 URL からウェブサイトをクロールし、各ページのマークダウンを返します。このツールはクロールが完了するまで待機します。 入力:

string

必須

クロールを開始する URL

number

デフォルト:"5"

クロールする最大ページ数 (1 から 25)

array

これらのグロブパターンに一致する URL のみをクロールします。例：["/docs/**"]

返り値: { url, pages: [{ url, markdown }] }

batch

olostepBatch()。一括で URL のリストをスクレイプし、各ページのマークダウンを返します。このツールはバッチが完了するまで待機します。 入力:

array

必須

スクレイプする URL (1 から 20)

返り値: { pages: [{ url, markdown }] }

クロールとバッチツールは、モデルの結果が小さくなるように、1 回の呼び出しで 25 ページと 20 URL に制限されています。より大きなジョブの場合は、Crawls および Batches API を Node.js SDK で直接呼び出してください。

オプション

すべてのツール、および olostepTools() は同じオプションを受け入れます：

olostepTools({
  apiKey: 'olostep_...',   // デフォルトは process.env.OLOSTEP_API_KEY
  maxCharacters: 20_000,   // モデルに返されるページごとの最大コンテンツ文字数
  timeoutSeconds: 300,     // クロールとバッチツールがジョブの完了を待つ時間
});

string

Olostep API キー。デフォルトは OLOSTEP_API_KEY 環境変数です。

number

デフォルト:"20000"

ページごとにモデルに返される最大コンテンツ文字数。長いページは切り捨てられます。

number

デフォルト:"300"

クロールとバッチツールがジョブの完了を待つ時間（秒）。

ストリーミング例

streamText を使用して同じツールを使用します。例えば、Next.js のルートハンドラーで：

app/api/chat/route.ts

import { convertToModelMessages, streamText, stepCountIs, type UIMessage } from 'ai';
import { olostepTools } from '@olostep/ai-sdk';

export async function POST(req: Request) {
  const { messages }: { messages: UIMessage[] } = await req.json();

  const result = streamText({
    model: 'openai/gpt-5-mini',
    system: 'あなたはリサーチアシスタントです。ウェブツールを使用し、ソースを引用してください。',
    messages: await convertToModelMessages(messages),
    tools: olostepTools(),
    stopWhen: stepCountIs(5),
  });

  return result.toUIMessageStreamResponse();
}

ベストプラクティス

必要なツールだけを渡す

各ツールの説明がモデルに送信されます。ツールが少ないほどトークンが少なく、誤ったツール選択が少なくなります。ページを読むだけのチャットには、scrape と search だけで十分です。

ステップ制限を設定する

常に stopWhen を設定します（例：stepCountIs(5)）。これにより、モデルはツール呼び出しを連鎖できますが、永遠にループすることはできません。

長いページに対して maxCharacters を下げる

ページコンテンツはトークンの最大部分です。多くのページをクロールまたはバッチ処理する場合、maxCharacters を下げて、すべての結果がモデルのコンテキストウィンドウに収まるようにします。

大規模なクロールには timeoutSeconds を上げる

クロールとバッチツールはジョブの完了を待ちます。タイムアウトが発生した場合は、timeoutSeconds を上げるか、maxPages を下げます。

トラブルシューティング

認証に失敗しました

エラー: “無効な API キー”解決策:

ダッシュボードで API キーを確認してください
OLOSTEP_API_KEY がコードが実行される場所に設定されていることを確認してください（例：Vercel プロジェクトの環境変数）
または、olostepTools({ apiKey }) で直接キーを渡します

モデルがツールを呼び出さない

解決策:

stopWhen を設定してください。そうしないと、生成が最初のステップで停止します
ツール呼び出しをサポートするモデルを使用してください
プロンプトやシステムメッセージでウェブを言及してください。例えば、「ウェブツールを使用し、ソースを引用してください」

クロールまたはバッチがタイムアウトする

解決策:

timeoutSeconds を上げる
maxPages を下げるか、URL を少なくする
サーバーレス関数では、関数自体の時間制限が timeoutSeconds より長いことを確認してください

コンテキスト長を超えました

解決策:

maxCharacters を下げる
map を searchQuery と共に使用して、読む前により関連性の高いページを選択します

料金

Olostep は AI SDK とは独立して、API 使用量に基づいて課金されます：

スクレイプ: スクレイプごとに課金
検索と回答: リクエストごとに課金
バッチ: バッチ内の URL ごとに課金
クロール: クロールされたページごとに課金
マップ: マップ操作ごとに課金

現在の料金は olostep.com/pricing で確認してください。

サポート

GitHub

ソースコードと問題

サポートメール

メール: info@olostep.com

AI SDK ドキュメント

Vercel AI SDK について学ぶ

ドキュメント

完全な API ドキュメントを閲覧

スクレイプ API

スクレイプエンドポイントについて学ぶ

クロール API

クロールエンドポイントについて学ぶ

Mastra 統合

Mastra でエージェントを構築

LangChain 統合

LangChain で AI エージェントを構築

統合

Olostep + Vercel AI SDK 統合

機能

スクレイプ

検索

回答

マップ

クロール

バッチ

インストール

セットアップ

クイックスタート

個別ツールの選択

利用可能なツール

scrape

search

answer

map

crawl

batch

オプション

ストリーミング例

人気のユースケース

ベストプラクティス

トラブルシューティング

料金

サポート

GitHub

サポートメール

AI SDK ドキュメント

ドキュメント

関連リソース

スクレイプ API

クロール API

Mastra 統合

LangChain 統合

​機能

スクレイプ

検索

回答

マップ

クロール

バッチ

​インストール

​セットアップ

​クイックスタート

​個別ツールの選択

​利用可能なツール

​scrape

​search

​answer

​map

​crawl

​batch

​オプション

​ストリーミング例

​人気のユースケース

​ベストプラクティス

​トラブルシューティング

​料金

​サポート

GitHub

サポートメール

AI SDK ドキュメント

ドキュメント

​関連リソース

スクレイプ API

クロール API

Mastra 統合

LangChain 統合

機能

インストール

セットアップ

クイックスタート

個別ツールの選択

利用可能なツール

scrape

search

answer

map

crawl

batch

オプション

ストリーミング例

人気のユースケース

ベストプラクティス

トラブルシューティング

料金

サポート

関連リソース