llmjs2 1.7.1 → 2.0.1

package/chain/agent-step-example.js

@@ -1,232 +0,0 @@
-/**
- * AgentStep Example Program
- *
- * This example demonstrates how to use AgentStep in llmjs-chain workflows.
- * It creates a multi-agent workflow for content creation and analysis.
- */
-
-const { Agent, AgentStep, Graph } = require('./index');
-
-async function runAgentStepExample() {
-  console.log('🚀 Starting AgentStep Workflow Example\n');
-
-  // ============================================================================
-  // 1. Create Specialized AI Agents
-  // ============================================================================
-
-  console.log('📝 Creating specialized AI agents...');
-
-  // Content Creator Agent - generates creative content
-  const contentCreator = new Agent({
-    instruction: `You are a creative content writer. Generate engaging, well-structured content based on the given topic.
-    Focus on being informative yet entertaining. Keep responses concise but comprehensive.`,
-    tools: [
-      {
-        name: 'get_word_count',
-        description: 'Count words in a text',
-        parameters: { text: { type: 'string', required: true } },
-        execute: async ({ text }) => `Word count: ${text.split(/\s+/).length}`
-      }
-    ]
-  });
-
-  // Content Analyzer Agent - analyzes and provides feedback
-  const contentAnalyzer = new Agent({
-    instruction: `You are a content quality analyst. Analyze the provided content for:
-    - Engagement and readability
-    - Structure and flow
-    - Key strengths and areas for improvement
-    - SEO considerations
-    Provide specific, actionable feedback.`,
-    tools: [
-      {
-        name: 'analyze_sentiment',
-        description: 'Analyze sentiment of text',
-        parameters: { text: { type: 'string', required: true } },
-        execute: async ({ text }) => {
-          // Simple sentiment analysis simulation
-          const positiveWords = ['good', 'great', 'excellent', 'amazing', 'wonderful'];
-          const negativeWords = ['bad', 'poor', 'terrible', 'awful', 'horrible'];
-
-          const words = text.toLowerCase().split(/\s+/);
-          const positiveCount = words.filter(w => positiveWords.includes(w)).length;
-          const negativeCount = words.filter(w => negativeWords.includes(w)).length;
-
-          if (positiveCount > negativeCount) return 'Positive sentiment';
-          if (negativeCount > positiveCount) return 'Negative sentiment';
-          return 'Neutral sentiment';
-        }
-      }
-    ]
-  });
-
-  // Content Editor Agent - refines and improves content
-  const contentEditor = new Agent({
-    instruction: `You are an expert content editor. Review and improve the provided content based on:
-    - Clarity and conciseness
-    - Grammar and style
-    - Engagement improvements
-    - Call-to-action additions
-    Provide the improved version along with change explanations.`,
-    tools: [
-      {
-        name: 'check_grammar',
-        description: 'Check grammar in text',
-        parameters: { text: { type: 'string', required: true } },
-        execute: async ({ text }) => 'Grammar check completed - no major issues found'
-      }
-    ]
-  });
-
-  // ============================================================================
-  // 2. Create AgentSteps with Input/Output Mapping
-  // ============================================================================
-
-  console.log('🔧 Creating AgentSteps with specialized mappings...');
-
-  // Step 1: Content Creation
-  const createContentStep = new AgentStep({
-    name: 'create-content',
-    agent: contentCreator,
-    inputMapper: (context) => {
-      const topic = context.topic || 'Artificial Intelligence';
-      const audience = context.audience || 'general public';
-      const wordCount = context.targetWordCount || 300;
-
-      return `Create an engaging article about "${topic}" for a ${audience} audience.
-      Target word count: approximately ${wordCount} words.
-      Make it informative, entertaining, and well-structured with a clear introduction, body, and conclusion.`;
-    },
-    outputMapper: (response, context) => ({
-      originalContent: response,
-      createdAt: new Date().toISOString(),
-      topic: context.topic,
-      stage: 'created'
-    })
-  });
-
-  // Step 2: Content Analysis
-  const analyzeContentStep = new AgentStep({
-    name: 'analyze-content',
-    agent: contentAnalyzer,
-    inputMapper: (context) => {
-      const content = context['create-content'].originalContent;
-      return `Please analyze this content for quality, engagement, and improvement opportunities:
-
-${content}
-
-Provide specific feedback on strengths, weaknesses, and suggestions for enhancement.`;
-    },
-    outputMapper: (response, context) => ({
-      analysis: response,
-      analyzedAt: new Date().toISOString(),
-      stage: 'analyzed'
-    })
-  });
-
-  // Step 3: Content Editing
-  const editContentStep = new AgentStep({
-    name: 'edit-content',
-    agent: contentEditor,
-    inputMapper: (context) => {
-      const originalContent = context['create-content'].originalContent;
-      const analysis = context['analyze-content'].analysis;
-
-      return `Please edit and improve this content based on the analysis provided:
-
-ORIGINAL CONTENT:
-${originalContent}
-
-ANALYSIS/FEEDBACK:
-${analysis}
-
-Provide an improved version that addresses the feedback, along with explanations of your changes.`;
-    },
-    outputMapper: (response, context) => ({
-      finalContent: response,
-      editedAt: new Date().toISOString(),
-      stage: 'final'
-    })
-  });
-
-  // ============================================================================
-  // 3. Build and Execute the Multi-Agent Workflow
-  // ============================================================================
-
-  console.log('🏗️  Building multi-agent workflow...');
-
-  const contentWorkflow = new Graph({
-    name: 'content-creation-pipeline'
-  })
-    .step(createContentStep, analyzeContentStep, editContentStep)
-    .edge(createContentStep, analyzeContentStep)
-    .edge(analyzeContentStep, editContentStep)
-    .compile();
-
-  console.log('▶️  Executing content creation workflow...\n');
-
-  // Execute with different topics to show flexibility
-  const topics = [
-    {
-      topic: 'The Future of Renewable Energy',
-      audience: 'tech-savvy professionals',
-      targetWordCount: 400
-    },
-    {
-      topic: 'Healthy Eating Habits',
-      audience: 'busy parents',
-      targetWordCount: 350
-    }
-  ];
-
-  for (let i = 0; i < topics.length; i++) {
-    const topicConfig = topics[i];
-    console.log(`📝 Processing Topic ${i + 1}: "${topicConfig.topic}"`);
-    console.log('═'.repeat(60));
-
-    try {
-      const result = await contentWorkflow.run(topicConfig);
-
-      // Display results
-      console.log('\n📄 ORIGINAL CONTENT:');
-      console.log(result['create-content'].originalContent.substring(0, 200) + '...');
-
-      console.log('\n🔍 ANALYSIS:');
-      console.log(result['analyze-content'].analysis.substring(0, 150) + '...');
-
-      console.log('\n✨ FINAL EDITED CONTENT:');
-      console.log(result['edit-content'].finalContent.substring(0, 200) + '...');
-
-      console.log('\n✅ Workflow completed successfully!');
-      console.log('═'.repeat(60));
-      console.log();
-
-    } catch (error) {
-      console.error(`❌ Error processing topic ${i + 1}:`, error.message);
-    }
-  }
-
-  // ============================================================================
-  // 4. Demonstrate Error Handling
-  // ============================================================================
-
-  console.log('🧪 Testing error handling...');
-
-  try {
-    // This should fail due to missing topic
-    await contentWorkflow.run({});
-  } catch (error) {
-    console.log('✅ Error handling works:', error.message);
-  }
-
-  console.log('\n🎉 AgentStep example completed successfully!');
-  console.log('\n💡 Key Features Demonstrated:');
-  console.log('  • Multiple specialized AI agents in one workflow');
-  console.log('  • Custom input/output mapping for each agent');
-  console.log('  • Sequential processing with context passing');
-  console.log('  • Real-world content creation pipeline');
-  console.log('  • Error handling and validation');
-}
-
-// Run the example
-runAgentStepExample().catch(console.error);

