> ## 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 Integration

> Füge Olostep-Websuche zu Eliza-Agenten mit der Aktion `OLOSTEP_SEARCH` hinzu.

Eliza + Olostep bietet deinen Agenten eine zuverlässige Websuche, sodass sie aktuelle Informationen nachschlagen, offene Fragen mit Live-Ergebnissen beantworten und deduplizierte Links mit Titeln und Beschreibungen zurückgeben können.

## Funktionen

<CardGroup cols={2}>
  <Card title="Websuche-Aktion" icon="magnifying-glass">
    Fügt die Aktion `OLOSTEP_SEARCH` zu Eliza-Agenten für Live-Websuche hinzu.
  </Card>

  <Card title="Deduplizierte Ergebnisse" icon="filter">
    Entfernt doppelte Links und hält die relevantesten Ergebnisse oben.
  </Card>

  <Card title="Einfache Einrichtung" icon="plug">
    Konfiguriere einen API-Schlüssel in deinen Eliza-Agenten-Einstellungen und beginne mit der Suche.
  </Card>

  <Card title="Natürliche Sprach-Trigger" icon="message-lines">
    Funktioniert, wenn Benutzer den Agenten bitten, im Web zu suchen, etwas nachzuschlagen oder Online-Quellen zu finden.
  </Card>

  <Card title="Strukturierte Ergebnisse" icon="list-check">
    Gibt Titel, Beschreibungen und URLs zurück, die Agenten leicht zusammenfassen oder zitieren können.
  </Card>

  <Card title="Kein SDK erforderlich" icon="code">
    Ruft Olostep direkt über den `/searches`-Endpunkt mit standardmäßigem `fetch` auf.
  </Card>
</CardGroup>

## Installation

<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>
  Dieses Paket wird auf npm als `@olostep/plugin-elizaos-olostep` veröffentlicht.
</Note>

## Einrichtung

1. Erstelle einen Olostep-API-Schlüssel in deinem Olostep-Dashboard.
2. Füge den Schlüssel zu deinen Eliza-Agenten-Einstellungen als `OLOSTEP_API_KEY` hinzu.
3. Integriere das Plugin in deine Charakterkonfiguration.

```json theme={null}
{
  "name": "MyAgent",
  "settings": {
    "secrets": {
      "OLOSTEP_API_KEY": "dein-olostep-api-schlüssel-hier"
    }
  }
}
```

<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>

## Verfügbare Werkzeuge

### `OLOSTEP_SEARCH`

Durchsucht das Web mit Olostep und gibt eine Liste relevanter Links mit Titeln und Beschreibungen zurück. Verwende es, wenn der Benutzer den Agenten bittet, Informationen zu suchen, ein Thema nachzuschlagen oder aktuelle Webquellen zu finden.

<ParamField path="OLOSTEP_API_KEY" type="string" required>
  Der Olostep-API-Schlüssel, der in den Laufzeitgeheimnissen des Agenten gespeichert ist.
</ParamField>

<ParamField path="message.content.text" type="string" required>
  Die Suchanfrage. Eliza verwendet den eingehenden Benutzernachrichtentext als Anfrage.
</ParamField>

<CodeGroup>
  ```typescript Basic Setup theme={null}
  // Registriere das Plugin und lasse Eliza Suchanfragen weiterleiten
  import type { Character } from '@elizaos/core';

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

  ```typescript Advanced Setup theme={null}
  // Kombiniere Olostep mit einem Modell-Plugin für einen vollständigen Forschungsagenten
  import type { Character } from '@elizaos/core';

  export const character: Character = {
    name: 'ResearchAgent',
    bio: ['Untersucht aktuelle Ereignisse und fasst Webquellen zusammen.'],
    plugins: [
      '@elizaos/plugin-bootstrap',
      '@elizaos/plugin-openai',
      '@olostep/plugin-elizaos-olostep',
    ],
  };
  ```

  ```typescript With Style Guide theme={null}
  // Passe den Agenten an, um Websuche zu bevorzugen
  import type { Character } from '@elizaos/core';

  export const character: Character = {
    name: 'NewsAgent',
    style: {
      all: ['Verwende Websuche, wenn sich die Antwort kürzlich geändert haben könnte.'],
    },
    plugins: ['@olostep/plugin-elizaos-olostep'],
  };
  ```
</CodeGroup>

Die Aktion gibt strukturierte Suchergebnisse in `data.links` zurück, und die Agentenantwort enthält eine lesbare Zusammenfassung mit bis zu fünf Top-Links.

## Vollständige Agentenbeispiele

### Forschungsassistent

Ein Allzweck-Forschungsagent, der aktuelle Fakten abruft, bevor er antwortet:

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

export const character: Character = {
  name: 'ResearchAssistant',
  bio: [
    'Beantwortet Fragen mit aktuellen Webquellen.',
    'Fasst Links in prägnante, zitierte Antworten zusammen.',
  ],
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  settings: {
    secrets: {
      OLOSTEP_API_KEY: process.env.OLOSTEP_API_KEY!,
    },
  },
};
```

