@signalwire/sdk 2.0.4 → 3.5.0

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 (656) hide show
  1. package/CHANGELOG.md +785 -0
  2. package/LICENSE +21 -0
  3. package/README.md +163 -68
  4. package/dist/AGENTS.md +13 -0
  5. package/dist/AgentBase.d.ts +550 -163
  6. package/dist/AgentBase.js +1640 -514
  7. package/dist/AgentBase.js.map +1 -1
  8. package/dist/AgentServer.d.ts +21 -0
  9. package/dist/AgentServer.js +154 -47
  10. package/dist/AgentServer.js.map +1 -1
  11. package/dist/AuthHandler.d.ts +14 -2
  12. package/dist/AuthHandler.js +7 -2
  13. package/dist/AuthHandler.js.map +1 -1
  14. package/dist/ConfigLoader.d.ts +5 -13
  15. package/dist/ConfigLoader.js +15 -29
  16. package/dist/ConfigLoader.js.map +1 -1
  17. package/dist/ContextBuilder.d.ts +202 -9
  18. package/dist/ContextBuilder.js +219 -36
  19. package/dist/ContextBuilder.js.map +1 -1
  20. package/dist/DataMap.d.ts +158 -45
  21. package/dist/DataMap.js +167 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +277 -83
  24. package/dist/FunctionResult.js +444 -116
  25. package/dist/FunctionResult.js.map +1 -1
  26. package/dist/Logger.d.ts +30 -5
  27. package/dist/Logger.js +77 -19
  28. package/dist/Logger.js.map +1 -1
  29. package/dist/POM/PromptObjectModel.d.ts +163 -0
  30. package/dist/POM/PromptObjectModel.js +481 -0
  31. package/dist/POM/PromptObjectModel.js.map +1 -0
  32. package/dist/ParameterSchema.d.ts +306 -0
  33. package/dist/ParameterSchema.js +251 -0
  34. package/dist/ParameterSchema.js.map +1 -0
  35. package/dist/PlatformContracts.d.ts +21 -0
  36. package/dist/PlatformContracts.generated.d.ts +109 -0
  37. package/dist/PlatformContracts.generated.js +8 -0
  38. package/dist/PlatformContracts.generated.js.map +1 -0
  39. package/dist/PlatformContracts.js +2 -0
  40. package/dist/PlatformContracts.js.map +1 -0
  41. package/dist/PomBuilder.d.ts +28 -0
  42. package/dist/PomBuilder.js +81 -3
  43. package/dist/PomBuilder.js.map +1 -1
  44. package/dist/PostPrompt.d.ts +110 -0
  45. package/dist/PostPrompt.js +204 -0
  46. package/dist/PostPrompt.js.map +1 -0
  47. package/dist/PromptManager.d.ts +29 -1
  48. package/dist/PromptManager.js +37 -1
  49. package/dist/PromptManager.js.map +1 -1
  50. package/dist/PublicFetch.d.ts +132 -0
  51. package/dist/PublicFetch.js +311 -0
  52. package/dist/PublicFetch.js.map +1 -0
  53. package/dist/RobotsTxt.d.ts +41 -0
  54. package/dist/RobotsTxt.js +152 -0
  55. package/dist/RobotsTxt.js.map +1 -0
  56. package/dist/SWMLHandler.js.map +1 -1
  57. package/dist/SWMLService.d.ts +265 -66
  58. package/dist/SWMLService.js +652 -112
  59. package/dist/SWMLService.js.map +1 -1
  60. package/dist/SchemaUtils.d.ts +115 -2
  61. package/dist/SchemaUtils.js +444 -12
  62. package/dist/SchemaUtils.js.map +1 -1
  63. package/dist/SecurityUtils.d.ts +55 -8
  64. package/dist/SecurityUtils.js +162 -49
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/ServerlessAdapter.d.ts +156 -7
  67. package/dist/ServerlessAdapter.js +399 -42
  68. package/dist/ServerlessAdapter.js.map +1 -1
  69. package/dist/SessionManager.d.ts +11 -2
  70. package/dist/SessionManager.js +50 -18
  71. package/dist/SessionManager.js.map +1 -1
  72. package/dist/SslConfig.d.ts +2 -1
  73. package/dist/SslConfig.js +4 -1
  74. package/dist/SslConfig.js.map +1 -1
  75. package/dist/SwaigActions.generated.d.ts +23 -0
  76. package/dist/SwaigActions.generated.js +8 -0
  77. package/dist/SwaigActions.generated.js.map +1 -0
  78. package/dist/SwaigContracts.d.ts +15 -0
  79. package/dist/SwaigContracts.generated.d.ts +264 -0
  80. package/dist/SwaigContracts.generated.js +12 -0
  81. package/dist/SwaigContracts.generated.js.map +1 -0
  82. package/dist/SwaigContracts.js +2 -0
  83. package/dist/SwaigContracts.js.map +1 -0
  84. package/dist/SwaigFunction.d.ts +110 -4
  85. package/dist/SwaigFunction.js +151 -19
  86. package/dist/SwaigFunction.js.map +1 -1
  87. package/dist/SwmlBuilder.d.ts +68 -19
  88. package/dist/SwmlBuilder.js +74 -38
  89. package/dist/SwmlBuilder.js.map +1 -1
  90. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  91. package/dist/SwmlVerbMethods.generated.js +1 -1
  92. package/dist/TypeInference.d.ts +39 -3
  93. package/dist/TypeInference.js +256 -16
  94. package/dist/TypeInference.js.map +1 -1
  95. package/dist/WebService.d.ts +79 -11
  96. package/dist/WebService.js +320 -109
  97. package/dist/WebService.js.map +1 -1
  98. package/dist/WebhookMiddleware.d.ts +119 -0
  99. package/dist/WebhookMiddleware.js +271 -0
  100. package/dist/WebhookMiddleware.js.map +1 -0
  101. package/dist/WebhookValidator.d.ts +92 -0
  102. package/dist/WebhookValidator.js +409 -0
  103. package/dist/WebhookValidator.js.map +1 -0
  104. package/dist/agents/BedrockAgent.d.ts +162 -0
  105. package/dist/agents/BedrockAgent.js +323 -0
  106. package/dist/agents/BedrockAgent.js.map +1 -0
  107. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  108. package/dist/ai-chat/AIChatClient.js +535 -0
  109. package/dist/ai-chat/AIChatClient.js.map +1 -0
  110. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  111. package/dist/ai-chat/ChatGateway.js +747 -0
  112. package/dist/ai-chat/ChatGateway.js.map +1 -0
  113. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  114. package/dist/ai-chat/HandoffRouter.js +518 -0
  115. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  116. package/dist/ai-chat/index.d.ts +12 -0
  117. package/dist/ai-chat/index.js +10 -0
  118. package/dist/ai-chat/index.js.map +1 -0
  119. package/dist/capabilities.d.ts +64 -0
  120. package/dist/capabilities.js +95 -0
  121. package/dist/capabilities.js.map +1 -0
  122. package/dist/cli/agent-loader.d.ts +32 -6
  123. package/dist/cli/agent-loader.js +95 -34
  124. package/dist/cli/agent-loader.js.map +1 -1
  125. package/dist/cli/datamap-exec.d.ts +175 -0
  126. package/dist/cli/datamap-exec.js +1284 -0
  127. package/dist/cli/datamap-exec.js.map +1 -0
  128. package/dist/cli/function-args.d.ts +40 -0
  129. package/dist/cli/function-args.js +146 -0
  130. package/dist/cli/function-args.js.map +1 -0
  131. package/dist/cli/simulation.d.ts +99 -0
  132. package/dist/cli/simulation.js +490 -0
  133. package/dist/cli/simulation.js.map +1 -0
  134. package/dist/cli/swaig-test.d.ts +12 -25
  135. package/dist/cli/swaig-test.js +935 -367
  136. package/dist/cli/swaig-test.js.map +1 -1
  137. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  138. package/dist/cli/tsdocs/agentsNote.js +92 -0
  139. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  140. package/dist/cli/tsdocs/api-index.json +1 -0
  141. package/dist/cli/tsdocs/api.d.ts +91 -0
  142. package/dist/cli/tsdocs/api.js +372 -0
  143. package/dist/cli/tsdocs/api.js.map +1 -0
  144. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  145. package/dist/cli/tsdocs/apiTypes.js +7 -0
  146. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  147. package/dist/cli/tsdocs/bin.d.ts +6 -0
  148. package/dist/cli/tsdocs/bin.js +23 -0
  149. package/dist/cli/tsdocs/bin.js.map +1 -0
  150. package/dist/cli/tsdocs/files.d.ts +108 -0
  151. package/dist/cli/tsdocs/files.js +287 -0
  152. package/dist/cli/tsdocs/files.js.map +1 -0
  153. package/dist/cli/tsdocs/index.d.ts +28 -0
  154. package/dist/cli/tsdocs/index.js +307 -0
  155. package/dist/cli/tsdocs/index.js.map +1 -0
  156. package/dist/cli/tsdocs/live.d.ts +41 -0
  157. package/dist/cli/tsdocs/live.js +202 -0
  158. package/dist/cli/tsdocs/live.js.map +1 -0
  159. package/dist/cli/tsdocs/locate.d.ts +51 -0
  160. package/dist/cli/tsdocs/locate.js +75 -0
  161. package/dist/cli/tsdocs/locate.js.map +1 -0
  162. package/dist/cli/tsdocs/render.d.ts +75 -0
  163. package/dist/cli/tsdocs/render.js +323 -0
  164. package/dist/cli/tsdocs/render.js.map +1 -0
  165. package/dist/cli/tsdocs/topics.d.ts +43 -0
  166. package/dist/cli/tsdocs/topics.js +916 -0
  167. package/dist/cli/tsdocs/topics.js.map +1 -0
  168. package/dist/index.d.ts +102 -39
  169. package/dist/index.js +107 -30
  170. package/dist/index.js.map +1 -1
  171. package/dist/livewire/index.d.ts +229 -155
  172. package/dist/livewire/index.js +298 -195
  173. package/dist/livewire/index.js.map +1 -1
  174. package/dist/llms.txt +65 -0
  175. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  176. package/dist/prefabs/CallSessionStore.js +72 -0
  177. package/dist/prefabs/CallSessionStore.js.map +1 -0
  178. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  179. package/dist/prefabs/ConciergeAgent.js +36 -31
  180. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  181. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  182. package/dist/prefabs/FAQBotAgent.js +113 -47
  183. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  184. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  185. package/dist/prefabs/InfoGathererAgent.js +67 -58
  186. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  187. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  188. package/dist/prefabs/ReceptionistAgent.js +39 -31
  189. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  190. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  191. package/dist/prefabs/SurveyAgent.js +84 -68
  192. package/dist/prefabs/SurveyAgent.js.map +1 -1
  193. package/dist/relay/Action.d.ts +44 -21
  194. package/dist/relay/Action.js +75 -17
  195. package/dist/relay/Action.js.map +1 -1
  196. package/dist/relay/Call.d.ts +312 -47
  197. package/dist/relay/Call.js +369 -18
  198. package/dist/relay/Call.js.map +1 -1
  199. package/dist/relay/Deferred.js.map +1 -1
  200. package/dist/relay/Message.d.ts +26 -5
  201. package/dist/relay/Message.js +36 -6
  202. package/dist/relay/Message.js.map +1 -1
  203. package/dist/relay/RelayClient.d.ts +79 -14
  204. package/dist/relay/RelayClient.js +268 -61
  205. package/dist/relay/RelayClient.js.map +1 -1
  206. package/dist/relay/RelayError.d.ts +14 -0
  207. package/dist/relay/RelayError.js +15 -0
  208. package/dist/relay/RelayError.js.map +1 -1
  209. package/dist/relay/RelayEvent.d.ts +96 -65
  210. package/dist/relay/RelayEvent.js +85 -56
  211. package/dist/relay/RelayEvent.js.map +1 -1
  212. package/dist/relay/closedSets.d.ts +111 -0
  213. package/dist/relay/closedSets.js +83 -0
  214. package/dist/relay/closedSets.js.map +1 -0
  215. package/dist/relay/index.d.ts +3 -1
  216. package/dist/relay/index.js +1 -0
  217. package/dist/relay/index.js.map +1 -1
  218. package/dist/relay/normalize.js.map +1 -1
  219. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  220. package/dist/relay/protocol.types.generated.js +8 -0
  221. package/dist/relay/protocol.types.generated.js.map +1 -0
  222. package/dist/relay/types.d.ts +81 -39
  223. package/dist/rest/HttpClient.d.ts +36 -8
  224. package/dist/rest/HttpClient.js +233 -40
  225. package/dist/rest/HttpClient.js.map +1 -1
  226. package/dist/rest/RequestOptions.d.ts +110 -0
  227. package/dist/rest/RequestOptions.js +113 -0
  228. package/dist/rest/RequestOptions.js.map +1 -0
  229. package/dist/rest/RestError.d.ts +52 -6
  230. package/dist/rest/RestError.js +89 -5
  231. package/dist/rest/RestError.js.map +1 -1
  232. package/dist/rest/base/CrudResource.d.ts +16 -26
  233. package/dist/rest/base/CrudResource.js +19 -33
  234. package/dist/rest/base/CrudResource.js.map +1 -1
  235. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  236. package/dist/rest/base/CrudWithAddresses.js +2 -2
  237. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  238. package/dist/rest/base/FabricResource.d.ts +15 -0
  239. package/dist/rest/base/FabricResource.js +16 -0
  240. package/dist/rest/base/FabricResource.js.map +1 -0
  241. package/dist/rest/base/ReadResource.d.ts +62 -0
  242. package/dist/rest/base/ReadResource.js +69 -0
  243. package/dist/rest/base/ReadResource.js.map +1 -0
  244. package/dist/rest/callHandler.d.ts +63 -0
  245. package/dist/rest/callHandler.js +62 -0
  246. package/dist/rest/callHandler.js.map +1 -0
  247. package/dist/rest/index.d.ts +19 -76
  248. package/dist/rest/index.js +49 -120
  249. package/dist/rest/index.js.map +1 -1
  250. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  251. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  252. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  253. package/dist/rest/namespaces/addresses.d.ts +3 -42
  254. package/dist/rest/namespaces/addresses.js +3 -50
  255. package/dist/rest/namespaces/addresses.js.map +1 -1
  256. package/dist/rest/namespaces/calling.d.ts +6 -378
  257. package/dist/rest/namespaces/calling.js +6 -473
  258. package/dist/rest/namespaces/calling.js.map +1 -1
  259. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  260. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  261. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  262. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  263. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  264. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  265. package/dist/rest/namespaces/chat.d.ts +4 -18
  266. package/dist/rest/namespaces/chat.js +4 -21
  267. package/dist/rest/namespaces/chat.js.map +1 -1
  268. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  269. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  270. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  271. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  272. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  273. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  274. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  275. package/dist/rest/namespaces/datasphere.js +6 -72
  276. package/dist/rest/namespaces/datasphere.js.map +1 -1
  277. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  278. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  279. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  280. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  281. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  282. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  283. package/dist/rest/namespaces/fabric.d.ts +11 -273
  284. package/dist/rest/namespaces/fabric.js +14 -363
  285. package/dist/rest/namespaces/fabric.js.map +1 -1
  286. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  287. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  288. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  289. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  290. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  291. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  293. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  294. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  296. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  297. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  298. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  299. package/dist/rest/namespaces/imported-numbers.js +3 -21
  300. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  301. package/dist/rest/namespaces/logs.d.ts +10 -101
  302. package/dist/rest/namespaces/logs.js +10 -128
  303. package/dist/rest/namespaces/logs.js.map +1 -1
  304. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  305. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  306. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  307. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  308. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  309. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  310. package/dist/rest/namespaces/lookup.d.ts +3 -25
  311. package/dist/rest/namespaces/lookup.js +3 -27
  312. package/dist/rest/namespaces/lookup.js.map +1 -1
  313. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  314. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  315. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  316. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  317. package/dist/rest/namespaces/message.types.generated.js +8 -0
  318. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  319. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  320. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  321. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  323. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  324. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  325. package/dist/rest/namespaces/mfa.d.ts +3 -42
  326. package/dist/rest/namespaces/mfa.js +3 -49
  327. package/dist/rest/namespaces/mfa.js.map +1 -1
  328. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  329. package/dist/rest/namespaces/number-groups.js +3 -53
  330. package/dist/rest/namespaces/number-groups.js.map +1 -1
  331. package/dist/rest/namespaces/phone-numbers.d.ts +9 -57
  332. package/dist/rest/namespaces/phone-numbers.js +9 -63
  333. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  334. package/dist/rest/namespaces/project.d.ts +6 -42
  335. package/dist/rest/namespaces/project.js +6 -51
  336. package/dist/rest/namespaces/project.js.map +1 -1
  337. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  338. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  339. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  340. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  341. package/dist/rest/namespaces/project.types.generated.js +8 -0
  342. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  343. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  344. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  345. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  347. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  348. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  349. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  350. package/dist/rest/namespaces/pubsub.js +4 -21
  351. package/dist/rest/namespaces/pubsub.js.map +1 -1
  352. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  353. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  354. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  355. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  356. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  357. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  358. package/dist/rest/namespaces/queues.d.ts +3 -38
  359. package/dist/rest/namespaces/queues.js +3 -44
  360. package/dist/rest/namespaces/queues.js.map +1 -1
  361. package/dist/rest/namespaces/recordings.d.ts +3 -34
  362. package/dist/rest/namespaces/recordings.js +3 -40
  363. package/dist/rest/namespaces/recordings.js.map +1 -1
  364. package/dist/rest/namespaces/registry.d.ts +6 -137
  365. package/dist/rest/namespaces/registry.js +6 -173
  366. package/dist/rest/namespaces/registry.js.map +1 -1
  367. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  368. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  369. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  370. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  371. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  372. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  373. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  374. package/dist/rest/namespaces/short-codes.js +3 -41
  375. package/dist/rest/namespaces/short-codes.js.map +1 -1
  376. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  377. package/dist/rest/namespaces/sip-profile.js +3 -29
  378. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  379. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  380. package/dist/rest/namespaces/verified-callers.js +3 -34
  381. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  382. package/dist/rest/namespaces/video.d.ts +10 -227
  383. package/dist/rest/namespaces/video.js +10 -288
  384. package/dist/rest/namespaces/video.js.map +1 -1
  385. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  386. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  387. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  388. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  389. package/dist/rest/namespaces/video.types.generated.js +8 -0
  390. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  391. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  392. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  393. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  395. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  396. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  397. package/dist/rest/pagination.d.ts +5 -1
  398. package/dist/rest/pagination.js +40 -20
  399. package/dist/rest/pagination.js.map +1 -1
  400. package/dist/rest/types.d.ts +21 -3
  401. package/dist/schema.json +299 -98
  402. package/dist/skills/SkillBase.d.ts +97 -20
  403. package/dist/skills/SkillBase.js +100 -17
  404. package/dist/skills/SkillBase.js.map +1 -1
  405. package/dist/skills/SkillManager.d.ts +66 -13
  406. package/dist/skills/SkillManager.js +101 -20
  407. package/dist/skills/SkillManager.js.map +1 -1
  408. package/dist/skills/SkillName.d.ts +44 -0
  409. package/dist/skills/SkillName.js +2 -0
  410. package/dist/skills/SkillName.js.map +1 -0
  411. package/dist/skills/SkillRegistry.d.ts +47 -7
  412. package/dist/skills/SkillRegistry.js +85 -13
  413. package/dist/skills/SkillRegistry.js.map +1 -1
  414. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  415. package/dist/skills/builtin/api_ninjas_trivia.js +24 -8
  416. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  417. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  418. package/dist/skills/builtin/ask_claude.js +36 -14
  419. package/dist/skills/builtin/ask_claude.js.map +1 -1
  420. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  421. package/dist/skills/builtin/claude_skills.js +19 -15
  422. package/dist/skills/builtin/claude_skills.js.map +1 -1
  423. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  424. package/dist/skills/builtin/custom_skills.js +26 -9
  425. package/dist/skills/builtin/custom_skills.js.map +1 -1
  426. package/dist/skills/builtin/datasphere.d.ts +5 -3
  427. package/dist/skills/builtin/datasphere.js +34 -25
  428. package/dist/skills/builtin/datasphere.js.map +1 -1
  429. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  430. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  431. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  432. package/dist/skills/builtin/datetime.d.ts +3 -1
  433. package/dist/skills/builtin/datetime.js +11 -7
  434. package/dist/skills/builtin/datetime.js.map +1 -1
  435. package/dist/skills/builtin/google_maps.d.ts +29 -14
  436. package/dist/skills/builtin/google_maps.js +89 -269
  437. package/dist/skills/builtin/google_maps.js.map +1 -1
  438. package/dist/skills/builtin/index.d.ts +8 -6
  439. package/dist/skills/builtin/index.js +8 -6
  440. package/dist/skills/builtin/index.js.map +1 -1
  441. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  442. package/dist/skills/builtin/info_gatherer.js +20 -12
  443. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  444. package/dist/skills/builtin/joke.d.ts +16 -6
  445. package/dist/skills/builtin/joke.js +54 -37
  446. package/dist/skills/builtin/joke.js.map +1 -1
  447. package/dist/skills/builtin/math.d.ts +3 -1
  448. package/dist/skills/builtin/math.js +14 -9
  449. package/dist/skills/builtin/math.js.map +1 -1
  450. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  451. package/dist/skills/builtin/mcp_gateway.js +77 -46
  452. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  453. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  454. package/dist/skills/builtin/native_vector_search.js +179 -61
  455. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  456. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  457. package/dist/skills/builtin/play_background_file.js +43 -122
  458. package/dist/skills/builtin/play_background_file.js.map +1 -1
  459. package/dist/skills/builtin/spider.d.ts +46 -1
  460. package/dist/skills/builtin/spider.js +317 -101
  461. package/dist/skills/builtin/spider.js.map +1 -1
  462. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  463. package/dist/skills/builtin/swml_transfer.js +45 -24
  464. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  465. package/dist/skills/builtin/weather_api.d.ts +24 -13
  466. package/dist/skills/builtin/weather_api.js +57 -31
  467. package/dist/skills/builtin/weather_api.js.map +1 -1
  468. package/dist/skills/builtin/web_search.d.ts +48 -10
  469. package/dist/skills/builtin/web_search.js +301 -84
  470. package/dist/skills/builtin/web_search.js.map +1 -1
  471. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  472. package/dist/skills/builtin/wikipedia_search.js +32 -14
  473. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  474. package/dist/skills/index.d.ts +3 -2
  475. package/dist/skills/index.js +1 -1
  476. package/dist/skills/index.js.map +1 -1
  477. package/dist/swml_verbs_generated.d.ts +2824 -0
  478. package/dist/swml_verbs_generated.js +12 -0
  479. package/dist/swml_verbs_generated.js.map +1 -0
  480. package/dist/types.d.ts +65 -6
  481. package/dist/web.d.ts +27 -0
  482. package/dist/web.js +20 -0
  483. package/dist/web.js.map +1 -0
  484. package/docs/agent-guide.md +1034 -0
  485. package/docs/ai_chat.md +560 -0
  486. package/docs/api-reference.md +3534 -0
  487. package/docs/architecture.md +846 -0
  488. package/docs/bedrock_agent.md +411 -0
  489. package/docs/cli-guide.md +403 -0
  490. package/docs/cloud_functions_guide.md +399 -0
  491. package/docs/configuration.md +548 -0
  492. package/docs/contexts-guide.md +884 -0
  493. package/docs/datamap-guide.md +1160 -0
  494. package/docs/developer_pain_points.md +548 -0
  495. package/docs/llm_parameters.md +298 -0
  496. package/docs/mcp_gateway_reference.md +354 -0
  497. package/docs/mcp_integration.md +162 -0
  498. package/docs/pgi_agent_guide.md +1820 -0
  499. package/docs/prefabs-guide.md +815 -0
  500. package/docs/programmatically_governed_inference.md +301 -0
  501. package/docs/sdk_features.md +501 -0
  502. package/docs/security.md +559 -0
  503. package/docs/serverless-guide.md +520 -0
  504. package/docs/skills-guide.md +1223 -0
  505. package/docs/skills-system.md +405 -0
  506. package/docs/skills_parameter_schema.md +417 -0
  507. package/docs/swaig-reference.md +1938 -0
  508. package/docs/swml_service_guide.md +573 -0
  509. package/docs/third_party_skills.md +410 -0
  510. package/docs/web_service.md +666 -0
  511. package/examples/README.md +202 -0
  512. package/examples/advanced-datamap.ts +108 -0
  513. package/examples/advanced-dynamic-config.ts +70 -0
  514. package/examples/auto-vivified.ts +95 -0
  515. package/examples/call-flow.ts +65 -0
  516. package/examples/comprehensive-dynamic.ts +125 -0
  517. package/examples/contexts-steps.ts +65 -0
  518. package/examples/custom-path.ts +45 -0
  519. package/examples/datamap-tools.ts +51 -0
  520. package/examples/datasphere-multi-instance.ts +66 -0
  521. package/examples/datasphere-serverless-env.ts +87 -0
  522. package/examples/datasphere-webhook-env.ts +65 -0
  523. package/examples/datasphere.ts +56 -0
  524. package/examples/declarative.ts +100 -0
  525. package/examples/dynamic-config.ts +54 -0
  526. package/examples/dynamic-info-gatherer.ts +69 -0
  527. package/examples/dynamic-swml-service.ts +67 -0
  528. package/examples/gather-info.ts +95 -0
  529. package/examples/gather-per-question-functions-demo.ts +139 -0
  530. package/examples/joke-agent.ts +34 -0
  531. package/examples/kubernetes-agent.ts +45 -0
  532. package/examples/llm-params.ts +75 -0
  533. package/examples/mcp-agent.ts +89 -0
  534. package/examples/mcp-gateway.ts +81 -0
  535. package/examples/multi-agent.ts +80 -0
  536. package/examples/multi-endpoint.ts +79 -0
  537. package/examples/pgi/case-domain.ts +114 -0
  538. package/examples/pgi/serve.ts +16 -0
  539. package/examples/pgi/support-agent.ts +265 -0
  540. package/examples/pom-prompt.ts +70 -0
  541. package/examples/prefab-concierge.ts +42 -0
  542. package/examples/prefab-faq.ts +58 -0
  543. package/examples/prefab-info-gatherer.ts +33 -0
  544. package/examples/prefab-receptionist.ts +36 -0
  545. package/examples/prefab-survey.ts +69 -0
  546. package/examples/quickstart-agent.ts +29 -0
  547. package/examples/quickstart-relay.ts +25 -0
  548. package/examples/quickstart-rest.ts +25 -0
  549. package/examples/record-call.ts +65 -0
  550. package/examples/relay-demo.ts +33 -0
  551. package/examples/room-and-sip.ts +93 -0
  552. package/examples/serverless-lambda.ts +43 -0
  553. package/examples/session-state.ts +83 -0
  554. package/examples/simple-agent.ts +36 -0
  555. package/examples/simple-static.ts +29 -0
  556. package/examples/skills-demo.ts +41 -0
  557. package/examples/step-function-inheritance-demo.ts +124 -0
  558. package/examples/swaig-features.ts +193 -0
  559. package/examples/swml-service-routing.ts +66 -0
  560. package/examples/swml-service.ts +38 -0
  561. package/examples/swmlservice_ai_sidecar.ts +104 -0
  562. package/examples/swmlservice_swaig_standalone.ts +79 -0
  563. package/examples/tap.ts +67 -0
  564. package/examples/typed-tools.ts +68 -0
  565. package/examples/verb-methods.ts +45 -0
  566. package/examples/web-search-multi-instance.ts +75 -0
  567. package/examples/web-search.ts +38 -0
  568. package/examples/wikipedia.ts +36 -0
  569. package/livewire/README.md +164 -0
  570. package/livewire/docs/migration-guide.md +251 -0
  571. package/livewire/examples/livewire-basic-agent.ts +74 -0
  572. package/livewire/examples/livewire-handoff.ts +196 -0
  573. package/livewire/examples/livewire-multi-tool.ts +121 -0
  574. package/package.json +88 -13
  575. package/relay/README.md +101 -0
  576. package/relay/docs/call-methods.md +622 -0
  577. package/relay/docs/client-reference.md +281 -0
  578. package/relay/docs/events.md +193 -0
  579. package/relay/docs/getting-started.md +221 -0
  580. package/relay/docs/guide.md +386 -0
  581. package/relay/docs/messaging.md +246 -0
  582. package/relay/examples/relay-inbound.ts +66 -0
  583. package/relay/examples/relay-messaging.ts +74 -0
  584. package/relay/examples/relay-outbound.ts +76 -0
  585. package/rest/README.md +141 -0
  586. package/rest/docs/calling.md +313 -0
  587. package/rest/docs/client-reference.md +149 -0
  588. package/rest/docs/fabric.md +192 -0
  589. package/rest/docs/getting-started.md +138 -0
  590. package/rest/docs/guide.md +421 -0
  591. package/rest/docs/namespaces.md +367 -0
  592. package/rest/docs/phone-binding.md +116 -0
  593. package/rest/examples/rest-10dlc-registration.ts +177 -0
  594. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  595. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  596. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  597. package/rest/examples/rest-client.ts +59 -0
  598. package/rest/examples/rest-datasphere-search.ts +81 -0
  599. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  600. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  601. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  602. package/rest/examples/rest-manage-resources.ts +64 -0
  603. package/rest/examples/rest-phone-number-management.ts +200 -0
  604. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  605. package/rest/examples/rest-video-rooms.ts +186 -0
  606. package/tutorial/fred/fred.ts +218 -0
  607. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  608. package/tutorial/fred/tutorial/02-setup.md +304 -0
  609. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  610. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  611. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  612. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  613. package/tutorial/fred/tutorial/README.md +56 -0
  614. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  615. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  616. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  617. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  618. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  619. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  620. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  621. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  622. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  623. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  624. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  625. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  626. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  627. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  628. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  629. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  630. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  631. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  632. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  633. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  634. package/tutorial/multi_agents/README.md +175 -0
  635. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  636. package/tutorial/multi_agents/extending_agents.ts +641 -0
  637. package/tutorial/multi_agents/knowledge.ts +59 -0
  638. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  639. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  640. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  641. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  642. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  643. package/tutorial/multi_agents/pc_builder.ts +529 -0
  644. package/tutorial/multi_agents/sales_agent.ts +88 -0
  645. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  646. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  647. package/tutorial/multi_agents/support_knowledge.md +256 -0
  648. package/dist/cli/mock-data.d.ts +0 -37
  649. package/dist/cli/mock-data.js +0 -80
  650. package/dist/cli/mock-data.js.map +0 -1
  651. package/dist/generateVerbTypes.d.ts +0 -11
  652. package/dist/generateVerbTypes.js +0 -265
  653. package/dist/generateVerbTypes.js.map +0 -1
  654. package/dist/rest/namespaces/compat.d.ts +0 -585
  655. package/dist/rest/namespaces/compat.js +0 -735
  656. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -0,0 +1,529 @@