package/chain/docs/AGENT.md

@@ -1,126 +0,0 @@
-# Agent Usage Guide
-
-The Agent class provides AI interactions with tool support and conversation memory.
-
-## Table of Contents
-- [Basic Usage](#basic-agent-usage)
-- [Tool Definition](#tool-definition)
-- [Memory Integration](#memory-integration)
-- [Advanced Configuration](#advanced-agent-configuration)
-
-## Basic Agent Usage
-
-```javascript
-const { Agent } = require('llmjs-chain');
-
-// Create a simple agent
-const agent = new Agent({
-  instruction: 'You are a helpful AI assistant.',
-  model: 'openai/gpt-4' // Optional - auto-detected if not provided
-});
-
-// Generate a response
-async function chat() {
-  const response = await agent.generate('Hello, how are you?');
-  console.log(response);
-}
-
-chat();
-```
-
-## Tool Definition
-
-Agents can use tools to perform actions. Tools can be defined in a simplified format:
-
-```javascript
-const agent = new Agent({
-  instruction: 'You are a helpful assistant with access to tools.',
-  tools: [
-    {
-      name: 'calculate',
-      description: 'Perform mathematical calculations',
-      parameters: {
-        expression: { type: 'string', description: 'Math expression to evaluate', required: true }
-      },
-      execute: async ({ expression }) => {
-        const result = eval(expression);
-        return JSON.stringify({ result, expression });
-      }
-    },
-    {
-      name: 'get_weather',
-      description: 'Get current weather for a location',
-      parameters: {
-        location: { type: 'string', description: 'City name', required: true }
-      },
-      execute: async ({ location }) => {
-        // Implement weather API call
-        return JSON.stringify({ location, temperature: 22, condition: 'sunny' });
-      }
-    }
-  ]
-});
-
-// The agent will automatically use tools when needed
-agent.generate('What is 15 + 27?').then(console.log);
-agent.generate('What is the weather in Tokyo?').then(console.log);
-```
-
-## Memory Integration
-
-Agents can maintain conversation history using the InMemory class:
-
-```javascript
-const { Agent, InMemory } = require('llmjs-chain');
-
-const memory = new InMemory();
-const agent = new Agent({
-  instruction: 'You are a helpful assistant with memory.',
-  memory: memory
-});
-
-// Start a conversation session
-const response1 = await agent.generate({
-  userPrompt: 'My name is Alice.',
-  memory: {
-    resourceId: 'user_alice',
-    threadId: 'conversation_1',
-    session: true // Include session history
-  }
-});
-
-const response2 = await agent.generate({
-  userPrompt: 'What is my name?',
-  memory: {
-    resourceId: 'user_alice',
-    threadId: 'conversation_1',
-    session: true
-  }
-});
-// Agent will remember your name from the previous message
-```
-
-## Advanced Agent Configuration
-
-```javascript
-const agent = new Agent({
-  model: 'ollama/llama2', // Specific model
-  apikey: 'your-api-key', // Override auto-detected API key
-  instruction: `You are an expert software developer.
-                Always provide detailed explanations and code examples.`,
-  tools: [/* tool definitions */],
-  memory: new InMemory()
-});
-
-// Advanced generation with memory options
-const response = await agent.generate({
-  userPrompt: 'Help me debug this JavaScript code...',
-  apikey: 'override-key', // Override API key for this call
-  memory: {
-    resourceId: 'debug_session',
-    threadId: 'js_debug_001',
-    session: true,     // Include conversation history
-    relevance: true    // Also search for relevant past conversations
-  }
-});
-```