signalwire-agents 0.1.0

package/dist/prefabs/ConciergeAgent.js

@@ -0,0 +1,188 @@
+/**
+ * ConciergeAgent - A prefab agent that provides multi-department routing
+ * with a knowledge base of department info, hours, and transfer capabilities.
+ */
+import { AgentBase } from '../AgentBase.js';
+import { SwaigFunctionResult } from '../SwaigFunctionResult.js';
+// ── Agent ───────────────────────────────────────────────────────────────────
+/** Prefab agent that provides multi-department routing with a knowledge base of department info, hours, and transfer capabilities. */
+export class ConciergeAgent extends AgentBase {
+    departments;
+    companyName;
+    generalInfo;
+    afterHoursMessage;
+    /** Declarative prompt sections merged by AgentBase constructor. */
+    static PROMPT_SECTIONS = [
+        {
+            title: 'Role',
+            body: 'You are a professional concierge agent. Help callers find the right department, provide information about available services, and transfer calls when requested.',
+        },
+        {
+            title: 'Rules',
+            bullets: [
+                'Greet the caller warmly and ask how you can help.',
+                'Use list_departments to describe available departments if the caller is unsure where to go.',
+                'Use get_department_info to provide detailed information about a specific department.',
+                'Use transfer_to_department to connect the caller to the right department.',
+                'If a department has hours of operation listed, mention them before transferring.',
+                'If a department does not have a transfer number, inform the caller and offer alternatives.',
+                'Be polite, professional, and efficient.',
+            ],
+        },
+    ];
+    /**
+     * Create a ConciergeAgent with the specified departments and company info.
+     * @param config - Configuration including departments, company name, and after-hours message.
+     */
+    constructor(config) {
+        const agentName = config.name ?? 'Concierge';
+        super({
+            name: agentName,
+            ...config.agentOptions,
+        });
+        this.departments = config.departments;
+        this.companyName = config.companyName ?? 'our company';
+        this.generalInfo = config.generalInfo ?? '';
+        this.afterHoursMessage = config.afterHoursMessage ?? 'This department is currently closed. Please try again during business hours.';
+        // Company intro section
+        let introBody = `You are the concierge for ${this.companyName}.`;
+        if (this.generalInfo) {
+            introBody += ` Company information: ${this.generalInfo}`;
+        }
+        this.promptAddSection('Company', { body: introBody });
+        // Build department overview section
+        const deptBullets = this.departments.map((dept) => {
+            let desc = `${dept.name}: ${dept.description}`;
+            if (dept.hoursOfOperation)
+                desc += ` (Hours: ${dept.hoursOfOperation})`;
+            if (dept.transferNumber)
+                desc += ' [transfer available]';
+            return desc;
+        });
+        this.promptAddSection('Available Departments', { bullets: deptBullets });
+        // Speech recognition hints from department names and keywords
+        const hints = this.departments.map((d) => d.name);
+        for (const dept of this.departments) {
+            if (dept.keywords)
+                hints.push(...dept.keywords);
+        }
+        this.addHints(hints);
+        // Register tools after all fields are initialized
+        this.defineTools();
+    }
+    // ── Department helpers ────────────────────────────────────────────────
+    findDepartment(name) {
+        const normalized = name.toLowerCase().trim();
+        return this.departments.find((d) => d.name.toLowerCase() === normalized ||
+            d.keywords?.some((k) => k.toLowerCase() === normalized));
+    }
+    // ── Tool registration ─────────────────────────────────────────────────
+    /** Register the list_departments, get_department_info, and transfer_to_department SWAIG tools. */
+    defineTools() {
+        // Tool: list_departments
+        this.defineTool({
+            name: 'list_departments',
+            description: `List all available departments at ${this.companyName} with their descriptions and hours of operation.`,
+            parameters: {
+                type: 'object',
+                properties: {},
+            },
+            handler: () => {
+                if (this.departments.length === 0) {
+                    return new SwaigFunctionResult('No departments are currently configured.');
+                }
+                const lines = this.departments.map((dept) => {
+                    let line = `${dept.name}: ${dept.description}`;
+                    if (dept.hoursOfOperation)
+                        line += ` | Hours: ${dept.hoursOfOperation}`;
+                    if (!dept.transferNumber)
+                        line += ' | (no direct transfer available)';
+                    return line;
+                });
+                return new SwaigFunctionResult(`Available departments at ${this.companyName}:\n${lines.join('\n')}`);
+            },
+        });
+        // Tool: get_department_info
+        this.defineTool({
+            name: 'get_department_info',
+            description: 'Get detailed information about a specific department including description, hours of operation, and transfer availability.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    department_name: {
+                        type: 'string',
+                        description: 'The name of the department to look up.',
+                    },
+                },
+                required: ['department_name'],
+            },
+            handler: (_args) => {
+                const deptName = _args['department_name'];
+                if (!deptName) {
+                    return new SwaigFunctionResult('Please provide a department name.');
+                }
+                const dept = this.findDepartment(deptName);
+                if (!dept) {
+                    const available = this.departments.map((d) => d.name).join(', ');
+                    return new SwaigFunctionResult(`Department "${deptName}" not found. Available departments: ${available}`);
+                }
+                let info = `Department: ${dept.name}\nDescription: ${dept.description}`;
+                if (dept.hoursOfOperation)
+                    info += `\nHours: ${dept.hoursOfOperation}`;
+                if (dept.transferNumber) {
+                    info += '\nTransfer: available';
+                }
+                else {
+                    info += '\nTransfer: not available (no phone number configured)';
+                }
+                if (dept.keywords && dept.keywords.length > 0) {
+                    info += `\nRelated topics: ${dept.keywords.join(', ')}`;
+                }
+                return new SwaigFunctionResult(info);
+            },
+        });
+        // Tool: transfer_to_department
+        this.defineTool({
+            name: 'transfer_to_department',
+            description: 'Transfer the caller to a specific department. Only works if the department has a transfer number configured.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    department_name: {
+                        type: 'string',
+                        description: 'The name of the department to transfer to.',
+                    },
+                },
+                required: ['department_name'],
+            },
+            handler: (_args) => {
+                const deptName = _args['department_name'];
+                if (!deptName) {
+                    return new SwaigFunctionResult('Please provide a department name.');
+                }
+                const dept = this.findDepartment(deptName);
+                if (!dept) {
+                    const available = this.departments.map((d) => d.name).join(', ');
+                    return new SwaigFunctionResult(`Department "${deptName}" not found. Available departments: ${available}`);
+                }
+                if (!dept.transferNumber) {
+                    return new SwaigFunctionResult(`The ${dept.name} department does not have a direct transfer number. ${this.afterHoursMessage}`);
+                }
+                const result = new SwaigFunctionResult(`Transferring you to the ${dept.name} department now.`);
+                result.connect(dept.transferNumber);
+                return result;
+            },
+        });
+    }
+}
+// ── Factory function ────────────────────────────────────────────────────────
+/**
+ * Factory function that creates and returns a new ConciergeAgent.
+ * @param config - Configuration for the concierge agent.
+ * @returns A configured ConciergeAgent instance.
+ */
+export function createConciergeAgent(config) {
+    return new ConciergeAgent(config);
+}
+export default ConciergeAgent;
+//# sourceMappingURL=ConciergeAgent.js.map

