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

# Intégration Olostep + ElizaOS

> Ajoutez la recherche web Olostep aux agents Eliza avec l’action `OLOSTEP_SEARCH`.

Eliza + Olostep offre à vos agents une recherche web fiable, leur permettant de consulter des informations à jour, de répondre à des questions ouvertes avec des résultats en direct, et de retourner des liens dédupliqués avec titres et descriptions.

## Fonctionnalités

<CardGroup cols={2}>
  <Card title="Action de Recherche Web" icon="magnifying-glass">
    Ajoute l’action `OLOSTEP_SEARCH` aux agents Eliza pour une recherche web en direct.
  </Card>

  <Card title="Résultats Dédupliqués" icon="filter">
    Supprime les liens en double et garde les résultats les plus pertinents en haut.
  </Card>

  <Card title="Configuration Simple" icon="plug">
    Configurez une clé API dans les paramètres de votre agent Eliza et commencez à rechercher.
  </Card>

  <Card title="Déclencheurs en Langage Naturel" icon="message-lines">
    Fonctionne lorsque les utilisateurs demandent à l’agent de rechercher sur le web, de chercher quelque chose ou de trouver des sources en ligne.
  </Card>

  <Card title="Résultats Structurés" icon="list-check">
    Retourne des titres, descriptions et URLs faciles à résumer ou à citer pour les agents.
  </Card>

  <Card title="Pas de SDK Requis" icon="code">
    Appelle directement Olostep via l’endpoint `/searches` avec `fetch` standard.
  </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>
  Ce package est publié sur npm sous le nom `@olostep/plugin-elizaos-olostep`.
</Note>

## Configuration

1. Créez une clé API Olostep dans votre tableau de bord Olostep.
2. Ajoutez la clé aux paramètres de votre agent Eliza en tant que `OLOSTEP_API_KEY`.
3. Incluez le plugin dans la configuration de votre personnage.

```json theme={null}
{
  "name": "MyAgent",
  "settings": {
    "secrets": {
      "OLOSTEP_API_KEY": "votre-clé-api-olostep-ici"
    }
  }
}
```

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

## Outils Disponibles

### `OLOSTEP_SEARCH`

Recherche sur le web avec Olostep et retourne une liste de liens pertinents avec titres et descriptions. Utilisez-le lorsque l’utilisateur demande à l’agent de rechercher des informations, de consulter un sujet ou de trouver des sources web actuelles.

<ParamField path="OLOSTEP_API_KEY" type="string" required>
  La clé API Olostep stockée dans les secrets d’exécution de l’agent.
</ParamField>

<ParamField path="message.content.text" type="string" required>
  La requête de recherche. Eliza utilise le texte du message utilisateur entrant comme requête.
</ParamField>

<CodeGroup>
  ```typescript Basic Setup theme={null}
  // Enregistrez le plugin et laissez Eliza gérer les requêtes de recherche
  import type { Character } from '@elizaos/core';

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

  ```typescript Advanced Setup theme={null}
  // Combinez Olostep avec un plugin modèle pour un agent de recherche complet
  import type { Character } from '@elizaos/core';

  export const character: Character = {
    name: 'ResearchAgent',
    bio: ['Enquête sur les événements actuels et résume les sources web.'],
    plugins: [
      '@elizaos/plugin-bootstrap',
      '@elizaos/plugin-openai',
      '@olostep/plugin-elizaos-olostep',
    ],
  };
  ```

  ```typescript With Style Guide theme={null}
  // Adaptez l’agent pour privilégier la recherche web
  import type { Character } from '@elizaos/core';

  export const character: Character = {
    name: 'NewsAgent',
    style: {
      all: ['Utilisez la recherche web lorsque la réponse peut avoir changé récemment.'],
    },
    plugins: ['@olostep/plugin-elizaos-olostep'],
  };
  ```
</CodeGroup>

L’action retourne des résultats de recherche structurés dans `data.links`, et la réponse de l’agent inclut un résumé lisible avec jusqu’à cinq liens principaux.

## Exemples Complets d'Agent

### Assistant de Recherche

Un agent de recherche polyvalent qui récupère des faits récents avant de répondre :

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

export const character: Character = {
  name: 'ResearchAssistant',
  bio: [
    'Répond aux questions en utilisant des sources web actuelles.',
    'Résume les liens en réponses concises et citées.',
  ],
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  settings: {
    secrets: {
      OLOSTEP_API_KEY: process.env.OLOSTEP_API_KEY!,
    },
  },
};
```

