@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,548 @@
1
+ # Developer pain points
2
+
3
+ This guide starts from problems developers recognize when they build voice agents. Each entry names the symptom, the mechanism that addresses it, and the responsibility that still belongs to the application. It's a map of capabilities, not a claim that every safeguard is enabled automatically.
4
+
5
+ It was checked against the `@signalwire/sdk` TypeScript source at commit `a778d3d` (version 3.2.0 in `package.json`), plus changes that were released in 3.5.0 (see `CHANGELOG.md`). It describes the SDK's contract. It doesn't verify the platform's server-side behavior, and no live call was tested. The [PGI implementation guide](pgi_agent_guide.md) labels its capabilities with these entries' `Pxx` numbers. Source identifiers such as [S03] resolve in [Sources](#sources).
6
+
7
+ A working voice demo is not the same as a dependable application. The difficult work often lives around the model: reaching users, managing live media, preserving state, enforcing prerequisites, executing real actions, and recovering when something fails.
8
+
9
+ SignalWire combines the communications runtime with an agent programming model. You define behavior and business logic. The platform runs the voice/AI interaction and applies the workflow and call instructions you provide. The model interprets and explains; your software authorizes and executes. [S01, S02]
10
+
11
+ ## Start here
12
+
13
+ Pick the entries that match where you are:
14
+
15
+ - Building your first voice agent: P01-P06.
16
+ - Making a demo dependable: P07-P18 and P25-P30.
17
+ - Embedding an agent in a product: P19-P24 and P31-P36.
18
+
19
+ ## Why this is more than tool calling
20
+
21
+ A conventional tool integration answers: **What happens when the model asks for this function?**
22
+
23
+ [Programmatically Governed Inference](programmatically_governed_inference.md) (PGI), also called System-Directed AI, also answers: **Which functions, facts, instructions, and transitions should the model even have available at this moment?**
24
+
25
+ That distinction changes where reliability comes from. You do not tell the model the entire business process and ask it not to break the rules. You construct a focused task, expose its permitted operations, and let trusted code advance the interaction when the real conditions are satisfied. [PGI, S03-S05]
26
+
27
+ ### Three responsibilities, not one giant prompt
28
+
29
+ The work splits between three owners:
30
+
31
+ **The model:** understand what a person means, collect information, request an available tool, and explain an outcome.
32
+
33
+ **Your application:** authenticate users, enforce business rules, validate requests, consult systems of record, commit transactions, and decide consequential outcomes.
34
+
35
+ **The platform:** run the communications and AI session, and apply tool and transition scoping. Manage context visibility, execute native interaction actions, and expose control and lifecycle events. [S01-S08]
36
+
37
+ The application can be deeply programmable without owning every audio packet. A webhook can carry business logic without turning the application into the media runtime.
38
+
39
+ ### Three kinds of support
40
+
41
+ Each entry falls into one or more of these:
42
+
43
+ **Handled by the platform:** the native media/AI session and its communications operations.
44
+
45
+ **Controlled through SDK primitives:** tool visibility, legal model navigation, context/history projection, structured results, and workflow actions.
46
+
47
+ **Implemented in your backend:** authorization, transaction correctness, durable state, idempotency, and business policy. PGI gives these controls a place in the interaction; it does not replace them.
48
+
49
+ ### A precise limit
50
+
51
+ Taking away the model's authority to charge a wrong amount is different from guaranteeing it can never say a wrong amount. PGI addresses consequential authority and reduces unnecessary model exposure. Generated speech and summaries still need appropriate validation, grounding, and testing. [PGI]
52
+
53
+ ## 01. Reach users without building a media platform
54
+
55
+ ### P01: I wanted an agent, and ended up building an audio pipeline
56
+
57
+ Connecting recognition, a model, speech synthesis, buffering, and call media can become a separate engineering project before the application does anything useful.
58
+
59
+ **How SignalWire addresses it:** SignalWire runs the voice and AI pipeline. Your Node.js service supplies agent instructions and tools; it does not have to relay each audio chunk. Start with `AgentBase`, not a custom audio bridge.
60
+
61
+ **You still own:** Your application logic, backend integrations, hosting, and end-to-end experience tests.
62
+
63
+ Sources: [S01], [S02].
64
+
65
+ ### P02: The browser demo does not fit our real calling environment
66
+
67
+ A useful agent needs to work in an app, on ordinary phone calls, and with existing business telephony, without a separate behavioral implementation for each.
68
+
69
+ **How SignalWire addresses it:** The platform exposes agents through PSTN calling, SIP, and WebRTC. Keep the agent behavior reusable while choosing the appropriate phone routing, SIP integration, or browser/client connection.
70
+
71
+ **You still own:** Endpoint provisioning, access policies, caller identity, and testing each supported client path. One agent definition does not mean zero endpoint setup.
72
+
73
+ Sources: [S01], [S08].
74
+
75
+ ### P03: Every conversation needs my own long-running audio worker
76
+
77
+ An application that owns the media loop must keep that worker alive and scale it with concurrent conversations.
78
+
79
+ **How SignalWire addresses it:** With the native agent path, SignalWire owns the ongoing media/AI session. Your service handles configuration and tool requests. `serve()` runs a Node.js HTTP server, and `run()` also detects AWS Lambda, Google Cloud Functions, Azure Functions and CGI through `ServerlessAdapter`.
80
+
81
+ **You still own:** Tool latency, webhook availability, provider limits, cold starts, and deployment configuration. RELAY applications still need an appropriate persistent connection.
82
+
83
+ Sources: [S01], [S16].
84
+
85
+ ## 02. Make the conversation work in real time
86
+
87
+ ### P04: The agent talks over people or keeps playing a canceled answer
88
+
89
+ Turn-taking is more than generating a fast answer. It involves speech detection, output playback, interruption, and the state of the live call.
90
+
91
+ **How SignalWire addresses it:** SignalWire handles these concerns in its voice runtime, rather than requiring an application to coordinate every media event. AI parameters and runtime actions expose tuning where the application needs it.
92
+
93
+ **You still own:** Test interruptions, silence, noise, and actual playback on target endpoints. Integrated handling is not a promise of zero latency or flawless recognition.
94
+
95
+ Sources: [S01], [S07], [S08].
96
+
97
+ ### P05: A slow tool leaves the caller in silence or an endless hold
98
+
99
+ Lookups and human availability checks can take longer than a normal conversational turn. An unplanned wait sounds broken.
100
+
101
+ **How SignalWire addresses it:** Configure tool fillers (the `fillers` option of `defineTool()`) for short waits. Use `FunctionResult.hold(prompt, timeout, step, timeoutStep)` for longer ones, with separate resume and timeout steps. With a `prompt`, the model takes one more turn before the hold, while speech detection is still running.
102
+
103
+ **You still own:** Bounded backend timeouts, a useful fallback, and a real completion signal. A hold is not background-job infrastructure.
104
+
105
+ Sources: [S04], [S05], [S08].
106
+
107
+ ### P06: Names, jargon, languages, and pronunciation need endless prompt patches
108
+
109
+ A correct workflow still fails when the agent misunderstands a product name or speaks it poorly.
110
+
111
+ **How SignalWire addresses it:** Configure languages and voices (`addLanguage()`), recognition hints and pattern hints (`addHints()`, `addPatternHint()`), pronunciation rules (`addPronunciation()`), and turn parameters (`setParams()`). These controls sit beside the workflow rather than being buried in a single prompt.
112
+
113
+ **You still own:** Verify supported voice/model settings and test with realistic speakers and audio. Hints improve recognition; they do not establish facts or identity.
114
+
115
+ Sources: [S07].
116
+
117
+ ## 03. Keep consequential decisions in software
118
+
119
+ ### P07: The model uses a tool that does not belong at this stage
120
+
121
+ Giving the model every available tool makes it responsible for remembering which ones are appropriate now.
122
+
123
+ **How SignalWire addresses it:** Expose a small, explicit tool set per step with `setFunctions()`. A verification stage can expose only verification-related operations; a later stage can expose fulfillment. Tools are registered once with `defineTool()` and made available per step.
124
+
125
+ **You still own:** Explicit tool lists, including empty ones, and backend authorization. An omitted list can inherit the previous active set; it is not the same as disabling tools.
126
+
127
+ Sources: [S03], [S05].
128
+
129
+ ### P08: The agent skips a required step because the user asks nicely
130
+
131
+ A prompt saying "verify first" leaves workflow sequencing dependent on model compliance.
132
+
133
+ **How SignalWire addresses it:** Define permitted model transitions with contexts and steps (`setValidSteps()`, `setValidContexts()`). Where a prerequisite is mandatory, remove model navigation with an empty list and let a validated tool result move the workflow with `swmlChangeStep()`. Trusted code retains transition authority.
134
+
135
+ **You still own:** Encode and test the prerequisite in software. Completion criteria describe intent; they are not proof of verification or consent.
136
+
137
+ Sources: [S03], [S04].
138
+
139
+ ### P09: The agent invents a price, promise, or transaction outcome
140
+
141
+ Fluent language is not an inventory check, an authorization decision, or a completed transaction.
142
+
143
+ **How SignalWire addresses it:** Handlers consult authoritative systems and perform permitted actions. Return verified outcomes for the model to explain, while state changes and routing go to the platform separately.
144
+
145
+ **You still own:** Correct business rules and data. The model can still say something wrong; PGI limits its authority over outcomes rather than guaranteeing every utterance.
146
+
147
+ Sources: [S04], [S05].
148
+
149
+ ## 04. Replace sprawling prompts with focused workflows
150
+
151
+ ### P10: One giant prompt is trying to run every department and exception
152
+
153
+ As scope grows, unrelated instructions, tools, and responsibilities compete in the same model context.
154
+
155
+ **How SignalWire addresses it:** Use a shared base prompt for stable behavior, contexts for distinct modes, and steps for the current task. Change the role and available capabilities without building a separate media application.
156
+
157
+ **You still own:** Design sensible boundaries. Keep each stage focused; do not reproduce the entire workflow in every step prompt.
158
+
159
+ Sources: [S03], [S07].
160
+
161
+ ### P11: The agent skips form questions or infers answers it should ask for
162
+
163
+ Collecting structured information through a freeform conversation can produce missing, reordered, or assumed values.
164
+
165
+ **How SignalWire addresses it:** Gather mode (`setGatherInfo()` and `addGatherQuestion()`) presents questions one at a time. It offers typed submissions, optional confirmation, per-question tools, and optional isolation from sibling answers. Results accumulate as structured session data.
166
+
167
+ **You still own:** Domain validation and downstream acceptance checks. During gather, required helpers and escalation tools must be explicitly available for each question.
168
+
169
+ Sources: [S03], [S20].
170
+
171
+ ### P12: Earlier instructions or answers keep contaminating the next task
172
+
173
+ Keeping everything in the model context can preserve irrelevant instructions; discarding everything can make the caller repeat useful information.
174
+
175
+ **How SignalWire addresses it:** Choose history visibility per step or context with `setHistory()`. Keep dialogue while dropping old instructions, hide prior dialogue, or reintroduce a curated summary with a `${step_history.*}` reference. The call log remains separate.
176
+
177
+ **You still own:** Decide what the next stage needs. Context isolation is not log deletion or a retention policy.
178
+
179
+ Sources: [S03].
180
+
181
+ ## 05. Separate application truth from conversational context
182
+
183
+ ### P13: The conversation transcript has become our database
184
+
185
+ Facts extracted from an informal conversation are a poor substitute for structured application state.
186
+
187
+ **How SignalWire addresses it:** Use `global_data` for session-scoped workflow data and references. Handlers read it from the request and return explicit updates with `updateGlobalData()`, while durable records remain in your database or system of record.
188
+
189
+ **You still own:** Cross-session persistence, validation, concurrency, and transactions. Do not store caller-specific truth on a shared agent instance.
190
+
191
+ Sources: [S04], [S07], [S26].
192
+
193
+ ### P14: We put whole customer records into the prompt in case they're needed
194
+
195
+ Overexposing data increases the amount the model can misuse or repeat, even when most fields are irrelevant.
196
+
197
+ **How SignalWire addresses it:** Keep authoritative data behind tools and project only the facts needed for the current task. Structured session data is not automatically the full model context; explicitly surfaced fields cross that boundary.
198
+
199
+ **You still own:** Minimize sensitive values in prompts, tool results, logs, and summaries. Prefer opaque references to secrets. This is not automatic redaction or compliance certification.
200
+
201
+ Sources: [S03], [S04], [S07].
202
+
203
+ ### P15: The agent guesses when it should consult a knowledge source
204
+
205
+ Adding documents to a giant prompt does not make live facts current or ensure a useful answer is grounded.
206
+
207
+ **How SignalWire addresses it:** Use search skills (`native_vector_search`, `datasphere`, `datasphere_serverless`, `web_search`, `wikipedia_search`) or application tools to retrieve relevant material on demand. The TypeScript `native_vector_search` skill searches documents passed in its configuration, or a remote search server; it has no local index files. Scope retrieval to the current task and return concise, attributable facts.
208
+
209
+ **You still own:** Freshness, access controls, source quality, and a clear no-answer path. Retrieval is evidence, not authorization, and retrieved text remains untrusted input.
210
+
211
+ Sources: [S10], [S11].
212
+
213
+ ## 06. Make tools operate the application, not only talk about it
214
+
215
+ ### P16: The tool returns text, then we hope the model does the next thing
216
+
217
+ "Tell the user it worked" should not also be the mechanism that commits state, updates a screen, or changes call routing.
218
+
219
+ **How SignalWire addresses it:** `FunctionResult` separates model-facing outcomes and instructions (`setToolResponse()`) from platform actions. A handler can return a data update, step change, client event (`swmlUserEvent()`), or call operation alongside the explanation.
220
+
221
+ **You still own:** External transaction correctness and failure recovery. One structured result does not make unrelated external services one rollback-capable transaction.
222
+
223
+ Sources: [S04], [S26].
224
+
225
+ ### P17: A small API lookup requires another custom webhook service
226
+
227
+ Writing and operating a proxy for every small REST integration adds glue code without adding business value.
228
+
229
+ **How SignalWire addresses it:** `DataMap` defines API calls the platform executes, response mapping, expressions, and fallback results. Use it for a direct REST integration; use TypeScript handlers for substantial policy and transaction logic.
230
+
231
+ **You still own:** API credentials, fixed/allowed destinations, authorization at the upstream service, and useful error handling. DataMap doesn't run your code.
232
+
233
+ Sources: [S09].
234
+
235
+ ### P18: Every agent rebuilds the same tools and integrations
236
+
237
+ Copying search, date/time, or integration code across agents makes maintenance and behavior inconsistent.
238
+
239
+ **How SignalWire addresses it:** Package capabilities as skills (`addSkill()`), include remote functions (`addFunctionInclude()`), or integrate MCP tools (`addMcpServer()`, or the `mcp_gateway` skill). Compose reusable implementation while still choosing which tools each phase exposes.
240
+
241
+ **You still own:** Review imported tools, configuration, credentials, and trust boundaries. Loading an integration does not mean every imported operation should be visible everywhere.
242
+
243
+ Sources: [S10], [S19], [S07].
244
+
245
+ ## 07. Treat AI, people, and interfaces as one interaction
246
+
247
+ ### P19: "Agent handoff" hides several different behaviors
248
+
249
+ Changing a role, consulting a specialist, temporarily connecting elsewhere, and permanently transferring the call have different state and lifecycle needs.
250
+
251
+ **How SignalWire addresses it:** Use a context change for a new role in the same agent, and a tool for a bounded consultation. Use a non-final `connect()` or `swmlTransfer()` when the call should return, and a final transfer for a true handoff.
252
+
253
+ **You still own:** Choose the right pattern, define return/failure behavior, and decide which state crosses the boundary. Hosting two agents does not orchestrate them.
254
+
255
+ Sources: [S03], [S04], [S22].
256
+
257
+ ### P20: Escalation to a human loses context or is only a spoken promise
258
+
259
+ An agent saying "I will transfer you" is not the same as routing the live call with a useful handoff.
260
+
261
+ **How SignalWire addresses it:** A handler can execute native call actions and announce the transfer first. It can send the receiving application selected context through the integration you define.
262
+
263
+ **You still own:** Destination availability, queue policy, access to the handoff record, and no-answer handling. A raw phone or SIP destination does not automatically receive structured state.
264
+
265
+ Sources: [S04], [S08].
266
+
267
+ ### P21: The voice says one thing while the application screen shows another
268
+
269
+ Parsing spoken language to drive the interface couples application behavior to model wording.
270
+
271
+ **How SignalWire addresses it:** Return structured client events and runtime state changes from the same handler that produced the result. Let the UI react to application data, not to a guessed interpretation of speech.
272
+
273
+ **You still own:** Client subscriptions, event correlation, reconnect recovery, and a durable source for resynchronizing the UI. Events are not durable storage.
274
+
275
+ Sources: [S04].
276
+
277
+ ## 08. Embed the experience without leaking authority
278
+
279
+ ### P22: Switching between text and voice starts the conversation over
280
+
281
+ A new medium can begin before the old one has finished saving, creating missing context and race conditions.
282
+
283
+ **How SignalWire addresses it:** The SDK includes `AIChatClient`, `ChatGateway`, and `HandoffRouter`. The handoff mechanism supports nonce-bound call access and waiting for application-confirmed capture before moving to the replacement leg.
284
+
285
+ **You still own:** Persist and restore the appropriate record through callbacks. Configure capture ordering and shared/sticky state where required; continuity is not automatic cross-channel memory.
286
+
287
+ Sources: [S13], [S14], [S22].
288
+
289
+ ### P23: Embedding a chat widget exposes our project API token
290
+
291
+ A browser cannot safely hold broad server credentials to start an agent conversation.
292
+
293
+ **How SignalWire addresses it:** `ChatGateway` keeps project credentials server-side, binds a publishable key to a selected agent configuration, issues signed handles, and applies conversation/turn caps.
294
+
295
+ **You still own:** Abuse prevention, stable signing secrets, and distributed limiting. A publishable key is public; origin restrictions are not user authentication. Voice-client authorization is configured separately.
296
+
297
+ Sources: [S13].
298
+
299
+ ### P24: Personalization leaks between customers or tenants
300
+
301
+ Mutating a shared agent instance can accidentally carry one caller's configuration into another caller's session.
302
+
303
+ **How SignalWire addresses it:** Per-call callbacks (`addPerCallConfig()`, `setDynamicConfigCallback()`) configure a per-request copy of the agent. Use them to vary prompts, languages, tools, and session data. `addPerCallConfig()` callbacks accumulate; `setDynamicConfigCallback()` replaces every callback registered so far.
304
+
305
+ **You still own:** Authenticate tenant selection and namespace durable state. Never grant privileges from a caller-supplied tier or mutate shared per-caller state.
306
+
307
+ Sources: [S06].
308
+
309
+ ## 09. Design for failure rather than only the happy path
310
+
311
+ ### P25: A retry creates the same booking, case, or message twice
312
+
313
+ Tools and networks fail in ways that leave the caller unsure whether an operation completed.
314
+
315
+ **How SignalWire addresses it:** Because handlers own execution, place idempotency keys, transaction checks, and authoritative status lookup in normal backend code. Return the existing outcome on a safe retry and move the workflow accordingly.
316
+
317
+ **You still own:** The idempotency implementation. PGI enables this design; it does not automatically make every external side effect exactly once.
318
+
319
+ Sources: [S04], [S05].
320
+
321
+ ### P26: Anyone with a callback URL can try to invoke a privileged tool
322
+
323
+ A hidden tool is not a replacement for authenticated HTTP endpoints and application authorization.
324
+
325
+ **How SignalWire addresses it:** The SDK supports Basic Auth, function tokens, and inbound webhook signature validation. Configure the relevant mechanisms, then validate identity, tenant, state, and permissions in handlers. With a signing key set (`signingKey` or `SIGNALWIRE_SIGNING_KEY`), the agent refuses a POST to its SWML, `/swaig`, `/post_prompt` and routing-callback routes without a valid SignalWire signature. That holds on a web server and through `ServerlessAdapter`. A secure tool, the default for `defineTool()`, runs only with the token minted for that function and call. The 3.5.0 section of `CHANGELOG.md` lists paths that earlier releases didn't check.
326
+
327
+ **You still own:** Enable signature checking, protect proxy trust, manage secrets, and reject unauthorized business operations. Apps added with `mount()` aren't behind the agent's basic auth or signature check. Caller ID alone is not verified customer identity.
328
+
329
+ Sources: [S12], [S27].
330
+
331
+ ### P27: A rolling deployment suddenly breaks tools on active calls
332
+
333
+ Tokens signed with a random process-local secret may fail after a restart or on another replica.
334
+
335
+ **How SignalWire addresses it:** Set a stable SWAIG secret (`swaigSecret` or `SIGNALWIRE_SWAIG_SECRET`) across the replicas serving an agent. Keep the inbound webhook signing key distinct. Chat handles (`SIGNALWIRE_CHAT_GATEWAY_SECRET`) and handoff registries also have explicit multi-replica requirements.
336
+
337
+ **You still own:** Secret storage and rotation, shared state or routing strategy, and deploy-while-active tests. Reconnection alone does not guarantee session recovery.
338
+
339
+ Sources: [S12], [S13], [S14].
340
+
341
+ ## 10. Test and observe behavior as software
342
+
343
+ ### P28: We can only test the agent by calling it and hoping
344
+
345
+ Listening to a demo does not verify legal transitions, tool exposure, or backend invariants.
346
+
347
+ **How SignalWire addresses it:** Use `swaig-test` (`--dump-swml`, `--list-tools`, `--exec`) to inspect SWML, discover tools, and execute handlers locally. Add unit tests for business rules and serialized workflow contracts, then use live tests for speech and platform behavior.
348
+
349
+ **You still own:** Adversarial scenarios, realistic calls, regression coverage, and deployment checks. Local handler tests do not exercise runtime tool scoping or audio behavior.
350
+
351
+ Sources: [S15], [S03], [S04].
352
+
353
+ ### P29: When something goes wrong, we only have the final transcript
354
+
355
+ The final words do not explain which step, tool, or application action produced an outcome.
356
+
357
+ **How SignalWire addresses it:** Use debug events (`enableDebugEvents()`), call logs, step and transition information where provided, RELAY control IDs, and application logs. Correlate model requests with handler decisions and platform actions.
358
+
359
+ **You still own:** Retention, redaction, correlation IDs, and alerting. Do not log full raw payloads or assume every diagnostic is enabled by default.
360
+
361
+ Sources: [S02], [S24], [S26].
362
+
363
+ ### P30: Post-call summaries become the only record of what happened
364
+
365
+ A generated recap can be useful and still be wrong about whether an action completed.
366
+
367
+ **How SignalWire addresses it:** Keep authoritative outcomes in your application. Use `onCallEnd()` for transcript capture and `onSummary()` with a post-prompt for generated summaries. The SDK distinguishes these lifecycle paths.
368
+
369
+ **You still own:** Durable, idempotent persistence and schema validation of summaries. Do not let an inferred summary become the source of transaction truth.
370
+
371
+ Sources: [S02], [S26].
372
+
373
+ ## 11. Keep the programming model composable
374
+
375
+ ### P31: We need both declarative agents and live application control
376
+
377
+ Some tasks are best described as a flow; others require reacting immediately to application events.
378
+
379
+ **How SignalWire addresses it:** Use `AgentBase` and SWML for behavior, RELAY (`RelayClient`) for persistent event-driven call control, and REST (`restClient()`) for resources or HTTP call commands. AI is already an operation on a live RELAY `Call` object (`call.ai()`).
380
+
381
+ **You still own:** Choose the surface to match the task. Not every action has identical semantics across interfaces, and an AI action's lifetime is not the whole call's lifetime.
382
+
383
+ Sources: [S01], [S08], [S17].
384
+
385
+ ### P32: The AI agent cannot fit into our existing call flow
386
+
387
+ Applications often need an announcement, recording, menu, verification flow, or routing decision before or after an AI interaction.
388
+
389
+ **How SignalWire addresses it:** Add pre-answer, post-answer, and post-AI operations around the AI verb in the same SWML document (`addPreAnswerVerb()`, `addPostAnswerVerb()`, `addPostAiVerb()`). Use `SWMLService` for non-AI flows and explicit platform actions during a conversation.
390
+
391
+ **You still own:** Lifecycle ordering and exit paths. A final transfer or hangup may bypass later operations; do not confuse ending step mode with ending the call.
392
+
393
+ Sources: [S02], [S03], [S21].
394
+
395
+ ### P33: Adding agents means multiplying servers and duplicated endpoints
396
+
397
+ A product may need several specialists, reusable application routes, and different entry points without a separate deployment for each.
398
+
399
+ **How SignalWire addresses it:** `AgentServer` hosts multiple agents by route. An agent's Hono app (`getApp()`) can be embedded in a web application, and `mount()` adds your routes beside the agent's, while `SWMLService` serves other flows. SIP username routing (`enableSipRouting()`, `registerSipUsername()`) provides another entry-point mapping.
400
+
401
+ **You still own:** Route ownership, authentication, per-agent configuration, and resource isolation. Shared hosting is an operational choice, not automatic cross-agent memory.
402
+
403
+ Sources: [S01], [S02], [S06], [S25].
404
+
405
+ ## 12. Retain control as the product grows
406
+
407
+ ### P34: Migrating frameworks means rewriting the whole agent at once
408
+
409
+ A team may already have familiar agent APIs and tools but want the communications runtime elsewhere.
410
+
411
+ **How SignalWire addresses it:** LiveWire (`@signalwire/sdk/livewire`) offers a documented LiveKit-style compatibility surface. Use it where its mapped behavior fits, or use the native SDK for explicit PGI controls and full clarity.
412
+
413
+ **You still own:** Review the compatibility table: several STT/TTS/VAD/plugin controls are stubs or no-ops because the platform owns them. It is not a complete drop-in replacement.
414
+
415
+ Sources: [S18].
416
+
417
+ ### P35: Changing a model means rebuilding the application architecture
418
+
419
+ When business rules depend on one model's obedience, every model change can affect more than language quality.
420
+
421
+ **How SignalWire addresses it:** Keep business policy in handlers and model-visible scope in the workflow. Configure supported model, voice, and language choices within the platform rather than rebuilding the media pipeline.
422
+
423
+ **You still own:** Verify supported options and retest tool use, language quality, latency, and cost. PGI reduces dependence on model compliance; it does not make models behaviorally identical.
424
+
425
+ Sources: [S07].
426
+
427
+ ### P36: The agent is a silo that cannot use the rest of communications
428
+
429
+ Real applications may need messages, recording, conferencing, SIP operations, media taps, or another call, not only a spoken answer.
430
+
431
+ **How SignalWire addresses it:** Function results (`sendSms()`, `recordCall()`, `joinConference()`, `tap()`, `sipRefer()`) and the broader SDK expose native communications actions alongside AI behavior. Use those primitives directly instead of making the model narrate an action your software never performs.
432
+
433
+ **You still own:** Permissions, destination allowlists, user consent, applicable policies, and validation of each action. Expose only the operations needed for the current task.
434
+
435
+ Sources: [S04], [S08], [S17].
436
+
437
+ ## One example: a service request, from conversation to completed work
438
+
439
+ A caller asks for an equipment repair. The model can understand that request without being trusted to create any repair, for any customer, at any time. The request moves through these phases:
440
+
441
+ | Phase | What the model gets | What software does |
442
+ |---|---|---|
443
+ | Identify | The minimum questions and identity-related tools | Establish the authenticated customer and permitted account scope |
444
+ | Collect | One focused task or gather sequence | Validate and retain the necessary fields |
445
+ | Prepare | Only request-preparation tools | Check eligibility, construct the proposed action, and return a factual preview |
446
+ | Review | Tools for revision, confirmation intent, or escalation | Enforce the appropriate approval policy against the current proposal |
447
+ | Execute | No authority to invent the result | Commit idempotently, then return outcome data and platform actions |
448
+ | Continue or hand off | The information relevant to the next task | Change the step, update the UI, connect a person, or end the call |
449
+
450
+ A user saying "skip verification" does not create a verification result. A model saying "done" does not create a completed transaction. A repeated tool request does not have to create a second case. Those are software properties, tested independently of the voice interface. [S03-S05]
451
+
452
+ For low-risk operations, the model may interpret a spoken confirmation. Where stronger evidence is required, collect it through a trusted application interaction or dedicated input flow, and bind it to the exact action being approved. A tool named confirm is not proof of consent.
453
+
454
+ The [reference implementation in the PGI implementation guide](pgi_agent_guide.md#6-reference-implementation) builds the prepare, review and execute phases of a flow like this one, with tests.
455
+
456
+ ### What the developer builds
457
+
458
+ An agent definition, small focused handlers, explicit workflow boundaries, backend persistence, and integration with the surrounding product. Not a recognition/model/synthesis relay loop. The live experience is still tested on real endpoints. [S01-S05]
459
+
460
+ ## An adoption path that does not start with a rewrite
461
+
462
+ Take these steps in order:
463
+
464
+ **Start with one useful task.** Define a business outcome and the invariants that must remain true even when the model misunderstands a user.
465
+
466
+ **Choose the right surface.** Use `AgentBase` for native agents and `SWMLService` for declarative non-AI flows. Use RELAY for event-driven live control, and REST for resource management and supported call commands. These are complementary choices. [S01, S08, S17, S21]
467
+
468
+ **Add only the necessary boundaries.** An informational agent does not need a twenty-stage workflow. A transaction flow does need explicit prerequisites, restricted capabilities, and backend checks. Add strictness where it protects an invariant.
469
+
470
+ **Test software first, conversation second.** Verify handlers and emitted workflow configuration locally. Then test calls, interruptions, tool failures, transfers, authentication, and rolling deployments. [S15]
471
+
472
+ **Expand by composition.** Add another task, language, agent route, tool, or communication path without moving policy into prompts or rebuilding the media loop. [S01-S08]
473
+
474
+ ## Glossary
475
+
476
+ These terms appear throughout the entries:
477
+
478
+ | Term | Plain meaning |
479
+ |---|---|
480
+ | AgentBase | The TypeScript class for defining an agent's behavior and tools |
481
+ | SWML | SignalWire Markup Language: the platform's declarative instructions for an interaction |
482
+ | SWAIG | SignalWire AI Gateway: tool definitions, requests, results, and platform actions |
483
+ | PGI / System-Directed AI | A programming discipline that keeps consequential authority in software and deliberately scopes the model's operating environment. See [Programmatically Governed Inference](programmatically_governed_inference.md). |
484
+ | AI Kernel | The platform's integrated AI/interaction runtime; not a claim that every model runs inside the Node.js service |
485
+ | Context / step | A conversation mode and its current phase |
486
+ | global_data | Structured session data, separate from the model's automatically visible context |
487
+ | FunctionResult | A handler result that can address both the model and the platform |
488
+ | DataMap | A tool mapping the platform executes, often for a direct REST integration |
489
+ | RELAY | Persistent, event-driven application control of calls and messaging |
490
+ | PSTN / SIP / WebRTC | Ordinary telephone access, business/Internet telephony, and real-time client/browser communications |
491
+
492
+ ## Sources
493
+
494
+ The identifiers in the entries resolve to these documents and source files in this repository. They use the same numbers as the [PGI implementation guide's sources](pgi_agent_guide.md#122-implementation-sources).
495
+
496
+ - [PGI] [Programmatically Governed Inference](programmatically_governed_inference.md): `docs/programmatically_governed_inference.md`.
497
+
498
+ - [S01] [SDK architecture and package surfaces](../README.md): `README.md`.
499
+
500
+ - [S02] Agent construction and call lifecycle: `src/AgentBase.ts`.
501
+
502
+ - [S03] Contexts, steps, history, and gather implementation: `src/ContextBuilder.ts`.
503
+
504
+ - [S04] Tool results and native platform actions: `src/FunctionResult.ts`.
505
+
506
+ - [S05] Tool registration, dispatch, and schemas: `src/SwaigFunction.ts`.
507
+
508
+ - [S06] Per-request configuration and mounted routes: `src/AgentBase.ts` (`addPerCallConfig()`, `setDynamicConfigCallback()`, `mount()`).
509
+
510
+ - [S07] AI configuration, languages, state, and model parameters: `src/AgentBase.ts` (`addLanguage()`, `setGlobalData()`, `setParams()`, `setPromptLlmParams()`).
511
+
512
+ - [S08] RELAY live call implementation: `src/relay/Call.ts`.
513
+
514
+ - [S09] [DataMap tools the platform executes](datamap-guide.md): `docs/datamap-guide.md`.
515
+
516
+ - [S10] [Skills and reusable integrations](skills-system.md): `docs/skills-system.md`.
517
+
518
+ - [S11] Document search skill: `src/skills/builtin/native_vector_search.ts`.
519
+
520
+ - [S12] [Authentication, signatures, and signing secrets](security.md): `docs/security.md`.
521
+
522
+ - [S13] [AI Chat client, browser gateway and handoff routes](ai_chat.md): `docs/ai_chat.md`.
523
+
524
+ - [S14] Voice/text continuity and secure handoff routing: `src/ai-chat/HandoffRouter.ts`.
525
+
526
+ - [S15] [Local CLI testing](cli-guide.md): `docs/cli-guide.md`.
527
+
528
+ - [S16] [Serverless deployment adapters](serverless-guide.md): `docs/serverless-guide.md`.
529
+
530
+ - [S17] [REST resource management and call control](../rest/README.md): `rest/README.md`.
531
+
532
+ - [S18] [LiveWire compatibility scope](../livewire/README.md): `livewire/README.md`.
533
+
534
+ - [S19] [MCP gateway and tool integration](mcp_gateway_reference.md): `docs/mcp_gateway_reference.md`.
535
+
536
+ - [S20] [Gather per-question capability scoping](../examples/gather-per-question-functions-demo.ts): `examples/gather-per-question-functions-demo.ts`.
537
+
538
+ - [S21] [Declarative SWML without an AI agent](swml_service_guide.md): `docs/swml_service_guide.md`.
539
+
540
+ - [S22] AI Chat client implementation: `src/ai-chat/AIChatClient.ts`.
541
+
542
+ - [S24] [RELAY event and action model](../relay/docs/events.md): `relay/docs/events.md`.
543
+
544
+ - [S25] Agent hosting and shared HTTP server: `src/AgentServer.ts`.
545
+
546
+ - [S26] [SWAIG request/result contract](swaig-reference.md): `docs/swaig-reference.md`.
547
+
548
+ - [S27] [Release notes, including 3.5.0](../CHANGELOG.md): `CHANGELOG.md`.