package/dist/prefabs/ConciergeAgent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConciergeAgent.js","sourceRoot":"","sources":["../../src/prefabs/ConciergeAgent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAiChE,+EAA+E;AAE/E,sIAAsI;AACtI,MAAM,OAAO,cAAe,SAAQ,SAAS;IACnC,WAAW,CAAe;IAC1B,WAAW,CAAS;IACpB,WAAW,CAAS;IACpB,iBAAiB,CAAS;IAElC,mEAAmE;IACnE,MAAM,CAAU,eAAe,GAAG;QAChC;YACE,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,kKAAkK;SACzK;QACD;YACE,KAAK,EAAE,OAAO;YACd,OAAO,EAAE;gBACP,mDAAmD;gBACnD,6FAA6F;gBAC7F,sFAAsF;gBACtF,2EAA2E;gBAC3E,kFAAkF;gBAClF,4FAA4F;gBAC5F,yCAAyC;aAC1C;SACF;KACF,CAAC;IAEF;;;OAGG;IACH,YAAY,MAAuB;QACjC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,IAAI,WAAW,CAAC;QAC7C,KAAK,CAAC;YACJ,IAAI,EAAE,SAAS;YACf,GAAG,MAAM,CAAC,YAAY;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,aAAa,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,IAAI,8EAA8E,CAAC;QAEpI,wBAAwB;QACxB,IAAI,SAAS,GAAG,6BAA6B,IAAI,CAAC,WAAW,GAAG,CAAC;QACjE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,SAAS,IAAI,yBAAyB,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QAEtD,oCAAoC;QACpC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAChD,IAAI,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;YAC/C,IAAI,IAAI,CAAC,gBAAgB;gBAAE,IAAI,IAAI,YAAY,IAAI,CAAC,gBAAgB,GAAG,CAAC;YACxE,IAAI,IAAI,CAAC,cAAc;gBAAE,IAAI,IAAI,uBAAuB,CAAC;YACzD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;QAEzE,8DAA8D;QAC9D,MAAM,KAAK,GAAa,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5D,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,QAAQ;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAErB,kDAAkD;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,yEAAyE;IAEjE,cAAc,CAAC,IAAY;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAC1B,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU;YACnC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,CAC1D,CAAC;IACJ,CAAC;IAED,yEAAyE;IAEzE,kGAAkG;IAC/E,WAAW;QAC5B,yBAAyB;QACzB,IAAI,CAAC,UAAU,CAAC;YACd,IAAI,EAAE,kBAAkB;YACxB,WAAW,EAAE,qCAAqC,IAAI,CAAC,WAAW,kDAAkD;YACpH,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;YACD,OAAO,EAAE,GAAG,EAAE;gBACZ,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO,IAAI,mBAAmB,CAAC,0CAA0C,CAAC,CAAC;gBAC7E,CAAC;gBAED,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC1C,IAAI,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC/C,IAAI,IAAI,CAAC,gBAAgB;wBAAE,IAAI,IAAI,aAAa,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBACxE,IAAI,CAAC,IAAI,CAAC,cAAc;wBAAE,IAAI,IAAI,mCAAmC,CAAC;oBACtE,OAAO,IAAI,CAAC;gBACd,CAAC,CAAC,CAAC;gBAEH,OAAO,IAAI,mBAAmB,CAC5B,4BAA4B,IAAI,CAAC,WAAW,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACrE,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;QAEH,4BAA4B;QAC5B,IAAI,CAAC,UAAU,CAAC;YACd,IAAI,EAAE,qBAAqB;YAC3B,WAAW,EAAE,4HAA4H;YACzI,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,eAAe,EAAE;wBACf,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,wCAAwC;qBACtD;iBACF;gBACD,QAAQ,EAAE,CAAC,iBAAiB,CAAC;aAC9B;YACD,OAAO,EAAE,CAAC,KAA8B,EAAE,EAAE;gBAC1C,MAAM,QAAQ,GAAG,KAAK,CAAC,iBAAiB,CAAW,CAAC;gBACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,OAAO,IAAI,mBAAmB,CAAC,mCAAmC,CAAC,CAAC;gBACtE,CAAC;gBAED,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;gBAC3C,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,OAAO,IAAI,mBAAmB,CAC5B,eAAe,QAAQ,uCAAuC,SAAS,EAAE,CAC1E,CAAC;gBACJ,CAAC;gBAED,IAAI,IAAI,GAAG,eAAe,IAAI,CAAC,IAAI,kBAAkB,IAAI,CAAC,WAAW,EAAE,CAAC;gBACxE,IAAI,IAAI,CAAC,gBAAgB;oBAAE,IAAI,IAAI,YAAY,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACvE,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;oBACxB,IAAI,IAAI,uBAAuB,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACN,IAAI,IAAI,wDAAwD,CAAC;gBACnE,CAAC;gBACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9C,IAAI,IAAI,qBAAqB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1D,CAAC;gBAED,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;YACvC,CAAC;SACF,CAAC,CAAC;QAEH,+BAA+B;QAC/B,IAAI,CAAC,UAAU,CAAC;YACd,IAAI,EAAE,wBAAwB;YAC9B,WAAW,EAAE,8GAA8G;YAC3H,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,eAAe,EAAE;wBACf,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,4CAA4C;qBAC1D;iBACF;gBACD,QAAQ,EAAE,CAAC,iBAAiB,CAAC;aAC9B;YACD,OAAO,EAAE,CAAC,KAA8B,EAAE,EAAE;gBAC1C,MAAM,QAAQ,GAAG,KAAK,CAAC,iBAAiB,CAAW,CAAC;gBACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,OAAO,IAAI,mBAAmB,CAAC,mCAAmC,CAAC,CAAC;gBACtE,CAAC;gBAED,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;gBAC3C,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,OAAO,IAAI,mBAAmB,CAC5B,eAAe,QAAQ,uCAAuC,SAAS,EAAE,CAC1E,CAAC;gBACJ,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;oBACzB,OAAO,IAAI,mBAAmB,CAC5B,OAAO,IAAI,CAAC,IAAI,uDAAuD,IAAI,CAAC,iBAAiB,EAAE,CAChG,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAG,IAAI,mBAAmB,CACpC,2BAA2B,IAAI,CAAC,IAAI,kBAAkB,CACvD,CAAC;gBACF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;gBACpC,OAAO,MAAM,CAAC;YAChB,CAAC;SACF,CAAC,CAAC;IACL,CAAC;;AAGH,+EAA+E;AAE/E;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAuB;IAC1D,OAAO,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC;AAED,eAAe,cAAc,CAAC"}

