@signalwire/sdk 2.0.5 → 3.6.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 (659) hide show
  1. package/CHANGELOG.md +821 -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 +510 -126
  6. package/dist/AgentBase.js +1581 -455
  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 +186 -45
  21. package/dist/DataMap.js +210 -52
  22. package/dist/DataMap.js.map +1 -1
  23. package/dist/FunctionResult.d.ts +309 -83
  24. package/dist/FunctionResult.js +483 -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 +12 -1
  30. package/dist/POM/PromptObjectModel.js +25 -9
  31. package/dist/POM/PromptObjectModel.js.map +1 -1
  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 +18 -0
  42. package/dist/PomBuilder.js +53 -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 +22 -1
  48. package/dist/PromptManager.js +28 -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 +169 -59
  58. package/dist/SWMLService.js +456 -129
  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 +49 -9
  64. package/dist/SecurityUtils.js +153 -51
  65. package/dist/SecurityUtils.js.map +1 -1
  66. package/dist/SemanticGate.d.ts +183 -0
  67. package/dist/SemanticGate.js +533 -0
  68. package/dist/SemanticGate.js.map +1 -0
  69. package/dist/ServerlessAdapter.d.ts +156 -7
  70. package/dist/ServerlessAdapter.js +399 -42
  71. package/dist/ServerlessAdapter.js.map +1 -1
  72. package/dist/SessionManager.d.ts +11 -2
  73. package/dist/SessionManager.js +50 -18
  74. package/dist/SessionManager.js.map +1 -1
  75. package/dist/SslConfig.d.ts +2 -1
  76. package/dist/SslConfig.js +4 -1
  77. package/dist/SslConfig.js.map +1 -1
  78. package/dist/SwaigActions.generated.d.ts +23 -0
  79. package/dist/SwaigActions.generated.js +8 -0
  80. package/dist/SwaigActions.generated.js.map +1 -0
  81. package/dist/SwaigContracts.d.ts +15 -0
  82. package/dist/SwaigContracts.generated.d.ts +264 -0
  83. package/dist/SwaigContracts.generated.js +12 -0
  84. package/dist/SwaigContracts.generated.js.map +1 -0
  85. package/dist/SwaigContracts.js +2 -0
  86. package/dist/SwaigContracts.js.map +1 -0
  87. package/dist/SwaigFunction.d.ts +139 -7
  88. package/dist/SwaigFunction.js +170 -22
  89. package/dist/SwaigFunction.js.map +1 -1
  90. package/dist/SwmlBuilder.d.ts +68 -19
  91. package/dist/SwmlBuilder.js +74 -38
  92. package/dist/SwmlBuilder.js.map +1 -1
  93. package/dist/SwmlVerbMethods.generated.d.ts +41 -4
  94. package/dist/SwmlVerbMethods.generated.js +1 -1
  95. package/dist/TypeInference.d.ts +39 -3
  96. package/dist/TypeInference.js +256 -16
  97. package/dist/TypeInference.js.map +1 -1
  98. package/dist/WebService.d.ts +79 -11
  99. package/dist/WebService.js +320 -109
  100. package/dist/WebService.js.map +1 -1
  101. package/dist/WebhookMiddleware.d.ts +119 -0
  102. package/dist/WebhookMiddleware.js +271 -0
  103. package/dist/WebhookMiddleware.js.map +1 -0
  104. package/dist/WebhookValidator.d.ts +92 -0
  105. package/dist/WebhookValidator.js +409 -0
  106. package/dist/WebhookValidator.js.map +1 -0
  107. package/dist/agents/BedrockAgent.d.ts +162 -0
  108. package/dist/agents/BedrockAgent.js +323 -0
  109. package/dist/agents/BedrockAgent.js.map +1 -0
  110. package/dist/ai-chat/AIChatClient.d.ts +316 -0
  111. package/dist/ai-chat/AIChatClient.js +535 -0
  112. package/dist/ai-chat/AIChatClient.js.map +1 -0
  113. package/dist/ai-chat/ChatGateway.d.ts +408 -0
  114. package/dist/ai-chat/ChatGateway.js +747 -0
  115. package/dist/ai-chat/ChatGateway.js.map +1 -0
  116. package/dist/ai-chat/HandoffRouter.d.ts +282 -0
  117. package/dist/ai-chat/HandoffRouter.js +518 -0
  118. package/dist/ai-chat/HandoffRouter.js.map +1 -0
  119. package/dist/ai-chat/index.d.ts +12 -0
  120. package/dist/ai-chat/index.js +10 -0
  121. package/dist/ai-chat/index.js.map +1 -0
  122. package/dist/capabilities.d.ts +64 -0
  123. package/dist/capabilities.js +95 -0
  124. package/dist/capabilities.js.map +1 -0
  125. package/dist/cli/agent-loader.d.ts +32 -6
  126. package/dist/cli/agent-loader.js +92 -33
  127. package/dist/cli/agent-loader.js.map +1 -1
  128. package/dist/cli/datamap-exec.d.ts +175 -0
  129. package/dist/cli/datamap-exec.js +1284 -0
  130. package/dist/cli/datamap-exec.js.map +1 -0
  131. package/dist/cli/function-args.d.ts +40 -0
  132. package/dist/cli/function-args.js +146 -0
  133. package/dist/cli/function-args.js.map +1 -0
  134. package/dist/cli/simulation.d.ts +99 -0
  135. package/dist/cli/simulation.js +490 -0
  136. package/dist/cli/simulation.js.map +1 -0
  137. package/dist/cli/swaig-test.d.ts +12 -25
  138. package/dist/cli/swaig-test.js +935 -371
  139. package/dist/cli/swaig-test.js.map +1 -1
  140. package/dist/cli/tsdocs/agentsNote.d.ts +30 -0
  141. package/dist/cli/tsdocs/agentsNote.js +92 -0
  142. package/dist/cli/tsdocs/agentsNote.js.map +1 -0
  143. package/dist/cli/tsdocs/api-index.json +1 -0
  144. package/dist/cli/tsdocs/api.d.ts +91 -0
  145. package/dist/cli/tsdocs/api.js +372 -0
  146. package/dist/cli/tsdocs/api.js.map +1 -0
  147. package/dist/cli/tsdocs/apiTypes.d.ts +64 -0
  148. package/dist/cli/tsdocs/apiTypes.js +7 -0
  149. package/dist/cli/tsdocs/apiTypes.js.map +1 -0
  150. package/dist/cli/tsdocs/bin.d.ts +6 -0
  151. package/dist/cli/tsdocs/bin.js +23 -0
  152. package/dist/cli/tsdocs/bin.js.map +1 -0
  153. package/dist/cli/tsdocs/files.d.ts +108 -0
  154. package/dist/cli/tsdocs/files.js +287 -0
  155. package/dist/cli/tsdocs/files.js.map +1 -0
  156. package/dist/cli/tsdocs/index.d.ts +28 -0
  157. package/dist/cli/tsdocs/index.js +307 -0
  158. package/dist/cli/tsdocs/index.js.map +1 -0
  159. package/dist/cli/tsdocs/live.d.ts +41 -0
  160. package/dist/cli/tsdocs/live.js +202 -0
  161. package/dist/cli/tsdocs/live.js.map +1 -0
  162. package/dist/cli/tsdocs/locate.d.ts +51 -0
  163. package/dist/cli/tsdocs/locate.js +75 -0
  164. package/dist/cli/tsdocs/locate.js.map +1 -0
  165. package/dist/cli/tsdocs/render.d.ts +75 -0
  166. package/dist/cli/tsdocs/render.js +323 -0
  167. package/dist/cli/tsdocs/render.js.map +1 -0
  168. package/dist/cli/tsdocs/topics.d.ts +43 -0
  169. package/dist/cli/tsdocs/topics.js +920 -0
  170. package/dist/cli/tsdocs/topics.js.map +1 -0
  171. package/dist/index.d.ts +49 -68
  172. package/dist/index.js +45 -73
  173. package/dist/index.js.map +1 -1
  174. package/dist/livewire/index.d.ts +229 -155
  175. package/dist/livewire/index.js +298 -195
  176. package/dist/livewire/index.js.map +1 -1
  177. package/dist/llms.txt +65 -0
  178. package/dist/prefabs/CallSessionStore.d.ts +52 -0
  179. package/dist/prefabs/CallSessionStore.js +72 -0
  180. package/dist/prefabs/CallSessionStore.js.map +1 -0
  181. package/dist/prefabs/ConciergeAgent.d.ts +13 -1
  182. package/dist/prefabs/ConciergeAgent.js +36 -31
  183. package/dist/prefabs/ConciergeAgent.js.map +1 -1
  184. package/dist/prefabs/FAQBotAgent.d.ts +9 -1
  185. package/dist/prefabs/FAQBotAgent.js +113 -47
  186. package/dist/prefabs/FAQBotAgent.js.map +1 -1
  187. package/dist/prefabs/InfoGathererAgent.d.ts +22 -3
  188. package/dist/prefabs/InfoGathererAgent.js +67 -58
  189. package/dist/prefabs/InfoGathererAgent.js.map +1 -1
  190. package/dist/prefabs/ReceptionistAgent.d.ts +16 -5
  191. package/dist/prefabs/ReceptionistAgent.js +39 -31
  192. package/dist/prefabs/ReceptionistAgent.js.map +1 -1
  193. package/dist/prefabs/SurveyAgent.d.ts +22 -4
  194. package/dist/prefabs/SurveyAgent.js +84 -68
  195. package/dist/prefabs/SurveyAgent.js.map +1 -1
  196. package/dist/relay/Action.d.ts +44 -21
  197. package/dist/relay/Action.js +75 -17
  198. package/dist/relay/Action.js.map +1 -1
  199. package/dist/relay/Call.d.ts +312 -47
  200. package/dist/relay/Call.js +369 -18
  201. package/dist/relay/Call.js.map +1 -1
  202. package/dist/relay/Deferred.js.map +1 -1
  203. package/dist/relay/Message.d.ts +26 -5
  204. package/dist/relay/Message.js +36 -6
  205. package/dist/relay/Message.js.map +1 -1
  206. package/dist/relay/RelayClient.d.ts +44 -17
  207. package/dist/relay/RelayClient.js +175 -65
  208. package/dist/relay/RelayClient.js.map +1 -1
  209. package/dist/relay/RelayError.d.ts +14 -0
  210. package/dist/relay/RelayError.js +15 -0
  211. package/dist/relay/RelayError.js.map +1 -1
  212. package/dist/relay/RelayEvent.d.ts +96 -65
  213. package/dist/relay/RelayEvent.js +85 -56
  214. package/dist/relay/RelayEvent.js.map +1 -1
  215. package/dist/relay/closedSets.d.ts +111 -0
  216. package/dist/relay/closedSets.js +83 -0
  217. package/dist/relay/closedSets.js.map +1 -0
  218. package/dist/relay/index.d.ts +3 -1
  219. package/dist/relay/index.js +1 -0
  220. package/dist/relay/index.js.map +1 -1
  221. package/dist/relay/normalize.js.map +1 -1
  222. package/dist/relay/protocol.types.generated.d.ts +1195 -0
  223. package/dist/relay/protocol.types.generated.js +8 -0
  224. package/dist/relay/protocol.types.generated.js.map +1 -0
  225. package/dist/relay/types.d.ts +73 -42
  226. package/dist/rest/HttpClient.d.ts +36 -8
  227. package/dist/rest/HttpClient.js +233 -40
  228. package/dist/rest/HttpClient.js.map +1 -1
  229. package/dist/rest/RequestOptions.d.ts +110 -0
  230. package/dist/rest/RequestOptions.js +113 -0
  231. package/dist/rest/RequestOptions.js.map +1 -0
  232. package/dist/rest/RestError.d.ts +52 -6
  233. package/dist/rest/RestError.js +89 -5
  234. package/dist/rest/RestError.js.map +1 -1
  235. package/dist/rest/base/CrudResource.d.ts +16 -26
  236. package/dist/rest/base/CrudResource.js +19 -33
  237. package/dist/rest/base/CrudResource.js.map +1 -1
  238. package/dist/rest/base/CrudWithAddresses.d.ts +3 -2
  239. package/dist/rest/base/CrudWithAddresses.js +2 -2
  240. package/dist/rest/base/CrudWithAddresses.js.map +1 -1
  241. package/dist/rest/base/FabricResource.d.ts +15 -0
  242. package/dist/rest/base/FabricResource.js +16 -0
  243. package/dist/rest/base/FabricResource.js.map +1 -0
  244. package/dist/rest/base/ReadResource.d.ts +62 -0
  245. package/dist/rest/base/ReadResource.js +69 -0
  246. package/dist/rest/base/ReadResource.js.map +1 -0
  247. package/dist/rest/callHandler.d.ts +5 -2
  248. package/dist/rest/callHandler.js +4 -1
  249. package/dist/rest/callHandler.js.map +1 -1
  250. package/dist/rest/index.d.ts +18 -77
  251. package/dist/rest/index.js +47 -120
  252. package/dist/rest/index.js.map +1 -1
  253. package/dist/rest/namespaces/_client_tree_generated.d.ts +103 -0
  254. package/dist/rest/namespaces/_client_tree_generated.js +171 -0
  255. package/dist/rest/namespaces/_client_tree_generated.js.map +1 -0
  256. package/dist/rest/namespaces/addresses.d.ts +3 -42
  257. package/dist/rest/namespaces/addresses.js +3 -50
  258. package/dist/rest/namespaces/addresses.js.map +1 -1
  259. package/dist/rest/namespaces/calling.d.ts +6 -378
  260. package/dist/rest/namespaces/calling.js +6 -473
  261. package/dist/rest/namespaces/calling.js.map +1 -1
  262. package/dist/rest/namespaces/calling.resources.generated.d.ts +165 -0
  263. package/dist/rest/namespaces/calling.resources.generated.js +477 -0
  264. package/dist/rest/namespaces/calling.resources.generated.js.map +1 -0
  265. package/dist/rest/namespaces/calling.types.generated.d.ts +2917 -0
  266. package/dist/rest/namespaces/calling.types.generated.js +8 -0
  267. package/dist/rest/namespaces/calling.types.generated.js.map +1 -0
  268. package/dist/rest/namespaces/chat.d.ts +4 -18
  269. package/dist/rest/namespaces/chat.js +4 -21
  270. package/dist/rest/namespaces/chat.js.map +1 -1
  271. package/dist/rest/namespaces/chat.resources.generated.d.ts +12 -0
  272. package/dist/rest/namespaces/chat.resources.generated.js +29 -0
  273. package/dist/rest/namespaces/chat.resources.generated.js.map +1 -0
  274. package/dist/rest/namespaces/chat.types.generated.d.ts +56 -0
  275. package/dist/rest/namespaces/chat.types.generated.js +8 -0
  276. package/dist/rest/namespaces/chat.types.generated.js.map +1 -0
  277. package/dist/rest/namespaces/datasphere.d.ts +6 -62
  278. package/dist/rest/namespaces/datasphere.js +6 -72
  279. package/dist/rest/namespaces/datasphere.js.map +1 -1
  280. package/dist/rest/namespaces/datasphere.resources.generated.d.ts +25 -0
  281. package/dist/rest/namespaces/datasphere.resources.generated.js +50 -0
  282. package/dist/rest/namespaces/datasphere.resources.generated.js.map +1 -0
  283. package/dist/rest/namespaces/datasphere.types.generated.d.ts +180 -0
  284. package/dist/rest/namespaces/datasphere.types.generated.js +8 -0
  285. package/dist/rest/namespaces/datasphere.types.generated.js.map +1 -0
  286. package/dist/rest/namespaces/fabric.d.ts +11 -327
  287. package/dist/rest/namespaces/fabric.js +14 -439
  288. package/dist/rest/namespaces/fabric.js.map +1 -1
  289. package/dist/rest/namespaces/fabric.resources.generated.d.ts +195 -0
  290. package/dist/rest/namespaces/fabric.resources.generated.js +399 -0
  291. package/dist/rest/namespaces/fabric.resources.generated.js.map +1 -0
  292. package/dist/rest/namespaces/fabric.types.generated.d.ts +4557 -0
  293. package/dist/rest/namespaces/fabric.types.generated.js +8 -0
  294. package/dist/rest/namespaces/fabric.types.generated.js.map +1 -0
  295. package/dist/rest/namespaces/fax.resources.generated.d.ts +6 -0
  296. package/dist/rest/namespaces/fax.resources.generated.js +14 -0
  297. package/dist/rest/namespaces/fax.resources.generated.js.map +1 -0
  298. package/dist/rest/namespaces/fax.types.generated.d.ts +131 -0
  299. package/dist/rest/namespaces/fax.types.generated.js +8 -0
  300. package/dist/rest/namespaces/fax.types.generated.js.map +1 -0
  301. package/dist/rest/namespaces/imported-numbers.d.ts +3 -18
  302. package/dist/rest/namespaces/imported-numbers.js +3 -21
  303. package/dist/rest/namespaces/imported-numbers.js.map +1 -1
  304. package/dist/rest/namespaces/logs.d.ts +10 -101
  305. package/dist/rest/namespaces/logs.js +10 -128
  306. package/dist/rest/namespaces/logs.js.map +1 -1
  307. package/dist/rest/namespaces/logs.resources.generated.d.ts +9 -0
  308. package/dist/rest/namespaces/logs.resources.generated.js +17 -0
  309. package/dist/rest/namespaces/logs.resources.generated.js.map +1 -0
  310. package/dist/rest/namespaces/logs.types.generated.d.ts +131 -0
  311. package/dist/rest/namespaces/logs.types.generated.js +8 -0
  312. package/dist/rest/namespaces/logs.types.generated.js.map +1 -0
  313. package/dist/rest/namespaces/lookup.d.ts +3 -25
  314. package/dist/rest/namespaces/lookup.js +3 -27
  315. package/dist/rest/namespaces/lookup.js.map +1 -1
  316. package/dist/rest/namespaces/message.resources.generated.d.ts +6 -0
  317. package/dist/rest/namespaces/message.resources.generated.js +14 -0
  318. package/dist/rest/namespaces/message.resources.generated.js.map +1 -0
  319. package/dist/rest/namespaces/message.types.generated.d.ts +122 -0
  320. package/dist/rest/namespaces/message.types.generated.js +8 -0
  321. package/dist/rest/namespaces/message.types.generated.js.map +1 -0
  322. package/dist/rest/namespaces/messages.resources.generated.d.ts +18 -0
  323. package/dist/rest/namespaces/messages.resources.generated.js +44 -0
  324. package/dist/rest/namespaces/messages.resources.generated.js.map +1 -0
  325. package/dist/rest/namespaces/messages.types.generated.d.ts +99 -0
  326. package/dist/rest/namespaces/messages.types.generated.js +8 -0
  327. package/dist/rest/namespaces/messages.types.generated.js.map +1 -0
  328. package/dist/rest/namespaces/mfa.d.ts +3 -42
  329. package/dist/rest/namespaces/mfa.js +3 -49
  330. package/dist/rest/namespaces/mfa.js.map +1 -1
  331. package/dist/rest/namespaces/number-groups.d.ts +3 -45
  332. package/dist/rest/namespaces/number-groups.js +3 -53
  333. package/dist/rest/namespaces/number-groups.js.map +1 -1
  334. package/dist/rest/namespaces/phone-numbers.d.ts +8 -196
  335. package/dist/rest/namespaces/phone-numbers.js +8 -230
  336. package/dist/rest/namespaces/phone-numbers.js.map +1 -1
  337. package/dist/rest/namespaces/project.d.ts +6 -42
  338. package/dist/rest/namespaces/project.js +6 -51
  339. package/dist/rest/namespaces/project.js.map +1 -1
  340. package/dist/rest/namespaces/project.resources.generated.d.ts +17 -0
  341. package/dist/rest/namespaces/project.resources.generated.js +44 -0
  342. package/dist/rest/namespaces/project.resources.generated.js.map +1 -0
  343. package/dist/rest/namespaces/project.types.generated.d.ts +58 -0
  344. package/dist/rest/namespaces/project.types.generated.js +8 -0
  345. package/dist/rest/namespaces/project.types.generated.js.map +1 -0
  346. package/dist/rest/namespaces/projects.resources.generated.d.ts +12 -0
  347. package/dist/rest/namespaces/projects.resources.generated.js +25 -0
  348. package/dist/rest/namespaces/projects.resources.generated.js.map +1 -0
  349. package/dist/rest/namespaces/projects.types.generated.d.ts +77 -0
  350. package/dist/rest/namespaces/projects.types.generated.js +8 -0
  351. package/dist/rest/namespaces/projects.types.generated.js.map +1 -0
  352. package/dist/rest/namespaces/pubsub.d.ts +4 -18
  353. package/dist/rest/namespaces/pubsub.js +4 -21
  354. package/dist/rest/namespaces/pubsub.js.map +1 -1
  355. package/dist/rest/namespaces/pubsub.resources.generated.d.ts +12 -0
  356. package/dist/rest/namespaces/pubsub.resources.generated.js +29 -0
  357. package/dist/rest/namespaces/pubsub.resources.generated.js.map +1 -0
  358. package/dist/rest/namespaces/pubsub.types.generated.d.ts +60 -0
  359. package/dist/rest/namespaces/pubsub.types.generated.js +8 -0
  360. package/dist/rest/namespaces/pubsub.types.generated.js.map +1 -0
  361. package/dist/rest/namespaces/queues.d.ts +3 -38
  362. package/dist/rest/namespaces/queues.js +3 -44
  363. package/dist/rest/namespaces/queues.js.map +1 -1
  364. package/dist/rest/namespaces/recordings.d.ts +3 -34
  365. package/dist/rest/namespaces/recordings.js +3 -40
  366. package/dist/rest/namespaces/recordings.js.map +1 -1
  367. package/dist/rest/namespaces/registry.d.ts +6 -137
  368. package/dist/rest/namespaces/registry.js +6 -173
  369. package/dist/rest/namespaces/registry.js.map +1 -1
  370. package/dist/rest/namespaces/relay-rest.resources.generated.d.ts +168 -0
  371. package/dist/rest/namespaces/relay-rest.resources.generated.js +430 -0
  372. package/dist/rest/namespaces/relay-rest.resources.generated.js.map +1 -0
  373. package/dist/rest/namespaces/relay-rest.types.generated.d.ts +1906 -0
  374. package/dist/rest/namespaces/relay-rest.types.generated.js +8 -0
  375. package/dist/rest/namespaces/relay-rest.types.generated.js.map +1 -0
  376. package/dist/rest/namespaces/short-codes.d.ts +3 -35
  377. package/dist/rest/namespaces/short-codes.js +3 -41
  378. package/dist/rest/namespaces/short-codes.js.map +1 -1
  379. package/dist/rest/namespaces/sip-profile.d.ts +3 -24
  380. package/dist/rest/namespaces/sip-profile.js +3 -29
  381. package/dist/rest/namespaces/sip-profile.js.map +1 -1
  382. package/dist/rest/namespaces/verified-callers.d.ts +3 -29
  383. package/dist/rest/namespaces/verified-callers.js +3 -34
  384. package/dist/rest/namespaces/verified-callers.js.map +1 -1
  385. package/dist/rest/namespaces/video.d.ts +10 -227
  386. package/dist/rest/namespaces/video.js +10 -288
  387. package/dist/rest/namespaces/video.js.map +1 -1
  388. package/dist/rest/namespaces/video.resources.generated.d.ts +81 -0
  389. package/dist/rest/namespaces/video.resources.generated.js +171 -0
  390. package/dist/rest/namespaces/video.resources.generated.js.map +1 -0
  391. package/dist/rest/namespaces/video.types.generated.d.ts +771 -0
  392. package/dist/rest/namespaces/video.types.generated.js +8 -0
  393. package/dist/rest/namespaces/video.types.generated.js.map +1 -0
  394. package/dist/rest/namespaces/voice.resources.generated.d.ts +9 -0
  395. package/dist/rest/namespaces/voice.resources.generated.js +17 -0
  396. package/dist/rest/namespaces/voice.resources.generated.js.map +1 -0
  397. package/dist/rest/namespaces/voice.types.generated.d.ts +214 -0
  398. package/dist/rest/namespaces/voice.types.generated.js +8 -0
  399. package/dist/rest/namespaces/voice.types.generated.js.map +1 -0
  400. package/dist/rest/pagination.d.ts +5 -1
  401. package/dist/rest/pagination.js +40 -20
  402. package/dist/rest/pagination.js.map +1 -1
  403. package/dist/rest/types.d.ts +21 -3
  404. package/dist/schema.json +299 -98
  405. package/dist/skills/SkillBase.d.ts +111 -21
  406. package/dist/skills/SkillBase.js +100 -17
  407. package/dist/skills/SkillBase.js.map +1 -1
  408. package/dist/skills/SkillManager.d.ts +66 -13
  409. package/dist/skills/SkillManager.js +101 -20
  410. package/dist/skills/SkillManager.js.map +1 -1
  411. package/dist/skills/SkillName.d.ts +44 -0
  412. package/dist/skills/SkillName.js +2 -0
  413. package/dist/skills/SkillName.js.map +1 -0
  414. package/dist/skills/SkillRegistry.d.ts +22 -11
  415. package/dist/skills/SkillRegistry.js +47 -17
  416. package/dist/skills/SkillRegistry.js.map +1 -1
  417. package/dist/skills/builtin/api_ninjas_trivia.d.ts +3 -1
  418. package/dist/skills/builtin/api_ninjas_trivia.js +18 -6
  419. package/dist/skills/builtin/api_ninjas_trivia.js.map +1 -1
  420. package/dist/skills/builtin/ask_claude.d.ts +14 -4
  421. package/dist/skills/builtin/ask_claude.js +36 -14
  422. package/dist/skills/builtin/ask_claude.js.map +1 -1
  423. package/dist/skills/builtin/claude_skills.d.ts +3 -1
  424. package/dist/skills/builtin/claude_skills.js +19 -15
  425. package/dist/skills/builtin/claude_skills.js.map +1 -1
  426. package/dist/skills/builtin/custom_skills.d.ts +10 -3
  427. package/dist/skills/builtin/custom_skills.js +26 -9
  428. package/dist/skills/builtin/custom_skills.js.map +1 -1
  429. package/dist/skills/builtin/datasphere.d.ts +5 -3
  430. package/dist/skills/builtin/datasphere.js +21 -22
  431. package/dist/skills/builtin/datasphere.js.map +1 -1
  432. package/dist/skills/builtin/datasphere_serverless.d.ts +12 -1
  433. package/dist/skills/builtin/datasphere_serverless.js +17 -6
  434. package/dist/skills/builtin/datasphere_serverless.js.map +1 -1
  435. package/dist/skills/builtin/datetime.d.ts +3 -1
  436. package/dist/skills/builtin/datetime.js +11 -7
  437. package/dist/skills/builtin/datetime.js.map +1 -1
  438. package/dist/skills/builtin/google_maps.d.ts +29 -14
  439. package/dist/skills/builtin/google_maps.js +89 -269
  440. package/dist/skills/builtin/google_maps.js.map +1 -1
  441. package/dist/skills/builtin/index.d.ts +8 -6
  442. package/dist/skills/builtin/index.js +8 -6
  443. package/dist/skills/builtin/index.js.map +1 -1
  444. package/dist/skills/builtin/info_gatherer.d.ts +4 -2
  445. package/dist/skills/builtin/info_gatherer.js +20 -12
  446. package/dist/skills/builtin/info_gatherer.js.map +1 -1
  447. package/dist/skills/builtin/joke.d.ts +16 -6
  448. package/dist/skills/builtin/joke.js +54 -37
  449. package/dist/skills/builtin/joke.js.map +1 -1
  450. package/dist/skills/builtin/math.d.ts +3 -1
  451. package/dist/skills/builtin/math.js +14 -9
  452. package/dist/skills/builtin/math.js.map +1 -1
  453. package/dist/skills/builtin/mcp_gateway.d.ts +34 -5
  454. package/dist/skills/builtin/mcp_gateway.js +77 -46
  455. package/dist/skills/builtin/mcp_gateway.js.map +1 -1
  456. package/dist/skills/builtin/native_vector_search.d.ts +19 -5
  457. package/dist/skills/builtin/native_vector_search.js +179 -61
  458. package/dist/skills/builtin/native_vector_search.js.map +1 -1
  459. package/dist/skills/builtin/play_background_file.d.ts +21 -15
  460. package/dist/skills/builtin/play_background_file.js +43 -122
  461. package/dist/skills/builtin/play_background_file.js.map +1 -1
  462. package/dist/skills/builtin/spider.d.ts +42 -4
  463. package/dist/skills/builtin/spider.js +277 -104
  464. package/dist/skills/builtin/spider.js.map +1 -1
  465. package/dist/skills/builtin/swml_transfer.d.ts +14 -3
  466. package/dist/skills/builtin/swml_transfer.js +45 -24
  467. package/dist/skills/builtin/swml_transfer.js.map +1 -1
  468. package/dist/skills/builtin/weather_api.d.ts +24 -13
  469. package/dist/skills/builtin/weather_api.js +38 -30
  470. package/dist/skills/builtin/weather_api.js.map +1 -1
  471. package/dist/skills/builtin/web_search.d.ts +48 -10
  472. package/dist/skills/builtin/web_search.js +294 -100
  473. package/dist/skills/builtin/web_search.js.map +1 -1
  474. package/dist/skills/builtin/wikipedia_search.d.ts +4 -2
  475. package/dist/skills/builtin/wikipedia_search.js +14 -13
  476. package/dist/skills/builtin/wikipedia_search.js.map +1 -1
  477. package/dist/skills/index.d.ts +3 -2
  478. package/dist/skills/index.js +1 -1
  479. package/dist/skills/index.js.map +1 -1
  480. package/dist/swml_verbs_generated.d.ts +2824 -0
  481. package/dist/swml_verbs_generated.js +12 -0
  482. package/dist/swml_verbs_generated.js.map +1 -0
  483. package/dist/types.d.ts +59 -6
  484. package/dist/web.d.ts +27 -0
  485. package/dist/web.js +20 -0
  486. package/dist/web.js.map +1 -0
  487. package/docs/agent-guide.md +1034 -0
  488. package/docs/ai_chat.md +560 -0
  489. package/docs/api-reference.md +3641 -0
  490. package/docs/architecture.md +846 -0
  491. package/docs/bedrock_agent.md +411 -0
  492. package/docs/cli-guide.md +403 -0
  493. package/docs/cloud_functions_guide.md +399 -0
  494. package/docs/configuration.md +548 -0
  495. package/docs/contexts-guide.md +884 -0
  496. package/docs/datamap-guide.md +1207 -0
  497. package/docs/developer_pain_points.md +548 -0
  498. package/docs/llm_parameters.md +298 -0
  499. package/docs/mcp_gateway_reference.md +354 -0
  500. package/docs/mcp_integration.md +162 -0
  501. package/docs/pgi_agent_guide.md +1820 -0
  502. package/docs/prefabs-guide.md +815 -0
  503. package/docs/programmatically_governed_inference.md +301 -0
  504. package/docs/sdk_features.md +501 -0
  505. package/docs/security.md +559 -0
  506. package/docs/serverless-guide.md +520 -0
  507. package/docs/skills-guide.md +1223 -0
  508. package/docs/skills-system.md +405 -0
  509. package/docs/skills_parameter_schema.md +417 -0
  510. package/docs/swaig-reference.md +1986 -0
  511. package/docs/swml_service_guide.md +573 -0
  512. package/docs/third_party_skills.md +410 -0
  513. package/docs/web_service.md +666 -0
  514. package/examples/README.md +202 -0
  515. package/examples/advanced-datamap.ts +108 -0
  516. package/examples/advanced-dynamic-config.ts +70 -0
  517. package/examples/auto-vivified.ts +95 -0
  518. package/examples/call-flow.ts +65 -0
  519. package/examples/comprehensive-dynamic.ts +125 -0
  520. package/examples/contexts-steps.ts +65 -0
  521. package/examples/custom-path.ts +45 -0
  522. package/examples/datamap-tools.ts +51 -0
  523. package/examples/datasphere-multi-instance.ts +66 -0
  524. package/examples/datasphere-serverless-env.ts +87 -0
  525. package/examples/datasphere-webhook-env.ts +65 -0
  526. package/examples/datasphere.ts +56 -0
  527. package/examples/declarative.ts +100 -0
  528. package/examples/dynamic-config.ts +54 -0
  529. package/examples/dynamic-info-gatherer.ts +69 -0
  530. package/examples/dynamic-swml-service.ts +67 -0
  531. package/examples/gather-info.ts +95 -0
  532. package/examples/gather-per-question-functions-demo.ts +139 -0
  533. package/examples/joke-agent.ts +34 -0
  534. package/examples/kubernetes-agent.ts +45 -0
  535. package/examples/llm-params.ts +75 -0
  536. package/examples/mcp-agent.ts +89 -0
  537. package/examples/mcp-gateway.ts +81 -0
  538. package/examples/multi-agent.ts +80 -0
  539. package/examples/multi-endpoint.ts +79 -0
  540. package/examples/pgi/case-domain.ts +114 -0
  541. package/examples/pgi/serve.ts +16 -0
  542. package/examples/pgi/support-agent.ts +265 -0
  543. package/examples/pom-prompt.ts +70 -0
  544. package/examples/prefab-concierge.ts +42 -0
  545. package/examples/prefab-faq.ts +58 -0
  546. package/examples/prefab-info-gatherer.ts +33 -0
  547. package/examples/prefab-receptionist.ts +36 -0
  548. package/examples/prefab-survey.ts +69 -0
  549. package/examples/quickstart-agent.ts +29 -0
  550. package/examples/quickstart-relay.ts +25 -0
  551. package/examples/quickstart-rest.ts +25 -0
  552. package/examples/record-call.ts +65 -0
  553. package/examples/relay-demo.ts +33 -0
  554. package/examples/room-and-sip.ts +93 -0
  555. package/examples/serverless-lambda.ts +43 -0
  556. package/examples/session-state.ts +83 -0
  557. package/examples/simple-agent.ts +36 -0
  558. package/examples/simple-static.ts +29 -0
  559. package/examples/skills-demo.ts +41 -0
  560. package/examples/step-function-inheritance-demo.ts +124 -0
  561. package/examples/swaig-features.ts +193 -0
  562. package/examples/swml-service-routing.ts +66 -0
  563. package/examples/swml-service.ts +38 -0
  564. package/examples/swmlservice_ai_sidecar.ts +104 -0
  565. package/examples/swmlservice_swaig_standalone.ts +79 -0
  566. package/examples/tap.ts +67 -0
  567. package/examples/typed-tools.ts +68 -0
  568. package/examples/verb-methods.ts +45 -0
  569. package/examples/web-search-multi-instance.ts +75 -0
  570. package/examples/web-search.ts +38 -0
  571. package/examples/wikipedia.ts +36 -0
  572. package/livewire/README.md +164 -0
  573. package/livewire/docs/migration-guide.md +251 -0
  574. package/livewire/examples/livewire-basic-agent.ts +74 -0
  575. package/livewire/examples/livewire-handoff.ts +196 -0
  576. package/livewire/examples/livewire-multi-tool.ts +121 -0
  577. package/package.json +85 -13
  578. package/relay/README.md +101 -0
  579. package/relay/docs/call-methods.md +622 -0
  580. package/relay/docs/client-reference.md +281 -0
  581. package/relay/docs/events.md +193 -0
  582. package/relay/docs/getting-started.md +221 -0
  583. package/relay/docs/guide.md +386 -0
  584. package/relay/docs/messaging.md +246 -0
  585. package/relay/examples/relay-inbound.ts +66 -0
  586. package/relay/examples/relay-messaging.ts +74 -0
  587. package/relay/examples/relay-outbound.ts +76 -0
  588. package/rest/README.md +141 -0
  589. package/rest/docs/calling.md +313 -0
  590. package/rest/docs/client-reference.md +149 -0
  591. package/rest/docs/fabric.md +192 -0
  592. package/rest/docs/getting-started.md +138 -0
  593. package/rest/docs/guide.md +421 -0
  594. package/rest/docs/namespaces.md +367 -0
  595. package/rest/docs/phone-binding.md +116 -0
  596. package/rest/examples/rest-10dlc-registration.ts +177 -0
  597. package/rest/examples/rest-bind-phone-to-swml-webhook.ts +66 -0
  598. package/rest/examples/rest-calling-ivr-and-ai.ts +136 -0
  599. package/rest/examples/rest-calling-play-and-record.ts +98 -0
  600. package/rest/examples/rest-client.ts +59 -0
  601. package/rest/examples/rest-datasphere-search.ts +81 -0
  602. package/rest/examples/rest-fabric-conferences-and-routing.ts +147 -0
  603. package/rest/examples/rest-fabric-subscribers-and-sip.ts +106 -0
  604. package/rest/examples/rest-fabric-swml-and-callflows.ts +101 -0
  605. package/rest/examples/rest-manage-resources.ts +64 -0
  606. package/rest/examples/rest-phone-number-management.ts +200 -0
  607. package/rest/examples/rest-queues-mfa-and-recordings.ts +143 -0
  608. package/rest/examples/rest-video-rooms.ts +186 -0
  609. package/tutorial/fred/fred.ts +218 -0
  610. package/tutorial/fred/tutorial/01-introduction.md +141 -0
  611. package/tutorial/fred/tutorial/02-setup.md +304 -0
  612. package/tutorial/fred/tutorial/03-basic-agent.md +284 -0
  613. package/tutorial/fred/tutorial/04-wikipedia-skill.md +298 -0
  614. package/tutorial/fred/tutorial/05-custom-functions.md +347 -0
  615. package/tutorial/fred/tutorial/06-running-testing.md +642 -0
  616. package/tutorial/fred/tutorial/README.md +56 -0
  617. package/tutorial/fred/tutorial/appendix-complete-code.md +632 -0
  618. package/tutorial/fred/tutorial/appendix-docker-deployment.md +504 -0
  619. package/tutorial/full-guardrails-agent/handlers.ts +436 -0
  620. package/tutorial/full-guardrails-agent/penny.ts +305 -0
  621. package/tutorial/full-guardrails-agent/reservations.ts +1109 -0
  622. package/tutorial/full-guardrails-agent/tutorial/01-why-guardrails.md +149 -0
  623. package/tutorial/full-guardrails-agent/tutorial/02-design-first.md +139 -0
  624. package/tutorial/full-guardrails-agent/tutorial/03-rules-first.md +422 -0
  625. package/tutorial/full-guardrails-agent/tutorial/04-the-shell.md +238 -0
  626. package/tutorial/full-guardrails-agent/tutorial/05-steps-and-scoping.md +247 -0
  627. package/tutorial/full-guardrails-agent/tutorial/06-tools-that-decide.md +467 -0
  628. package/tutorial/full-guardrails-agent/tutorial/07-gather-and-projection.md +160 -0
  629. package/tutorial/full-guardrails-agent/tutorial/08-the-verification-gate.md +333 -0
  630. package/tutorial/full-guardrails-agent/tutorial/09-people-and-endings.md +313 -0
  631. package/tutorial/full-guardrails-agent/tutorial/10-testing-and-running.md +387 -0
  632. package/tutorial/full-guardrails-agent/tutorial/README.md +106 -0
  633. package/tutorial/full-guardrails-agent/tutorial/appendix-complete-code.md +2207 -0
  634. package/tutorial/full-guardrails-agent/tutorial/appendix-deployment.md +191 -0
  635. package/tutorial/full-guardrails-agent/tutorial/appendix-technique-map.md +117 -0
  636. package/tutorial/full-guardrails-agent/workflow.ts +219 -0
  637. package/tutorial/multi_agents/README.md +175 -0
  638. package/tutorial/multi_agents/advanced_agent.ts +395 -0
  639. package/tutorial/multi_agents/extending_agents.ts +641 -0
  640. package/tutorial/multi_agents/knowledge.ts +59 -0
  641. package/tutorial/multi_agents/lesson1_first_agent.md +368 -0
  642. package/tutorial/multi_agents/lesson2_knowledge_bases.md +404 -0
  643. package/tutorial/multi_agents/lesson3_multi_agent_systems.md +621 -0
  644. package/tutorial/multi_agents/lesson4_advanced_features.md +805 -0
  645. package/tutorial/multi_agents/lesson5_extending_agents.md +856 -0
  646. package/tutorial/multi_agents/pc_builder.ts +529 -0
  647. package/tutorial/multi_agents/sales_agent.ts +88 -0
  648. package/tutorial/multi_agents/sales_agent_with_search.ts +116 -0
  649. package/tutorial/multi_agents/sales_knowledge.md +139 -0
  650. package/tutorial/multi_agents/support_knowledge.md +256 -0
  651. package/dist/cli/mock-data.d.ts +0 -37
  652. package/dist/cli/mock-data.js +0 -80
  653. package/dist/cli/mock-data.js.map +0 -1
  654. package/dist/generateVerbTypes.d.ts +0 -11
  655. package/dist/generateVerbTypes.js +0 -265
  656. package/dist/generateVerbTypes.js.map +0 -1
  657. package/dist/rest/namespaces/compat.d.ts +0 -585
  658. package/dist/rest/namespaces/compat.js +0 -735
  659. package/dist/rest/namespaces/compat.js.map +0 -1
