agentic-api 1.0.1 → 1.0.3

package/README.md

@@ -1,58 +1,41 @@
 # @agentic-api
 
-API pour l'orchestration d'agents intelligents avec séquences et escalades automatiques.
-> **Note personnelle** :  
-Ce projet n'a pas l'intention d'être meilleur que Vercel ou LangChain. Il est simplement moins générique, et optimisé pour un petit nombre de problèmes.
-Il se concentre sur des fonctionnalités spécifiques qui impliquait trop de dépendances avec les autres frameworks. 
-
-## 🚀 Fonctionnalités clés
-- Orchestration d'agents en séquences selon un graphe prédéfini
-- Escalade automatique vers des modèles plus performants
-- Transfert intelligent entre agents spécialisés avec seuil de confiance
-- Gestion de la mémoire (session et long terme)
-- Extraction de texte depuis les PDFs
-- Outil de réflexion (thinking) pour le raisonnement complexe
-- Feedback en temps réel sur l'état des agents
-
-### Avantages clés de @agentic-api
-1. **Simplicité d'utilisation**
-   - Configuration minimale requise
-   - Un minimum de dépendances
-
-2. **Performance**
-   - Optimisé pour les applications en production
-   - Gestion efficace de la mémoire
-   - Transferts d'agents rapides et (relativement) fiables
-
-3. **Flexibilité**
-   - Support principalement d'OpenAI
-   - Système extensible
-   - Personnalisation facile des agents 
-
-
-### Cas d'utilisation recommandés
-- Applications nécessitant une orchestration d'agents spécialisés
-- Projets nécessitant une extraction de contenu fiable
+Super simple API for intelligent agent orchestration with automatic sequences and escalations. (inspiré du projet [OpenAI Swarm](https://github.com/openai/openai-realtime-agents))
 
-## 📦 Installation
+> **Personal Note**:  
+> This project is not meant to be better than Vercel or LangChain. It's simply less generic and optimized for a specific set of problems.
+> It focuses on specific features that required too many dependencies with other frameworks.
+
+
+## 🚀 Key Features
+
+- Agent orchestration in predefined sequences
+- Automatic model escalation to more intelligent instructions and models. 
+- Smart transfer between specialized agents with confidence threshold
+- Prompting models to follow a state machine, for example to accurately collect things like names and phone numbers.
 
-```bash
-npm install @agentic-api
-```
 
-## 🔧 Configuration requise
+### Key Advantages
 
-### Dépendance Python pour l'extraction PDF
+1. **Simplicity**
+   - Minimal configuration
+   - Few dependencies
+   - Fast
+
+### Recommended Use Cases
+
+- Applications requiring specialized agent orchestration
+- Projects needing reliable content extraction
+
+[![](https://mermaid.ink/img/pako:eNpVkd1OwjAUx1-lOYmJJkDYhxvswoRB0AtvdCQmbsTU7bAt2dqltCogz2K89uV8BMs-AM9F199__3N6TruDmCcIHqwK_h5nVEiymEWM6Aikpsuw_iyvGm0S3gpEiWLZ8OwyjOD36-eb3KmSsgg6Y7Ou1WsqaJWRAMVbHuPLJEUm1yRsmTTcFjtEkguMZc4ZuX88qb4RBrTAc6NvhlO1lrxEQQJVVVw3efbXCh8Ul8cMZEnEmu00fFrMlx3V05F-_4ZM2glr8I1_ZP4jq0u-uCBzLmLdAS3ylGGphyEZF_mWM0mLxuQbpD84K-KbLVstWw3Puqptwuec5oUS-EmmbeOH00_q0Q890JdQ0jzRz7g7aBHITDcTgae3Ca6oKmQEEdtrK1WSBxsWgyeFwh4IrtIMvBUt1ppUlVCJs5zqZyuPakXZM-dll5KKw1Ftur5ZFFOumATPdN3aDN4OPsC7HpkDwzRcczw0DEtHDzbgucPBtWPajuXYY9twbGffg21dfTgYufb4PPZ_wB3E1Q?type=png)](https://mermaid.live/edit#pako:eNpVkd1OwjAUx1-lOYmJJkDYhxvswoRB0AtvdCQmbsTU7bAt2dqltCogz2K89uV8BMs-AM9F199__3N6TruDmCcIHqwK_h5nVEiymEWM6Aikpsuw_iyvGm0S3gpEiWLZ8OwyjOD36-eb3KmSsgg6Y7Ou1WsqaJWRAMVbHuPLJEUm1yRsmTTcFjtEkguMZc4ZuX88qb4RBrTAc6NvhlO1lrxEQQJVVVw3efbXCh8Ul8cMZEnEmu00fFrMlx3V05F-_4ZM2glr8I1_ZP4jq0u-uCBzLmLdAS3ylGGphyEZF_mWM0mLxuQbpD84K-KbLVstWw3Puqptwuec5oUS-EmmbeOH00_q0Q890JdQ0jzRz7g7aBHITDcTgae3Ca6oKmQEEdtrK1WSBxsWgyeFwh4IrtIMvBUt1ppUlVCJs5zqZyuPakXZM-dll5KKw1Ftur5ZFFOumATPdN3aDN4OPsC7HpkDwzRcczw0DEtHDzbgucPBtWPajuXYY9twbGffg21dfTgYufb4PPZ_wB3E1Q)
+
+## 📦 Installation
 
 ```bash
-# Installation de l'environnement Python
-sudo apt install python3.*-venv
-python3 -m venv .venv
-source .venv/bin/activate
-pip install -r bin/requirements.txt
+npm install @agentic-api
 ```
 
-## 💡 Utilisation rapide
+## 💡 Quick Start
 
 ```typescript
 import OpenAI from "openai";
@@ -64,7 +47,7 @@ const openai = new OpenAI({
   apiKey: process.env.OPENAI_API_KEY,
 });
 
-// Création du contexte de session
+// Create session context
 const session: AgenticContext = {
   memory: {
     messages: [],
@@ -73,64 +56,64 @@ const session: AgenticContext = {
     usage: { prompt: 0, completion: 0, total: 0, cost: 0 }
   },
   user: {
-    id: "default_user"
+    id: user.id
   }
 };
 
-// Exécution de l'agent avec enrichissement de la mémoire
+// Execute agent with memory enrichment
 const stream = await executeAgentSet(agents, session, {
-  query: "Bonjour que puis-je faire avec vous?",
+  query: "Hello, what can you do?",
   initialAgent: "greeter",
   verbose: true,
   enrichWithMemory: async (role) => {
-    // Logique d'enrichissement de la mémoire
+    // Memory enrichment logic
     return "";
   }
 });
 ```
 
-## 🤖 Création d'agents personnalisés
+## 🤖 Custom Agent Creation
 
 ```typescript
 import { AgentConfig } from '@agentic-api/types';
 import { modelConfig } from '@agentic-api/execute';
 
-// Exemple d'agent spécialisé avec outil de réflexion
+// Example specialized agent with thinking tool
 const haiku: AgentConfig = {
   name: "haiku",
-  publicDescription: "Agent qui écrit des haïkus.",
-  instructions: "Demande à l'utilisateur un sujet, puis réponds avec un haïku.",
+  publicDescription: "Agent that writes haikus.",
+  instructions: "Ask the user for a subject, then respond with a haiku.",
   model: modelConfig("LOW"),
   tools: [],
-  maxSteps: 3 // Limite le nombre d'étapes de réflexion
+  maxSteps: 3 // Limit thinking steps
 };
 
-// Agent d'accueil avec transfert
+// Welcome agent with transfer
 const welcome: AgentConfig = {
   name: "welcome",
-  publicDescription: "Agent qui accueille l'utilisateur.",
-  instructions: "Accueille l'utilisateur et propose des options.",
+  publicDescription: "Agent that welcomes users.",
+  instructions: "Welcome the user and suggest options.",
   model: modelConfig("LOW"),
   tools: [],
   downstreamAgents: [haiku]
 };
 
-// Injection des outils de transfert et de réflexion
+// Inject transfer and thinking tools
 import { injectTransferTools } from '@agentic-api/utils';
 const myAgents = injectTransferTools([welcome, haiku]);
 ```
 
-## 🧠 Gestion de la mémoire
+## 🧠 Memory Management
 
 ```typescript
 import { MemoriesLite } from '@memories-lite';
 
 const memory = new MemoriesLite({
-  // Configuration de la mémoire
+  // Memory configuration
 });
 
 async function chatWithMemories(message: string, userId = "default_user") {
-  // Recherche sémantique dans les mémoires
+  // Semantic memory search
   const relevantMemories = await memory.retrieve(message, userId, {
     limit: 5,
     filters: { type: "conversation" }
@@ -145,39 +128,39 @@ ${relevantMemories.results.map(entry => `- ${entry.memory}`).join("\n")}`;
     { role: "user", content: message },
   ];
 
-  // Capture de la nouvelle conversation
+  // Capture new conversation
   await memory.capture(messages, userId, {
     metadata: { type: "conversation" }
   });
 }
 ```
 
-## ⚙️ Niveaux de modèles
+## ⚙️ Model Levels
 
-- **LOW**: gpt-4.1-nano (tâches simples)
-- **MEDIUM**: gpt-4.1-mini (équilibre performance/coût)
-- **HIGH**: gpt-4.1 (raisonnement avancé)
-- **SEARCH**: gpt-4o-mini-search-preview (recherches web avec localisation)
+- **LOW**: gpt-4.1-nano (simple tasks)
+- **MEDIUM**: gpt-4.1-mini (balanced performance/cost)
+- **HIGH**: gpt-4.1 (advanced reasoning)
+- **SEARCH**: gpt-4o-mini-search-preview (web search with localization)
 
-## 🔄 Transfert entre agents
+## 🔄 Agent Transfer
 
-Le transfert entre agents est géré automatiquement avec :
-- Seuil de confiance (0.7) pour le transfert
-- Justification du transfert
-- Conservation du contexte de conversation
-- Mise à jour automatique des instructions système
+Agent transfer is automatically managed with:
+- Confidence threshold (0.7) for transfer
+- Transfer justification
+- Conversation context preservation
+- Automatic system instruction updates
 
-## 🧪 Tests
+## 🧪 Testing
 
 ```bash
 npm test
 ```
 
-## 📄 Licence
+## 📄 License
 
 MIT License
 
-Copyright (c) 2024 Olivier Evalet
+Copyright (c) 2024 Pilet-Renaud SA
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agentic-api",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "API pour l'orchestration d'agents intelligents avec séquences et escalades automatiques",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",