package/dist/prefabs/FAQBotAgent.d.ts

@@ -0,0 +1,68 @@
+/**
+ * FAQBotAgent - A prefab agent that answers frequently asked questions using
+ * keyword/word-overlap matching with configurable similarity thresholds
+ * and optional escalation to a live agent.
+ */
+import { AgentBase } from '../AgentBase.js';
+import type { AgentOptions } from '../types.js';
+export interface FAQEntry {
+    /** The representative question text. */
+    question: string;
+    /** The answer to provide when this FAQ matches. */
+    answer: string;
+    /** Additional keywords to boost matching accuracy. */
+    keywords?: string[];
+}
+export interface FAQBotConfig {
+    /** Agent display name. */
+    name?: string;
+    /** List of FAQ entries for the knowledge base. */
+    faqs: FAQEntry[];
+    /** Minimum match score (0-1) for an FAQ to be considered a match. Default 0.5. */
+    threshold?: number;
+    /** Message spoken when no FAQ matches the query. */
+    escalationMessage?: string;
+    /** Phone number to transfer to on escalation. If not set, escalate tool is not registered. */
+    escalationNumber?: string;
+    /** Additional AgentBase options forwarded to super(). */
+    agentOptions?: Partial<AgentOptions>;
+}
+/** Prefab agent that answers frequently asked questions using keyword matching with optional escalation to a live agent. */
+export declare class FAQBotAgent extends AgentBase {
+    private faqs;
+    private threshold;
+    private escalationMessage;
+    private escalationNumber;
+    /** Declarative prompt sections merged by AgentBase constructor. */
+    static PROMPT_SECTIONS: ({
+        title: string;
+        body: string;
+        bullets?: undefined;
+    } | {
+        title: string;
+        bullets: string[];
+        body?: undefined;
+    })[];
+    /**
+     * Create a FAQBotAgent with the specified FAQ entries and matching threshold.
+     * @param config - Configuration including FAQ entries, threshold, and escalation settings.
+     */
+    constructor(config: FAQBotConfig);
+    /**
+     * Compute a word-overlap similarity score between a query and an FAQ entry.
+     * Combines question text similarity and keyword overlap.
+     * Returns a value between 0 and 1.
+     */
+    private computeMatchScore;
+    private tokenize;
+    private wordOverlap;
+    /** Register the search_faq and optional escalate SWAIG tools. */
+    protected defineTools(): void;
+}
+/**
+ * Factory function that creates and returns a new FAQBotAgent.
+ * @param config - Configuration for the FAQ bot agent.
+ * @returns A configured FAQBotAgent instance.
+ */
+export declare function createFAQBotAgent(config: FAQBotConfig): FAQBotAgent;
+export default FAQBotAgent;

