@signalwire/sdk 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (610) hide show
  1. package/dist/AgentBase.d.ts +1045 -0
  2. package/dist/AgentBase.js +2375 -0
  3. package/dist/AgentBase.js.map +1 -0
  4. package/dist/AgentServer.d.ts +146 -0
  5. package/dist/AgentServer.js +388 -0
  6. package/dist/AgentServer.js.map +1 -0
  7. package/dist/AuthHandler.d.ts +127 -0
  8. package/dist/AuthHandler.js +212 -0
  9. package/dist/AuthHandler.js.map +1 -0
  10. package/dist/ConfigLoader.d.ts +170 -0
  11. package/dist/ConfigLoader.js +393 -0
  12. package/dist/ConfigLoader.js.map +1 -0
  13. package/dist/ContextBuilder.d.ts +652 -0
  14. package/dist/ContextBuilder.js +1115 -0
  15. package/dist/ContextBuilder.js.map +1 -0
  16. package/dist/DataMap.d.ts +271 -0
  17. package/dist/DataMap.js +430 -0
  18. package/dist/DataMap.js.map +1 -0
  19. package/dist/FunctionResult.d.ts +481 -0
  20. package/dist/FunctionResult.js +775 -0
  21. package/dist/FunctionResult.js.map +1 -0
  22. package/dist/Logger.d.ts +113 -0
  23. package/dist/Logger.js +320 -0
  24. package/dist/Logger.js.map +1 -0
  25. package/dist/PomBuilder.d.ts +208 -0
  26. package/dist/PomBuilder.js +409 -0
  27. package/dist/PomBuilder.js.map +1 -0
  28. package/dist/PromptManager.d.ts +85 -0
  29. package/dist/PromptManager.js +108 -0
  30. package/dist/PromptManager.js.map +1 -0
  31. package/dist/SWMLHandler.d.ts +159 -0
  32. package/dist/SWMLHandler.js +229 -0
  33. package/dist/SWMLHandler.js.map +1 -0
  34. package/dist/SWMLService.d.ts +326 -0
  35. package/dist/SWMLService.js +610 -0
  36. package/dist/SWMLService.js.map +1 -0
  37. package/dist/SchemaUtils.d.ts +108 -0
  38. package/dist/SchemaUtils.js +317 -0
  39. package/dist/SchemaUtils.js.map +1 -0
  40. package/dist/SecurityUtils.d.ts +60 -0
  41. package/{src/SecurityUtils.ts → dist/SecurityUtils.js} +82 -83
  42. package/dist/SecurityUtils.js.map +1 -0
  43. package/dist/ServerlessAdapter.d.ts +119 -0
  44. package/dist/ServerlessAdapter.js +188 -0
  45. package/dist/ServerlessAdapter.js.map +1 -0
  46. package/dist/SessionManager.d.ts +142 -0
  47. package/dist/SessionManager.js +260 -0
  48. package/dist/SessionManager.js.map +1 -0
  49. package/dist/SslConfig.d.ts +77 -0
  50. package/dist/SslConfig.js +100 -0
  51. package/dist/SslConfig.js.map +1 -0
  52. package/dist/SwaigFunction.d.ts +159 -0
  53. package/dist/SwaigFunction.js +209 -0
  54. package/dist/SwaigFunction.js.map +1 -0
  55. package/dist/SwmlBuilder.d.ts +165 -0
  56. package/dist/SwmlBuilder.js +247 -0
  57. package/dist/SwmlBuilder.js.map +1 -0
  58. package/dist/SwmlVerbMethods.generated.d.ts +254 -0
  59. package/dist/SwmlVerbMethods.generated.js +9 -0
  60. package/dist/SwmlVerbMethods.generated.js.map +1 -0
  61. package/dist/TypeInference.d.ts +71 -0
  62. package/dist/TypeInference.js +164 -0
  63. package/dist/TypeInference.js.map +1 -0
  64. package/dist/WebService.d.ts +148 -0
  65. package/dist/WebService.js +532 -0
  66. package/dist/WebService.js.map +1 -0
  67. package/dist/cli/agent-loader.d.ts +22 -0
  68. package/dist/cli/agent-loader.js +144 -0
  69. package/dist/cli/agent-loader.js.map +1 -0
  70. package/dist/cli/mock-data.d.ts +37 -0
  71. package/dist/cli/mock-data.js +80 -0
  72. package/dist/cli/mock-data.js.map +1 -0
  73. package/dist/cli/swaig-test.d.ts +32 -0
  74. package/dist/cli/swaig-test.js +418 -0
  75. package/dist/cli/swaig-test.js.map +1 -0
  76. package/dist/generateVerbTypes.d.ts +11 -0
  77. package/dist/generateVerbTypes.js +265 -0
  78. package/dist/generateVerbTypes.js.map +1 -0
  79. package/{src/index.ts → dist/index.d.ts} +13 -100
  80. package/dist/index.js +152 -0
  81. package/dist/index.js.map +1 -0
  82. package/dist/livewire/index.d.ts +653 -0
  83. package/dist/livewire/index.js +992 -0
  84. package/dist/livewire/index.js.map +1 -0
  85. package/dist/prefabs/ConciergeAgent.d.ts +89 -0
  86. package/dist/prefabs/ConciergeAgent.js +245 -0
  87. package/dist/prefabs/ConciergeAgent.js.map +1 -0
  88. package/dist/prefabs/FAQBotAgent.d.ts +113 -0
  89. package/dist/prefabs/FAQBotAgent.js +329 -0
  90. package/dist/prefabs/FAQBotAgent.js.map +1 -0
  91. package/dist/prefabs/InfoGathererAgent.d.ts +126 -0
  92. package/dist/prefabs/InfoGathererAgent.js +287 -0
  93. package/dist/prefabs/InfoGathererAgent.js.map +1 -0
  94. package/dist/prefabs/ReceptionistAgent.d.ts +104 -0
  95. package/dist/prefabs/ReceptionistAgent.js +303 -0
  96. package/dist/prefabs/ReceptionistAgent.js.map +1 -0
  97. package/dist/prefabs/SurveyAgent.d.ts +148 -0
  98. package/dist/prefabs/SurveyAgent.js +540 -0
  99. package/dist/prefabs/SurveyAgent.js.map +1 -0
  100. package/{src/prefabs/index.ts → dist/prefabs/index.d.ts} +1 -15
  101. package/dist/prefabs/index.js +14 -0
  102. package/dist/prefabs/index.js.map +1 -0
  103. package/dist/relay/Action.d.ts +258 -0
  104. package/dist/relay/Action.js +402 -0
  105. package/dist/relay/Action.js.map +1 -0
  106. package/dist/relay/Call.d.ts +697 -0
  107. package/dist/relay/Call.js +1062 -0
  108. package/dist/relay/Call.js.map +1 -0
  109. package/dist/relay/Deferred.d.ts +44 -0
  110. package/dist/relay/Deferred.js +69 -0
  111. package/dist/relay/Deferred.js.map +1 -0
  112. package/dist/relay/Message.d.ts +103 -0
  113. package/dist/relay/Message.js +169 -0
  114. package/dist/relay/Message.js.map +1 -0
  115. package/dist/relay/RelayClient.d.ts +302 -0
  116. package/dist/relay/RelayClient.js +1026 -0
  117. package/dist/relay/RelayClient.js.map +1 -0
  118. package/dist/relay/RelayError.d.ts +15 -0
  119. package/dist/relay/RelayError.js +20 -0
  120. package/dist/relay/RelayError.js.map +1 -0
  121. package/dist/relay/RelayEvent.d.ts +254 -0
  122. package/dist/relay/RelayEvent.js +509 -0
  123. package/dist/relay/RelayEvent.js.map +1 -0
  124. package/dist/relay/constants.d.ts +90 -0
  125. package/{src/relay/constants.ts → dist/relay/constants.js} +11 -29
  126. package/dist/relay/constants.js.map +1 -0
  127. package/dist/relay/index.d.ts +16 -0
  128. package/dist/relay/index.js +18 -0
  129. package/dist/relay/index.js.map +1 -0
  130. package/dist/relay/types.d.ts +142 -0
  131. package/dist/relay/types.js +5 -0
  132. package/dist/relay/types.js.map +1 -0
  133. package/dist/rest/HttpClient.d.ts +80 -0
  134. package/dist/rest/HttpClient.js +148 -0
  135. package/dist/rest/HttpClient.js.map +1 -0
  136. package/dist/rest/RestError.d.ts +30 -0
  137. package/dist/rest/RestError.js +39 -0
  138. package/dist/rest/RestError.js.map +1 -0
  139. package/dist/rest/base/BaseResource.d.ts +24 -0
  140. package/dist/rest/base/BaseResource.js +29 -0
  141. package/dist/rest/base/BaseResource.js.map +1 -0
  142. package/dist/rest/base/CrudResource.d.ts +68 -0
  143. package/dist/rest/base/CrudResource.js +82 -0
  144. package/dist/rest/base/CrudResource.js.map +1 -0
  145. package/dist/rest/base/CrudWithAddresses.d.ts +22 -0
  146. package/dist/rest/base/CrudWithAddresses.js +25 -0
  147. package/dist/rest/base/CrudWithAddresses.js.map +1 -0
  148. package/dist/rest/index.d.ts +131 -0
  149. package/{src/rest/index.ts → dist/rest/index.js} +101 -136
  150. package/dist/rest/index.js.map +1 -0
  151. package/dist/rest/namespaces/addresses.d.ts +46 -0
  152. package/dist/rest/namespaces/addresses.js +55 -0
  153. package/dist/rest/namespaces/addresses.js.map +1 -0
  154. package/dist/rest/namespaces/calling.d.ts +382 -0
  155. package/dist/rest/namespaces/calling.js +478 -0
  156. package/dist/rest/namespaces/calling.js.map +1 -0
  157. package/dist/rest/namespaces/chat.d.ts +22 -0
  158. package/dist/rest/namespaces/chat.js +26 -0
  159. package/dist/rest/namespaces/chat.js.map +1 -0
  160. package/dist/rest/namespaces/compat.d.ts +585 -0
  161. package/dist/rest/namespaces/compat.js +735 -0
  162. package/dist/rest/namespaces/compat.js.map +1 -0
  163. package/dist/rest/namespaces/datasphere.d.ts +66 -0
  164. package/dist/rest/namespaces/datasphere.js +77 -0
  165. package/dist/rest/namespaces/datasphere.js.map +1 -0
  166. package/dist/rest/namespaces/fabric.d.ts +282 -0
  167. package/dist/rest/namespaces/fabric.js +373 -0
  168. package/dist/rest/namespaces/fabric.js.map +1 -0
  169. package/dist/rest/namespaces/imported-numbers.d.ts +22 -0
  170. package/dist/rest/namespaces/imported-numbers.js +26 -0
  171. package/dist/rest/namespaces/imported-numbers.js.map +1 -0
  172. package/dist/rest/namespaces/logs.d.ts +105 -0
  173. package/dist/rest/namespaces/logs.js +133 -0
  174. package/dist/rest/namespaces/logs.js.map +1 -0
  175. package/dist/rest/namespaces/lookup.d.ts +29 -0
  176. package/dist/rest/namespaces/lookup.js +32 -0
  177. package/dist/rest/namespaces/lookup.js.map +1 -0
  178. package/dist/rest/namespaces/mfa.d.ts +46 -0
  179. package/dist/rest/namespaces/mfa.js +54 -0
  180. package/dist/rest/namespaces/mfa.js.map +1 -0
  181. package/dist/rest/namespaces/number-groups.d.ts +49 -0
  182. package/dist/rest/namespaces/number-groups.js +58 -0
  183. package/dist/rest/namespaces/number-groups.js.map +1 -0
  184. package/dist/rest/namespaces/phone-numbers.d.ts +60 -0
  185. package/dist/rest/namespaces/phone-numbers.js +67 -0
  186. package/dist/rest/namespaces/phone-numbers.js.map +1 -0
  187. package/dist/rest/namespaces/project.d.ts +46 -0
  188. package/dist/rest/namespaces/project.js +56 -0
  189. package/dist/rest/namespaces/project.js.map +1 -0
  190. package/dist/rest/namespaces/pubsub.d.ts +22 -0
  191. package/dist/rest/namespaces/pubsub.js +26 -0
  192. package/dist/rest/namespaces/pubsub.js.map +1 -0
  193. package/dist/rest/namespaces/queues.d.ts +42 -0
  194. package/dist/rest/namespaces/queues.js +49 -0
  195. package/dist/rest/namespaces/queues.js.map +1 -0
  196. package/dist/rest/namespaces/recordings.d.ts +38 -0
  197. package/dist/rest/namespaces/recordings.js +45 -0
  198. package/dist/rest/namespaces/recordings.js.map +1 -0
  199. package/dist/rest/namespaces/registry.d.ts +141 -0
  200. package/dist/rest/namespaces/registry.js +178 -0
  201. package/dist/rest/namespaces/registry.js.map +1 -0
  202. package/dist/rest/namespaces/short-codes.d.ts +39 -0
  203. package/dist/rest/namespaces/short-codes.js +46 -0
  204. package/dist/rest/namespaces/short-codes.js.map +1 -0
  205. package/dist/rest/namespaces/sip-profile.d.ts +28 -0
  206. package/dist/rest/namespaces/sip-profile.js +34 -0
  207. package/dist/rest/namespaces/sip-profile.js.map +1 -0
  208. package/dist/rest/namespaces/verified-callers.d.ts +33 -0
  209. package/dist/rest/namespaces/verified-callers.js +39 -0
  210. package/dist/rest/namespaces/verified-callers.js.map +1 -0
  211. package/dist/rest/namespaces/video.d.ts +235 -0
  212. package/dist/rest/namespaces/video.js +297 -0
  213. package/dist/rest/namespaces/video.js.map +1 -0
  214. package/{src/rest/pagination.ts → dist/rest/pagination.d.ts} +2 -61
  215. package/dist/rest/pagination.js +78 -0
  216. package/dist/rest/pagination.js.map +1 -0
  217. package/dist/rest/types.d.ts +54 -0
  218. package/dist/rest/types.js +5 -0
  219. package/dist/rest/types.js.map +1 -0
  220. package/dist/skills/SkillBase.d.ts +404 -0
  221. package/dist/skills/SkillBase.js +471 -0
  222. package/dist/skills/SkillBase.js.map +1 -0
  223. package/dist/skills/SkillManager.d.ts +195 -0
  224. package/dist/skills/SkillManager.js +378 -0
  225. package/dist/skills/SkillManager.js.map +1 -0
  226. package/dist/skills/SkillRegistry.d.ts +176 -0
  227. package/dist/skills/SkillRegistry.js +310 -0
  228. package/dist/skills/SkillRegistry.js.map +1 -0
  229. package/dist/skills/builtin/api_ninjas_trivia.d.ts +47 -0
  230. package/dist/skills/builtin/api_ninjas_trivia.js +211 -0
  231. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -0
  232. package/dist/skills/builtin/ask_claude.d.ts +37 -0
  233. package/dist/skills/builtin/ask_claude.js +162 -0
  234. package/dist/skills/builtin/ask_claude.js.map +1 -0
  235. package/dist/skills/builtin/claude_skills.d.ts +75 -0
  236. package/dist/skills/builtin/claude_skills.js +753 -0
  237. package/dist/skills/builtin/claude_skills.js.map +1 -0
  238. package/dist/skills/builtin/custom_skills.d.ts +79 -0
  239. package/dist/skills/builtin/custom_skills.js +227 -0
  240. package/dist/skills/builtin/custom_skills.js.map +1 -0
  241. package/dist/skills/builtin/datasphere.d.ts +73 -0
  242. package/dist/skills/builtin/datasphere.js +350 -0
  243. package/dist/skills/builtin/datasphere.js.map +1 -0
  244. package/dist/skills/builtin/datasphere_serverless.d.ts +89 -0
  245. package/dist/skills/builtin/datasphere_serverless.js +291 -0
  246. package/dist/skills/builtin/datasphere_serverless.js.map +1 -0
  247. package/dist/skills/builtin/datetime.d.ts +40 -0
  248. package/dist/skills/builtin/datetime.js +118 -0
  249. package/dist/skills/builtin/datetime.js.map +1 -0
  250. package/dist/skills/builtin/google_maps.d.ts +48 -0
  251. package/dist/skills/builtin/google_maps.js +470 -0
  252. package/dist/skills/builtin/google_maps.js.map +1 -0
  253. package/dist/skills/builtin/index.d.ts +31 -0
  254. package/{src/skills/builtin/index.ts → dist/skills/builtin/index.js} +30 -36
  255. package/dist/skills/builtin/index.js.map +1 -0
  256. package/dist/skills/builtin/info_gatherer.d.ts +115 -0
  257. package/dist/skills/builtin/info_gatherer.js +328 -0
  258. package/dist/skills/builtin/info_gatherer.js.map +1 -0
  259. package/dist/skills/builtin/joke.d.ts +41 -0
  260. package/dist/skills/builtin/joke.js +156 -0
  261. package/dist/skills/builtin/joke.js.map +1 -0
  262. package/dist/skills/builtin/math.d.ts +39 -0
  263. package/dist/skills/builtin/math.js +119 -0
  264. package/dist/skills/builtin/math.js.map +1 -0
  265. package/dist/skills/builtin/mcp_gateway.d.ts +82 -0
  266. package/dist/skills/builtin/mcp_gateway.js +574 -0
  267. package/dist/skills/builtin/mcp_gateway.js.map +1 -0
  268. package/dist/skills/builtin/native_vector_search.d.ts +128 -0
  269. package/dist/skills/builtin/native_vector_search.js +752 -0
  270. package/dist/skills/builtin/native_vector_search.js.map +1 -0
  271. package/dist/skills/builtin/play_background_file.d.ts +59 -0
  272. package/dist/skills/builtin/play_background_file.js +274 -0
  273. package/dist/skills/builtin/play_background_file.js.map +1 -0
  274. package/dist/skills/builtin/spider.d.ts +91 -0
  275. package/dist/skills/builtin/spider.js +758 -0
  276. package/dist/skills/builtin/spider.js.map +1 -0
  277. package/dist/skills/builtin/swml_transfer.d.ts +66 -0
  278. package/dist/skills/builtin/swml_transfer.js +475 -0
  279. package/dist/skills/builtin/swml_transfer.js.map +1 -0
  280. package/dist/skills/builtin/weather_api.d.ts +59 -0
  281. package/dist/skills/builtin/weather_api.js +196 -0
  282. package/dist/skills/builtin/weather_api.js.map +1 -0
  283. package/dist/skills/builtin/web_search.d.ts +160 -0
  284. package/dist/skills/builtin/web_search.js +894 -0
  285. package/dist/skills/builtin/web_search.js.map +1 -0
  286. package/dist/skills/builtin/wikipedia_search.d.ts +77 -0
  287. package/dist/skills/builtin/wikipedia_search.js +241 -0
  288. package/dist/skills/builtin/wikipedia_search.js.map +1 -0
  289. package/{src/skills/index.ts → dist/skills/index.d.ts} +0 -1
  290. package/dist/skills/index.js +10 -0
  291. package/dist/skills/index.js.map +1 -0
  292. package/dist/types.d.ts +118 -0
  293. package/dist/types.js +5 -0
  294. package/dist/types.js.map +1 -0
  295. package/package.json +7 -1
  296. package/.github/workflows/publish.yml +0 -27
  297. package/.github/workflows/test.yml +0 -17
  298. package/CLAUDE.md +0 -112
  299. package/docs/MIGRATION-2.0.md +0 -81
  300. package/docs/agent-guide.md +0 -869
  301. package/docs/agent_guide.md +0 -1026
  302. package/docs/api-reference.md +0 -2420
  303. package/docs/api_reference.md +0 -1301
  304. package/docs/architecture.md +0 -843
  305. package/docs/cli-guide.md +0 -579
  306. package/docs/cli_guide.md +0 -448
  307. package/docs/cloud_functions_guide.md +0 -474
  308. package/docs/configuration.md +0 -422
  309. package/docs/contexts-guide.md +0 -787
  310. package/docs/contexts_guide.md +0 -511
  311. package/docs/datamap-guide.md +0 -1141
  312. package/docs/datamap_guide.md +0 -595
  313. package/docs/llm_parameters.md +0 -239
  314. package/docs/mcp_gateway_reference.md +0 -648
  315. package/docs/mcp_integration.md +0 -108
  316. package/docs/prefabs-guide.md +0 -800
  317. package/docs/sdk_features.md +0 -477
  318. package/docs/security.md +0 -436
  319. package/docs/serverless-guide.md +0 -513
  320. package/docs/skills-guide.md +0 -857
  321. package/docs/skills-system.md +0 -301
  322. package/docs/skills_parameter_schema.md +0 -392
  323. package/docs/skills_system.md +0 -467
  324. package/docs/swaig-reference.md +0 -1627
  325. package/docs/swaig_reference.md +0 -910
  326. package/docs/swml_service_guide.md +0 -600
  327. package/docs/third_party_skills.md +0 -533
  328. package/docs/web_service.md +0 -677
  329. package/examples/README.md +0 -131
  330. package/examples/advanced-datamap.ts +0 -100
  331. package/examples/advanced-dynamic-config.ts +0 -70
  332. package/examples/auto-vivified.ts +0 -94
  333. package/examples/call-flow.ts +0 -63
  334. package/examples/comprehensive-dynamic.ts +0 -125
  335. package/examples/contexts-steps.ts +0 -65
  336. package/examples/custom-path.ts +0 -45
  337. package/examples/datamap-tools.ts +0 -55
  338. package/examples/datasphere-multi-instance.ts +0 -63
  339. package/examples/datasphere-serverless-env.ts +0 -68
  340. package/examples/datasphere-webhook-env.ts +0 -66
  341. package/examples/datasphere.ts +0 -37
  342. package/examples/declarative.ts +0 -100
  343. package/examples/dynamic-config.ts +0 -54
  344. package/examples/dynamic-info-gatherer.ts +0 -69
  345. package/examples/dynamic-swml-service.ts +0 -67
  346. package/examples/gather-info.ts +0 -71
  347. package/examples/gather-per-question-functions-demo.ts +0 -140
  348. package/examples/joke-agent.ts +0 -34
  349. package/examples/kubernetes-agent.ts +0 -45
  350. package/examples/llm-params.ts +0 -69
  351. package/examples/mcp-agent.ts +0 -84
  352. package/examples/mcp-gateway.ts +0 -35
  353. package/examples/multi-agent.ts +0 -73
  354. package/examples/multi-endpoint.ts +0 -79
  355. package/examples/pom-prompt.ts +0 -71
  356. package/examples/prefab-concierge.ts +0 -47
  357. package/examples/prefab-faq.ts +0 -54
  358. package/examples/prefab-info-gatherer.ts +0 -33
  359. package/examples/prefab-receptionist.ts +0 -36
  360. package/examples/prefab-survey.ts +0 -68
  361. package/examples/record-call.ts +0 -67
  362. package/examples/relay-demo.ts +0 -33
  363. package/examples/room-and-sip.ts +0 -94
  364. package/examples/serverless-lambda.ts +0 -35
  365. package/examples/session-state.ts +0 -83
  366. package/examples/simple-agent.ts +0 -36
  367. package/examples/simple-static.ts +0 -29
  368. package/examples/skills-demo.ts +0 -38
  369. package/examples/step-function-inheritance-demo.ts +0 -124
  370. package/examples/swaig-features.ts +0 -187
  371. package/examples/swml-service-routing.ts +0 -66
  372. package/examples/swml-service.ts +0 -38
  373. package/examples/tap.ts +0 -68
  374. package/examples/verb-methods.ts +0 -45
  375. package/examples/web-search-multi-instance.ts +0 -72
  376. package/examples/web-search.ts +0 -38
  377. package/examples/wikipedia.ts +0 -36
  378. package/livewire/README.md +0 -140
  379. package/livewire/docs/migration-guide.md +0 -228
  380. package/livewire/examples/livewire-basic-agent.ts +0 -74
  381. package/livewire/examples/livewire-handoff.ts +0 -197
  382. package/livewire/examples/livewire-multi-tool.ts +0 -117
  383. package/relay/README.md +0 -70
  384. package/relay/RELAY_IMPLEMENTATION_GUIDE.md +0 -1257
  385. package/relay/docs/call-methods.md +0 -474
  386. package/relay/docs/client-reference.md +0 -142
  387. package/relay/docs/events.md +0 -134
  388. package/relay/docs/getting-started.md +0 -134
  389. package/relay/docs/guide.md +0 -306
  390. package/relay/docs/messaging.md +0 -182
  391. package/relay/examples/relay-inbound.ts +0 -66
  392. package/relay/examples/relay-messaging.ts +0 -71
  393. package/relay/examples/relay-outbound.ts +0 -76
  394. package/rest/README.md +0 -95
  395. package/rest/docs/calling.md +0 -273
  396. package/rest/docs/client-reference.md +0 -107
  397. package/rest/docs/compat.md +0 -204
  398. package/rest/docs/fabric.md +0 -183
  399. package/rest/docs/getting-started.md +0 -110
  400. package/rest/docs/guide.md +0 -351
  401. package/rest/docs/namespaces.md +0 -285
  402. package/rest/examples/rest-10dlc-registration.ts +0 -161
  403. package/rest/examples/rest-calling-ivr-and-ai.ts +0 -102
  404. package/rest/examples/rest-calling-play-and-record.ts +0 -91
  405. package/rest/examples/rest-client.ts +0 -65
  406. package/rest/examples/rest-compat-laml.ts +0 -210
  407. package/rest/examples/rest-datasphere-search.ts +0 -82
  408. package/rest/examples/rest-fabric-conferences-and-routing.ts +0 -144
  409. package/rest/examples/rest-fabric-subscribers-and-sip.ts +0 -108
  410. package/rest/examples/rest-fabric-swml-and-callflows.ts +0 -99
  411. package/rest/examples/rest-manage-resources.ts +0 -65
  412. package/rest/examples/rest-phone-number-management.ts +0 -197
  413. package/rest/examples/rest-queues-mfa-and-recordings.ts +0 -143
  414. package/rest/examples/rest-video-rooms.ts +0 -186
  415. package/src/AgentBase.ts +0 -2598
  416. package/src/AgentServer.ts +0 -442
  417. package/src/AuthHandler.ts +0 -256
  418. package/src/ConfigLoader.ts +0 -447
  419. package/src/ContextBuilder.ts +0 -1181
  420. package/src/DataMap.ts +0 -477
  421. package/src/FunctionResult.ts +0 -903
  422. package/src/Logger.ts +0 -337
  423. package/src/PomBuilder.ts +0 -467
  424. package/src/PromptManager.ts +0 -133
  425. package/src/SWMLHandler.ts +0 -298
  426. package/src/SWMLService.ts +0 -749
  427. package/src/SchemaUtils.ts +0 -361
  428. package/src/ServerlessAdapter.ts +0 -240
  429. package/src/SessionManager.ts +0 -311
  430. package/src/SslConfig.ts +0 -118
  431. package/src/SwaigFunction.ts +0 -276
  432. package/src/SwmlBuilder.ts +0 -283
  433. package/src/SwmlVerbMethods.generated.ts +0 -234
  434. package/src/TypeInference.ts +0 -199
  435. package/src/WebService.ts +0 -641
  436. package/src/cli/agent-loader.ts +0 -166
  437. package/src/cli/mock-data.ts +0 -111
  438. package/src/cli/swaig-test.ts +0 -452
  439. package/src/generateVerbTypes.ts +0 -322
  440. package/src/livewire/index.ts +0 -1252
  441. package/src/prefabs/ConciergeAgent.ts +0 -309
  442. package/src/prefabs/FAQBotAgent.ts +0 -415
  443. package/src/prefabs/InfoGathererAgent.ts +0 -379
  444. package/src/prefabs/ReceptionistAgent.ts +0 -395
  445. package/src/prefabs/SurveyAgent.ts +0 -671
  446. package/src/relay/Action.ts +0 -482
  447. package/src/relay/Call.ts +0 -1270
  448. package/src/relay/Deferred.ts +0 -94
  449. package/src/relay/Message.ts +0 -199
  450. package/src/relay/RelayClient.ts +0 -1185
  451. package/src/relay/RelayError.ts +0 -20
  452. package/src/relay/RelayEvent.ts +0 -944
  453. package/src/relay/index.ts +0 -123
  454. package/src/relay/types.ts +0 -149
  455. package/src/rest/HttpClient.ts +0 -164
  456. package/src/rest/RestError.ts +0 -45
  457. package/src/rest/base/BaseResource.ts +0 -32
  458. package/src/rest/base/CrudResource.ts +0 -98
  459. package/src/rest/base/CrudWithAddresses.ts +0 -37
  460. package/src/rest/namespaces/addresses.ts +0 -64
  461. package/src/rest/namespaces/calling.ts +0 -534
  462. package/src/rest/namespaces/chat.ts +0 -31
  463. package/src/rest/namespaces/compat.ts +0 -812
  464. package/src/rest/namespaces/datasphere.ts +0 -88
  465. package/src/rest/namespaces/fabric.ts +0 -417
  466. package/src/rest/namespaces/imported-numbers.ts +0 -31
  467. package/src/rest/namespaces/logs.ts +0 -151
  468. package/src/rest/namespaces/lookup.ts +0 -38
  469. package/src/rest/namespaces/mfa.ts +0 -61
  470. package/src/rest/namespaces/number-groups.ts +0 -68
  471. package/src/rest/namespaces/phone-numbers.ts +0 -76
  472. package/src/rest/namespaces/project.ts +0 -65
  473. package/src/rest/namespaces/pubsub.ts +0 -31
  474. package/src/rest/namespaces/queues.ts +0 -58
  475. package/src/rest/namespaces/recordings.ts +0 -53
  476. package/src/rest/namespaces/registry.ts +0 -200
  477. package/src/rest/namespaces/short-codes.ts +0 -54
  478. package/src/rest/namespaces/sip-profile.ts +0 -40
  479. package/src/rest/namespaces/verified-callers.ts +0 -46
  480. package/src/rest/namespaces/video.ts +0 -332
  481. package/src/rest/types.ts +0 -61
  482. package/src/skills/SkillBase.ts +0 -582
  483. package/src/skills/SkillManager.ts +0 -419
  484. package/src/skills/SkillRegistry.ts +0 -367
  485. package/src/skills/builtin/api_ninjas_trivia.ts +0 -285
  486. package/src/skills/builtin/ask_claude.ts +0 -246
  487. package/src/skills/builtin/claude_skills.ts +0 -983
  488. package/src/skills/builtin/custom_skills.ts +0 -327
  489. package/src/skills/builtin/datasphere.ts +0 -447
  490. package/src/skills/builtin/datasphere_serverless.ts +0 -347
  491. package/src/skills/builtin/datetime.ts +0 -137
  492. package/src/skills/builtin/google_maps.ts +0 -656
  493. package/src/skills/builtin/info_gatherer.ts +0 -415
  494. package/src/skills/builtin/joke.ts +0 -196
  495. package/src/skills/builtin/math.ts +0 -149
  496. package/src/skills/builtin/mcp_gateway.ts +0 -685
  497. package/src/skills/builtin/native_vector_search.ts +0 -910
  498. package/src/skills/builtin/play_background_file.ts +0 -367
  499. package/src/skills/builtin/spider.ts +0 -874
  500. package/src/skills/builtin/swml_transfer.ts +0 -645
  501. package/src/skills/builtin/weather_api.ts +0 -255
  502. package/src/skills/builtin/web_search.ts +0 -1083
  503. package/src/skills/builtin/wikipedia_search.ts +0 -304
  504. package/src/types.ts +0 -132
  505. package/tests/AgentBase.test.ts +0 -1093
  506. package/tests/AgentServer.test.ts +0 -126
  507. package/tests/AuthHandler.test.ts +0 -133
  508. package/tests/ConfigLoader.test.ts +0 -151
  509. package/tests/ContextBuilder.test.ts +0 -108
  510. package/tests/DataMap.test.ts +0 -367
  511. package/tests/EphemeralSkillCopy.test.ts +0 -107
  512. package/tests/FunctionResult.test.ts +0 -298
  513. package/tests/GracefulShutdown.test.ts +0 -46
  514. package/tests/Logger.test.ts +0 -420
  515. package/tests/PomBuilder.test.ts +0 -228
  516. package/tests/ProxyDetection.test.ts +0 -228
  517. package/tests/SWMLService.test.ts +0 -320
  518. package/tests/SWMLVerbHandler.test.ts +0 -523
  519. package/tests/SchemaUtils.test.ts +0 -106
  520. package/tests/SchemaUtils.verb.test.ts +0 -206
  521. package/tests/SecurityUtils.test.ts +0 -192
  522. package/tests/ServerlessAdapter.test.ts +0 -222
  523. package/tests/SessionManager.test.ts +0 -257
  524. package/tests/SkillBaseFeatures.test.ts +0 -130
  525. package/tests/SkillMultiInstance.test.ts +0 -102
  526. package/tests/SkillParameterSchemas.test.ts +0 -134
  527. package/tests/SkillRegistrySchema.test.ts +0 -84
  528. package/tests/SslConfig.test.ts +0 -97
  529. package/tests/SwmlBuilder.test.ts +0 -400
  530. package/tests/TypeInference.test.ts +0 -165
  531. package/tests/VerbHandlerRegistry.test.ts +0 -128
  532. package/tests/cli/mock-data.test.ts +0 -113
  533. package/tests/cli/swaig-test.test.ts +0 -108
  534. package/tests/examples.test.ts +0 -194
  535. package/tests/fixtures/scrape-parity/README.md +0 -53
  536. package/tests/fixtures/scrape-parity/expected/01_simple_article.json +0 -5
  537. package/tests/fixtures/scrape-parity/expected/02_class_based_noise.json +0 -5
  538. package/tests/fixtures/scrape-parity/expected/03_nested_containers.json +0 -5
  539. package/tests/fixtures/scrape-parity/expected/04_bare_body.json +0 -5
  540. package/tests/fixtures/scrape-parity/expected/05_malformed.json +0 -5
  541. package/tests/fixtures/scrape-parity/expected/06_multi_class.json +0 -5
  542. package/tests/fixtures/scrape-parity/expected/07_anchor_pattern.json +0 -5
  543. package/tests/fixtures/scrape-parity/expected/08_inline_script.json +0 -5
  544. package/tests/fixtures/scrape-parity/expected/09_whitespace_nbsp.json +0 -5
  545. package/tests/fixtures/scrape-parity/expected/10_entity_unicode.json +0 -5
  546. package/tests/fixtures/scrape-parity/expected/11_cdata_comments.json +0 -5
  547. package/tests/fixtures/scrape-parity/expected/12_deep_nested_removals.json +0 -5
  548. package/tests/fixtures/scrape-parity/html/01_simple_article.html +0 -18
  549. package/tests/fixtures/scrape-parity/html/02_class_based_noise.html +0 -18
  550. package/tests/fixtures/scrape-parity/html/03_nested_containers.html +0 -13
  551. package/tests/fixtures/scrape-parity/html/04_bare_body.html +0 -9
  552. package/tests/fixtures/scrape-parity/html/05_malformed.html +0 -11
  553. package/tests/fixtures/scrape-parity/html/06_multi_class.html +0 -18
  554. package/tests/fixtures/scrape-parity/html/07_anchor_pattern.html +0 -12
  555. package/tests/fixtures/scrape-parity/html/08_inline_script.html +0 -17
  556. package/tests/fixtures/scrape-parity/html/09_whitespace_nbsp.html +0 -21
  557. package/tests/fixtures/scrape-parity/html/10_entity_unicode.html +0 -10
  558. package/tests/fixtures/scrape-parity/html/11_cdata_comments.html +0 -13
  559. package/tests/fixtures/scrape-parity/html/12_deep_nested_removals.html +0 -24
  560. package/tests/fixtures/scrape-parity/python_extract.py +0 -109
  561. package/tests/livewire/livewire.test.ts +0 -780
  562. package/tests/mcp.test.ts +0 -221
  563. package/tests/prefabs/prefabs.test.ts +0 -1093
  564. package/tests/relay/Action.test.ts +0 -392
  565. package/tests/relay/Call.test.ts +0 -535
  566. package/tests/relay/Deferred.test.ts +0 -71
  567. package/tests/relay/Message.test.ts +0 -164
  568. package/tests/relay/RelayClient.test.ts +0 -779
  569. package/tests/relay/RelayEvent.test.ts +0 -463
  570. package/tests/relay/helpers.ts +0 -79
  571. package/tests/rest/HttpClient.test.ts +0 -274
  572. package/tests/rest/RestError.test.ts +0 -53
  573. package/tests/rest/calling.test.ts +0 -156
  574. package/tests/rest/client.test.ts +0 -197
  575. package/tests/rest/compat.test.ts +0 -335
  576. package/tests/rest/datasphere.test.ts +0 -71
  577. package/tests/rest/fabric.test.ts +0 -186
  578. package/tests/rest/helpers.ts +0 -95
  579. package/tests/rest/logs.test.ts +0 -68
  580. package/tests/rest/pagination.test.ts +0 -133
  581. package/tests/rest/registry.test.ts +0 -94
  582. package/tests/rest/relay-rest.test.ts +0 -290
  583. package/tests/rest/video.test.ts +0 -173
  584. package/tests/setup.ts +0 -6
  585. package/tests/skills/SkillBase.test.ts +0 -108
  586. package/tests/skills/SkillManager.test.ts +0 -268
  587. package/tests/skills/SkillRegistry.test.ts +0 -176
  588. package/tests/skills/builtin.test.ts +0 -1472
  589. package/tests/skills/claude-skills.test.ts +0 -54
  590. package/tests/skills/custom-skills.test.ts +0 -53
  591. package/tests/skills/datasphere-serverless.test.ts +0 -70
  592. package/tests/skills/datasphere.test.ts +0 -107
  593. package/tests/skills/datetime.test.ts +0 -101
  594. package/tests/skills/google-maps.test.ts +0 -78
  595. package/tests/skills/info-gatherer.test.ts +0 -411
  596. package/tests/skills/joke.test.ts +0 -81
  597. package/tests/skills/math.test.ts +0 -68
  598. package/tests/skills/mcp-gateway.test.ts +0 -101
  599. package/tests/skills/play-background.test.ts +0 -54
  600. package/tests/skills/spider.test.ts +0 -108
  601. package/tests/skills/swml-transfer.test.ts +0 -178
  602. package/tests/skills/trivia.test.ts +0 -54
  603. package/tests/skills/vector-search.test.ts +0 -135
  604. package/tests/skills/weather-api.test.ts +0 -77
  605. package/tests/skills/web-search-parity.test.ts +0 -59
  606. package/tests/skills/web-search.test.ts +0 -103
  607. package/tests/skills/wikipedia.test.ts +0 -63
  608. package/tsconfig.json +0 -18
  609. package/vitest.config.ts +0 -9
  610. /package/{src → dist}/schema.json +0 -0