1
+ /**
2
+ * PC Builder Pro - multi-agent service (Lesson 3)
3
+ *
4
+ * Three agents on one AgentServer:
5
+ * - Triage agent (/): greets the caller and routes them to a specialist
6
+ * - Sales agent (/sales): product recommendations, with a search tool over sales_knowledge.md
7
+ * - Support agent (/support): troubleshooting, with a search tool over support_knowledge.md
8
+ *
9
+ * The triage agent hands the call off with the swml_transfer skill. Its
10
+ * required_fields make the model collect the caller's name and a summary
11
+ * before the transfer, and save them in global data as `call_data`, where the
12
+ * specialists' prompts read them as ${call_data.user_name} and ${call_data.summary}.
13
+ *
14
+ * Run: npx tsx tutorial/multi_agents/pc_builder.ts
15
+ */
16
+
17
+ import { randomBytes } from 'node:crypto';
18
+ import { fileURLToPath, pathToFileURL } from 'node:url';
19
+ import {
20
+ AgentBase,
21
+ AgentServer,
22
+ FunctionResult,
23
+ NativeVectorSearchSkill,
24
+ ServerlessAdapter,
25
+ SwmlTransferSkill,
26
+ getLogger,
27
+ type ServerlessEvent,
28
+ } from '@signalwire/sdk';
29
+ import { loadKnowledge } from './knowledge.js';
30
+
31
+ const log = getLogger('pc_builder');
32
+
33
+ /** Where the service listens, and the credentials all three agents accept. */
34
+ export interface PcBuilderOptions {
35
+ host?: string;
36
+ port?: number;
37
+ basicAuth?: [string, string];
38
+ logLevel?: string;
39
+ }
40
+
41
+ /** The options each agent is constructed with: the server's address and credentials. */
42
+ type AgentOptions = { host: string; port: number; basicAuth?: [string, string] };
43
+
44
+ const knowledgeFile = (name: string): string =>
45
+ fileURLToPath(new URL(`./${name}`, import.meta.url));
46
+
47
+ // region: triage-agent
48
+ /** Alex, the triage agent at the root route. */
49
+ export function createTriageAgent(options: AgentOptions): AgentBase {
50
+ const agent = new AgentBase({ name: 'PC Builder Triage Agent', route: '/', ...options });
51
+
52
+ configureTriagePrompt(agent);
53
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rime.spore' });
54
+
55
+ // The transfer URLs depend on the request (proxy detection), so the
56
+ // transfer tool is added to each request's copy of the agent
57
+ agent.setDynamicConfigCallback(configureTransferTools);
58
+ return agent;
59
+ }
60
+ // endregion: triage-agent
61
+
62
+ // region: transfer-tools
63
+ /**
64
+ * Runs for every request to the triage agent, on that request's copy of it,
65
+ * and adds the swml_transfer skill with URLs built for this request.
66
+ */
67
+ export async function configureTransferTools(
68
+ _query: Record<string, string>,
69
+ _body: unknown,
70
+ _headers: Record<string, string>,
71
+ agent: AgentBase,
72
+ ): Promise<void> {
73
+ // The triage agent's own URL, with its credentials, is the base for the others
74
+ const base = agent.getFullUrl(true).replace(/\/+$/, '');
75
+ const salesUrl = `${base}/sales?transfer=true`;
76
+ const supportUrl = `${base}/support?transfer=true`;
77
+
78
+ await agent.addSkill(
79
+ new SwmlTransferSkill({
80
+ tool_name: 'transfer_to_specialist',
81
+ description: 'Transfer to sales or support specialist with conversation summary',
82
+ parameter_name: 'specialist_type',
83
+ parameter_description: 'The type of specialist to transfer to (sales or support)',
84
+ required_fields: {
85
+ user_name: "The customer's name",
86
+ summary:
87
+ 'A comprehensive summary of the conversation so far, including what the customer needs help with',
88
+ },
89
+ transfers: {
90
+ '/sales/i': {
91
+ url: salesUrl,
92
+ message: 'Perfect! Let me transfer you to our sales specialist right away.',
93
+ return_message:
94
+ 'The call with the sales specialist is complete. How else can I help you?',
95
+ },
96
+ '/support/i': {
97
+ url: supportUrl,
98
+ message: "I'll connect you with our technical support specialist right away.",
99
+ return_message:
100
+ 'The call with the support specialist is complete. How else can I help you?',
101
+ },
102
+ },
103
+ default_message:
104
+ 'I can transfer you to either our sales or support specialist. Which would you prefer?',
105
+ }),
106
+ );
107
+ }
108
+ // endregion: transfer-tools
109
+
110
+ /** The triage agent's prompt. */
111
+ function configureTriagePrompt(agent: AgentBase): void {
112
+ agent.promptAddSection('AI Role', {
113
+ body:
114
+ 'You are Alex, the friendly front desk assistant at PC Builder Pro. ' +
115
+ "You're enthusiastic about technology and love helping customers find " +
116
+ 'the right specialist for their needs. Introduce yourself by name when ' +
117
+ 'greeting customers.',
118
+ });
119
+ agent.promptAddSection('Your Tasks', {
120
+ body: 'Guide customers through the initial triage process with enthusiasm and energy.',
121
+ bullets: [
122
+ 'Greet the customer warmly with your signature enthusiasm',
123
+ 'Ask for their name in a friendly way',
124
+ 'Determine if they need sales (buying/building) or support (technical issues)',
125
+ 'Get a brief description of what they need help with',
126
+ 'Prepare a comprehensive summary before transferring',
127
+ 'Use transfer_to_specialist with both the destination and summary',
128
+ ],
129
+ });
130
+ agent.promptAddSection('Voice Instructions', {
131
+ body: 'Speak with energy and enthusiasm about technology.',
132
+ });
133
+ agent.promptAddSection('Important', {
134
+ body: 'Follow these key guidelines for effective triage:',
135
+ bullets: [
136
+ "Always get the customer's name first",
137
+ 'Ask clarifying questions to determine sales vs support',
138
+ 'The transfer_to_specialist function requires specialist_type, user_name AND summary',
139
+ 'Include customer name, their needs, and reason for transfer in the summary',
140
+ ],
141
+ });
142
+ agent.promptAddSection('Summary Example', {
143
+ body:
144
+ "When transferring, provide a summary like: 'Customer John Smith is " +
145
+ 'interested in building a gaming PC with a budget of $2000. He needs ' +
146
+ 'help selecting compatible components and wants recommendations for ' +
147
+ "the best performance within his budget.'",
148
+ });
149
+ }
150
+
151
+ // region: sales-agent
152
+ /** Morgan, the sales specialist at /sales. */
153
+ export async function createSalesAgent(options: AgentOptions): Promise<AgentBase> {
154
+ const agent = new AgentBase({ name: 'PC Builder Sales Specialist', route: '/sales', ...options });
155
+
156
+ // Greet a transferred caller by name, and a direct caller normally
157
+ agent.setDynamicConfigCallback(configureSalesGreeting);
158
+
159
+ configureSalesPrompt(agent);
160
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rime.marsh' });
161
+
162
+ await agent.addSkill(
163
+ new NativeVectorSearchSkill({
164
+ tool_name: 'search_sales_knowledge',
165
+ description: 'Search sales and product information',
166
+ documents: loadKnowledge(knowledgeFile('sales_knowledge.md')),
167
+ count: 3,
168
+ }),
169
+ );
170
+
171
+ agent.defineTool({
172
+ name: 'create_build_recommendation',
173
+ description: 'Create a custom PC build recommendation',
174
+ parameters: {
175
+ budget: { type: 'string', description: "The customer's budget in dollars" },
176
+ use_case: { type: 'string', description: 'What the PC will be used for' },
177
+ preferences: { type: 'string', description: 'Brand, size or style preferences' },
178
+ },
179
+ required: ['budget', 'use_case', 'preferences'],
180
+ handler: ({ budget, use_case, preferences }) =>
181
+ new FunctionResult(
182
+ `Based on your $${budget} budget for ${use_case}, I recommend: ` +
183
+ '[Custom build details would be generated here based on current ' +
184
+ `market data and your preferences: ${preferences}]`,
185
+ ),
186
+ });
187
+
188
+ agent.defineTool({
189
+ name: 'check_component_compatibility',
190
+ description: 'Check if PC components are compatible',
191
+ parameters: {
192
+ components: { type: 'string', description: 'The components to check, as a list' },
193
+ },
194
+ required: ['components'],
195
+ handler: ({ components }) =>
196
+ new FunctionResult(
197
+ `Compatibility check for: ${components} - ` +
198
+ '[Detailed compatibility analysis would be performed here]',
199
+ ),
200
+ });
201
+
202
+ return agent;
203
+ }
204
+ // endregion: sales-agent
205
+
206
+ // region: sales-greeting
207
+ /** Runs for every request to the sales agent, on that request's copy of it. */
208
+ export function configureSalesGreeting(
209
+ query: Record<string, string>,
210
+ _body: unknown,
211
+ _headers: Record<string, string>,
212
+ agent: AgentBase,
213
+ ): void {
214
+ if (query['transfer'] === 'true') {
215
+ agent.promptAddSection('Call Transfer Information', {
216
+ body: 'This call has been transferred to you from the triage agent.',
217
+ bullets: [
218
+ "The customer's name is ${call_data.user_name} - greet them by name",
219
+ 'They were transferred because: ${call_data.summary}',
220
+ 'Start by greeting them by name and acknowledging why they were transferred',
221
+ "Example: 'Hi ${call_data.user_name}, I'm Morgan! I understand " +
222
+ "you're looking to build a gaming PC with a $2000 budget. I'm " +
223
+ "excited to help you build the perfect system!'",
224
+ ],
225
+ });
226
+ } else {
227
+ agent.promptAddSection('Initial Greeting', {
228
+ body: 'This is a direct call to the sales department.',
229
+ bullets: [
230
+ 'Greet the customer warmly and professionally',
231
+ 'Introduce yourself as a PC building sales specialist',
232
+ 'Ask for their name',
233
+ 'Ask how you can help them today',
234
+ "Example: 'Hello! Welcome to PC Builder Pro sales. I'm Morgan, " +
235
+ 'your PC building specialist. May I have your name, and how can ' +
236
+ "I help you build something amazing today?'",
237
+ ],
238
+ });
239
+ }
240
+ }
241
+ // endregion: sales-greeting
242
+
243
+ /** The sales agent's prompt. */
244
+ function configureSalesPrompt(agent: AgentBase): void {
245
+ agent.promptAddSection('AI Role', {
246
+ body:
247
+ 'You are Morgan, a passionate PC building expert and sales specialist ' +
248
+ "at PC Builder Pro. You're known for your deep knowledge of components " +
249
+ 'and your ability to match customers with their perfect build. You get ' +
250
+ 'excited about the latest hardware and love sharing that enthusiasm. ' +
251
+ 'Always introduce yourself by name.',
252
+ });
253
+ agent.promptAddSection('Your Expertise', {
254
+ body: 'Areas of specialization:',
255
+ bullets: [
256
+ 'Custom PC builds for all budgets',
257
+ 'Component compatibility and optimization',
258
+ 'Performance recommendations',
259
+ 'Price/performance analysis',
260
+ 'Current market trends',
261
+ ],
262
+ });
263
+ agent.promptAddSection('Your Tasks', {
264
+ body: 'Complete sales process workflow with passion and expertise:',
265
+ bullets: [
266
+ 'Understand their specific PC building requirements with genuine interest',
267
+ 'Ask about budget, intended use, and preferences enthusiastically',
268
+ 'Search knowledge base for current product info',
269
+ 'Create customized build recommendations with excitement about the possibilities',
270
+ 'Help with component selection and compatibility while sharing your expertise',
271
+ ],
272
+ });
273
+ agent.promptAddSection('Voice Instructions', {
274
+ body:
275
+ 'Share your passion for PC building and get excited about ' +
276
+ 'helping customers create their perfect system.',
277
+ });
278
+ agent.promptAddSection('Tools Available', {
279
+ body: 'Use these tools to assist customers:',
280
+ bullets: [
281
+ 'search_sales_knowledge: Find current product information',
282
+ 'create_build_recommendation: Generate custom build suggestions',
283
+ 'check_component_compatibility: Verify component compatibility',
284
+ ],
285
+ });
286
+ agent.promptAddSection('Important', {
287
+ body: 'Key guidelines for sales interactions:',
288
+ bullets: [
289
+ 'Ask clarifying questions about their specific requirements',
290
+ 'Use search to get current pricing and availability',
291
+ 'Provide detailed explanations for recommendations',
292
+ ],
293
+ });
294
+ }
295
+
296
+ /** Sam, the support specialist at /support. */
297
+ export async function createSupportAgent(options: AgentOptions): Promise<AgentBase> {
298
+ const agent = new AgentBase({
299
+ name: 'PC Builder Support Specialist',
300
+ route: '/support',
301
+ ...options,
302
+ });
303
+
304
+ agent.setDynamicConfigCallback(configureSupportGreeting);
305
+
306
+ configureSupportPrompt(agent);
307
+ agent.addLanguage({ name: 'English', code: 'en-US', voice: 'rime.cove' });
308
+
309
+ await agent.addSkill(
310
+ new NativeVectorSearchSkill({
311
+ tool_name: 'search_support_knowledge',
312
+ description: 'Search technical support and troubleshooting information',
313
+ documents: loadKnowledge(knowledgeFile('support_knowledge.md')),
314
+ count: 3,
315
+ }),
316
+ );
317
+
318
+ agent.defineTool({
319
+ name: 'diagnose_hardware_issue',
320
+ description: 'Help diagnose PC hardware problems',
321
+ parameters: {
322
+ symptoms: { type: 'string', description: 'What the customer sees or hears' },
323
+ system_specs: { type: 'string', description: "The customer's components, if known" },
324
+ },
325
+ required: ['symptoms', 'system_specs'],
326
+ handler: ({ symptoms, system_specs }) =>
327
+ new FunctionResult(
328
+ `For symptoms '${symptoms}' on system '${system_specs}': ` +
329
+ '[Diagnostic steps and potential solutions would be provided here]',
330
+ ),
331
+ });
332
+
333
+ agent.defineTool({
334
+ name: 'create_support_ticket',
335
+ description: 'Create a support ticket for complex issues',
336
+ parameters: {
337
+ issue_description: { type: 'string', description: 'The problem, in a sentence or two' },
338
+ customer_info: { type: 'string', description: "The customer's name and contact details" },
339
+ priority: { type: 'string', description: 'low, medium or high' },
340
+ },
341
+ required: ['issue_description', 'customer_info', 'priority'],
342
+ handler: ({ issue_description, priority }) => {
343
+ // SUP-YYYYMMDD-HHMMSS, from the current UTC time
344
+ const stamp = new Date().toISOString().replace(/[-:]/g, '').replace('T', '-').slice(0, 15);
345
+ return new FunctionResult(
346
+ `Support ticket SUP-${stamp} created for: ${issue_description}. ` +
347
+ `Priority: ${priority}. We'll follow up within 24 hours.`,
348
+ );
349
+ },
350
+ });
351
+
352
+ return agent;
353
+ }
354
+
355
+ /** Runs for every request to the support agent, on that request's copy of it. */
356
+ export function configureSupportGreeting(
357
+ query: Record<string, string>,
358
+ _body: unknown,
359
+ _headers: Record<string, string>,
360
+ agent: AgentBase,
361
+ ): void {
362
+ if (query['transfer'] === 'true') {
363
+ agent.promptAddSection('Call Transfer Information', {
364
+ body: 'This call has been transferred to you from the triage agent.',
365
+ bullets: [
366
+ "The customer's name is ${call_data.user_name} - greet them by name",
367
+ 'They were transferred because: ${call_data.summary}',
368
+ 'Start by greeting them by name and acknowledging their technical issue',
369
+ "Example: 'Hi ${call_data.user_name}, I'm Sam. I understand you're " +
370
+ "experiencing issues with your PC not booting. Let's work through " +
371
+ "this together and get your system back up and running.'",
372
+ ],
373
+ });
374
+ } else {
375
+ agent.promptAddSection('Initial Greeting', {
376
+ body: 'This is a direct call to the support department.',
377
+ bullets: [
378
+ 'Greet the customer warmly and professionally',
379
+ 'Introduce yourself as a technical support specialist',
380
+ 'Ask for their name',
381
+ "Ask what technical issue they're experiencing",
382
+ "Example: 'Hello! Welcome to PC Builder Pro technical support. " +
383
+ "I'm Sam, and I'm here to help solve any technical issues you're " +
384
+ "facing. May I have your name, and what can I help you troubleshoot today?'",
385
+ ],
386
+ });
387
+ }
388
+ }
389
+
390
+ /** The support agent's prompt. */
391
+ function configureSupportPrompt(agent: AgentBase): void {
392
+ agent.promptAddSection('AI Role', {
393
+ body:
394
+ 'You are Sam, a patient and methodical technical support specialist at ' +
395
+ 'PC Builder Pro. You have a calming presence and excel at breaking down ' +
396
+ "complex technical problems into simple steps. You're known for never " +
397
+ "giving up on a problem until it's solved. Always introduce yourself by name.",
398
+ });
399
+ agent.promptAddSection('Your Expertise', {
400
+ body: 'Areas of technical specialization:',
401
+ bullets: [
402
+ 'Hardware troubleshooting and diagnostics',
403
+ 'Software compatibility issues',
404
+ 'System optimization and performance',
405
+ 'Component failure analysis',
406
+ 'Warranty and repair processes',
407
+ ],
408
+ });
409
+ agent.promptAddSection('Your Tasks', {
410
+ body: 'Complete support process workflow with patience and thoroughness:',
411
+ bullets: [
412
+ 'Understand their specific technical problems with careful listening',
413
+ 'Search knowledge base for solutions methodically',
414
+ 'Guide through diagnostic steps one at a time',
415
+ 'Provide troubleshooting solutions with clear explanations',
416
+ 'Create support tickets for complex issues when needed',
417
+ ],
418
+ });
419
+ agent.promptAddSection('Voice Instructions', {
420
+ body: 'Maintain a calm, patient tone that reassures customers their problems will be solved.',
421
+ });
422
+ agent.promptAddSection('Tools Available', {
423
+ body: 'Use these tools to resolve issues:',
424
+ bullets: [
425
+ 'search_support_knowledge: Find technical solutions',
426
+ 'diagnose_hardware_issue: Analyze hardware problems',
427
+ 'create_support_ticket: Escalate complex issues',
428
+ ],
429
+ });
430
+ agent.promptAddSection('Important', {
431
+ body: 'Key guidelines for support interactions:',
432
+ bullets: [
433
+ 'Ask detailed questions about the problem',
434
+ 'Use search to find known solutions',
435
+ 'Guide step-by-step through troubleshooting',
436
+ 'Be patient and thorough',
437
+ ],
438
+ });
439
+ }
440
+
441
+ // region: server
442
+ /** Create the AgentServer with the three agents registered on their routes. */
443
+ export async function createPcBuilderApp(opts: PcBuilderOptions = {}): Promise<AgentServer> {
444
+ const host = opts.host ?? '0.0.0.0';
445
+ const port = opts.port ?? Number(process.env['PORT'] ?? 3001);
446
+ // AgentServer sets the global log level, so pass SIGNALWIRE_LOG_LEVEL through
447
+ const logLevel = opts.logLevel ?? process.env['SIGNALWIRE_LOG_LEVEL'] ?? 'info';
448
+ const server = new AgentServer({ host, port, logLevel });
449
+
450
+ // The triage agent puts its own credentials in the transfer URLs, so all
451
+ // three agents must accept the same ones
452
+ const agentOptions = { host, port, basicAuth: opts.basicAuth ?? sharedCredentials() };
453
+
454
+ server.register(createTriageAgent(agentOptions), '/');
455
+ server.register(await createSalesAgent(agentOptions), '/sales');
456
+ server.register(await createSupportAgent(agentOptions), '/support');
457
+
458
+ // A route of the server's own, beside the agents'
459
+ server.getApp().get('/info', (c) => c.json(serviceInfo(host, port)));
460
+ return server;
461
+ }
462
+ // endregion: server
463
+
464
+ // region: credentials
465
+ /**
466
+ * The credentials to give all three agents: undefined when
467
+ * SWML_BASIC_AUTH_PASSWORD is set (each agent reads the same variables),
468
+ * otherwise one generated password for all of them.
469
+ */
470
+ function sharedCredentials(): [string, string] | undefined {
471
+ if (process.env['SWML_BASIC_AUTH_PASSWORD']) return undefined;
472
+ const user = process.env['SWML_BASIC_AUTH_USER'] || 'pc_builder';
473
+ return [user, randomBytes(16).toString('hex')];
474
+ }
475
+ // endregion: credentials
476
+
477
+ /** What GET /info returns. */
478
+ function serviceInfo(host: string, port: number): Record<string, unknown> {
479
+ return {
480
+ message: 'PC Builder Pro - Multi-Agent Service',
481
+ agents: {
482
+ triage: {
483
+ endpoint: '/',
484
+ description: 'Greets customers and routes to specialists with automatic context collection',
485
+ },
486
+ sales: {
487
+ endpoint: '/sales',
488
+ description: 'PC building sales and recommendations specialist',
489
+ },
490
+ support: {
491
+ endpoint: '/support',
492
+ description: 'Technical support and troubleshooting specialist',
493
+ },
494
+ },
495
+ features: {
496
+ context_sharing: 'Uses swml_transfer skill with user_name and summary requirements',
497
+ pom_prompts: 'Structured prompts using Prompt Object Model',
498
+ summary_access:
499
+ 'Transfer context available via ${call_data.user_name} and ${call_data.summary}',
500
+ multi_agent: 'Three specialized agents working together',
501
+ },
502
+ usage: {
503
+ triage_swml: `GET/POST http://${host}:${port}/`,
504
+ sales_swml: `GET/POST http://${host}:${port}/sales`,
505
+ support_swml: `GET/POST http://${host}:${port}/support`,
506
+ },
507
+ };
508
+ }
509
+
510
+ // region: main
511
+ export const server = await createPcBuilderApp();
512
+
513
+ // Start the server only when this file is run, not when it's imported
514
+ if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
515
+ const url = `http://localhost:${server.port}`;
516
+ log.info('Starting PC Builder Pro Multi-Agent Service');
517
+ log.info(`Triage Agent (Alex): ${url}/`);
518
+ log.info(`Sales Agent (Morgan): ${url}/sales`);
519
+ log.info(`Support Agent (Sam): ${url}/support`);
520
+ log.info(`Service Info: ${url}/info`);
521
+ await server.run();
522
+ }
523
+ // endregion: main
524
+
525
+ // region: lambda
526
+ /** AWS Lambda entry point: the same three agents, through ServerlessAdapter. */
527
+ export const lambdaHandler: (event: ServerlessEvent) => Promise<unknown> =
528
+ ServerlessAdapter.createLambdaHandler(server.getApp());
529
+ // endregion: lambda
@@ -0,0 +1,88 @@
1
+ /**
2
+ * Simple Sales Agent - Morgan (Lesson 1)
3
+ *
4
+ * A PC building sales specialist with a structured prompt and a voice.
5
+ *
6
+ * Run: npx tsx tutorial/multi_agents/sales_agent.ts
7
+ */
8
+
9
+ // region: construct
10
+ import { pathToFileURL } from 'node:url';
11
+ import { AgentBase } from '@signalwire/sdk';
12
+
13
+ export const agent = new AgentBase({
14
+ name: 'PC Builder Sales Agent - Morgan',
15
+ route: '/',
16
+ host: '0.0.0.0',
17
+ });
18
+ // endregion: construct
19
+
20
+ // region: role
21
+ // Configure the agent's personality and role
22
+ agent.promptAddSection('AI Role', {
23
+ body:
24
+ 'You are Morgan, a passionate PC building expert and sales specialist ' +
25
+ "at PC Builder Pro. You're known for your deep knowledge of components " +
26
+ 'and your ability to match customers with their perfect build. You get ' +
27
+ 'excited about the latest hardware and love sharing that enthusiasm. ' +
28
+ 'Always introduce yourself by name.',
29
+ });
30
+ // endregion: role
31
+
32
+ // region: expertise
33
+ // Add expertise section
34
+ agent.promptAddSection('Your Expertise', {
35
+ body: 'Areas of specialization:',
36
+ bullets: [
37
+ 'Custom PC builds for all budgets',
38
+ 'Component compatibility and optimization',
39
+ 'Performance recommendations',
40
+ 'Price/performance analysis',
41
+ 'Current market trends',
42
+ ],
43
+ });
44
+ // endregion: expertise
45
+
46
+ // region: tasks
47
+ // Define the sales workflow
48
+ agent.promptAddSection('Your Tasks', {
49
+ body: 'Complete sales process workflow with passion and expertise:',
50
+ bullets: [
51
+ 'Greet customers warmly and introduce yourself',
52
+ 'Understand their specific PC building requirements',
53
+ 'Ask about budget, intended use, and preferences',
54
+ 'Provide knowledgeable recommendations',
55
+ 'Share your enthusiasm for PC building',
56
+ 'Offer to explain technical details when helpful',
57
+ ],
58
+ });
59
+ // endregion: tasks
60
+
61
+ // region: voice-instructions
62
+ // Voice and tone instructions
63
+ agent.promptAddSection('Voice Instructions', {
64
+ body:
65
+ 'Share your passion for PC building and get excited about ' +
66
+ 'helping customers create their perfect system. Your enthusiasm ' +
67
+ 'should be genuine and infectious.',
68
+ });
69
+ // endregion: voice-instructions
70
+
71
+ // region: language
72
+ // Configure language and voice
73
+ agent.addLanguage({
74
+ name: 'English',
75
+ code: 'en-US',
76
+ voice: 'rime.marsh', // A friendly, enthusiastic voice
77
+ });
78
+ // endregion: language
79
+
80
+ // region: main
81
+ // Start the server only when this file is run, not when it's imported
82
+ if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
83
+ console.log('Starting PC Builder Sales Agent - Morgan');
84
+ console.log(`Agent running at: ${agent.getFullUrl()}/`);
85
+ console.log('Press Ctrl+C to stop');
86
+ await agent.run();
87
+ }
88
+ // endregion: main