package/dist/prefabs/FAQBotAgent.js

@@ -0,0 +1,206 @@
+/**
+ * FAQBotAgent - A prefab agent that answers frequently asked questions using
+ * keyword/word-overlap matching with configurable similarity thresholds
+ * and optional escalation to a live agent.
+ */
+import { AgentBase } from '../AgentBase.js';
+import { SwaigFunctionResult } from '../SwaigFunctionResult.js';
+// ── Agent ───────────────────────────────────────────────────────────────────
+/** Prefab agent that answers frequently asked questions using keyword matching with optional escalation to a live agent. */
+export class FAQBotAgent extends AgentBase {
+    faqs;
+    threshold;
+    escalationMessage;
+    escalationNumber;
+    /** Declarative prompt sections merged by AgentBase constructor. */
+    static PROMPT_SECTIONS = [
+        {
+            title: 'Role',
+            body: 'You are a helpful FAQ assistant. Answer the caller\'s questions by searching the knowledge base. If you cannot find a satisfactory answer, offer to escalate to a human agent.',
+        },
+        {
+            title: 'Rules',
+            bullets: [
+                'Always use the search_faq tool to find answers. Do not make up answers.',
+                'If the search returns a good match, relay the answer naturally to the caller.',
+                'If the match score is low or no match is found, let the caller know and offer to escalate.',
+                'Be concise and helpful in your responses.',
+                'If the caller asks a follow-up, search again with the new query.',
+            ],
+        },
+    ];
+    /**
+     * Create a FAQBotAgent with the specified FAQ entries and matching threshold.
+     * @param config - Configuration including FAQ entries, threshold, and escalation settings.
+     */
+    constructor(config) {
+        const agentName = config.name ?? 'FAQBot';
+        super({
+            name: agentName,
+            ...config.agentOptions,
+        });
+        this.faqs = config.faqs;
+        this.threshold = config.threshold ?? 0.5;
+        this.escalationMessage = config.escalationMessage ?? 'I\'m sorry, I couldn\'t find an answer to your question. Let me transfer you to someone who can help.';
+        this.escalationNumber = config.escalationNumber ?? null;
+        // Build FAQ topics section for the prompt
+        const topicBullets = this.faqs.map((faq) => {
+            const kw = faq.keywords ? ` (keywords: ${faq.keywords.join(', ')})` : '';
+            return `${faq.question}${kw}`;
+        });
+        this.promptAddSection('Available FAQ Topics', { bullets: topicBullets });
+        // Add hints from FAQ keywords for speech recognition
+        const allKeywords = [];
+        for (const faq of this.faqs) {
+            if (faq.keywords)
+                allKeywords.push(...faq.keywords);
+        }
+        if (allKeywords.length > 0) {
+            this.addHints(allKeywords);
+        }
+        // Register tools after all fields are initialized
+        this.defineTools();
+    }
+    // ── Matching engine ───────────────────────────────────────────────────
+    /**
+     * Compute a word-overlap similarity score between a query and an FAQ entry.
+     * Combines question text similarity and keyword overlap.
+     * Returns a value between 0 and 1.
+     */
+    computeMatchScore(query, faq) {
+        const queryWords = this.tokenize(query);
+        if (queryWords.length === 0)
+            return 0;
+        // Score against the question text
+        const questionWords = this.tokenize(faq.question);
+        const questionOverlap = this.wordOverlap(queryWords, questionWords);
+        // Score against keywords
+        let keywordScore = 0;
+        if (faq.keywords && faq.keywords.length > 0) {
+            const keywordTokens = faq.keywords.map((k) => k.toLowerCase().trim());
+            const queryLower = query.toLowerCase();
+            let keywordHits = 0;
+            for (const kw of keywordTokens) {
+                if (queryLower.includes(kw)) {
+                    keywordHits++;
+                }
+            }
+            keywordScore = keywordTokens.length > 0 ? keywordHits / keywordTokens.length : 0;
+        }
+        // Weighted combination: 60% question overlap, 40% keyword score
+        return faq.keywords && faq.keywords.length > 0
+            ? questionOverlap * 0.6 + keywordScore * 0.4
+            : questionOverlap;
+    }
+    tokenize(text) {
+        return text
+            .toLowerCase()
+            .replace(/[^a-z0-9\s]/g, ' ')
+            .split(/\s+/)
+            .filter((w) => w.length > 1 && !STOP_WORDS.has(w));
+    }
+    wordOverlap(queryWords, targetWords) {
+        if (queryWords.length === 0 || targetWords.length === 0)
+            return 0;
+        const targetSet = new Set(targetWords);
+        let matches = 0;
+        for (const word of queryWords) {
+            if (targetSet.has(word))
+                matches++;
+        }
+        // Normalize by the smaller set to be lenient
+        const divisor = Math.min(queryWords.length, targetWords.length);
+        return divisor > 0 ? matches / divisor : 0;
+    }
+    // ── Tool registration ─────────────────────────────────────────────────
+    /** Register the search_faq and optional escalate SWAIG tools. */
+    defineTools() {
+        // Tool: search_faq
+        this.defineTool({
+            name: 'search_faq',
+            description: 'Search the FAQ knowledge base for an answer to the caller\'s question. Returns the best matching FAQ entry with a confidence score.',
+            parameters: {
+                type: 'object',
+                properties: {
+                    query: {
+                        type: 'string',
+                        description: 'The caller\'s question or search query.',
+                    },
+                },
+                required: ['query'],
+            },
+            handler: (_args) => {
+                const query = _args['query'];
+                if (!query) {
+                    return new SwaigFunctionResult('A query is required to search the FAQ.');
+                }
+                // Score all FAQs
+                const scored = this.faqs.map((faq) => ({
+                    faq,
+                    score: this.computeMatchScore(query, faq),
+                }));
+                // Sort by score descending
+                scored.sort((a, b) => b.score - a.score);
+                const best = scored[0];
+                if (!best || best.score < this.threshold) {
+                    return new SwaigFunctionResult(`No FAQ matched the query "${query}" with sufficient confidence (best score: ${best ? best.score.toFixed(2) : '0.00'}, threshold: ${this.threshold.toFixed(2)}). ${this.escalationMessage}`);
+                }
+                // Return the best match
+                let response = `FAQ Match (confidence: ${best.score.toFixed(2)}): Q: "${best.faq.question}" A: ${best.faq.answer}`;
+                // If there are close runner-ups, mention them
+                const runnerUps = scored.filter((s, i) => i > 0 && s.score >= this.threshold);
+                if (runnerUps.length > 0) {
+                    const alsoStr = runnerUps
+                        .slice(0, 2)
+                        .map((s) => `"${s.faq.question}" (${s.score.toFixed(2)})`)
+                        .join(', ');
+                    response += ` Also related: ${alsoStr}`;
+                }
+                return new SwaigFunctionResult(response);
+            },
+        });
+        // Tool: escalate (only if escalation number is configured)
+        if (this.escalationNumber) {
+            this.defineTool({
+                name: 'escalate',
+                description: 'Transfer the caller to a live agent when the FAQ knowledge base cannot answer their question.',
+                parameters: {
+                    type: 'object',
+                    properties: {
+                        reason: {
+                            type: 'string',
+                            description: 'The reason for escalation.',
+                        },
+                    },
+                },
+                handler: (_args) => {
+                    const reason = _args['reason'] || 'Caller needs assistance beyond FAQ';
+                    const result = new SwaigFunctionResult(`Transferring caller to a live agent. Reason: ${reason}`);
+                    result.connect(this.escalationNumber);
+                    return result;
+                },
+            });
+        }
+    }
+}
+// ── Common English stop words filtered from matching ────────────────────────
+const STOP_WORDS = new Set([
+    'a', 'an', 'the', 'is', 'it', 'to', 'in', 'of', 'and', 'or', 'for',
+    'on', 'at', 'by', 'do', 'if', 'my', 'so', 'up', 'am', 'as', 'be',
+    'he', 'me', 'we', 'no', 'not', 'are', 'was', 'has', 'had', 'how',
+    'its', 'can', 'did', 'get', 'but', 'you', 'her', 'him', 'his', 'she',
+    'our', 'who', 'this', 'that', 'what', 'with', 'have', 'from', 'will',
+    'your', 'they', 'them', 'been', 'does', 'just', 'than', 'when', 'which',
+    'would', 'could', 'should', 'about', 'their', 'there', 'these', 'those',
+]);
+// ── Factory function ────────────────────────────────────────────────────────
+/**
+ * Factory function that creates and returns a new FAQBotAgent.
+ * @param config - Configuration for the FAQ bot agent.
+ * @returns A configured FAQBotAgent instance.
+ */
+export function createFAQBotAgent(config) {
+    return new FAQBotAgent(config);
+}
+export default FAQBotAgent;
+//# sourceMappingURL=FAQBotAgent.js.map

