@signalwire/sdk 2.0.1 → 2.0.2

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 +1019 -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
@@ -1,800 +0,0 @@
1
- # Prefab Agents Guide
2
-
3
- Complete guide to the pre-built Prefab agents included in the SignalWire AI Agents TypeScript SDK.
4
-
5
- ---
6
-
7
- ## Table of Contents
8
-
9
- - [Overview](#overview)
10
- - [InfoGathererAgent](#infogathereragent)
11
- - [Configuration](#infogatherer-configuration)
12
- - [Fields](#infogatherer-fields)
13
- - [Tools](#infogatherer-tools)
14
- - [Session Tracking](#infogatherer-session-tracking)
15
- - [Example](#infogatherer-example)
16
- - [SurveyAgent](#surveyagent)
17
- - [Configuration](#survey-configuration)
18
- - [Question Types](#survey-question-types)
19
- - [Branching Logic](#survey-branching-logic)
20
- - [Scoring](#survey-scoring)
21
- - [Tools](#survey-tools)
22
- - [Example](#survey-example)
23
- - [FAQBotAgent](#faqbotagent)
24
- - [Configuration](#faqbot-configuration)
25
- - [Matching Engine](#faqbot-matching-engine)
26
- - [Tools](#faqbot-tools)
27
- - [Example](#faqbot-example)
28
- - [ConciergeAgent](#conciergeagent)
29
- - [Configuration](#concierge-configuration)
30
- - [Tools](#concierge-tools)
31
- - [Example](#concierge-example)
32
- - [ReceptionistAgent](#receptionistagent)
33
- - [Configuration](#receptionist-configuration)
34
- - [Tools](#receptionist-tools)
35
- - [Example](#receptionist-example)
36
- - [Factory Functions](#factory-functions)
37
- - [Subclassing Prefabs](#subclassing-prefabs)
38
-
39
- ---
40
-
41
- ## Overview
42
-
43
- Prefab agents are ready-to-use agent implementations built on top of `AgentBase`. They provide complete, production-ready AI voice agents for common use cases -- information gathering, surveys, FAQ bots, department routing, and front-desk reception.
44
-
45
- Each prefab:
46
-
47
- - **Extends `AgentBase`** and inherits all core functionality (HTTP serving, SWML generation, basic auth, CORS, proxy detection).
48
- - **Defines its own SWAIG tools** through the `defineTools()` override, giving the AI model the ability to perform domain-specific actions.
49
- - **Declares static `PROMPT_SECTIONS`** that set up the AI's role and behavioral rules automatically.
50
- - **Adds dynamic prompt sections** in the constructor based on your configuration (field lists, question lists, department directories, etc.).
51
- - **Tracks per-call session state** using `call_id` from the incoming request data, so multiple concurrent calls are isolated.
52
-
53
- Prefabs can be used in two ways:
54
-
55
- 1. **Directly via the constructor** -- pass a configuration object and get a fully functional agent.
56
- 2. **Via a factory function** -- a shorthand that creates and returns a new instance (e.g., `createInfoGathererAgent(config)`).
57
-
58
- All prefabs are exported from the main SDK entry point:
59
-
60
- ```typescript
61
- import {
62
- InfoGathererAgent, SurveyAgent, FAQBotAgent,
63
- ConciergeAgent, ReceptionistAgent,
64
- } from '@signalwire/sdk';
65
- ```
66
-
67
- ---
68
-
69
- ## InfoGathererAgent
70
-
71
- A conversational agent that asks the caller a sequence of questions one at a time and records each answer in `global_data`. Supports both static configuration (questions defined at construction) and dynamic configuration (questions resolved per request via a callback).
72
-
73
- **Source:** `src/prefabs/InfoGathererAgent.ts`
74
-
75
- ### InfoGatherer Configuration
76
-
77
- The constructor accepts an `InfoGathererConfig` object:
78
-
79
- | Property | Type | Required | Default | Description |
80
- |---|---|---|---|---|
81
- | `name` | `string` | No | `"info_gatherer"` | Agent display name. |
82
- | `route` | `string` | No | `"/info_gatherer"` | HTTP route for this agent. |
83
- | `questions` | `InfoGathererQuestion[]` | No | -- | Questions to ask (static mode). Omit for dynamic mode. |
84
- | `questionCallback` | `InfoGathererQuestionCallback` | No | -- | Resolves questions per request (dynamic mode); equivalent to calling `setQuestionCallback()` after construction. |
85
- | `agentOptions` | `Partial<AgentOptions>` | No | -- | Additional AgentBase options forwarded to `super()` (e.g., `port`, `basicAuth`). |
86
-
87
- ### InfoGatherer Questions
88
-
89
- Each entry in the `questions` array is an `InfoGathererQuestion`:
90
-
91
- | Property | Type | Required | Default | Description |
92
- |---|---|---|---|---|
93
- | `key_name` | `string` | **Yes** | -- | Identifier used as the key when storing the caller's answer. |
94
- | `question_text` | `string` | **Yes** | -- | The question text spoken to the caller. |
95
- | `confirm` | `boolean` | No | `false` | When `true`, the agent insists the caller confirms the answer before submitting. |
96
-
97
- ### InfoGatherer Tools
98
-
99
- The agent registers two SWAIG tools:
100
-
101
- #### `start_questions`
102
-
103
- Retrieves the first question from `global_data.questions` and returns an instruction asking the caller to answer it.
104
-
105
- **Parameters:** None.
106
-
107
- **Returns:** A formatted instruction including the first question's text and confirmation guidance when `confirm` is set. Also sets `replace_in_history` to the generic "Welcome" prompt.
108
-
109
- #### `submit_answer`
110
-
111
- Records the caller's answer to the current question and advances to the next.
112
-
113
- **Parameters:**
114
-
115
- | Name | Type | Required | Description |
116
- |---|---|---|---|
117
- | `answer` | `string` | Yes | The caller's answer to the current question. |
118
-
119
- **Behavior:**
120
- - Appends `{ key_name, answer }` to `global_data.answers`.
121
- - Increments `global_data.question_index`.
122
- - If more questions remain, returns the next question's instruction text.
123
- - If all questions are answered, returns the completion message.
124
-
125
- ### Dynamic Mode
126
-
127
- Omit `questions` and register a callback to resolve the question list per incoming request:
128
-
129
- ```typescript
130
- const agent = new InfoGathererAgent({ name: 'dynamic-intake' });
131
- agent.setQuestionCallback((queryParams, bodyParams, headers) => {
132
- if (queryParams['set'] === 'support') {
133
- return [
134
- { key_name: 'name', question_text: 'What is your name?' },
135
- { key_name: 'issue', question_text: "What's the issue?" },
136
- ];
137
- }
138
- return [{ key_name: 'name', question_text: 'What is your name?' }];
139
- });
140
- ```
141
-
142
- The callback runs on every SWML request, and its return value populates `global_data.questions` for that call. If no callback is registered or the callback throws, a default two-question fallback (`name`, `message`) is used.
143
-
144
- ### InfoGatherer Example
145
-
146
- ```typescript
147
- import { InfoGathererAgent } from '@signalwire/sdk';
148
-
149
- const agent = new InfoGathererAgent({
150
- name: 'PatientIntake',
151
- questions: [
152
- { key_name: 'full_name', question_text: 'What is your full legal name?' },
153
- { key_name: 'date_of_birth', question_text: 'What is your date of birth?', confirm: true },
154
- { key_name: 'phone_number', question_text: 'What is a good callback number?', confirm: true },
155
- { key_name: 'insurance_provider', question_text: 'Who is your insurance provider?' },
156
- ],
157
- agentOptions: {
158
- port: 3001,
159
- route: '/intake',
160
- },
161
- });
162
-
163
- agent.run();
164
- ```
165
-
166
- ---
167
-
168
- ## SurveyAgent
169
-
170
- A conversational agent that conducts surveys with multiple question types, branching logic based on answers, and per-answer scoring.
171
-
172
- **Source:** `src/prefabs/SurveyAgent.ts`
173
-
174
- ### Survey Configuration
175
-
176
- The constructor accepts a `SurveyConfig` object:
177
-
178
- | Property | Type | Required | Default | Description |
179
- |---|---|---|---|---|
180
- | `name` | `string` | No | `"survey"` | Agent display name. |
181
- | `route` | `string` | No | `"/survey"` | HTTP route for this agent. |
182
- | `surveyName` | `string` | **Yes** | -- | Human-readable survey name used in prompts and global data. |
183
- | `questions` | `SurveyQuestion[]` | **Yes** | -- | Ordered list of survey questions. |
184
- | `introduction` | `string` | No | `"Welcome to our ${surveyName}. We appreciate your participation."` | Opening message before the first question (used as a non-bargeable static greeting). |
185
- | `conclusion` | `string` | No | `"Thank you for completing our survey. Your feedback is valuable to us."` | Message spoken after the survey is complete. |
186
- | `brandName` | `string` | No | `"Our Company"` | Brand or company name the agent represents. |
187
- | `maxRetries` | `number` | No | `2` | Maximum number of times to retry invalid answers. |
188
- | `onComplete` | `(responses: Record<string, unknown>, score: number) => void \| Promise<void>` | No | -- | Callback fired when the survey is finished. Receives all responses and the total score. |
189
- | `agentOptions` | `Partial<AgentOptions>` | No | -- | Additional AgentBase options. |
190
-
191
- Each `SurveyQuestion` has the following shape:
192
-
193
- | Property | Type | Required | Description |
194
- |---|---|---|---|
195
- | `id` | `string` | **Yes** | Unique question identifier. |
196
- | `text` | `string` | **Yes** | The question text to ask the caller. |
197
- | `type` | `'multiple_choice' \| 'open_ended' \| 'rating' \| 'yes_no'` | **Yes** | Question type; determines validation and display. |
198
- | `options` | `string[]` | No | Answer options (used when `type` is `multiple_choice`). |
199
- | `scale` | `number` | No | For `rating` questions, the upper bound of the 1..scale range. Defaults to `5`. |
200
- | `required` | `boolean` | No | Whether the question requires an answer. Defaults to `true`. |
201
- | `nextQuestion` | `string \| Record<string, string>` | No | Controls flow after this question (see Branching Logic). |
202
- | `points` | `number \| Record<string, number>` | No | Points awarded for answers (see Scoring). |
203
-
204
- ### Survey Question Types
205
-
206
- | Type | Validation | Notes |
207
- |---|---|---|
208
- | `multiple_choice` | Answer must exactly match one of the `options` (case-insensitive). | All options are read aloud. |
209
- | `open_ended` | No validation; any answer is accepted. | Free-form response. |
210
- | `rating` | Must be an integer between 1 and the question's `scale` (default `5`). | The AI specifies the scale to the caller. |
211
- | `yes_no` | Must be a recognized affirmative or negative word. | Accepts: `yes`, `y`, `yeah`, `yep`, `sure`, `absolutely`, `correct`, `true`, `no`, `n`, `nah`, `nope`, `negative`, `false`. Normalized to `"yes"` or `"no"` before storage. |
212
-
213
- ### Survey Branching Logic
214
-
215
- The `nextQuestion` property controls which question follows the current one:
216
-
217
- | Value | Behavior |
218
- |---|---|
219
- | `undefined` (omitted) | Proceed to the next question in array order. If this is the last question, the survey ends. |
220
- | `string` | Always jump to the question with this ID, regardless of the answer. |
221
- | `Record<string, string>` | Conditional branching: the answer value (case-insensitive) is looked up as a key, and the value is the next question ID. A special `_default` key serves as a fallback. If no key matches and there is no `_default`, falls through to the next question in array order. |
222
-
223
- ### Survey Scoring
224
-
225
- The `points` property controls point accumulation:
226
-
227
- | Value | Behavior |
228
- |---|---|
229
- | `undefined` (omitted) | No points for this question. |
230
- | `number` | Fixed points awarded for any answer. |
231
- | `Record<string, number>` | Per-answer scoring: the answer value (case-insensitive) is looked up as a key, and the matched value is the number of points awarded. Unmatched answers receive 0 points. |
232
-
233
- The total score is accumulated across all answered questions and passed to the `onComplete` callback.
234
-
235
- ### Survey Tools
236
-
237
- The agent registers the following SWAIG tools:
238
-
239
- #### `validate_response`
240
-
241
- Validates whether a response satisfies the question's type and constraints without recording or advancing.
242
-
243
- **Parameters:**
244
-
245
- | Name | Type | Required | Description |
246
- |---|---|---|---|
247
- | `question_id` | `string` | Yes | The ID of the question to validate against. |
248
- | `response` | `string` | Yes | The candidate response. |
249
-
250
- **Returns:** A confirmation message when valid, or a type-specific error describing why the response is invalid.
251
-
252
- #### `log_response`
253
-
254
- Acknowledges that a validated response has been recorded for the specified question.
255
-
256
- **Parameters:**
257
-
258
- | Name | Type | Required | Description |
259
- |---|---|---|---|
260
- | `question_id` | `string` | Yes | The ID of the question. |
261
- | `response` | `string` | Yes | The validated response. |
262
-
263
- **Returns:** A confirmation message referencing the question's text.
264
-
265
- #### `answer_question`
266
-
267
- Records the caller's answer to the current survey question.
268
-
269
- **Parameters:**
270
-
271
- | Name | Type | Required | Description |
272
- |---|---|---|---|
273
- | `question_id` | `string` | Yes | The ID of the question being answered. |
274
- | `answer` | `string` | Yes | The caller's answer. |
275
-
276
- **Behavior:**
277
- - Validates the answer based on question type. Returns a validation error if invalid.
278
- - Normalizes the answer (e.g., yes/no variants become `"yes"` or `"no"`).
279
- - Calculates and accumulates points.
280
- - Resolves the next question via branching logic.
281
- - If there is no next question, marks the survey complete, fires `onComplete`, and returns the completion message with answer count and total score.
282
- - Otherwise, advances the session and returns the next question text with its type-specific instructions.
283
-
284
- #### `get_current_question`
285
-
286
- Returns the current question to be asked to the caller.
287
-
288
- **Parameters:** None.
289
-
290
- **Returns:** The question ID, type, text, and type-specific instructions (options for multiple choice, scale for rating, etc.).
291
-
292
- #### `get_survey_progress`
293
-
294
- Returns the current progress of the survey.
295
-
296
- **Parameters:** None.
297
-
298
- **Returns:** A summary including questions answered out of total, percentage complete, current score, completion status, and all answers so far.
299
-
300
- ### Survey Example
301
-
302
- ```typescript
303
- import { SurveyAgent } from '@signalwire/sdk';
304
-
305
- const agent = new SurveyAgent({
306
- name: 'CustomerSatisfaction',
307
- surveyName: 'Customer Satisfaction Survey',
308
- introduction: 'Hi! We would love to hear your feedback about our service.',
309
- conclusion: 'Thanks for your feedback! We really appreciate it.',
310
- questions: [
311
- {
312
- id: 'overall',
313
- text: 'How would you rate your overall experience?',
314
- type: 'rating',
315
- points: { '9': 10, '10': 10, '7': 7, '8': 7 },
316
- },
317
- {
318
- id: 'recommend',
319
- text: 'Would you recommend us to a friend?',
320
- type: 'yes_no',
321
- points: { 'yes': 5, 'no': 0 },
322
- nextQuestion: {
323
- 'yes': 'what_liked',
324
- 'no': 'what_improve',
325
- },
326
- },
327
- {
328
- id: 'what_liked',
329
- text: 'What did you like the most about our service?',
330
- type: 'open_ended',
331
- nextQuestion: 'followup',
332
- },
333
- {
334
- id: 'what_improve',
335
- text: 'What could we improve?',
336
- type: 'open_ended',
337
- nextQuestion: 'followup',
338
- },
339
- {
340
- id: 'followup',
341
- text: 'How would you like us to follow up?',
342
- type: 'multiple_choice',
343
- options: ['Email', 'Phone call', 'No follow-up needed'],
344
- },
345
- ],
346
- onComplete: async (responses, score) => {
347
- console.log('Survey complete! Score:', score);
348
- console.log('Responses:', responses);
349
- // Store results, send to analytics, etc.
350
- },
351
- });
352
-
353
- agent.start();
354
- ```
355
-
356
- ---
357
-
358
- ## FAQBotAgent
359
-
360
- A conversational agent that answers frequently asked questions using keyword and word-overlap matching with configurable similarity thresholds and optional escalation to a live agent.
361
-
362
- **Source:** `src/prefabs/FAQBotAgent.ts`
363
-
364
- ### FAQBot Configuration
365
-
366
- The constructor accepts a `FAQBotConfig` object:
367
-
368
- | Property | Type | Required | Default | Description |
369
- |---|---|---|---|---|
370
- | `name` | `string` | No | `"FAQBot"` | Agent display name. |
371
- | `faqs` | `FAQEntry[]` | **Yes** | -- | List of FAQ entries for the knowledge base. |
372
- | `threshold` | `number` | No | `0.5` | Minimum match score (0--1) for an FAQ to be considered a match. |
373
- | `escalationMessage` | `string` | No | `"I'm sorry, I couldn't find an answer to your question. Let me transfer you to someone who can help."` | Message spoken when no FAQ matches the query. |
374
- | `escalationNumber` | `string` | No | -- | Phone number to transfer to on escalation. If not set, the `escalate` tool is **not registered**. |
375
- | `agentOptions` | `Partial<AgentOptions>` | No | -- | Additional AgentBase options. |
376
-
377
- Each `FAQEntry` has the following shape:
378
-
379
- | Property | Type | Required | Description |
380
- |---|---|---|---|
381
- | `question` | `string` | **Yes** | The representative question text. |
382
- | `answer` | `string` | **Yes** | The answer to provide when this FAQ matches. |
383
- | `keywords` | `string[]` | No | Additional keywords to boost matching accuracy. |
384
-
385
- ### FAQBot Matching Engine
386
-
387
- The matching engine computes a word-overlap similarity score between the caller's query and each FAQ entry.
388
-
389
- **Tokenization:**
390
- 1. Text is lowercased.
391
- 2. Non-alphanumeric characters are replaced with spaces.
392
- 3. Text is split on whitespace.
393
- 4. Words shorter than 2 characters are removed.
394
- 5. Common English stop words are filtered out (e.g., "the", "is", "to", "and", "or", etc.).
395
-
396
- **Scoring:**
397
- - **Question overlap** -- the number of shared tokens between the query and the FAQ question text, normalized by the smaller token set.
398
- - **Keyword overlap** -- each keyword is checked for substring presence in the lowercased query; the hit count is divided by total keywords.
399
- - **Combined score** -- if keywords are present, the final score is `0.6 * questionOverlap + 0.4 * keywordScore`. Without keywords, only question overlap is used.
400
-
401
- The best-scoring FAQ is returned if its score meets or exceeds the configured `threshold`. Runner-up matches above the threshold are mentioned as related results.
402
-
403
- ### FAQBot Tools
404
-
405
- #### `search_faq`
406
-
407
- Searches the FAQ knowledge base for an answer to the caller's question.
408
-
409
- **Parameters:**
410
-
411
- | Name | Type | Required | Description |
412
- |---|---|---|---|
413
- | `query` | `string` | Yes | The caller's question or search query. |
414
-
415
- **Returns:** The best matching FAQ entry with confidence score, plus up to 2 related runner-ups if they also exceed the threshold. If no match meets the threshold, returns the escalation message.
416
-
417
- #### `escalate`
418
-
419
- Transfers the caller to a live agent. **Only registered when `escalationNumber` is configured.**
420
-
421
- **Parameters:**
422
-
423
- | Name | Type | Required | Description |
424
- |---|---|---|---|
425
- | `reason` | `string` | No | The reason for escalation. Defaults to `"Caller needs assistance beyond FAQ"`. |
426
-
427
- **Behavior:** Uses `FunctionResult.connect()` to transfer the call to the configured `escalationNumber`.
428
-
429
- ### FAQBot Example
430
-
431
- ```typescript
432
- import { FAQBotAgent } from '@signalwire/sdk';
433
-
434
- const agent = new FAQBotAgent({
435
- name: 'HelpDesk',
436
- threshold: 0.4,
437
- escalationNumber: '+15559876543',
438
- escalationMessage: 'I was not able to find an answer for that. Let me connect you with a support specialist.',
439
- faqs: [
440
- {
441
- question: 'What are your business hours?',
442
- answer: 'We are open Monday through Friday, 9 AM to 5 PM Eastern Time.',
443
- keywords: ['hours', 'open', 'close', 'schedule', 'when'],
444
- },
445
- {
446
- question: 'How do I reset my password?',
447
- answer: 'Go to the login page, click "Forgot Password", and follow the email instructions.',
448
- keywords: ['password', 'reset', 'forgot', 'login', 'locked'],
449
- },
450
- {
451
- question: 'What is your return policy?',
452
- answer: 'We offer a 30-day return policy for unused items in original packaging.',
453
- keywords: ['return', 'refund', 'exchange', 'policy'],
454
- },
455
- {
456
- question: 'How do I contact support?',
457
- answer: 'You can reach our support team by calling this number, by email at support@example.com, or through live chat on our website.',
458
- keywords: ['support', 'contact', 'help', 'email', 'chat'],
459
- },
460
- ],
461
- agentOptions: {
462
- route: '/helpdesk',
463
- },
464
- });
465
-
466
- agent.start();
467
- ```
468
-
469
- ---
470
-
471
- ## ConciergeAgent
472
-
473
- A virtual concierge for a venue or business. Provides information about services, amenities, and hours of operation, and answers availability and directions questions.
474
-
475
- **Source:** `src/prefabs/ConciergeAgent.ts`
476
-
477
- ### Concierge Configuration
478
-
479
- The constructor accepts a `ConciergeConfig` object:
480
-
481
- | Property | Type | Required | Default | Description |
482
- |---|---|---|---|---|
483
- | `name` | `string` | No | `"concierge"` | Agent display name. |
484
- | `route` | `string` | No | `"/concierge"` | HTTP route for this agent. |
485
- | `venueName` | `string` | **Yes** | -- | Name of the venue or business. |
486
- | `services` | `string[]` | **Yes** | -- | List of services offered. |
487
- | `amenities` | `Record<string, Record<string, string>>` | **Yes** | -- | Amenities as an object of amenity-name → detail-pairs. |
488
- | `hoursOfOperation` | `Record<string, string>` | No | `{ default: '9 AM - 5 PM' }` | Operating hours by category. |
489
- | `specialInstructions` | `string[]` | No | `[]` | Extra instruction bullets to append. |
490
- | `welcomeMessage` | `string` | No | -- | When set, installed as a non-bargeable static greeting. |
491
- | `agentOptions` | `Partial<AgentOptions>` | No | -- | Additional AgentBase options. |
492
-
493
- The venue name, all services, and amenity names are added as speech recognition hints.
494
-
495
- ### Concierge Tools
496
-
497
- #### `check_availability`
498
-
499
- Checks whether a given service is offered on a specified date and time.
500
-
501
- **Parameters:**
502
-
503
- | Name | Type | Required | Description |
504
- |---|---|---|---|
505
- | `service` | `string` | Yes | The service to check. |
506
- | `date` | `string` | Yes | The date in `YYYY-MM-DD` format. |
507
- | `time` | `string` | Yes | The time in `HH:MM` 24-hour format. |
508
-
509
- **Returns:** A confirmation or a list of offered services when the requested service is not available.
510
-
511
- #### `get_directions`
512
-
513
- Looks up directions for an amenity by name.
514
-
515
- **Parameters:**
516
-
517
- | Name | Type | Required | Description |
518
- |---|---|---|---|
519
- | `location` | `string` | Yes | The amenity or location to get directions to. |
520
-
521
- **Returns:** Directions referencing the amenity's `location` detail, or a fallback pointing the caller to the front desk.
522
-
523
- ### Concierge Example
524
-
525
- ```typescript
526
- import { ConciergeAgent } from '@signalwire/sdk';
527
-
528
- const agent = new ConciergeAgent({
529
- venueName: 'Grand Hotel',
530
- services: ['room service', 'spa bookings', 'restaurant reservations'],
531
- amenities: {
532
- pool: { hours: '7 AM - 10 PM', location: '2nd Floor' },
533
- gym: { hours: '24 hours', location: '3rd Floor' },
534
- },
535
- hoursOfOperation: { weekday: '9 AM - 9 PM', weekend: '10 AM - 6 PM' },
536
- specialInstructions: ['Always mention the weekly wine tasting.'],
537
- welcomeMessage: 'Welcome to the Grand Hotel! How may I assist you?',
538
- });
539
-
540
- agent.run();
541
- ```
542
-
543
- ---
544
-
545
- ## ReceptionistAgent
546
-
547
- A front-desk agent that greets callers, collects their name and reason for calling, and transfers them to the appropriate department. Optionally supports visitor check-in as a TS-specific enhancement.
548
-
549
- **Source:** `src/prefabs/ReceptionistAgent.ts`
550
-
551
- ### Receptionist Configuration
552
-
553
- The constructor accepts a `ReceptionistConfig` object:
554
-
555
- | Property | Type | Required | Default | Description |
556
- |---|---|---|---|---|
557
- | `name` | `string` | No | `"receptionist"` | Agent display name. |
558
- | `route` | `string` | No | `"/receptionist"` | HTTP route for this agent. |
559
- | `departments` | `ReceptionistDepartment[]` | **Yes** | -- | Departments the agent can transfer callers to. |
560
- | `greeting` | `string` | No | `"Thank you for calling. How can I help you today?"` | Initial greeting message. |
561
- | `voice` | `string` | No | `"rime.spore"` | Voice identifier passed to `addLanguage`. |
562
- | `companyName` | `string` | No | -- | Optional company name appended to the greeting and used as a speech hint. |
563
- | `checkInEnabled` | `boolean` | No | `false` | Whether the TS-specific `check_in_visitor` tool is registered. |
564
- | `onVisitorCheckIn` | `(visitor: Record<string, string>) => void \| Promise<void>` | No | -- | Callback fired when a visitor checks in. |
565
- | `agentOptions` | `Partial<AgentOptions>` | No | -- | Additional AgentBase options. |
566
-
567
- Each `ReceptionistDepartment` has the following shape:
568
-
569
- | Property | Type | Required | Description |
570
- |---|---|---|---|
571
- | `name` | `string` | **Yes** | Department identifier (used as enum value in `transfer_call`). |
572
- | `description` | `string` | **Yes** | Description of the department (shown to the AI). |
573
- | `number` | `string` | **Yes** | Phone number (or SIP address) to dial on transfer. |
574
-
575
- ### Receptionist Tools
576
-
577
- #### `collect_caller_info`
578
-
579
- Records the caller's name and reason for calling in `global_data.caller_info` via `set_global_data`.
580
-
581
- **Parameters:**
582
-
583
- | Name | Type | Required | Description |
584
- |---|---|---|---|
585
- | `name` | `string` | Yes | The caller's name. |
586
- | `reason` | `string` | Yes | The reason for the call. |
587
-
588
- **Returns:** An acknowledgement referencing the caller by name.
589
-
590
- #### `transfer_call`
591
-
592
- Transfers the caller to the selected department.
593
-
594
- **Parameters:**
595
-
596
- | Name | Type | Required | Description |
597
- |---|---|---|---|
598
- | `department` | `string` (enum over department names) | Yes | The department to transfer to. |
599
-
600
- **Behavior:**
601
- - Uses `post_process=true` so the AI speaks the response before executing the transfer.
602
- - Uses `FunctionResult.connect(number, final=true)` to make the transfer permanent.
603
- - Reads `global_data.caller_info.name` (populated by `collect_caller_info`) to personalize the hand-off message.
604
- - Returns an error if the department name is unknown.
605
-
606
- #### `check_in_visitor` (TS enhancement)
607
-
608
- Only registered when `checkInEnabled` is `true`. Records a visitor in the per-call session and fires the `onVisitorCheckIn` callback.
609
-
610
- **Parameters:**
611
-
612
- | Name | Type | Required | Description |
613
- |---|---|---|---|
614
- | `visitor_name` | `string` | Yes | Full name of the visitor. |
615
- | `purpose` | `string` | Yes | Purpose of the visit. |
616
- | `visiting` | `string` | Yes | Name of the person or department the visitor is here to see. |
617
-
618
- ### Receptionist Example
619
-
620
- ```typescript
621
- import { ReceptionistAgent } from '@signalwire/sdk';
622
-
623
- const agent = new ReceptionistAgent({
624
- companyName: 'Acme Corporation',
625
- greeting: 'Thank you for calling Acme Corporation. How can I help you today?',
626
- voice: 'rime.spore',
627
- checkInEnabled: true,
628
- departments: [
629
- {
630
- name: 'engineering',
631
- description: 'Software development and technical teams',
632
- number: '+15551001001',
633
- },
634
- {
635
- name: 'hr',
636
- description: 'Employee services, benefits, and recruiting',
637
- number: '+15551001002',
638
- },
639
- {
640
- name: 'marketing',
641
- description: 'Brand, communications, and events',
642
- number: '+15551001003',
643
- },
644
- {
645
- name: 'executive',
646
- description: 'CEO and executive leadership',
647
- number: '+15551001004',
648
- },
649
- ],
650
- onVisitorCheckIn: async (visitor) => {
651
- console.log('Visitor checked in:', visitor);
652
- // Send Slack notification, update visitor log, print badge, etc.
653
- },
654
- agentOptions: {
655
- route: '/reception',
656
- },
657
- });
658
-
659
- agent.start();
660
- ```
661
-
662
- ---
663
-
664
- ## Factory Functions
665
-
666
- Each prefab provides a factory function that creates and returns a new instance. These are simple shorthands for `new PrefabAgent(config)`:
667
-
668
- | Factory Function | Creates |
669
- |---|---|
670
- | `createInfoGathererAgent(config)` | `InfoGathererAgent` |
671
- | `createSurveyAgent(config)` | `SurveyAgent` |
672
- | `createFAQBotAgent(config)` | `FAQBotAgent` |
673
- | `createConciergeAgent(config)` | `ConciergeAgent` |
674
- | `createReceptionistAgent(config)` | `ReceptionistAgent` |
675
-
676
- Factory functions accept the same config type as their corresponding class constructors.
677
-
678
- ```typescript
679
- import { createSurveyAgent } from '@signalwire/sdk';
680
-
681
- const agent = createSurveyAgent({
682
- questions: [
683
- { id: 'q1', text: 'How was your experience?', type: 'rating' },
684
- ],
685
- onComplete: (responses, score) => {
686
- console.log('Done!', responses, score);
687
- },
688
- });
689
-
690
- agent.start();
691
- ```
692
-
693
- Factory functions and class constructors are exported both from the individual prefab modules and from the main SDK entry point:
694
-
695
- ```typescript
696
- // From the SDK entry point
697
- import { createFAQBotAgent, FAQBotAgent } from '@signalwire/sdk';
698
-
699
- // From the prefab module directly
700
- import { createFAQBotAgent } from '@signalwire/sdk/prefabs';
701
- ```
702
-
703
- ---
704
-
705
- ## Subclassing Prefabs
706
-
707
- Prefab agents can be subclassed to customize their behavior. The two primary extension points are the static `PROMPT_SECTIONS` array and the `defineTools()` method.
708
-
709
- ### Overriding `PROMPT_SECTIONS`
710
-
711
- Each prefab declares a `static override PROMPT_SECTIONS` array that the `AgentBase` constructor merges into the prompt. You can override this in your subclass to change the AI's role and rules:
712
-
713
- ```typescript
714
- import { InfoGathererAgent } from '@signalwire/sdk';
715
- import type { InfoGathererConfig } from '@signalwire/sdk';
716
-
717
- class SpanishInfoGatherer extends InfoGathererAgent {
718
- static override PROMPT_SECTIONS = [
719
- {
720
- title: 'Role',
721
- body: 'You are a bilingual information-gathering assistant. You speak Spanish and English. Always respond in the same language the caller uses.',
722
- },
723
- {
724
- title: 'Rules',
725
- bullets: [
726
- 'Ask one question at a time, in the order provided by start_questions.',
727
- 'Use submit_answer to record each response and advance to the next question.',
728
- 'If a question has confirm=true, insist on confirmation before submitting.',
729
- 'If validation fails, politely ask the caller to try again in their language.',
730
- ],
731
- },
732
- ];
733
-
734
- constructor(config: InfoGathererConfig) {
735
- super(config);
736
- }
737
- }
738
- ```
739
-
740
- ### Overriding `defineTools()`
741
-
742
- You can override `defineTools()` to add additional tools, replace existing tools, or extend the default tool set by calling `super.defineTools()` first:
743
-
744
- ```typescript
745
- import { FAQBotAgent, FunctionResult } from '@signalwire/sdk';
746
- import type { FAQBotConfig } from '@signalwire/sdk';
747
-
748
- class FAQBotWithFeedback extends FAQBotAgent {
749
- protected override defineTools(): void {
750
- // Register all the default tools first
751
- super.defineTools();
752
-
753
- // Add a custom feedback tool
754
- this.defineTool({
755
- name: 'submit_feedback',
756
- description: 'Allow the caller to submit feedback about the FAQ answers.',
757
- parameters: {
758
- type: 'object',
759
- properties: {
760
- rating: {
761
- type: 'string',
762
- description: 'How helpful was the answer: good, okay, or poor.',
763
- },
764
- comment: {
765
- type: 'string',
766
- description: 'Optional comment from the caller.',
767
- },
768
- },
769
- required: ['rating'],
770
- },
771
- handler: (args: Record<string, unknown>) => {
772
- const rating = args['rating'] as string;
773
- const comment = args['comment'] as string | undefined;
774
- console.log(`FAQ Feedback: ${rating}${comment ? ' - ' + comment : ''}`);
775
- return new FunctionResult('Thank you for your feedback!');
776
- },
777
- });
778
- }
779
- }
780
- ```
781
-
782
- ### Adding Dynamic Prompt Sections
783
-
784
- Beyond the static `PROMPT_SECTIONS`, you can use `this.promptAddSection()` in the constructor body to add additional dynamic prompt content:
785
-
786
- ```typescript
787
- import { ConciergeAgent } from '@signalwire/sdk';
788
- import type { ConciergeConfig } from '@signalwire/sdk';
789
-
790
- class HolidayConcierge extends ConciergeAgent {
791
- constructor(config: ConciergeConfig) {
792
- super(config);
793
-
794
- // Add a holiday schedule section to the prompt
795
- this.promptAddSection('Holiday Schedule', {
796
- body: 'Note: The office is closed on December 25th and January 1st. All departments will reopen on January 2nd.',
797
- });
798
- }
799
- }
800
- ```