> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Olostep + ElizaOS 統合

> Olostep ウェブ検索を Eliza エージェントに `OLOSTEP_SEARCH` アクションとして追加します。

Eliza + Olostep は、エージェントに信頼性のあるウェブ検索を提供し、最新情報を調べたり、オープンエンドの質問にライブ結果で答えたり、重複のないリンクをタイトルと説明付きで返したりすることができます。

## 機能

<CardGroup cols={2}>
  <Card title="ウェブ検索アクション" icon="magnifying-glass">
    Eliza エージェントに `OLOSTEP_SEARCH` アクションを追加し、ライブウェブ検索を可能にします。
  </Card>

  <Card title="重複排除された結果" icon="filter">
    重複したリンクを削除し、最も関連性の高い結果を上位に表示します。
  </Card>

  <Card title="簡単なセットアップ" icon="plug">
    Eliza エージェント設定で1つの API キーを設定して検索を開始します。
  </Card>

  <Card title="自然言語トリガー" icon="message-lines">
    ユーザーがエージェントにウェブを検索するよう依頼したときに動作します。
  </Card>

  <Card title="構造化された結果" icon="list-check">
    エージェントが要約や引用しやすいタイトル、説明、URLを返します。
  </Card>

  <Card title="SDK 不要" icon="code">
    標準の `fetch` を使用して `/searches` エンドポイントを通じて Olostep に直接呼び出します。
  </Card>
</CardGroup>

## インストール

<CodeGroup>
  ```bash npm theme={null}
  npm install @olostep/plugin-elizaos-olostep
  ```

  ```bash pnpm theme={null}
  pnpm add @olostep/plugin-elizaos-olostep
  ```

  ```bash bun theme={null}
  bun add @olostep/plugin-elizaos-olostep
  ```
</CodeGroup>

<Note>
  このパッケージは npm で `@olostep/plugin-elizaos-olostep` として公開されています。
</Note>

## セットアップ

1. Olostep ダッシュボードで Olostep API キーを作成します。
2. Eliza エージェント設定にキーを `OLOSTEP_API_KEY` として追加します。
3. プラグインをキャラクター設定に含めます。

```json theme={null}
{
  "name": "MyAgent",
  "settings": {
    "secrets": {
      "OLOSTEP_API_KEY": "your-olostep-api-key-here"
    }
  }
}
```

<CodeGroup>
  ```typescript TypeScript theme={null}
  import type { Character } from '@elizaos/core';

  export const character: Character = {
    name: 'MyAgent',
    plugins: [
      '@elizaos/plugin-bootstrap',
      '@elizaos/plugin-openai',
      '@olostep/plugin-elizaos-olostep',
    ],
  };
  ```

  ```json JSON theme={null}
  {
    "name": "MyAgent",
    "plugins": [
      "@elizaos/plugin-bootstrap",
      "@elizaos/plugin-openai",
      "@olostep/plugin-elizaos-olostep"
    ]
  }
  ```
</CodeGroup>

## 利用可能なツール

### `OLOSTEP_SEARCH`

Olostep を使用してウェブを検索し、タイトルと説明付きの関連リンクのリストを返します。ユーザーがエージェントに情報を検索するよう依頼したとき、トピックを調べるとき、または最新のウェブソースを見つけるときに使用します。

<ParamField path="OLOSTEP_API_KEY" type="string" required>
  エージェントランタイムのシークレットに保存された Olostep API キー。
</ParamField>

<ParamField path="message.content.text" type="string" required>
  検索クエリ。Eliza は受信したユーザーメッセージテキストをクエリとして使用します。
</ParamField>

<CodeGroup>
  ```typescript Basic Setup theme={null}
  // プラグインを登録し、Eliza が検索リクエストをルーティングするようにします
  import type { Character } from '@elizaos/core';

  export const character: Character = {
    name: 'ResearchAgent',
    plugins: ['@olostep/plugin-elizaos-olostep'],
  };
  ```

  ```typescript Advanced Setup theme={null}
  // Olostep をモデルプラグインと組み合わせて、完全なリサーチエージェントを作成します
  import type { Character } from '@elizaos/core';

  export const character: Character = {
    name: 'ResearchAgent',
    bio: ['現在のイベントを調査し、ウェブソースを要約します。'],
    plugins: [
      '@elizaos/plugin-bootstrap',
      '@elizaos/plugin-openai',
      '@olostep/plugin-elizaos-olostep',
    ],
  };
  ```

  ```typescript With Style Guide theme={null}
  // エージェントをウェブ検索を好むように調整します
  import type { Character } from '@elizaos/core';

  export const character: Character = {
    name: 'NewsAgent',
    style: {
      all: ['最近変更された可能性のある答えにはウェブ検索を使用します。'],
    },
    plugins: ['@olostep/plugin-elizaos-olostep'],
  };
  ```