package/dist/prefabs/FAQBotAgent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FAQBotAgent.js","sourceRoot":"","sources":["../../src/prefabs/FAQBotAgent.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AA6BhE,+EAA+E;AAE/E,4HAA4H;AAC5H,MAAM,OAAO,WAAY,SAAQ,SAAS;IAChC,IAAI,CAAa;IACjB,SAAS,CAAS;IAClB,iBAAiB,CAAS;IAC1B,gBAAgB,CAAgB;IAExC,mEAAmE;IACnE,MAAM,CAAU,eAAe,GAAG;QAChC;YACE,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,gLAAgL;SACvL;QACD;YACE,KAAK,EAAE,OAAO;YACd,OAAO,EAAE;gBACP,yEAAyE;gBACzE,+EAA+E;gBAC/E,4FAA4F;gBAC5F,2CAA2C;gBAC3C,kEAAkE;aACnE;SACF;KACF,CAAC;IAEF;;;OAGG;IACH,YAAY,MAAoB;QAC9B,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,IAAI,QAAQ,CAAC;QAC1C,KAAK,CAAC;YACJ,IAAI,EAAE,SAAS;YACf,GAAG,MAAM,CAAC,YAAY;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,GAAG,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,IAAI,uGAAuG,CAAC;QAC7J,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,IAAI,CAAC;QAExD,0CAA0C;QAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACzC,MAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,eAAe,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACzE,OAAO,GAAG,GAAG,CAAC,QAAQ,GAAG,EAAE,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;QAEzE,qDAAqD;QACrD,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,GAAG,CAAC,QAAQ;gBAAE,WAAW,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC;QAED,kDAAkD;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,yEAAyE;IAEzE;;;;OAIG;IACK,iBAAiB,CAAC,KAAa,EAAE,GAAa;QACpD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;QAEtC,kCAAkC;QAClC,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAEpE,yBAAyB;QACzB,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,aAAa,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;YACtE,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;YACvC,IAAI,WAAW,GAAG,CAAC,CAAC;YACpB,KAAK,MAAM,EAAE,IAAI,aAAa,EAAE,CAAC;gBAC/B,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBAC5B,WAAW,EAAE,CAAC;gBAChB,CAAC;YACH,CAAC;YACD,YAAY,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACnF,CAAC;QAED,gEAAgE;QAChE,OAAO,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAC5C,CAAC,CAAC,eAAe,GAAG,GAAG,GAAG,YAAY,GAAG,GAAG;YAC5C,CAAC,CAAC,eAAe,CAAC;IACtB,CAAC;IAEO,QAAQ,CAAC,IAAY;QAC3B,OAAO,IAAI;aACR,WAAW,EAAE;aACb,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC;aAC5B,KAAK,CAAC,KAAK,CAAC;aACZ,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IAEO,WAAW,CAAC,UAAoB,EAAE,WAAqB;QAC7D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;QAClE,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;QACvC,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;YAC9B,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,OAAO,EAAE,CAAC;QACrC,CAAC;QACD,6CAA6C;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QAChE,OAAO,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,yEAAyE;IAEzE,iEAAiE;IAC9C,WAAW;QAC5B,mBAAmB;QACnB,IAAI,CAAC,UAAU,CAAC;YACd,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,qIAAqI;YAClJ,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,yCAAyC;qBACvD;iBACF;gBACD,QAAQ,EAAE,CAAC,OAAO,CAAC;aACpB;YACD,OAAO,EAAE,CAAC,KAA8B,EAAE,EAAE;gBAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAW,CAAC;gBACvC,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,IAAI,mBAAmB,CAAC,wCAAwC,CAAC,CAAC;gBAC3E,CAAC;gBAED,iBAAiB;gBACjB,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBACrC,GAAG;oBACH,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC;iBAC1C,CAAC,CAAC,CAAC;gBAEJ,2BAA2B;gBAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;gBAEzC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;gBAEvB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;oBACzC,OAAO,IAAI,mBAAmB,CAC5B,6BAA6B,KAAK,6CAA6C,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,gBAAgB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAC5L,CAAC;gBACJ,CAAC;gBAED,wBAAwB;gBACxB,IAAI,QAAQ,GAAG,0BAA0B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,GAAG,CAAC,QAAQ,QAAQ,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;gBAEnH,8CAA8C;gBAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC9E,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzB,MAAM,OAAO,GAAG,SAAS;yBACtB,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;yBACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,MAAM,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;yBACzD,IAAI,CAAC,IAAI,CAAC,CAAC;oBACd,QAAQ,IAAI,kBAAkB,OAAO,EAAE,CAAC;gBAC1C,CAAC;gBAED,OAAO,IAAI,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YAC3C,CAAC;SACF,CAAC,CAAC;QAEH,2DAA2D;QAC3D,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,IAAI,CAAC,UAAU,CAAC;gBACd,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,+FAA+F;gBAC5G,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,4BAA4B;yBAC1C;qBACF;iBACF;gBACD,OAAO,EAAE,CAAC,KAA8B,EAAE,EAAE;oBAC1C,MAAM,MAAM,GAAI,KAAK,CAAC,QAAQ,CAAY,IAAI,oCAAoC,CAAC;oBACnF,MAAM,MAAM,GAAG,IAAI,mBAAmB,CACpC,gDAAgD,MAAM,EAAE,CACzD,CAAC;oBACF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAiB,CAAC,CAAC;oBACvC,OAAO,MAAM,CAAC;gBAChB,CAAC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;;AAGH,+EAA+E;AAE/E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK;IAClE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;IAChE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK;IAChE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK;IACpE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IACpE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO;IACvE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO;CACxE,CAAC,CAAC;AAEH,+EAA+E;AAE/E;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAoB;IACpD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,eAAe,WAAW,CAAC"}