@@ -0,0 +1,329 @@
1
+ /**
2
+ * FAQBotAgent - A prefab agent that answers frequently asked questions using
3
+ * keyword/word-overlap matching with configurable similarity thresholds
4
+ * and optional escalation to a live agent.
5
+ *
6
+ * Ported from the Python SDK `signalwire.prefabs.faq_bot.FAQBotAgent`. Keeps
7
+ * TS-specific enhancements (configurable similarity threshold, word-overlap
8
+ * matcher, escalation tool) alongside the Python prefab's public surface.
9
+ */
10
+ import { AgentBase } from '../AgentBase.js';
11
+ import { FunctionResult } from '../FunctionResult.js';
12
+ // ── Agent ───────────────────────────────────────────────────────────────────
13
+ /**
14
+ * Prefab agent that answers frequently asked questions using keyword matching with optional escalation to a live agent.
15
+ *
16
+ * Pass an array of `{ question, answer, keywords }` entries and the agent will
17
+ * fuzzy-match inbound utterances against them. If no match crosses the confidence
18
+ * threshold, the call can optionally escalate to a configured phone number.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * import { FAQBotAgent } from '@signalwire/sdk';
23
+ *
24
+ * const agent = new FAQBotAgent({
25
+ * faqs: [
26
+ * {
27
+ * question: 'What are your business hours?',
28
+ * answer: "We're open 9 AM to 5 PM Pacific, Monday through Friday.",
29
+ * keywords: ['hours', 'open', 'closed', 'time'],
30
+ * },
31
+ * {
32
+ * question: 'Where are you located?',
33
+ * answer: 'Our headquarters are in San Francisco, California.',
34
+ * keywords: ['location', 'address', 'office'],
35
+ * },
36
+ * ],
37
+ * escalationNumber: '+15551234567',
38
+ * });
39
+ *
40
+ * await agent.serve({ port: 3000 });
41
+ * ```
42
+ */
43
+ export class FAQBotAgent extends AgentBase {
44
+ /** The configured FAQ entries. */
45
+ faqs;
46
+ /** Whether runner-up FAQ suggestions are appended to matches. */
47
+ suggestRelated;
48
+ /** The personality description used in the prompt. */
49
+ persona;
50
+ threshold;
51
+ escalationMessage;
52
+ escalationNumber;
53
+ /**
54
+ * Create a FAQBotAgent with the specified FAQ entries and matching threshold.
55
+ * @param config - Configuration including FAQ entries, threshold, and escalation settings.
56
+ */
57
+ constructor(config) {
58
+ const agentName = config.name ?? 'faq_bot';
59
+ super({
60
+ name: agentName,
61
+ route: config.route ?? '/faq',
62
+ usePom: true,
63
+ ...config.agentOptions,
64
+ });
65
+ this.faqs = config.faqs;
66
+ this.suggestRelated = config.suggestRelated ?? true;
67
+ this.persona =
68
+ config.persona ??
69
+ 'You are a helpful FAQ bot that provides accurate answers to common questions.';
70
+ this.threshold = config.threshold ?? 0.5;
71
+ this.escalationMessage =
72
+ config.escalationMessage ??
73
+ "I'm sorry, I couldn't find an answer to your question. Let me transfer you to someone who can help.";
74
+ this.escalationNumber = config.escalationNumber ?? null;
75
+ this.buildPrompt();
76
+ this.configureAgentSettings();
77
+ // Register tools after all fields are initialized
78
+ this.defineTools();
79
+ }
80
+ // ── Prompt construction (mirrors Python _build_faq_bot_prompt) ────────
81
+ buildPrompt() {
82
+ // Personality
83
+ this.promptAddSection('Personality', { body: this.persona });
84
+ // Goal
85
+ this.promptAddSection('Goal', {
86
+ body: 'Answer user questions by matching them to the most similar FAQ in your database.',
87
+ });
88
+ // Instructions
89
+ const instructions = [
90
+ 'Compare user questions to your FAQ database and find the best match.',
91
+ 'Provide the answer from the FAQ database for the matching question.',
92
+ 'If no close match exists, politely say you don\'t have that information.',
93
+ 'Be concise and factual in your responses.',
94
+ ];
95
+ if (this.suggestRelated) {
96
+ instructions.push('When appropriate, suggest other related questions from the FAQ database that might be helpful.');
97
+ }
98
+ this.promptAddSection('Instructions', { bullets: instructions });
99
+ // FAQ Database (each FAQ as a subsection with optional categories line)
100
+ const faqSubsections = this.faqs
101
+ .filter((faq) => faq.question && faq.answer)
102
+ .map((faq) => {
103
+ let body = faq.answer;
104
+ if (faq.categories && faq.categories.length > 0) {
105
+ body = `${body}\n\nCategories: ${faq.categories.join(', ')}`;
106
+ }
107
+ return { title: faq.question, body };
108
+ });
109
+ this.promptAddSection('FAQ Database', {
110
+ body: 'Here is your database of frequently asked questions and answers:',
111
+ subsections: faqSubsections,
112
+ });
113
+ if (this.suggestRelated) {
114
+ this.promptAddSection('Related Questions', {
115
+ body: 'When appropriate, suggest other related questions from the FAQ database that might be helpful.',
116
+ });
117
+ }
118
+ }
119
+ // ── Agent settings (mirrors Python _configure_agent_settings + _setup_post_prompt) ─
120
+ configureAgentSettings() {
121
+ // Post-prompt summary template
122
+ this.setPostPrompt(`
123
+ Return a JSON summary of this interaction:
124
+ {
125
+ "question": "MAIN_QUESTION_ASKED",
126
+ "matched_faq": "MATCHED_FAQ_QUESTION_OR_null",
127
+ "answered_successfully": true/false,
128
+ "suggested_related": []
129
+ }
130
+ `);
131
+ // Hints: 4+ char question words, FAQ keywords, and categories
132
+ const hints = [];
133
+ for (const faq of this.faqs) {
134
+ const question = faq.question ?? '';
135
+ if (question) {
136
+ const words = question
137
+ .split(/\s+/)
138
+ .map((w) => w.replace(/^[.,?!]+|[.,?!]+$/g, ''))
139
+ .filter((w) => w.length >= 4);
140
+ hints.push(...words);
141
+ }
142
+ if (faq.keywords)
143
+ hints.push(...faq.keywords);
144
+ if (faq.categories)
145
+ hints.push(...faq.categories);
146
+ }
147
+ const unique = Array.from(new Set(hints));
148
+ if (unique.length > 0)
149
+ this.addHints(unique);
150
+ // AI behavior parameters
151
+ this.setParams({
152
+ wait_for_user: false,
153
+ end_of_speech_timeout: 1000,
154
+ ai_volume: 5,
155
+ });
156
+ // Global data: faq count and categories
157
+ const categories = Array.from(new Set(this.faqs.flatMap((faq) => faq.categories ?? [])));
158
+ this.setGlobalData({
159
+ faq_count: this.faqs.length,
160
+ categories,
161
+ });
162
+ // Native functions
163
+ this.setNativeFunctions(['check_time']);
164
+ }
165
+ // ── Matching engine ───────────────────────────────────────────────────
166
+ /**
167
+ * Compute a word-overlap similarity score between a query and an FAQ entry.
168
+ * Combines question text similarity and keyword overlap.
169
+ * Returns a value between 0 and 1.
170
+ */
171
+ computeMatchScore(query, faq) {
172
+ const queryWords = this.tokenize(query);
173
+ if (queryWords.length === 0)
174
+ return 0;
175
+ // Score against the question text
176
+ const questionWords = this.tokenize(faq.question);
177
+ const questionOverlap = this.wordOverlap(queryWords, questionWords);
178
+ // Score against keywords
179
+ let keywordScore = 0;
180
+ if (faq.keywords && faq.keywords.length > 0) {
181
+ const keywordTokens = faq.keywords.map((k) => k.toLowerCase().trim());
182
+ const queryLower = query.toLowerCase();
183
+ let keywordHits = 0;
184
+ for (const kw of keywordTokens) {
185
+ if (queryLower.includes(kw)) {
186
+ keywordHits++;
187
+ }
188
+ }
189
+ keywordScore = keywordTokens.length > 0 ? keywordHits / keywordTokens.length : 0;
190
+ }
191
+ // Weighted combination: 60% question overlap, 40% keyword score
192
+ return faq.keywords && faq.keywords.length > 0
193
+ ? questionOverlap * 0.6 + keywordScore * 0.4
194
+ : questionOverlap;
195
+ }
196
+ tokenize(text) {
197
+ return text
198
+ .toLowerCase()
199
+ .replace(/[^a-z0-9\s]/g, ' ')
200
+ .split(/\s+/)
201
+ .filter((w) => w.length > 1 && !STOP_WORDS.has(w));
202
+ }
203
+ wordOverlap(queryWords, targetWords) {
204
+ if (queryWords.length === 0 || targetWords.length === 0)
205
+ return 0;
206
+ const targetSet = new Set(targetWords);
207
+ let matches = 0;
208
+ for (const word of queryWords) {
209
+ if (targetSet.has(word))
210
+ matches++;
211
+ }
212
+ // Normalize by the smaller set to be lenient
213
+ const divisor = Math.min(queryWords.length, targetWords.length);
214
+ return divisor > 0 ? matches / divisor : 0;
215
+ }
216
+ // ── Tool registration ─────────────────────────────────────────────────
217
+ /** Register the search_faqs and optional escalate SWAIG tools. */
218
+ defineTools() {
219
+ // Tool: search_faqs (matches Python name; supports optional category filter)
220
+ this.defineTool({
221
+ name: 'search_faqs',
222
+ description: 'Search for FAQs matching a specific query or category',
223
+ parameters: {
224
+ type: 'object',
225
+ properties: {
226
+ query: {
227
+ type: 'string',
228
+ description: 'The search query',
229
+ },
230
+ category: {
231
+ type: 'string',
232
+ description: 'Optional category to filter by',
233
+ },
234
+ },
235
+ },
236
+ handler: (args) => {
237
+ const query = args['query'] ?? '';
238
+ const category = (args['category'] ?? '').toLowerCase().trim();
239
+ if (!query) {
240
+ return new FunctionResult('A query is required to search the FAQ.');
241
+ }
242
+ // Optionally filter by category
243
+ const pool = category
244
+ ? this.faqs.filter((faq) => (faq.categories ?? []).some((c) => c.toLowerCase().trim() === category))
245
+ : this.faqs;
246
+ if (pool.length === 0) {
247
+ return new FunctionResult('No matching FAQs found.');
248
+ }
249
+ // Score all FAQs in the (possibly filtered) pool
250
+ const scored = pool
251
+ .map((faq) => ({ faq, score: this.computeMatchScore(query, faq) }))
252
+ .filter((s) => s.score >= this.threshold)
253
+ .sort((a, b) => b.score - a.score);
254
+ if (scored.length === 0) {
255
+ return new FunctionResult('No matching FAQs found.');
256
+ }
257
+ // Match Python's response format: a numbered list of the top 3 matches'
258
+ // question text (faq_bot.py:276-283). The answer text is supplied to
259
+ // the AI via the prompt's "FAQ Database" section — the tool just
260
+ // indicates which FAQs matched. The `suggest_related` flag does not
261
+ // change the top-N here; it only toggles the prompt's "Related
262
+ // Questions" section and the extra instruction bullet (Python parity).
263
+ const top = scored.slice(0, 3);
264
+ const lines = top.map((s, i) => `${i + 1}. ${s.faq.question}`).join('\n');
265
+ return new FunctionResult(`Here are the most relevant FAQs:\n\n${lines}\n`);
266
+ },
267
+ });
268
+ // Tool: escalate (only if escalation number is configured)
269
+ if (this.escalationNumber) {
270
+ this.defineTool({
271
+ name: 'escalate',
272
+ description: 'Transfer the caller to a live agent when the FAQ knowledge base cannot answer their question.',
273
+ parameters: {
274
+ type: 'object',
275
+ properties: {
276
+ reason: {
277
+ type: 'string',
278
+ description: 'The reason for escalation.',
279
+ },
280
+ },
281
+ },
282
+ handler: (_args) => {
283
+ const reason = _args['reason'] || 'Caller needs assistance beyond FAQ';
284
+ const result = new FunctionResult(`${this.escalationMessage} Transferring caller to a live agent. Reason: ${reason}`);
285
+ result.connect(this.escalationNumber);
286
+ return result;
287
+ },
288
+ });
289
+ }
290
+ }
291
+ // ── Lifecycle hooks ───────────────────────────────────────────────────
292
+ /**
293
+ * Process the interaction summary returned at the end of a call.
294
+ * Logs structured summaries as JSON. Subclasses may override to persist or process.
295
+ */
296
+ onSummary(summary, _rawData) {
297
+ if (summary) {
298
+ try {
299
+ // eslint-disable-next-line no-console
300
+ console.log(`FAQ interaction summary: ${JSON.stringify(summary, null, 2)}`);
301
+ }
302
+ catch (err) {
303
+ // eslint-disable-next-line no-console
304
+ console.log(`Error processing summary: ${String(err)}`);
305
+ }
306
+ }
307
+ }
308
+ }
309
+ // ── Common English stop words filtered from matching ────────────────────────
310
+ const STOP_WORDS = new Set([
311
+ 'a', 'an', 'the', 'is', 'it', 'to', 'in', 'of', 'and', 'or', 'for',
312
+ 'on', 'at', 'by', 'do', 'if', 'my', 'so', 'up', 'am', 'as', 'be',
313
+ 'he', 'me', 'we', 'no', 'not', 'are', 'was', 'has', 'had', 'how',
314
+ 'its', 'can', 'did', 'get', 'but', 'you', 'her', 'him', 'his', 'she',
315
+ 'our', 'who', 'this', 'that', 'what', 'with', 'have', 'from', 'will',
316
+ 'your', 'they', 'them', 'been', 'does', 'just', 'than', 'when', 'which',
317
+ 'would', 'could', 'should', 'about', 'their', 'there', 'these', 'those',
318
+ ]);
319
+ // ── Factory function ────────────────────────────────────────────────────────
320
+ /**
321
+ * Factory function that creates and returns a new FAQBotAgent.
322
+ * @param config - Configuration for the FAQ bot agent.
323
+ * @returns A configured FAQBotAgent instance.
324
+ */
325
+ export function createFAQBotAgent(config) {
326
+ return new FAQBotAgent(config);
327
+ }
328
+ export default FAQBotAgent;
329
+ //# sourceMappingURL=FAQBotAgent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"FAQBotAgent.js","sourceRoot":"","sources":["../../src/prefabs/FAQBotAgent.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAuCtD,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAS;IACxC,kCAAkC;IAC3B,IAAI,CAAa;IACxB,iEAAiE;IAC1D,cAAc,CAAU;IAC/B,sDAAsD;IAC/C,OAAO,CAAS;IACf,SAAS,CAAS;IAClB,iBAAiB,CAAS;IAC1B,gBAAgB,CAAgB;IAExC;;;OAGG;IACH,YAAY,MAAoB;QAC9B,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,IAAI,SAAS,CAAC;QAC3C,KAAK,CAAC;YACJ,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,MAAM;YAC7B,MAAM,EAAE,IAAI;YACZ,GAAG,MAAM,CAAC,YAAY;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC;QACpD,IAAI,CAAC,OAAO;YACV,MAAM,CAAC,OAAO;gBACd,+EAA+E,CAAC;QAClF,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,GAAG,CAAC;QACzC,IAAI,CAAC,iBAAiB;YACpB,MAAM,CAAC,iBAAiB;gBACxB,qGAAqG,CAAC;QACxG,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,IAAI,CAAC;QAExD,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,kDAAkD;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,yEAAyE;IAEjE,WAAW;QACjB,cAAc;QACd,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAE7D,OAAO;QACP,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAC5B,IAAI,EACF,kFAAkF;SACrF,CAAC,CAAC;QAEH,eAAe;QACf,MAAM,YAAY,GAAG;YACnB,sEAAsE;YACtE,qEAAqE;YACrE,0EAA0E;YAC1E,2CAA2C;SAC5C,CAAC;QACF,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,YAAY,CAAC,IAAI,CACf,gGAAgG,CACjG,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;QAEjE,wEAAwE;QACxE,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI;aAC7B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,MAAM,CAAC;aAC3C,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACX,IAAI,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC;YACtB,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChD,IAAI,GAAG,GAAG,IAAI,mBAAmB,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/D,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;QACvC,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE;YACpC,IAAI,EAAE,kEAAkE;YACxE,WAAW,EAAE,cAAc;SAC5B,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,EAAE;gBACzC,IAAI,EACF,gGAAgG;aACnG,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,sFAAsF;IAE9E,sBAAsB;QAC5B,+BAA+B;QAC/B,IAAI,CAAC,aAAa,CAAC;;;;;;;;SAQd,CAAC,CAAC;QAEP,8DAA8D;QAC9D,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC;YACpC,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,KAAK,GAAG,QAAQ;qBACnB,KAAK,CAAC,KAAK,CAAC;qBACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;qBAC/C,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;gBAChC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;YACvB,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC9C,IAAI,GAAG,CAAC,UAAU;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAE7C,yBAAyB;QACzB,IAAI,CAAC,SAAS,CAAC;YACb,aAAa,EAAE,KAAK;YACpB,qBAAqB,EAAE,IAAI;YAC3B,SAAS,EAAE,CAAC;SACb,CAAC,CAAC;QAEH,wCAAwC;QACxC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAC3B,IAAI,GAAG,CACL,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CACjD,CACF,CAAC;QACF,IAAI,CAAC,aAAa,CAAC;YACjB,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;YAC3B,UAAU;SACX,CAAC,CAAC;QAEH,mBAAmB;QACnB,IAAI,CAAC,kBAAkB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IAC1C,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,kEAAkE;IAC/C,WAAW;QAC5B,6EAA6E;QAC7E,IAAI,CAAC,UAAU,CAAC;YACd,IAAI,EAAE,aAAa;YACnB,WAAW,EAAE,uDAAuD;YACpE,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,kBAAkB;qBAChC;oBACD,QAAQ,EAAE;wBACR,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,gCAAgC;qBAC9C;iBACF;aACF;YACD,OAAO,EAAE,CAAC,IAA6B,EAAE,EAAE;gBACzC,MAAM,KAAK,GAAI,IAAI,CAAC,OAAO,CAAY,IAAI,EAAE,CAAC;gBAC9C,MAAM,QAAQ,GAAG,CAAE,IAAI,CAAC,UAAU,CAAY,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;gBAC3E,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,IAAI,cAAc,CAAC,wCAAwC,CAAC,CAAC;gBACtE,CAAC;gBAED,gCAAgC;gBAChC,MAAM,IAAI,GAAG,QAAQ;oBACnB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CACd,CAAC,GAAG,EAAE,EAAE,CACN,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,CAC1E;oBACH,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;gBAEd,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACtB,OAAO,IAAI,cAAc,CAAC,yBAAyB,CAAC,CAAC;gBACvD,CAAC;gBAED,iDAAiD;gBACjD,MAAM,MAAM,GAAG,IAAI;qBAChB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;qBAClE,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC;qBACxC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;gBAErC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACxB,OAAO,IAAI,cAAc,CAAC,yBAAyB,CAAC,CAAC;gBACvD,CAAC;gBAED,wEAAwE;gBACxE,qEAAqE;gBACrE,iEAAiE;gBACjE,oEAAoE;gBACpE,+DAA+D;gBAC/D,uEAAuE;gBACvE,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC/B,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1E,OAAO,IAAI,cAAc,CAAC,uCAAuC,KAAK,IAAI,CAAC,CAAC;YAC9E,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,cAAc,CAC/B,GAAG,IAAI,CAAC,iBAAiB,iDAAiD,MAAM,EAAE,CACnF,CAAC;oBACF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAiB,CAAC,CAAC;oBACvC,OAAO,MAAM,CAAC;gBAChB,CAAC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,yEAAyE;IAEzE;;;OAGG;IACM,SAAS,CAChB,OAAuC,EACvC,QAAiC;QAEjC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC;gBACH,sCAAsC;gBACtC,OAAO,CAAC,GAAG,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;YAC9E,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,sCAAsC;gBACtC,OAAO,CAAC,GAAG,CAAC,6BAA6B,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED,+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"}
@@ -0,0 +1,126 @@
1
+ /**
2
+ * InfoGathererAgent - Prefab agent for collecting answers to a series of
3
+ * questions.
4
+ *
5
+ * Ported from the Python SDK `signalwire.prefabs.info_gatherer.InfoGathererAgent`.
6
+ * Supports both static (questions provided at init) and dynamic (questions
7
+ * determined by a callback function per request) configuration modes.
8
+ */
9
+ import { AgentBase } from '../AgentBase.js';
10
+ import type { AgentOptions } from '../types.js';
11
+ /** A single question in the information-gathering flow. */
12
+ export interface InfoGathererQuestion {
13
+ /** Identifier used as the key when storing the caller's answer. */
14
+ key_name: string;
15
+ /** The question text to ask the caller. */
16
+ question_text: string;
17
+ /** When true, the agent insists the caller confirms before submitting. */
18
+ confirm?: boolean;
19
+ }
20
+ /**
21
+ * Callback invoked on each incoming SWML request to produce the list of
22
+ * questions for that request. Mirrors Python's `set_question_callback`.
23
+ * @returns a list of questions (may be async).
24
+ */
25
+ export type InfoGathererQuestionCallback = (queryParams: Record<string, string>, bodyParams: Record<string, unknown>, headers: Record<string, string>) => InfoGathererQuestion[] | Promise<InfoGathererQuestion[]>;
26
+ /** Configuration for the InfoGathererAgent. */
27
+ export interface InfoGathererConfig {
28
+ /**
29
+ * Optional list of questions to ask. When omitted, the agent runs in
30
+ * dynamic mode and resolves questions via the callback registered with
31
+ * `setQuestionCallback()` (or via `questionCallback` below).
32
+ */
33
+ questions?: InfoGathererQuestion[];
34
+ /**
35
+ * Convenience alternative to calling `setQuestionCallback()` after
36
+ * construction. Only consulted when `questions` is not provided.
37
+ */
38
+ questionCallback?: InfoGathererQuestionCallback;
39
+ /** Agent display name (defaults to `"info_gatherer"`). */
40
+ name?: string;
41
+ /** HTTP route for this agent (defaults to `"/info_gatherer"`). */
42
+ route?: string;
43
+ /** Additional AgentBase options forwarded to super(). */
44
+ agentOptions?: Partial<AgentOptions>;
45
+ }
46
+ /**
47
+ * Prefab agent that gathers caller information one question at a time.
48
+ *
49
+ * Supports two modes:
50
+ *
51
+ * - **Static** — provide `questions` at construction; the same questions are
52
+ * asked on every call.
53
+ * - **Dynamic** — leave `questions` unset and register a callback via
54
+ * `questionCallback` (or `setQuestionCallback()`); the callback decides which
55
+ * questions to ask per incoming call based on query params, body, or headers.
56
+ *
57
+ * @example Static questions
58
+ * ```ts
59
+ * import { InfoGathererAgent } from '@signalwire/sdk';
60
+ *
61
+ * const agent = new InfoGathererAgent({
62
+ * questions: [
63
+ * { key_name: 'name', question_text: 'What is your name?' },
64
+ * { key_name: 'email', question_text: 'What is your email address?', confirm: true },
65
+ * { key_name: 'issue', question_text: 'How can we help?' },
66
+ * ],
67
+ * });
68
+ *
69
+ * await agent.serve({ port: 3000 });
70
+ * ```
71
+ *
72
+ * @example Dynamic questions per request
73
+ * ```ts
74
+ * const agent = new InfoGathererAgent({
75
+ * questionCallback: async (query) => {
76
+ * if (query.intake === 'medical') {
77
+ * return [
78
+ * { key_name: 'dob', question_text: 'Date of birth?' },
79
+ * { key_name: 'insurance_id', question_text: 'Insurance member ID?' },
80
+ * ];
81
+ * }
82
+ * return [{ key_name: 'message', question_text: 'How can I help?' }];
83
+ * },
84
+ * });
85
+ * ```
86
+ */
87
+ export declare class InfoGathererAgent extends AgentBase {
88
+ private staticQuestions;
89
+ private questionCallback;
90
+ /**
91
+ * Create an InfoGathererAgent.
92
+ * @param config - Either `questions` (static mode) or leave omitted and use
93
+ * `questionCallback` / `setQuestionCallback()` (dynamic mode).
94
+ */
95
+ constructor(config?: InfoGathererConfig);
96
+ /**
97
+ * Register a callback for dynamic question configuration. The callback is
98
+ * invoked on each incoming SWML request with the query params, body, and
99
+ * headers, and must return the list of questions to ask on that call.
100
+ * Mirrors Python `set_question_callback`.
101
+ */
102
+ setQuestionCallback(callback: InfoGathererQuestionCallback): this;
103
+ private static validateQuestions;
104
+ private buildPrompt;
105
+ /**
106
+ * Generate the instruction text for asking a question. Mirrors Python's
107
+ * `_generate_question_instruction`.
108
+ */
109
+ private generateQuestionInstruction;
110
+ /**
111
+ * Handle dynamic configuration using the registered callback. Returns the
112
+ * per-request global_data payload which AgentBase merges into the SWML
113
+ * response. Mirrors Python's `on_swml_request` return-dict contract.
114
+ */
115
+ onSwmlRequest(rawData: Record<string, unknown>): Promise<Record<string, unknown> | void>;
116
+ private extractRecord;
117
+ /** Register the `start_questions` and `submit_answer` SWAIG tools. */
118
+ protected defineTools(): void;
119
+ }
120
+ /**
121
+ * Factory function that creates and returns a new InfoGathererAgent.
122
+ * @param config - Configuration for the info gatherer agent.
123
+ * @returns A configured InfoGathererAgent instance.
124
+ */
125
+ export declare function createInfoGathererAgent(config?: InfoGathererConfig): InfoGathererAgent;
126
+ export default InfoGathererAgent;