### Nachrichtenmonitor

Ein Agent, der zeitnahe Themen verfolgt und bemerkenswerte Updates meldet:

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

export const character: Character = {
  name: 'NewsMonitor',
  bio: ['Verfolgt zeitnahe Themen und meldet bemerkenswerte Updates aus dem Web.'],
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  style: {
    all: ['Bevorzuge aktuelle Quellen und füge nach Möglichkeit direkte URLs hinzu.'],
  },
};
```

Verwende dies für Benachrichtigungen, Marktbeobachtungsaufgaben, Trendforschung und andere zeitkritische Workflows.

### Support-Agent mit Such-Backup

Perfekt, um Kundenfragen mit Produkthandbuch-Suche zu beantworten:

```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: [
    'Produktsupport',
    'Dokumentationssuche',
    'Release-Notes-Suche',
  ],
};
```

Dieses Muster funktioniert gut, wenn dein Agent Dokumentationen oder Produktseiten durchsuchen soll, bevor er eine Kundenfrage beantwortet.

## Konfiguration

### Plugin aktivieren

Füge `@olostep/plugin-elizaos-olostep` zum `plugins`-Array in deiner Charakterkonfiguration hinzu.

### Websuche deaktivieren

Entferne das Plugin aus der Charakterkonfiguration, wenn du einen Eliza-Agenten möchtest, der keinen Zugriff auf die Olostep-Suche hat.

### Nur einige Funktionen nutzen

Dieses Plugin bietet eine einzige Aktion, daher gibt es keinen Schalter pro Werkzeug. Steuere das Verhalten durch:

* Welche Plugins du in der Charakterkonfiguration lädst
* Die Anweisungen und den Stil des Agenten
* Wann deine Laufzeit `OLOSTEP_API_KEY` einfügt

## Spezialisierte Funktionen

* **Direkter Zugriff auf den `/searches`-Endpunkt** — das Plugin ruft Olostep direkt mit `fetch` auf.
* **Ergebnis-Deduplikation** — doppelte URLs werden entfernt, bevor die Antwort zurückgegeben wird.
* **Freundliche Fallbacks** — die Aktion gibt klare Fehler zurück, wenn der API-Schlüssel fehlt oder die Anfrage leer ist.
* **Begrenzung der Top-Ergebnisse** — Antworten werden auf die fünf relevantesten Links gekürzt.

## Preisgestaltung

Die Preisgestaltung für die Nutzung der Suche hängt von deinem Olostep-Plan und den Dashboard-Einstellungen ab.

* Überprüfe dein Olostep-Dashboard für aktuelle Nutzungs- und Abrechnungsdetails.
* Überprüfe deine Kontolimits, bevor du Agenten mit hohem Volumen einsetzt.

## Support

* **NPM-Paket**: [@olostep/plugin-elizaos-olostep](https://www.npmjs.com/package/@olostep/plugin-elizaos-olostep)
* **Olostep-Website**: [olostep.com](https://www.olostep.com)
* **Olostep-Dashboard**: [dashboard.olostep.com](https://www.olostep.com/dashboard)
* **ElizaOS**: [elizaos.ai](https://elizaos.ai)
* **E-Mail-Support**: [info@olostep.com](mailto:info@olostep.com)

## Verwandte Ressourcen

<CardGroup cols={2}>
  <Card title="Search API" icon="magnifying-glass" href="/searches/searches">
    Erfahre, wie der Suchendpunkt Web-Ergebnisse zurückgibt
  </Card>

  <Card title="Batches API" icon="layer-group" href="/features/batches/batches">
    Stelle Suchen und andere Jobs für größere Workflows in die Warteschlange
  </Card>

  <Card title="Answers API" icon="question" href="/features/answers/answers">
    Erzeuge antwortenartige Ausgaben aus abgerufenen Webquellen
  </Card>

  <Card title="Crawls API" icon="spider-web" href="/features/crawls/crawls">
    Erkunde tiefere Site-Sammlungs- und Crawling-Workflows
  </Card>

  <Card title="Python SDK" icon="python" href="/sdks/python">
    Verwende das Python SDK für benutzerdefinierte Automatisierung rund um Olostep
  </Card>

  <Card title="Node.js SDK" icon="code" href="/sdks/node-js">
    Baue JavaScript-Integrationen und Agenten-Workflows
  </Card>
</CardGroup>