Passer au contenu principal

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.

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

Action de Recherche Web

Ajoute l’action OLOSTEP_SEARCH aux agents Eliza pour une recherche web en direct.

Résultats Dédupliqués

Supprime les liens en double et garde les résultats les plus pertinents en haut.

Configuration Simple

Configurez une clé API dans les paramètres de votre agent Eliza et commencez à rechercher.

Déclencheurs en Langage Naturel

Fonctionne lorsque les utilisateurs demandent à l’agent de rechercher sur le web, de chercher quelque chose ou de trouver des sources en ligne.

Résultats Structurés

Retourne des titres, descriptions et URLs faciles à résumer ou à citer pour les agents.

Pas de SDK Requis

Appelle directement Olostep via l’endpoint /searches avec fetch standard.

Installation

npm install @olostep/plugin-elizaos-olostep
Ce package est publié sur npm sous le nom @olostep/plugin-elizaos-olostep.

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.
{
  "name": "MyAgent",
  "settings": {
    "secrets": {
      "OLOSTEP_API_KEY": "votre-clé-api-olostep-ici"
    }
  }
}
import type { Character } from '@elizaos/core';

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

Outils Disponibles

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.
OLOSTEP_API_KEY
string
requis
La clé API Olostep stockée dans les secrets d’exécution de l’agent.
message.content.text
string
requis
La requête de recherche. Eliza utilise le texte du message utilisateur entrant comme requête.
// 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'],
};
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 :
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 :
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 :
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

Ressources Associées

API de Recherche

Apprenez comment l’endpoint de recherche retourne des résultats web

API de Lots

Mettez en file d’attente les recherches et autres tâches pour des flux de travail plus larges

API de Réponses

Générez des sorties de type réponse à partir des sources web récupérées

API de Crawls

Explorez des collections de sites plus profondes et des flux de travail de crawling

SDK Python

Utilisez le SDK Python pour une automatisation personnalisée autour d’Olostep

SDK Node.js

Construisez des intégrations JavaScript et des flux de travail d’agent