### Moniteur de Nouvelles

Un agent qui suit les sujets d’actualité et rapporte des mises à jour notables :

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

export const character: Character = {
  name: 'NewsMonitor',
  bio: ['Suit les sujets d’actualité et rapporte des mises à jour notables du web.'],
  plugins: [
    '@elizaos/plugin-bootstrap',
    '@elizaos/plugin-openai',
    '@olostep/plugin-elizaos-olostep',
  ],
  style: {
    all: ['Privilégiez les sources actuelles et incluez les URLs directes lorsque possible.'],
  },
};
```

Utilisez cela pour les alertes, les tâches de surveillance du marché, la recherche de tendances et d’autres flux de travail sensibles au temps.

### Agent de Support avec Recherche de Secours

Parfait pour répondre aux questions des clients avec une recherche dans la documentation produit :

```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: [
    'support produit',
    'recherche dans la documentation',
    'recherche de notes de version',
  ],
};
```

Ce modèle fonctionne bien lorsque votre agent doit rechercher dans les documents ou les pages produits avant de répondre à une question client.

## Configuration

### Activer le plugin

Ajoutez `@olostep/plugin-elizaos-olostep` au tableau `plugins` dans la configuration de votre personnage.

### Désactiver la recherche web

Retirez le plugin de la configuration du personnage si vous souhaitez un agent Eliza sans accès à la recherche Olostep.

### Utiliser uniquement certaines capacités

Ce plugin expose une seule action, il n’y a donc pas de bascule par outil. Contrôlez le comportement via :

* Les plugins que vous chargez dans la configuration du personnage
* Les instructions et le style de l’agent
* Quand votre environnement d’exécution injecte `OLOSTEP_API_KEY`

## Fonctionnalités Spécialisées

* **Accès direct à l’endpoint `/searches`** — le plugin appelle directement Olostep avec `fetch`.
* **Déduplication des résultats** — les URLs en double sont supprimées avant que la réponse ne soit retournée.
* **Retours de secours conviviaux** — l’action retourne des erreurs claires lorsque la clé API est manquante ou que la requête est vide.
* **Limitation des résultats principaux** — les réponses sont réduites aux cinq liens les plus pertinents.

## Tarification

La tarification de l’utilisation de la recherche dépend de votre plan Olostep et des paramètres de votre tableau de bord.

* Consultez votre tableau de bord Olostep pour les détails actuels d’utilisation et de facturation.
* Vérifiez les limites de votre compte avant de déployer des agents à fort volume.

## Support

* **Package NPM** : [@olostep/plugin-elizaos-olostep](https://www.npmjs.com/package/@olostep/plugin-elizaos-olostep)
* **Site Web Olostep** : [olostep.com](https://www.olostep.com)
* **Tableau de Bord Olostep** : [dashboard.olostep.com](https://www.olostep.com/dashboard)
* **ElizaOS** : [elizaos.ai](https://elizaos.ai)
* **Support par Email** : [info@olostep.com](mailto:info@olostep.com)

## Ressources Associées

<CardGroup cols={2}>
  <Card title="API de Recherche" icon="magnifying-glass" href="/searches/searches">
    Apprenez comment l’endpoint de recherche retourne des résultats web
  </Card>

  <Card title="API de Lots" icon="layer-group" href="/features/batches/batches">
    Mettez en file d’attente les recherches et autres tâches pour des flux de travail plus larges
  </Card>

  <Card title="API de Réponses" icon="question" href="/features/answers/answers">
    Générez des sorties de type réponse à partir des sources web récupérées
  </Card>

  <Card title="API de Crawls" icon="spider-web" href="/features/crawls/crawls">
    Explorez des collections de sites plus profondes et des flux de travail de crawling
  </Card>

  <Card title="SDK Python" icon="python" href="/sdks/python">
    Utilisez le SDK Python pour une automatisation personnalisée autour d’Olostep
  </Card>

  <Card title="SDK Node.js" icon="code" href="/sdks/node-js">
    Construisez des intégrations JavaScript et des flux de travail d’agent
  </Card>
</CardGroup>