package/dist/prefabs/InfoGathererAgent.d.ts

@@ -0,0 +1,73 @@
+/**
+ * InfoGathererAgent - A prefab agent that sequentially collects information
+ * from callers through conversational interaction.
+ *
+ * Tracks fields per call, validates with optional regex patterns, and fires
+ * an onComplete callback once all required fields are gathered.
+ */
+import { AgentBase } from '../AgentBase.js';
+import type { AgentOptions } from '../types.js';
+export interface InfoGathererField {
+    /** Unique field name (used as key in collected data). */
+    name: string;
+    /** Human-readable description shown to the AI agent. */
+    description: string;
+    /** Whether this field must be collected before completion. Default true. */
+    required?: boolean;
+    /** Optional validation pattern. String is compiled to RegExp. */
+    validation?: RegExp | string;
+}
+export interface InfoGathererConfig {
+    /** Agent display name. */
+    name?: string;
+    /** Fields to collect from the caller. */
+    fields: InfoGathererField[];
+    /** Opening message the agent speaks when call starts. */
+    introMessage?: string;
+    /** Message spoken after all required fields are gathered. */
+    confirmationMessage?: string;
+    /** Callback fired when all required fields have been collected. */
+    onComplete?: (data: Record<string, string>) => void | Promise<void>;
+    /** Additional AgentBase options forwarded to super(). */
+    agentOptions?: Partial<AgentOptions>;
+}
+/** Prefab agent that sequentially collects named fields from a caller with optional validation and completion callback. */
+export declare class InfoGathererAgent extends AgentBase {
+    private fields;
+    private introMessage;
+    private confirmationMessage;
+    private onCompleteCallback?;
+    private sessions;
+    /**
+     * Declarative prompt sections merged by AgentBase constructor.
+     * Additional dynamic sections are added in the constructor body below.
+     */
+    static PROMPT_SECTIONS: ({
+        title: string;
+        body: string;
+        bullets?: undefined;
+    } | {
+        title: string;
+        bullets: string[];
+        body?: undefined;
+    })[];
+    /**
+     * Create an InfoGathererAgent with the specified fields and callbacks.
+     * @param config - Configuration including fields to collect, messages, and completion callback.
+     */
+    constructor(config: InfoGathererConfig);
+    private getSession;
+    private getFieldByName;
+    private validateValue;
+    private getRequiredFields;
+    private allRequiredCollected;
+    /** Register the save_field and get_status SWAIG tools. */
+    protected defineTools(): void;
+}
+/**
+ * Factory function that creates and returns a new InfoGathererAgent.
+ * @param config - Configuration for the info gatherer agent.
+ * @returns A configured InfoGathererAgent instance.
+ */
+export declare function createInfoGathererAgent(config: InfoGathererConfig): InfoGathererAgent;
+export default InfoGathererAgent;