@falai/agent 0.9.2 → 1.0.1

package/docs/core/ai-integration/prompt-composition.md

@@ -218,3 +218,138 @@ Prompts are optimized for token efficiency:
 - Leverage route-specific overrides for specialized behavior
 - Monitor token usage and optimize prompt length
 - Test prompts with different AI providers for consistency
+
+## BatchPromptBuilder for Multi-Step Execution
+
+When multiple steps execute in a single batch, the `BatchPromptBuilder` combines their prompts into a single coherent prompt.
+
+### Combined Prompt Structure
+
+```
+[Agent Identity & Personality]
+[Route Context]
+
+## Current Conversation Flow
+
+You are handling multiple aspects of this conversation in a single response.
+
+### Step 1: [Step Description]
+[Step Prompt]
+
+### Step 2: [Step Description]  
+[Step Prompt]
+
+[... additional steps ...]
+
+## Data Collection
+
+Extract the following information from your response:
+- field1 (type): description
+- field2 (type): description
+
+## Response Format
+
+Return JSON with:
+- message: Your response to the user
+- [collected fields as top-level properties]
+```
+
+### How Prompts Are Merged
+
+The `BatchPromptBuilder` preserves each step's intent while creating a unified prompt:
+
+```typescript
+// Individual step prompts
+const step1 = { prompt: "What's your name?", collect: ["name"] };
+const step2 = { prompt: "What's your email?", collect: ["email"] };
+const step3 = { prompt: "How can I help?", collect: ["request"] };
+
+// Combined prompt includes all three
+const result = await batchPromptBuilder.buildBatchPrompt({
+  steps: [step1, step2, step3],
+  route,
+  history,
+  context,
+  session,
+  agentOptions,
+});
+
+// result.prompt contains unified prompt
+// result.collectFields = ["name", "email", "request"]
+// result.stepCount = 3
+```
+
+### Collect Fields Aggregation
+
+All `collect` fields from all steps are combined and deduplicated:
+
+```typescript
+// Steps with overlapping collect fields
+const steps = [
+  { collect: ["name", "email"] },
+  { collect: ["email", "phone"] },  // email appears twice
+  { collect: ["preferences"] }
+];
+
+// Combined collect fields (deduplicated)
+// ["name", "email", "phone", "preferences"]
+```
+
+### Schema-Aware Field Descriptions
+
+When the agent has a schema, field descriptions are included in the prompt:
+
+```typescript
+// Agent schema
+const schema = {
+  properties: {
+    email: { type: "string", format: "email", description: "User's email address" },
+    guests: { type: "number", minimum: 1, description: "Number of guests" }
+  }
+};
+
+// Generated data collection section:
+// ## Data Collection
+// Extract the following information from your response:
+// - email (string): User's email address
+// - guests (number): Number of guests
+```
+
+### Single vs Multi-Step Prompts
+
+The prompt structure adapts based on batch size:
+
+```typescript
+// Single step batch
+// ## Current Step
+// [Step prompt]
+
+// Multi-step batch
+// ## Current Conversation Flow
+// You are handling multiple aspects of this conversation in a single response.
+// ### Step 1: ...
+// ### Step 2: ...
+```
+
+### Using BatchPromptBuilder
+
+```typescript
+import { BatchPromptBuilder } from "@falai/agent";
+
+const builder = new BatchPromptBuilder<MyContext, MyData>();
+
+const result = await builder.buildBatchPrompt({
+  steps: batchResult.steps,
+  route: currentRoute,
+  history: conversationHistory,
+  context: agentContext,
+  session: currentSession,
+  agentOptions: agent.getAgentOptions(),
+});
+
+// Use result.prompt for LLM call
+const llmResponse = await provider.generateMessage({
+  prompt: result.prompt,
+  // ...
+});
+```

package/docs/core/ai-integration/response-processing.md

@@ -277,6 +277,150 @@ Built-in monitoring capabilities:
 - **Debug logging** - Detailed processing traces
 - **Performance profiling** - Identify bottlenecks
 