</CodeGroup>

このアクションは `data.links` に構造化された検索結果を返し、エージェントの応答には最大5つのトップリンクを含む読みやすい要約が含まれます。

## フルエージェントの例

### リサーチアシスタント

最近の事実を取得してから回答する汎用リサーチエージェント：

```typescript theme={null}
import type { Character } from '@elizaos/core';

export const character: Character = {
  name: 'ResearchAssistant',
  bio: [
    '現在のウェブソースを使用して質問に答えます。',
    'リンクを要約し、簡潔で引用された応答を提供します。',
  ],
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  settings: {
    secrets: {
      OLOSTEP_API_KEY: process.env.OLOSTEP_API_KEY!,
    },
  },
};
```

### ニュースモニター

タイムリーなトピックを追跡し、注目すべき更新を報告するエージェント：

```typescript theme={null}
import type { Character } from '@elizaos/core';

export const character: Character = {
  name: 'NewsMonitor',
  bio: ['タイムリーなトピックを追跡し、ウェブから注目すべき更新を報告します。'],
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  style: {
    all: ['可能な限り最新のソースを優先し、直接のURLを含めます。'],
  },
};
```

これをアラート、マーケットウォッチタスク、トレンドリサーチ、その他の時間に敏感なワークフローに使用します。

### 検索フォールバック付きサポートエージェント

製品ドキュメントの検索で顧客の質問に答えるのに最適：

```typescript theme={null}
import type { Character } from '@elizaos/core';

export const character: Character = {
  name: 'SupportAgent',
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  topics: [
    '製品サポート',
    'ドキュメント検索',
    'リリースノート検索',
  ],
};
```

このパターンは、エージェントが顧客の質問に答える前にドキュメントや製品ページを検索する必要がある場合にうまく機能します。

## 設定

### プラグインを有効にする

キャラクター設定の `plugins` 配列に `@olostep/plugin-elizaos-olostep` を追加します。

### ウェブ検索を無効にする

Olostep 検索アクセスを持たない Eliza エージェントを望む場合は、キャラクター設定からプラグインを削除します。

### 一部の機能のみを使用する

このプラグインは単一のアクションを公開しているため、ツールごとの切り替えはありません。次の方法で動作を制御します：

* キャラクター設定で読み込むプラグイン
* エージェントの指示とスタイル
* ランタイムが `OLOSTEP_API_KEY` を注入するタイミング

## 専門機能

* **直接 `/searches` エンドポイントアクセス** — プラグインは `fetch` で Olostep に直接呼び出します。
* **結果の重複排除** — 応答が返される前に重複した URL が削除されます。
* **フレンドリーフォールバック** — API キーが欠落しているか、クエリが空の場合に明確なエラーを返します。
* **トップ結果の制限** — 応答は最も関連性の高い5つのリンクにトリミングされます。

## 価格設定

検索使用の価格は、Olostep プランとダッシュボード設定に依存します。

* 現在の使用状況と請求の詳細については、Olostep ダッシュボードを確認してください。
* 高ボリュームエージェントを展開する前にアカウントの制限を確認してください。

## サポート

* **NPM パッケージ**: [@olostep/plugin-elizaos-olostep](https://www.npmjs.com/package/@olostep/plugin-elizaos-olostep)
* **Olostep ウェブサイト**: [olostep.com](https://www.olostep.com)
* **Olostep ダッシュボード**: [dashboard.olostep.com](https://www.olostep.com/dashboard)
* **ElizaOS**: [elizaos.ai](https://elizaos.ai)
* **メールサポート**: [info@olostep.com](mailto:info@olostep.com)

## 関連リソース

<CardGroup cols={2}>
  <Card title="検索 API" icon="magnifying-glass" href="/searches/searches">
    検索エンドポイントがウェブ結果を返す方法を学びます
  </Card>

  <Card title="バッチ API" icon="layer-group" href="/features/batches/batches">
    大規模なワークフローのために検索やその他のジョブをキューに入れます
  </Card>

  <Card title="回答 API" icon="question" href="/features/answers/answers">
    取得したウェブソースから回答スタイルの出力を生成します
  </Card>

  <Card title="クロール API" icon="spider-web" href="/features/crawls/crawls">
    より深いサイトコレクションとクロールワークフローを探ります
  </Card>

  <Card title="Python SDK" icon="python" href="/sdks/python">
    Olostep 周りのカスタムオートメーションに Python SDK を使用します
  </Card>

  <Card title="Node.js SDK" icon="code" href="/sdks/node-js">
    JavaScript 統合とエージェントワークフローを構築します
  </Card>
</CardGroup>
