@falai/agent 1.2.8 → 2.0.0

package/docs/core/conversation-flows/routes.md

@@ -1,249 +0,0 @@
-# Routes
-
-Routes define conversational journeys in @falai/agent with agent-level data collection. This document covers route definition with required fields, lifecycle management, and completion handling based on data availability.
-
-## Overview
-
-Routes represent complete conversational workflows that guide users through specific tasks or processes. Each route specifies required fields for completion, consists of steps that collect data into the agent-level schema, and can complete when their data requirements are satisfied regardless of which route collected the data.
-
-## Route Definition with Required Fields
-
-```typescript
-// Agent defines comprehensive schema
-interface HotelData {
-  destination: string;
-  checkIn: string;
-  checkOut: string;
-  guests: number;
-  roomType?: string;
-  customerName?: string;
-  email?: string;
-  phone?: string;
-  specialRequests?: string;
-}
-
-const agent = new Agent<{}, HotelData>({
-  name: "Hotel Booking Agent",
-  schema: {
-    type: "object",
-    properties: {
-      destination: { type: "string" },
-      checkIn: { type: "string", format: "date" },
-      checkOut: { type: "string", format: "date" },
-      guests: { type: "number", minimum: 1 },
-      roomType: { type: "string" },
-      customerName: { type: "string" },
-      email: { type: "string", format: "email" },
-      phone: { type: "string" },
-      specialRequests: { type: "string" }
-    }
-  }
-});
-
-// Routes specify required fields instead of schemas
-const bookingRoute = agent.createRoute({
-  title: "Hotel Booking",
-  description: "Help users book hotel accommodations",
-  when: ["User wants to book a hotel"],
-  requiredFields: ["destination", "checkIn", "checkOut", "guests", "customerName", "email"],
-  optionalFields: ["roomType", "phone", "specialRequests"]
-});
-
-const customerServiceRoute = agent.createRoute({
-  title: "Customer Service",
-  description: "Help with booking issues",
-  when: ["User needs help with existing booking"],
-  requiredFields: ["customerName", "email"], // Minimal requirements
-  optionalFields: ["phone", "destination"]
-});
-```
-
-## Route Lifecycle
-
-Routes have a complete lifecycle from creation through execution to completion based on data availability.
-
-### Route Creation
-
-Routes are created using the agent's `createRoute()` method with required fields specifications that reference the agent-level schema.
-
-### Route Execution
-
-Routes are selected by the AI routing system based on user intent and conversation context, with access to all agent-level data.
-
-**Session resume**: If a session already has a `currentRoute` set and the conversation starts with no user messages (system-only or empty history), the pre-set route is honored without AI routing. This supports persistence-based resume and programmatic session placement. See [Session Management](../agent/session-management.md#session-resume-pre-set-route-and-step) for details.
-
-### Route Completion
-
-Routes complete when all their required fields are present in the agent's collected data, regardless of which route collected the data. This enables flexible cross-route completion scenarios.
-
-### Basic Route Completion
-
-```typescript
-// Route completion evaluation
-const isComplete = bookingRoute.isComplete(agent.getCollectedData());
-const missingFields = bookingRoute.getMissingRequiredFields(agent.getCollectedData());
-const progress = bookingRoute.getCompletionProgress(agent.getCollectedData()); // 0-1
-
-console.log(`Booking route is ${Math.round(progress * 100)}% complete`);
-if (missingFields.length > 0) {
-  console.log(`Still need: ${missingFields.join(', ')}`);
-}
-```
-
-### Route Completion with Error Handling
-
-Proper error handling ensures accurate route completion detection:
-
-```typescript
-const checkRouteCompletion = async (route: Route, agent: Agent) => {
-  try {
-    const collectedData = agent.getCollectedData();
-    
-    // Check data-based completion
-    if (route.isComplete(collectedData)) {
-      return { complete: true, reason: "all_required_data_collected" };
-    }
-    
-    // Check step-based completion (for routes with skipIf conditions)
-    const allStepsProcessed = route.steps.every(step => {
-      if (step.skipIf && step.skipIf(collectedData)) {
-        return true; // Step is skipped, counts as processed
-      }
-      return step.isCompleted;
-    });
-    
-    if (allStepsProcessed) {
-      return { complete: true, reason: "all_steps_processed" };
-    }
-    
-    // Check for explicit route termination
-    if (route.hasExplicitEnd()) {
-      return { complete: true, reason: "explicit_end_route" };
-    }
-    
-    return { 
-      complete: false, 
-      missingFields: route.getMissingRequiredFields(collectedData),
-      progress: route.getCompletionProgress(collectedData)
-    };
-  } catch (error) {
-    console.error("Route completion check failed:", error);
-    return { 
-      complete: false, 
-      error: error.message,
-      fallback: true 
-    };
-  }
-};
-
-// Usage with error handling
-const completionResult = await checkRouteCompletion(bookingRoute, agent);
-
-if (completionResult.error) {
-  console.warn("Completion check failed, assuming incomplete:", completionResult.error);
-} else if (completionResult.complete) {
-  console.log(`Route completed: ${completionResult.reason}`);
-} else {
-  console.log(`Route ${Math.round(completionResult.progress * 100)}% complete`);
-  console.log(`Missing: ${completionResult.missingFields.join(', ')}`);
-}
-```
-
-### Handling Routes with Conditional Steps
-
-Routes with `skipIf` conditions require special completion logic:
-
-```typescript
-const conditionalRoute = agent.createRoute({
-  title: "Conditional Booking",
-  requiredFields: ["destination", "dates", "passengers"]
-});
-
-const askDestination = conditionalRoute.initialStep.nextStep({
-  prompt: "Where would you like to go?",
-  collect: ["destination"],
-  skipIf: (data) => !!data.destination, // Skip if already collected
-});
-
-const askDates = askDestination.nextStep({
-  prompt: "When would you like to travel?",
-  collect: ["dates"],
-  skipIf: (data) => !!data.dates,
-});
-
-const confirmBooking = askDates.nextStep({
-  prompt: "Confirm your booking details",
-  requires: ["destination", "dates", "passengers"],
-  onComplete: () => ({ endRoute: true }) // Explicit route termination
-});
-
-// Completion detection handles skipped steps
-const response = await agent.respond({
-  message: "I want to go to Paris on March 15th for 2 passengers",
-  sessionId: "user-123"
-});
-
-// All steps may be skipped due to complete data extraction
-// Route should still be marked as complete
-console.log("Route complete:", response.isRouteComplete); // Should be true
-```
-
-### Error Recovery in Route Completion
-
-```typescript
-const safeRouteCompletion = async (route: Route, agent: Agent) => {
-  const maxRetries = 3;
-  let attempt = 0;
-  
-  while (attempt < maxRetries) {
-    try {
-      return await checkRouteCompletion(route, agent);
-    } catch (error) {
-      attempt++;
-      console.warn(`Route completion check attempt ${attempt} failed:`, error.message);
-      
-      if (attempt >= maxRetries) {
-        // Final fallback - assume incomplete
-        return {
-          complete: false,
-          error: `Completion check failed after ${maxRetries} attempts: ${error.message}`,
-          fallback: true
-        };
-      }
-      
-      // Brief delay before retry
-      await new Promise(resolve => setTimeout(resolve, 100 * attempt));
-    }
-  }
-};
-```
-
-## Route Transitions
-
-Routes can automatically transition to other routes upon completion using the `onComplete` configuration. With agent-level data, the target route may already have some of its required data.
-
-```typescript
-const bookingRoute = agent.createRoute({
-  title: "Hotel Booking",
-  requiredFields: ["destination", "checkIn", "checkOut", "guests", "customerName", "email"],
-  onComplete: "Feedback Collection", // Transition to feedback route
-});
-
-const feedbackRoute = agent.createRoute({
-  title: "Feedback Collection",
-  requiredFields: ["customerName", "email", "rating"], // Already has name and email from booking
-  optionalFields: ["comments"]
-});
-
-// When booking completes, feedback route is already 2/3 complete
-```
-
-## Best Practices
-
-- Use descriptive titles and conditions for better AI routing
-- Define comprehensive agent-level schemas for type safety across all routes
-- Specify minimal required fields for faster route completion
-- Use optional fields to enhance user experience without blocking completion
-- Implement appropriate completion handlers that leverage shared data
-- Consider route transitions for multi-step workflows with data continuity
-- Design routes that can benefit from cross-route data sharing