+## Batch Execution Response Fields
+
+When using multi-step execution, the `AgentResponse` includes additional fields for batch execution information.
+
+### New AgentResponse Fields
+
+```typescript
+interface AgentResponse<TData = unknown> {
+  /** The generated message */
+  message: string;
+  /** Updated session state */
+  session?: SessionState<TData>;
+  /** Tool calls made during response */
+  toolCalls?: Array<{ toolName: string; arguments: Record<string, unknown> }>;
+  /** Whether the route is complete */
+  isRouteComplete?: boolean;
+  
+  // Multi-step execution fields
+  /** Steps executed in this response */
+  executedSteps?: StepRef[];
+  /** Why execution stopped */
+  stoppedReason?: StoppedReason;
+}
+```
+
+### executedSteps Array
+
+Lists all steps that were executed in the batch:
+
+```typescript
+const response = await agent.respond("Book Grand Hotel for 2 on Friday");
+
+console.log(response.executedSteps);
+// [
+//   { id: "ask-hotel", routeId: "booking" },
+//   { id: "ask-guests", routeId: "booking" },
+//   { id: "ask-date", routeId: "booking" }
+// ]
+```
+
+Each `StepRef` contains:
+- `id` - The step identifier
+- `routeId` - The route this step belongs to
+
+### stoppedReason Field
+
+Indicates why batch execution stopped:
+
+```typescript
+type StoppedReason =
+  | 'needs_input'      // Step requires uncollected data
+  | 'end_route'        // Reached END_ROUTE
+  | 'route_complete'   // All Steps processed
+  | 'prepare_error'    // Error in prepare hook
+  | 'llm_error'        // Error during LLM call
+  | 'validation_error' // Error validating collected data
+  | 'finalize_error';  // Error in finalize hook (non-fatal)
+```
+
+### BatchExecutionResult Structure
+
+The internal batch execution result provides detailed information:
+
+```typescript
+interface BatchExecutionResult<TData = unknown> {
+  /** The generated message */
+  message: string;
+  /** Updated session state */
+  session: SessionState<TData>;
+  /** Steps that were executed */
+  executedSteps: StepRef[];
+  /** Why execution stopped */
+  stoppedReason: StoppedReason;
+  /** Collected data from the batch */
+  collectedData?: Partial<TData>;
+  /** Any errors that occurred */
+  error?: BatchExecutionError;
+}
+```
+
+### Error Information
+
+When errors occur, detailed information is available:
+
+```typescript
+interface BatchExecutionError {
+  /** Type of error that occurred */
+  type: 'pre_extraction' | 'skipif_evaluation' | 'prepare_hook' | 
+        'llm_call' | 'data_validation' | 'finalize_hook';
+  /** Error message */
+  message: string;
+  /** Step where error occurred (if applicable) */
+  stepId?: string;
+  /** Additional error details */
+  details?: unknown;
+}
+```
+
+### Using Response Fields
+
+```typescript
+const response = await agent.respond("Complete my booking");
+
+// Check what was executed
+console.log(`Executed ${response.executedSteps?.length || 0} steps`);
+
+// Check why execution stopped
+switch (response.stoppedReason) {
+  case 'needs_input':
+    console.log("Waiting for more information from user");
+    break;
+  case 'route_complete':
+  case 'end_route':
+    console.log("Route finished successfully");
+    break;
+  case 'validation_error':
+    console.log("Data validation issues:", response.error);
+    break;
+  default:
+    console.log("Stopped due to:", response.stoppedReason);
+}
+
+// Check route completion
+if (response.isRouteComplete) {
+  console.log("All required data collected");
+}
+```
+
+### Session State After Batch
+
+The session state reflects the final step position:
+
+```typescript
+const response = await agent.respond("Book for 2 guests");
+
+// Session shows current position
+console.log(response.session?.currentStep);
+// { id: "ask-date", routeId: "booking" }
+
+// Session data includes all collected values
+console.log(response.session?.data);
+// { hotel: "Grand Hotel", guests: 2 }
+```
+
 ## Best Practices
 
 - Design schemas for reliable AI extraction
@@ -285,3 +429,5 @@ Built-in monitoring capabilities:
 - Use streaming for better user experience
 - Leverage tool results for context enrichment
 - Validate data at multiple levels (schema + business rules)
+- Check `executedSteps` to understand batch behavior
+- Handle different `stoppedReason` values appropriately

package/docs/core/conversation-flows/data-collection.md

@@ -13,6 +13,149 @@ The agent-level data collection system provides:
 - **Natural Conversations**: AI handles information gathering conversationally
 - **Validation & Enrichment**: Agent-level lifecycle hooks for data processing
 - **Session Persistence**: Data survives across conversation turns and route transitions