@@ -0,0 +1,284 @@
1
+ # Lesson 3: Creating Fred's Basic Structure
2
+
3
+ This lesson builds Fred's foundation: the agent class, the prompt that sets its persona, its voice, and its conversation settings. Fred can't search anything yet. Lesson 4 adds that.
4
+
5
+ ## Table of Contents
6
+
7
+ 1. [Creating the Agent Class](#creating-the-agent-class)
8
+ 2. [Defining Fred's Personality](#defining-freds-personality)
9
+ 3. [Configuring Voice and Language](#configuring-voice-and-language)
10
+ 4. [Setting Conversation Parameters](#setting-conversation-parameters)
11
+ 5. [Adding Speech Recognition Hints](#adding-speech-recognition-hints)
12
+ 6. [Testing the Basic Structure](#testing-the-basic-structure)
13
+
14
+ ---
15
+
16
+ ## Creating the Agent Class
17
+
18
+ Fred is a class that extends `AgentBase`. Create a new file called `fred.ts` in the project directory.
19
+
20
+ ### Step 1: Import and Class Definition
21
+
22
+ Start with the import and the class:
23
+
24
+ ```typescript
25
+ /**
26
+ * Fred: a Wikipedia knowledge bot
27
+ *
28
+ * An agent that searches Wikipedia and shares facts about Wikipedia itself,
29
+ * with a friendly, curious persona.
30
+ *
31
+ * Run: npx tsx fred.ts
32
+ */
33
+
34
+ import { AgentBase } from '@signalwire/sdk';
35
+
36
+ /** Fred, a Wikipedia assistant with a friendly persona. */
37
+ export class FredTheWikiBot extends AgentBase {
38
+ constructor() {
39
+ super({ name: 'Fred', route: '/fred' });
40
+ }
41
+ }
42
+ ```
43
+
44
+ Each part has a job:
45
+
46
+ - `AgentBase` is the SDK class every agent is built from. Lessons 4 and 5 add two more names to this import.
47
+ - `export` lets other files, and the SDK's test tool, use the class
48
+ - `name: 'Fred'` is the agent's name
49
+ - `route: '/fred'` is the agent's HTTP path, so Fred answers at `http://localhost:3000/fred`
50
+
51
+ Every step in the rest of this lesson adds code inside the constructor, after the `super()` call.
52
+
53
+ ## Defining Fred's Personality
54
+
55
+ The prompt tells the model who Fred is and how to behave. The SDK builds it from named sections, using the Prompt Object Model (POM).
56
+
57
+ ### Step 2: Add Personality Section
58
+
59
+ The first section sets the persona:
60
+
61
+ <!-- include: tutorial/fred/fred.ts#personality --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
62
+ ```typescript
63
+ // Set up Fred's personality with the Prompt Object Model
64
+ this.promptAddSection('Personality', {
65
+ body:
66
+ 'You are Fred, a friendly and knowledgeable assistant who loves learning and ' +
67
+ "sharing information from Wikipedia. You're enthusiastic about facts and always " +
68
+ 'eager to help people discover new things.',
69
+ });
70
+ ```
71
+
72
+ `promptAddSection()` takes the section's title and an object with its content. A section has a `body`, a list of `bullets`, or both.
73
+
74
+ ### Step 3: Add Goal and Instructions
75
+
76
+ Two more sections give Fred a goal and specific instructions:
77
+
78
+ <!-- include: tutorial/fred/fred.ts#goal --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
79
+ ```typescript
80
+ this.promptAddSection('Goal', {
81
+ body:
82
+ 'Help users find reliable factual information by searching Wikipedia. ' +
83
+ 'Make learning fun and engaging.',
84
+ });
85
+
86
+ this.promptAddSection('Instructions', {
87
+ bullets: [
88
+ 'Introduce yourself as Fred when greeting users',
89
+ 'Use the search_wiki function whenever users ask about factual topics',
90
+ 'Be enthusiastic about sharing knowledge',
91
+ 'Search before you say Wikipedia has nothing on a topic, even one that sounds made up',
92
+ "If Wikipedia doesn't have information, suggest alternative search terms",
93
+ 'Make learning conversational and enjoyable',
94
+ 'Add interesting context or follow-up questions to engage users',
95
+ ],
96
+ });
97
+ ```
98
+
99
+ Each section has a purpose:
100
+
101
+ - **Personality**: Fred's character and tone
102
+ - **Goal**: what Fred is for
103
+ - **Instructions**: specific behavior, as bullet points
104
+
105
+ The instructions name `search_wiki`, the function Lesson 4 adds. The fourth bullet comes from testing. Without it, the model sometimes decided a topic sounded made up, and said Wikipedia had nothing on it without searching.
106
+
107
+ ## Configuring Voice and Language
108
+
109
+ A language entry sets the voice Fred speaks with, and the phrases it can say while it thinks.
110
+
111
+ ### Step 4: Add Language Configuration
112
+
113
+ Add the language after the prompt sections:
114
+
115
+ <!-- include: tutorial/fred/fred.ts#voice --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
116
+ ```typescript
117
+ // Configure Fred's voice
118
+ this.addLanguage({
119
+ name: 'English',
120
+ code: 'en-US',
121
+ voice: 'rime.bolt', // A friendly, energetic voice for Fred
122
+ speechFillers: [
123
+ 'Hmm, let me think...',
124
+ "Oh, that's interesting...",
125
+ 'Great question!',
126
+ 'Let me see...',
127
+ ],
128
+ });
129
+ ```
130
+
131
+ The settings work like this:
132
+
133
+ - `name`: a display name for the language
134
+ - `code`: the language code, `en-US` for US English
135
+ - `voice`: the text-to-speech voice, written as `provider.voice_name`. `rime.bolt` is the Rime provider's "bolt" voice.
136
+ - `speechFillers`: phrases the platform can say while the model prepares a reply
137
+
138
+ The SWML document spells this setting `fillers`, because Fred sets no function fillers. The agent guide's [Languages](../../../docs/agent-guide.md#languages) section covers the other language settings.
139
+
140
+ ## Setting Conversation Parameters
141
+
142
+ Parameters control how the conversation runs: which model, who speaks first, and how long a pause ends a turn.
143
+
144
+ ### Step 5: Set AI Parameters
145
+
146
+ Set the parameters with `setParams()`:
147
+
148
+ <!-- include: tutorial/fred/fred.ts#params --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
149
+ ```typescript
150
+ // Set conversation parameters
151
+ this.setParams({
152
+ ai_model: 'gpt-4.1-nano', // The model that runs the conversation
153
+ wait_for_user: true, // The caller speaks first
154
+ end_of_speech_timeout: 1000, // Milliseconds of silence that end the caller's turn
155
+ ai_volume: 7, // Voice volume adjustment (-50 to 50, default 0)
156
+ local_tz: 'America/New_York', // Time zone for time-related functions
157
+ });
158
+ ```
159
+
160
+ The keys are the SWML schema's own names, in `snake_case`. Each has a range the platform accepts:
161
+
162
+ - `ai_model`: the model that runs the conversation. The SWML schema lists `gpt-4o-mini` (the default), `gpt-4.1-mini` and `gpt-4.1-nano`. Fred uses `gpt-4.1-nano`, the smallest of the three.
163
+ - `wait_for_user`: when `true`, the caller speaks first. When `false`, the agent opens the conversation.
164
+ - `end_of_speech_timeout`: how many milliseconds of silence end the caller's turn, from 250 to 10,000. The default is 700.
165
+ - `ai_volume`: raises or lowers the agent's voice, from -50 to 50. The default is 0.
166
+ - `local_tz`: the agent's time zone, as an IANA name
167
+
168
+ ### Step 6: Add Global Data
169
+
170
+ Global data is session data that travels with the call:
171
+
172
+ <!-- include: tutorial/fred/fred.ts#global-data --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
173
+ ```typescript
174
+ // Add some context about Fred
175
+ this.setGlobalData({
176
+ assistant_name: 'Fred',
177
+ specialty: 'Wikipedia knowledge',
178
+ personality_traits: ['friendly', 'curious', 'enthusiastic', 'helpful'],
179
+ });
180
+ ```
181
+
182
+ The model doesn't see global data unless a prompt refers to a key, such as `${global_data.specialty}`. Functions receive it with every request, as `rawData.global_data`, so it's a place for facts your code needs during the call.
183
+
184
+ ## Adding Speech Recognition Hints
185
+
186
+ Hints tell speech recognition which words and phrases to expect.
187
+
188
+ ### Step 7: Add Recognition Hints
189
+
190
+ Add the words callers are likely to say to Fred:
191
+
192
+ <!-- include: tutorial/fred/fred.ts#hints --> <!-- snippet: no-compile a quote from inside the constructor in tutorial/fred/fred.ts, which tsc checks whole -->
193
+ ```typescript
194
+ // Add hints for better speech recognition
195
+ this.addHints([
196
+ 'Wikipedia',
197
+ 'Fred',
198
+ 'tell me about',
199
+ 'what is',
200
+ 'who is',
201
+ 'search for',
202
+ 'look up',
203
+ ]);
204
+ ```
205
+
206
+ Hints improve recognition accuracy when callers say these words. The order of Steps 2 to 7 doesn't matter to the SDK. The finished `fred.ts` in [Appendix A](appendix-complete-code.md#complete-fredts) adds the hints before the parameters.
207
+
208
+ ## Testing the Basic Structure
209
+
210
+ Creating Fred doesn't start a server, so a few lines at the end of the file can build it and print what it is. Add them after the class:
211
+
212
+ <!-- snippet: no-compile continues fred.ts from Step 1, whose FredTheWikiBot class it uses -->
213
+ ```typescript
214
+ // Build Fred without starting a server, and show what it is
215
+ const fred = new FredTheWikiBot();
216
+ console.log('Fred created.');
217
+ console.log(` Name: ${fred.getName()}`);
218
+ console.log(` Route: ${fred.route}`);
219
+ ```
220
+
221
+ Run the file to build the agent and print its name and route:
222
+
223
+ ```bash
224
+ npx tsx fred.ts
225
+ ```
226
+
227
+ Two warnings from the SDK come first. The first says that Fred doesn't check webhook signatures, and the second says the SDK generated a password, because none is set. [Lesson 6](06-running-testing.md#important-information) covers both. The rest of the output confirms the agent's name and route:
228
+
229
+ ```text
230
+ 2026-09-29T17:33:25.871Z [WARN] [AgentBase] [signalwire] webhook signature validation is disabled — set signingKey or SIGNALWIRE_SIGNING_KEY to enable
231
+ 2026-09-29T17:33:25.872Z [WARN] [AgentBase] basic_auth_password_autogenerated: username="Fred". No SWML_BASIC_AUTH_PASSWORD found in environment and no basicAuth passed to the agent constructor. The SDK generated a random password that exists only in this process; external callers will get HTTP 401 unless this process hands it to them (getBasicAuthCredentials()). To fix, set SWML_BASIC_AUTH_USER and SWML_BASIC_AUTH_PASSWORD in your .env, or pass { basicAuth: [user, pass] } to the agent constructor.
232
+ Fred created.
233
+ Name: Fred
234
+ Route: /fred
235
+ ```
236
+
237
+ The `typecheck` script from [Lesson 2](02-setup.md#the-packagejson-file) runs `tsc` over the file. `tsx` runs a file without checking its types, so run the check after each change:
238
+
239
+ ```bash
240
+ npm run typecheck
241
+ ```
242
+
243
+ When the types are right, the output shows only the command npm ran:
244
+
245
+ ```text
246
+ > fred-bot@1.0.0 typecheck
247
+ > tsc --noEmit
248
+ ```
249
+
250
+ ## Key Concepts Review
251
+
252
+ This lesson used three of the SDK's building blocks.
253
+
254
+ ### Prompt Object Model (POM)
255
+
256
+ POM organizes the prompt into named sections:
257
+
258
+ - Easier to maintain than one long prompt
259
+ - Each behavior can be updated in its own section
260
+ - A clear structure as the agent grows
261
+
262
+ ### Voice Configuration
263
+
264
+ The language entry controls how Fred sounds:
265
+
266
+ - Several text-to-speech providers are available
267
+ - Each voice has its own character
268
+ - Speech fillers cover the pause while the model prepares a reply
269
+
270
+ ### Global Data
271
+
272
+ Global data holds session facts:
273
+
274
+ - Functions receive it with every request
275
+ - The model sees a value only when a prompt refers to it
276
+ - It can hold any JSON-serializable data
277
+
278
+ ## Next Steps
279
+
280
+ Fred has a persona and a voice, but it can't search Wikipedia yet. Continue with [Lesson 4: Adding the Wikipedia Search Skill](04-wikipedia-skill.md).
281
+
282
+ ---
283
+
284
+ [Previous: Environment Setup](02-setup.md) | [Overview](README.md) | [Next: Wikipedia Skill](04-wikipedia-skill.md)
@@ -0,0 +1,298 @@
1
+ # Lesson 4: Adding the Wikipedia Search Skill
2
+
3
+ Fred's job is answering questions from Wikipedia. Instead of writing the search code, this lesson adds the SDK's `wikipedia_search` skill, configures it, and looks at what the skill does inside the agent.
4
+
5
+ ## Table of Contents
6
+
7
+ 1. [Understanding Skills](#understanding-skills)
8
+ 2. [Adding the Wikipedia Skill](#adding-the-wikipedia-skill)
9
+ 3. [Configuring the Skill](#configuring-the-skill)
10
+ 4. [How Skills Work Internally](#how-skills-work-internally)
11
+ 5. [Testing Wikipedia Search](#testing-wikipedia-search)
12
+ 6. [How Fred Uses Wikipedia Search](#how-fred-uses-wikipedia-search)
13
+ 7. [Skill Benefits](#skill-benefits)
14
+
15
+ ---
16
+
17
+ ## Understanding Skills
18
+
19
+ Skills are modules that add a capability to an agent, much like plugins.
20
+
21
+ ### What Is a Skill?
22
+
23
+ A skill has four properties:
24
+
25
+ - It's a self-contained class with one capability
26
+ - It registers its own functions and prompt text with the agent
27
+ - It's configured with an object of parameters
28
+ - It can be reused across agents
29
+
30
+ ### Available Built-in Skills
31
+
32
+ The SDK includes several ready-made skills, including:
33
+
34
+ - `wikipedia_search`: search Wikipedia articles
35
+ - `datetime`: get the current date and time
36
+ - `math`: perform calculations
37
+ - `web_search`: search the web with the Google Custom Search API (needs an API key and the `cheerio` package)
38
+ - `weather_api`: get the weather from OpenWeatherMap (needs an API key)
39
+
40
+ The [Skills System Guide](../../../docs/skills-guide.md#built-in-skills) lists every built-in skill and what it needs.
41
+
42
+ ## Adding the Wikipedia Skill
43
+
44
+ A skill is a class. You create it, then pass it to the agent's `addSkill()` method.
45
+
46
+ ### Step 1: Basic Skill Addition
47
+
48
+ `addSkill()` returns a promise, because a skill can do setup work before it's ready. A constructor can't wait for a promise, so the skill doesn't go in Fred's constructor. Instead, an `async` function builds Fred and then adds the skill.
49
+
50
+ First, add `WikipediaSearchSkill` to the import at the top of `fred.ts`:
51
+
52
+ ```typescript
53
+ import { AgentBase, WikipediaSearchSkill } from '@signalwire/sdk';
54
+ ```
55
+
56
+ Then add this function after the class:
57
+
58
+ <!-- snippet: no-compile continues fred.ts, whose FredTheWikiBot class it uses -->
59
+ ```typescript
60
+ /** Build Fred, then add the Wikipedia search skill, which loads asynchronously. */
61
+ export async function createFred(): Promise<FredTheWikiBot> {
62
+ const fred = new FredTheWikiBot();
63
+
64
+ // Add the Wikipedia search skill
65
+ await fred.addSkill(new WikipediaSearchSkill());
66
+
67
+ return fred;
68
+ }
69
+ ```
70
+
71
+ With that function, Fred can search Wikipedia. The next step tunes the skill for Fred.
72
+
73
+ ### Step 2: Customized Configuration
74
+
75
+ Replace the function with a version that configures the skill:
76
+
77
+ <!-- include: tutorial/fred/fred.ts#create --> <!-- snippet: no-compile a quote of the createFred function in tutorial/fred/fred.ts, which tsc checks whole -->
78
+ ```typescript
79
+ /** Build Fred, then add the Wikipedia search skill, which loads asynchronously. */
80
+ export async function createFred(): Promise<FredTheWikiBot> {
81
+ const fred = new FredTheWikiBot();
82
+
83
+ // Add the Wikipedia search skill with custom configuration
84
+ await fred.addSkill(
85
+ new WikipediaSearchSkill({
86
+ num_results: 2, // Get up to 2 articles for broader coverage
87
+ no_results_message:
88
+ "Oh, I couldn't find anything about '{query}' on Wikipedia. " +
89
+ 'Maybe try different keywords or let me know if you meant something else!',
90
+ swaig_fields: {
91
+ fillers: {
92
+ 'en-US': [
93
+ 'Let me look that up on Wikipedia for you...',
94
+ 'Searching Wikipedia for that information...',
95
+ 'One moment, checking Wikipedia...',
96
+ 'Let me find that in the encyclopedia...',
97
+ ],
98
+ },
99
+ },
100
+ }),
101
+ );
102
+
103
+ return fred;
104
+ }
105
+ ```
106
+
107
+ The configuration keys are `snake_case`, as they are in the SignalWire SDKs for other languages.
108
+
109
+ ## Configuring the Skill
110
+
111
+ The configuration object has three options.
112
+
113
+ ### Configuration Parameters
114
+
115
+ Each option changes one part of how the skill behaves:
116
+
117
+ | Option | Default | What it does |
118
+ |---|---|---|
119
+ | `num_results` | `1` | The number of Wikipedia articles to return. The skill's parameter schema allows 1 to 5. More results cover more ground, and make longer responses. Fred uses 2. |
120
+ | `no_results_message` | A generic "couldn't find" message | What the function returns when no article matches. `{query}` is replaced with the search term. Write it in the agent's voice, because the model relays it to the caller. |
121
+ | `swaig_fields` | None | Extra settings for the function the skill registers. `fillers` are phrases the platform says while the search runs, by language code. |
122
+
123
+ The skill searches English Wikipedia, `en.wikipedia.org`, and has no option for another language.
124
+
125
+ ### Example Configurations
126
+
127
+ Different agents need different settings. This example gives three agents three configurations:
128
+
129
+ ```typescript
130
+ import { AgentBase, WikipediaSearchSkill } from '@signalwire/sdk';
131
+
132
+ // Minimal configuration
133
+ const minimal = new AgentBase({ name: 'minimal', route: '/minimal' });
134
+ await minimal.addSkill(new WikipediaSearchSkill());
135
+
136
+ // Academic assistant
137
+ const academic = new AgentBase({ name: 'academic', route: '/academic' });
138
+ await academic.addSkill(
139
+ new WikipediaSearchSkill({
140
+ num_results: 3,
141
+ no_results_message:
142
+ "No Wikipedia entries found for '{query}'. Check the spelling or try related terms.",
143
+ }),
144
+ );
145
+
146
+ // Casual helper
147
+ const casual = new AgentBase({ name: 'casual', route: '/casual' });
148
+ await casual.addSkill(
149
+ new WikipediaSearchSkill({
150
+ num_results: 1,
151
+ no_results_message: "Hmm, Wikipedia doesn't have info on '{query}'. Got another topic?",
152
+ swaig_fields: {
153
+ fillers: { 'en-US': ['Let me check...', 'Looking that up...'] },
154
+ },
155
+ }),
156
+ );
157
+ ```
158
+
159
+ ## How Skills Work Internally
160
+
161
+ `addSkill()` does three things when it runs.
162
+
163
+ ### What Happens When You Add a Skill
164
+
165
+ 1. **Checks.** The agent's skill manager refuses a second copy of a skill that allows only one. It also checks the environment variables and packages the skill needs, and `wikipedia_search` needs none.
166
+
167
+ 2. **Setup.** It awaits the skill's `setup()` method. The Wikipedia skill reads `num_results` and `no_results_message` there. A skill whose `setup()` returns `false` isn't added, and `addSkill()` rejects.
168
+
169
+ 3. **Registration.** The agent registers what the skill contributes: its functions, its prompt sections, its hints and its global data. This is the function definition in the skill's own code, `src/skills/builtin/wikipedia_search.ts`:
170
+
171
+ <!-- copy of: src/skills/builtin/wikipedia_search.ts (excerpt) --> <!-- snippet: no-compile an excerpt from the skill's getTools() method in the SDK source -->
172
+ ```typescript
173
+ defineSkillTool({
174
+ name: 'search_wiki',
175
+ description: 'Search Wikipedia for information about a topic and get article summaries',
176
+ parameters: {
177
+ query: {
178
+ type: 'string',
179
+ description: 'The search term or topic to look up on Wikipedia.',
180
+ },
181
+ },
182
+ ```
183
+
184
+ The skill also adds a "Wikipedia Search" section to the prompt, which tells the model when to use the function and how many summaries it returns.
185
+
186
+ ### The search_wiki Function
187
+
188
+ After adding the skill, Fred has a `search_wiki` function. It takes one string argument and returns text:
189
+
190
+ ```text
191
+ search_wiki(query: string): string
192
+ ```
193
+
194
+ When the model calls it, the function:
195
+
196
+ 1. Searches Wikipedia for articles that match the query
197
+ 2. Retrieves the introduction of each article
198
+ 3. Returns the introductions as text, separated by a line of `=` characters
199
+
200
+ The model calls it with the caller's topic as the `query` argument, for example `{ "query": "Marie Curie" }`.
201
+
202
+ ## Testing Wikipedia Search
203
+
204
+ A few lines at the end of `fred.ts` can confirm the skill loaded, without starting a server.
205
+
206
+ ### Step 3: Update the Test Lines
207
+
208
+ Replace the test lines from Lesson 3 with these. `createFred` is `async`, so they `await` it:
209
+
210
+ <!-- snippet: no-compile continues fred.ts, whose createFred function it uses -->
211
+ ```typescript
212
+ // Build Fred and list what the skill added
213
+ const fred = await createFred();
214
+ console.log(`Fred's skills: ${fred.listSkills().map((skill) => skill.name).join(', ')}`);
215
+ console.log(`Fred's tools: ${fred.getTools().map((tool) => tool.name).join(', ')}`);
216
+ ```
217
+
218
+ `listSkills()` returns the loaded skills, and `getTools()` returns the functions the agent registered. Run the file:
219
+
220
+ ```bash
221
+ npx tsx fred.ts
222
+ ```
223
+
224
+ After the same two warnings as in Lesson 3, the output lists the skill and the function it added:
225
+
226
+ ```text
227
+ Fred's skills: wikipedia_search
228
+ Fred's tools: search_wiki
229
+ ```
230
+
231
+ ## How Fred Uses Wikipedia Search
232
+
233
+ When a caller asks about a topic, five things happen:
234
+
235
+ 1. **The caller says:** "Who was Marie Curie?"
236
+ 2. **The model decides** the question needs Wikipedia
237
+ 3. **The model calls** `search_wiki` with `{ "query": "Marie Curie" }`
238
+ 4. **The skill returns** the article introductions
239
+ 5. **The model answers** the caller, in Fred's voice
240
+
241
+ ### Example Conversation Flow
242
+
243
+ This exchange is from a text chat with the finished Fred, shortened to two turns. On a phone call, the platform also says one of the fillers while the search runs.
244
+
245
+ ```text
246
+ Caller: Hi there!
247
+ Fred: Hi there! I'm Fred, your friendly Wikipedia explorer. What fascinating fact or topic would you like to learn about today?
248
+
249
+ Caller: Who was Marie Curie, and what year did she win her second Nobel Prize?
250
+ [Fred calls search_wiki with {"query":"Marie Curie"}]
251
+ Fred: Marie Curie was a remarkable physicist and chemist who made groundbreaking discoveries in radioactivity. She won her second Nobel Prize in Chemistry in 1911, for the discovery of the elements radium and polonium, and for her studies on their nature and compounds. Would you like to learn more about her scientific achievements or her life story?
252
+ ```
253
+
254
+ The answer comes from the article's introduction, which says she won the 1911 Nobel Prize in Chemistry.
255
+
256
+ ## Skill Benefits
257
+
258
+ A skill saves you from writing and maintaining the integration yourself.
259
+
260
+ ### Why Use Skills Instead of Custom Code?
261
+
262
+ With the skill, Wikipedia search is one call:
263
+
264
+ <!-- snippet: no-compile fragment: `fred` is the agent createFred builds -->
265
+ ```typescript
266
+ await fred.addSkill(new WikipediaSearchSkill());
267
+ ```
268
+
269
+ Without it, you'd write every part yourself:
270
+
271
+ ```typescript
272
+ // You'd need to:
273
+ // 1. Choose a Wikipedia API
274
+ // 2. Make the API calls
275
+ // 3. Parse the responses
276
+ // 4. Format the results
277
+ // 5. Handle errors
278
+ // 6. Register a SWAIG function
279
+ // 7. Write its handler
280
+ ```
281
+
282
+ ### What Skills Provide
283
+
284
+ Using a skill gives you:
285
+
286
+ 1. **Tested functionality**: built and tested with the SDK
287
+ 2. **A consistent interface**: every skill is configured the same way
288
+ 3. **Error handling**: failures return a message instead of crashing the call
289
+ 4. **Documentation**: the [Skills System Guide](../../../docs/skills-guide.md) covers each built-in skill
290
+ 5. **Maintenance**: fixes arrive with SDK updates
291
+
292
+ ## Next Steps
293
+
294
+ Fred can search Wikipedia. Next, add a function of your own that shares facts about Wikipedia. Continue with [Lesson 5: Creating Custom Functions](05-custom-functions.md).
295
+
296
+ ---
297
+
298
+ [Previous: Basic Agent](03-basic-agent.md) | [Overview](README.md) | [Next: Custom Functions](05-custom-functions.md)