+- **Batch Data Collection**: Multiple steps can collect data in a single LLM call
+
+## Data Collection Across Batched Steps
+
+When multiple steps execute in a single batch, data collection works across all steps simultaneously.
+
+### How Batch Data Collection Works
+
+1. **Gather collect fields** - All `collect` fields from all steps in the batch are combined
+2. **Single LLM call** - The combined prompt instructs the LLM to extract all fields
+3. **Extract from response** - All specified fields are extracted from the LLM response
+4. **Validate against schema** - Collected data is validated against the agent schema
+5. **Update session** - All collected values are merged into session data
+
+```typescript
+// Batch with 3 steps, each collecting different fields
+const batch = [
+  { collect: ["name"] },
+  { collect: ["email", "phone"] },
+  { collect: ["preferences"] }
+];
+
+// Combined collection: ["name", "email", "phone", "preferences"]
+// Single LLM response extracts all fields at once
+```
+
+### Pre-Extraction and Batch Determination
+
+Pre-extraction happens **before** batch determination and directly impacts which steps can be batched:
+
+```typescript
+// User message: "I'm John, email john@example.com, I prefer dark mode"
+
+// Phase 1: Pre-extraction
+const preExtracted = {
+  name: "John",
+  email: "john@example.com",
+  preferences: { theme: "dark" }
+};
+
+// Phase 2: Batch determination (with pre-extracted data merged)
+// Step 1: collect: ["name"] → name exists → doesn't need input
+// Step 2: collect: ["email"] → email exists → doesn't need input
+// Step 3: collect: ["preferences"] → preferences exists → doesn't need input
+// Result: All 3 steps batched together
+```
+
+### Pre-Extraction Configuration
+
+Pre-extraction is automatic when routes define data fields:
+
+```typescript
+// Option 1: Route-level required fields
+agent.createRoute({
+  title: "Booking",
+  requiredFields: ["hotel", "date", "guests"],
+  // Pre-extraction enabled automatically
+});
+
+// Option 2: Route-level optional fields
+agent.createRoute({
+  title: "Booking",
+  optionalFields: ["specialRequests"],
+  // Pre-extraction enabled automatically
+});
+
+// Option 3: Steps with collect arrays
+agent.createRoute({
+  title: "Booking",
+  steps: [
+    { collect: ["hotel"] },  // Pre-extraction enabled automatically
+  ]
+});
+```
+
+### Batch Collection Example
+
+```typescript
+const response = await agent.respond(
+  "I'm Alice, alice@example.com, and I want to book for 2 guests"
+);
+
+// Response includes all collected data
+console.log(response.session.data);
+// {
+//   name: "Alice",
+//   email: "alice@example.com",
+//   guests: 2
+// }
+
+// Shows which steps executed
+console.log(response.executedSteps);
+// [
+//   { id: "ask-name", routeId: "booking" },
+//   { id: "ask-email", routeId: "booking" },
+//   { id: "ask-guests", routeId: "booking" }
+// ]
+```
+
+### Validation Across Batch
+
+Data validation happens after collection for all fields:
+
+```typescript
+// Agent schema defines validation rules
+const agent = new Agent({
+  schema: {
+    type: "object",
+    properties: {
+      email: { type: "string", format: "email" },
+      guests: { type: "number", minimum: 1, maximum: 10 }
+    }
+  }
+});
+
+// If validation fails for any field:
+const response = await agent.respond("Book for 100 guests");
+
+// Response includes validation errors
+if (response.stoppedReason === 'validation_error') {
+  console.log(response.error);
+  // {
+  //   type: 'data_validation',
+  //   message: 'Validation failed for 1 field(s): guests',
+  //   details: [{ field: 'guests', message: 'Value exceeds maximum of 10' }]
+  // }
+}
+```
+
+### Partial Data Preservation
+
+Even when validation fails, valid partial data is preserved:
+
+```typescript
+// User provides valid name but invalid email
+const response = await agent.respond("I'm John, email: not-an-email");
+
+// Valid data is still collected
+console.log(response.session.data.name); // "John"
+
+// Invalid data triggers validation error
+console.log(response.stoppedReason); // "validation_error"
+```
 
 ## Agent-Level Schema Definition
 

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

@@ -44,7 +44,7 @@ const agent = new Agent<{}, HotelData>({
 const bookingRoute = agent.createRoute({
   title: "Hotel Booking",
   description: "Help users book hotel accommodations",
-  conditions: ["User wants to book a hotel"],
+  when: ["User wants to book a hotel"],
   requiredFields: ["destination", "checkIn", "checkOut", "guests", "customerName", "email"],
   optionalFields: ["roomType", "phone", "specialRequests"]
 });
@@ -52,7 +52,7 @@ const bookingRoute = agent.createRoute({
 const customerServiceRoute = agent.createRoute({
   title: "Customer Service",
   description: "Help with booking issues",
-  conditions: ["User needs help with existing booking"],
+  when: ["User needs help with existing booking"],
   requiredFields: ["customerName", "email"], // Minimal requirements
   optionalFields: ["phone", "destination"]
 });

package/docs/core/conversation-flows/step-transitions.md

@@ -12,6 +12,138 @@ Step transitions handle:
 - **Route Completion**: Detect when routes reach their end
 - **Loop Prevention**: Avoid infinite traversal in complex flows
 
+## Stopping Conditions in Batch Execution
+
+When executing multiple steps in a batch, the engine stops for specific reasons indicated by the `stoppedReason` field in the response.
+
+### StoppedReason Values
+
+| Reason | Description | Behavior |
+|--------|-------------|----------|
+| `needs_input` | Step requires data not yet available | Batch stops, LLM generates response to collect data |
+| `end_route` | Reached END_ROUTE marker | Route is complete, no more steps to execute |
+| `route_complete` | All steps in route processed | Route finished successfully |
+| `prepare_error` | Error in prepare hook | Batch stops, error returned with last successful state |
+| `llm_error` | Error during LLM call | Batch stops, session state preserved |
+| `validation_error` | Data validation failed | Batch continues, errors included in response |
+| `finalize_error` | Error in finalize hook | Non-fatal, logged and execution continues |
+
+### Needs-Input Stopping
+
+The most common stopping condition. A step needs input when:
+
+```typescript
+// Step needs input if requires fields are missing
+const step1 = {
+  prompt: "Confirm your booking",
+  requires: ["hotel", "date"], // Both must be present
+};
+
+// Step needs input if collecting and no collect fields have data
+const step2 = {
+  prompt: "What's your preference?",
+  collect: ["preference", "notes"], // Needs input if BOTH are missing
+};
+```
+
+### End-Route Stopping
+
+Batch stops when reaching the END_ROUTE marker:
+
+```typescript
+const finalStep = confirmStep.nextStep({
+  prompt: "Booking confirmed! Anything else?",
+}).endRoute(); // Creates END_ROUTE transition
+
+// Response will have:
+// stoppedReason: "end_route"
+// isRouteComplete: true
+```
+
+### Route-Complete Stopping
+
+When all steps have been processed without hitting END_ROUTE:
+
+```typescript
+// If the last step has no transitions and doesn't need input
+const response = await agent.respond("Complete my booking");
+
+// Response will have:
+// stoppedReason: "route_complete"
+// isRouteComplete: true
+```
+
+### Transitions Within Batched Execution
+
+During batch execution, transitions work as follows:
+
+1. **Linear transitions** - Steps connected via `nextStep()` are evaluated sequentially
+2. **SkipIf evaluation** - Each step's `skipIf` is checked before inclusion
+3. **Needs-input check** - If a step needs input, batch stops there
+4. **END_ROUTE detection** - Batch stops when reaching route end
+
+```typescript
+// Example: Steps A → B → C → END_ROUTE
+// If user provides data for A and B but not C:
+
+const response = await agent.respond("Data for A and B");
+
+// Batch includes: [A, B]
+// Stops at: C (needs_input)
+// Next call will continue from C
+```
+
+### Error Stopping Conditions
+
+Errors during batch execution have different behaviors:
+
+```typescript
+// Prepare hook error - stops immediately
+const stepWithPrepare = {
+  prompt: "Processing...",
+  prepare: async (context, data) => {
+    if (!data.valid) throw new Error("Invalid data");
+  },
+};
+// stoppedReason: "prepare_error"
+// Session state: last successful state preserved
+
+// LLM error - stops with preserved state
+// stoppedReason: "llm_error"
+// Session state: preserved from before LLM call
+
+// Validation error - continues but reports error
+// stoppedReason: "validation_error"
+// Collected data: partial data preserved
+
+// Finalize hook error - logged, continues
+// stoppedReason: original reason (not changed)
+// Error: included in response for logging
+```
+
+### Checking Stop Reason in Response
+
+```typescript
+const response = await agent.respond("Book a hotel");
+
+switch (response.stoppedReason) {
+  case 'needs_input':
+    console.log("Waiting for user input");
+    break;
+  case 'end_route':
+  case 'route_complete':
+    console.log("Route finished:", response.isRouteComplete);
+    break;
+  case 'prepare_error':
+  case 'llm_error':
+    console.error("Error occurred:", response.error);
+    break;
+  case 'validation_error':
+    console.warn("Validation issues:", response.error);
+    break;
+}
+```
+
 ## Conditional Skipping
 
 ### SkipIf Logic